Users must login to the  "My Media page" to access the editing page.

To edit or add a chapter 

1. Login to your My Media page.
2. Click on the entry you want to edit.
   
3. In the entry page, click the Actions button and select Edit.
   
4. Select the Timeline tab. Here you can view all the chapters and slides in the video.
   
   
5. Place the cursor on the timeline and click Create Chapter to update a new chapter, or click on the cue point for the chapter you want to edit to view its properties. 
   
6. After you create a chapter, you can:
   
1. Add or modify the Chapter Title.
2. Select a thumbnail. You can upload a thumbnail image for the chapter, or automatically create one from the video. 
3. Add or modify the Chapter Description (optional).
4. Add Search Tags (optional).
7. Click View in Player to see your changes.

To delete a chapter

Using Slides to Enhance the Kaltura Video Experience 

_______________________________________________________________________________________

Updating Kaltura HTML5 Player V2 is an easy operation, and requires a  few simple steps. To see the step by step process for the upgrade click here.

_______________________________________________________________________________________

Players can be branded or skinned by changing the Player logo and colors, or even by creating completely new css themes.To change the logo on your Player see: How to remove or change the Kaltura logo from the Player control bar?

To learn more about creating a custom theme, please refer to the Kaltura Player v2 Toolkit Theme & Skin Guide.

_______________________________________________________________________________________

When a Player is edited the Studio tab, the Player is automatically rendered every time you change a control. Unchecking the Auto-preview check box will discontinue this behavior. 

_______________________________________________________________________________________

Yes, it is possible by saving these events as cue-points metadata in Kaltura. This will allow the Player (across devices) to read the cue points and create all sorts of experiences like chapters. For example, see the Chapters Player plugin.

_______________________________________________________________________________________

You can learn about all the Universal Studio, and how to access it within the KMC from the Universal Studio Information Guide.

_______________________________________________________________________________________

The Universal Studio enables users to directly customize Kaltura Player Toolkit Players, also known as v2 Players. The Kaltura Player Toolkit uses a unified HTML, CSS and JavaScript runtime to drive all Players. This is a big improvement over the the Flash Studio which only reflected the Flash UI and configuration. For a more and complete list of advantages of the Kaltura Player Toolkit over previous versions see the Kaltura Player Toolkit page.

_______________________________________________________________________________________

The Universal Studio works best with the all the latest versions of HTML5 browsers IE11, Firefox or Chrome. IE8 is functional but for the best experience we recommend you use one of the lastest browsers.

_______________________________________________________________________________________

We are actively working to enhance the Universal Studio to support all features previously supported in the Flash Studio. Some features that are currently unavailable are:
    •    Custom Flash skins -- any custom Flash skin work will not cross over to the v2 HTML / CSS based skin. 
    •    Player Templates, Light and dark themes -- presently only a single dark theme is provided in  the Universal Studio. Templates for initial Player creation are currently in the development stages. 
    •    Download, upload, capture
    •    3rd party components captions, PLYmedia
    •    Custom buttons -- no generic custom button interface is yet available
    •    Additional Parms and plugins -- no generic interface for adding custom plugins. You can presently use the work around described in the integration document, where by you edit JSON Player configuration directly using the Player version utility page

Basic Controls:

• Vertical volume control – not supported on v2 (was not available on old Studio as well but was supported)
• Left Play Counter – Can be configured from old Studio. Cannot be configured from new
• Right Play Counter – Can be configured from old Studio. Cannot be configured from new Studio.
• On Video Play Button – Can be configured from old Studio. Cannot be configured from new Studio.
• Download Button - Can be configured from old Studio. Cannot be configured from new Studio.
• Upload Button - Can be configured from old Studio. Cannot be configured from new Studio.
• Scrubber – Can be switched on/off in old Studio. Cannot be switched on/off in new Studio.
• Replay button – Can be switched on/off in old Studio. Cannot be switched on/off in new Studio.
• On video unmute button - Can be configured from old Studio. Cannot be configured from new Studio.
• Share button – It is possible to configure when to show the button on old Studio. Not possible on new Studio.
• Capture thumbnail -  - Can be configured from old Studio. Cannot be configured from new Studio.

_______________________________________________________________________________________

All Universal Studio Players are 508 compliant. The Player’s features include:

• Support for captions file in timed text or SRT formats for the video/audio file
• Support for an audio description in a standardized format for the video/audio file
• Hidden text elements for every non-text element (for screen readers)
• Tooltips

Keyboard tabbing and controls For more information see 508 Support within the Kaltura Player Toolkit.

_______________________________________________________________________________________

The same entry captions flow should be used to add captions to a specific entry. Once added, you can use the "captions" plugin in the Universal Player Studio to activate the captions plugin. See the Universal Player Studio Guide for more details.

_______________________________________________________________________________________

The Player Studio provides a highly functional GUI interface, but you can also edit the Player JSON directly via the Player version utility page. In the near future, the Universal Studio will support direct JSON edited as well.

_______________________________________________________________________________________

See the analytics tab within the Player Studio and the Universal Studio Information Guide.

_______________________________________________________________________________________

Playlists are supported in the Universal Studio. You can set up the look and feel of the playlist under the "look and feel" section of the Universal Studio.

_______________________________________________________________________________________

All of the features listed on Player.kaltura.com will make their way into the Universal Studio, and the documentation is shared between both systems.

_______________________________________________________________________________________

All changes you make to an existing Player will propagate to all sites where the Player has been embedded, including syndicated Players on other sites.

To edit a Player

1. Select the Universal Studio tab.
2. Click on the relevant Player in the Player List.
3. Select an icon to modify the current Player configuration.
4. Click Save Player Settings. To learn more refer to Universal Studio Information Guide. 

_______________________________________________________________________________________

To duplicate a Player

1. Select the Universal Studio tab.
2. Click on the relevant Player in the Player List.
3. Click Duplicate.
4. The Player configuration Basic Configuration window is displayed and the Player is rendered as a Creating a Player in the Universal Studio Universal Studio Information Guide 10 copy of the existing Player.
5. Modify the Player’s Basic Display settings to give the new Player a distinct name
6. Click Save Player Settings. To learn more refer to Universal Studio Information Guide 

_______________________________________________________________________________________

To delete a Player

1. Select the Universal Studio tab.
2. In the Actions column of the relevant Player, click Delete.
   A Delete confirmation prompt is displayed.
3. Confirm the deletion. To learn more refer to Universal Studio Information Guide

_______________________________________________________________________________________

The Universal Studio tab displays the complete list of the Players defined in your account. This includes Players created with the Flash Studio. To edit any Player in the Universal s\Studio the Player must be updated to the new Universal Studio Players. This includes any Players previously created via API and even early versions of v2 Players. All Players created using the previous KMC Studio are automatically available to be upgraded in the new Universal Studio. All Players can be upgraded to the latest version of software.

To update/upgrade the Players 

1. Select the Studio tab and then click Universal Studio.
   The list of existing Players is displayed.
2. Click Update to update the Player to the Universal Studio Player. To learn more refer to Universal Studio Information Guide.

_______________________________________________________________________________________

Each Player contains a collection of features of a specific Kaltura Player configuration. In addition to the Kaltura defined features, a Player can include a custom plugin configuration.

To create a Player

1. Select the Universal Studio tab.
2. Click Add New Player
3. Configure the Basic settings.
4. Configure the Universal Studio Player Look and Feel Features.
5. Configure the Analytics. (Optional)
6. Configure the Monetization. (Optional)
7. Configure the Plugins (Optional)
8. Click Save Player Settings. To learn more refer to Universal Studio Information Guide.

_______________________________________________________________________________________

To modify custom styles

1.     Select the Universal Studio tab and select the Look and Feel icon.
2.     Check the box next to Custom Styles to enable this option.
3.     Modify the parameters.
4.     Click Preview changes to preview your modifications.
5.     Click Save Player Settings. 

You can use to add information screen about the video.

To modify the info screen

1.     Select the Universal Studio tab and select the Look and Feel icon.
2.     Check the box next to Info screen to enable this option.
3.     Modify the parameters.
4.     Click Preview changes to preview your modifications.
5.     Click Save Player Settings. 

You can use the Share feature to add the Share interface to the Player.

To set the share button

1. Select the Universal Studio tab and select the Look and Feel icon.
2. Check the box next to Share feature to enable this option.
3. Select the parent (where the Share button should be placed) from the drop down menu.

   The options are:

4. Select the Share button alignment location.
5. Enter the Order where the Share button should be displayed.
6. Enter a Social share URL. (optional) This will control what URL is shared to the respective social networks. For example http://mysite.com/videos/{mediaProxy.entry.id} would share a page on your site with that URL where the current video entry id is substituted into the URL.
7. Enter the social networks that you want to create Share buttons for. The defaults are Facebook, Twitter and Google+.
8. Click Preview changes to preview your modifications.
9. Click Save Player Settings. 

_______________________________________________________________________________________

KDP requires Flash Player v10.2 or above. To learn how to set up the Flash Builder with the KDP3 project, see Setting up the KDP in Flash Builder 4.

_______________________________________________________________________________________

When you edit a Player in the Studio tab, the Player is automatically rendered every time you change a control. Uncheck the Auto-preview check box to discontinue this behavior. 

• On-the-fly repackaging of MP4 files to DASH, HDS, HLS, MSS

• Adaptive bitrate support

• Working modes:

  1. Local - serve locally accessible files (local disk/NFS mounted)
  2. Remote - serve files accessible via HTTP using range requests
  3. Mapped - perform an HTTP request to map the input URI to a locally accessible file

• Fallback support for file not found in local/mapped modes (useful in multi-datacenter environments)

• Video codecs: H264, H265 (dash only)

• Audio codecs: AAC

• Audio only/video only files

• Track selection for multi audio/video MP4 files

• Playback rate change - 0.5x up to 2x (requires libavcodec and libavfilter)

• Source file clipping (only from I-Frame to P-frame)

• Support for variable segment lengths - enabling the player to select the optimal bitrate fast, without the overhead of short segments for the whole duration of the video

• Serving of files for progressive download playback

• DASH: common encryption (cenc) support

• HLS: Mux audio and video streams from separate MP4 files (HLS/HDS)

• HLS: Generation of I-frames playlist (EXT-X-I-FRAMES-ONLY)

• HLS: AES-128 encryption support

• Only AAC audio is supported (MP3 audio is not)

• Clipping is not supported in progressive download

• I-frames playlist generation is not supported when encryption is enabled

• SAMPLE-AES encryption is not supported

• Tested on Linux only

cd to NGINX source directory and execute:

./configure --add-module=/path/to/nginx-vod-module
make
make install

For asynchronous I/O support add --with-file-aio (highly recommended, local and mapped modes only)

./configure --add-module=/path/to/nginx-vod-module --with-file-aio

For asynchronous file open using thread pool add --with-threads (nginx 1.7.11+, local and mapped modes only)

./configure --add-module=/path/to/nginx-vod-module --with-threads

To compile nginx with debug messages add --with-debug

./configure --add-module=/path/to/nginx-vod-module --with-debug

To disable compiler optimizations (for debugging with gdb) add CFLAGS="-g -O0"

CFLAGS="-g -O0" ./configure ....

If you are using RHEL or CentOS 6, you can install by setting up the repo:

# rpm -ihv http://installrepo.kaltura.org/releases/kaltura-release.noarch.rpm
# yum install kaltura-nginx

If you are using RHEL/CentOS7, install the kaltura-release RPM and modify /etc/yum.repos.d/kaltura.repo to read:

baseurl = http://installrepo.kaltura.org/releases/rhel7/RPMS/$basearch/

Instead of the default:

baseurl = http://installrepo.kaltura.org/releases/latest/RPMS/$basearch/

# wget -O - http://installrepo.kaltura.org/repo/apt/debian/kaltura-deb.gpg.key|apt-key add -
# echo "deb http://installrepo.kaltura.org/repo/apt/debian jupiter main"> /etc/apt/sources.list.d/kaltura.list
# apt-get install kaltura-nginx

The basic structure of an nginx-vod-module URL is: http://<domain>/<location>/<fileuri>/<filename>

Where:

• domain - the domain of the nginx-vod-module server
• location - the location specified in the nginx conf
• fileuri - a URI to the mp4 file:filename - detailed below
  • local mode - the full file path is determined according to the root / alias nginx.conf directives
  • mapped mode - the full file path is determined according to the response from the upstream
  • remote mode - the mp4 file is read from upstream in chunks

Note: in mapped & remote modes, the URL of the upstream request is http://<upstream>/<location>/<fileuri>?<extraargs> (extraargs is determined by the vod_upstream_extra_args parameter)

Multi URLs are used to encode several URLs on a single URL. A multi URL can be used to specify the URLs of several different MP4 files that should be included together in a DASH MPD for example.

The structure of a multi URL is: http://<domain>/<location>/<prefix>,<middle1>,<middle2>,<middle3>,<postfix>.urlset/<filename>

The sample URL above represents 3 URLs:

• http://<domain>/<location>/<prefix><middle1><postfix>.urlset/<filename>
• http://<domain>/<location>/<prefix><middle2><postfix>.urlset/<filename>
• http://<domain>/<location>/<prefix><middle3><postfix>.urlset/<filename>

The suffix .urlset (can be changed with vod_multi_uri_suffix) indicates that the URL should be treated as a multi URL.

The following parameters are supported on the URL path:

• clipFrom - an offset in milliseconds since the beginning of the video, where the generated stream should start. For example, .../clipFrom/10000/... will generate a stream that starts 10 seconds into the video.
• clipTo - an offset in milliseconds since the beginning of the video, where the generated stream should end. For example, .../clipTo/60000/... will generate a stream truncated to 60 seconds.
• tracks - can be used to select specific audio/video tracks. The structure of parameter is: v<id1>-v<id2>-a<id1>-a<id2>... For example, .../tracks/v1-a1/... will select the first video track and first audio track. The default is to include all tracks.

The structure of filename is: <basename>[<fileparams>][<trackparams>].<extension>

Where:

• basename + extension - the set of options is packager specific (the list below applies to the default settings):fileparams - can be used to select specific files (URLs) when using multi URLs. For example, manifest-f1.mpd will return an MPD only from the first URL.
  • dash - manifest.mpd
  • hds - manifest.f4m
  • hls master playlist - master.m3u8
  • hls media playlist - index.m3u8
  • mss - manifest
• fileparams - can be used to select specific files (URLs) when using multi URLs. For example, manifest-f1.mpd will return an MPD only from the first URL.
• trackparams - can be used to select specific audio/video tracks. For example, manifest-a1.f4m will return an F4M containing only the first audio stream. The default is to include the first audio and first video tracks of each file. The tracks selected on the file name are AND-ed with the tracks selected with the /tracks/ path parameter.

• syntax: vod segmenter
• default: n/a
• context: location

Enables the nginx-vod module on the enclosing location. Currently the allowed values for segmenter are:

1. none - serves the MP4 files as is
2. dash - Dynamic Adaptive Streaming over HTTP packetizer
3. hds - Adobe HTTP Dynamic Streaming packetizer
4. hls - Apple HTTP Live Streaming packetizer
5. mss - Microsoft Smooth Streaming packetizer

• syntax: vod_mode mode
• default: local
• context: http, server, location

Sets the file access mode - local, remote or mapped (see the features section above for more details)

• syntax: vod_status
• default: n/a
• context: location

Enables the nginx-vod status page on the enclosing location.

• syntax: vod_multi_uri_suffix suffix
• default: .urlset
• context: http, server, location

A URL suffix that is used to identify multi URLs. A multi URL is a way to encode several different URLs that should be played together as an adaptive streaming set, under a single URL. When the default suffix is used, an HLS set URL may look like: http://host/hls/common-prefix,bitrate1,bitrate2,common-suffix.urlset/master.m3u8

• syntax: vod_segment_duration duration
• default: 10s
• context: http, server, location

Sets the segment duration in milliseconds.

• syntax: vod_bootstrap_segment_durations duration
• default: none
• context: http, server, location

Adds a bootstrap segment duration in milliseconds. This setting can be used to make the first few segments shorter than the default segment duration, thus making the adaptive flavor selection kick-in earlier without the overhead of short segments throughout the video.

• syntax: vod_align_segments_to_key_frames on/off
• default: off
• context: http, server, location

When enabled, the module forces all segments to start with a key frame. Enabling this setting can lead to differences between the actual segment durations and the durations reported in the manifest (unless vod_manifest_segment_durations_mode is set to accurate).

• syntax: vod_segment_count_policy last_short/last_long/last_rounded
• default: last_short
• context: http, server, location

Configures the policy for calculating the segment count, for segment_duration = 10 seconds:

• last_short - a file of 33 sec is partitioned as - 10, 10, 10, 3
• last_long - a file of 33 sec is partitioned as - 10, 10, 13
• last_rounded - a file of 33 sec is partitioned as - 10, 10, 13, a file of 38 sec is partitioned as 10, 10, 10, 8

• syntax: vod_manifest_segment_durations_mode estimate/accurate
• default: estimate
• context: http, server, location

Configures the calculation mode of segment durations within manifest requests:

• estimate - reports the duration as configured in nginx.conf, e.g. if vod_segment_duration has the value 10000, an HLS manifest will contain #EXTINF:10
• accurate - reports the exact duration of the segment, taking into account the frame durations, e.g. for a frame rate of 29.97 and 10 second segments it will report the first segment as 10.01. accurate mode also takes into account the key frame alignment, in case vod_align_segments_to_key_frames is on

• syntax: vod_secret_key string
• default: empty
• context: http, server, location

Sets the secret that is used to generate the TS encryption key, if empty, no encryption is performed.

• syntax: vod_duplicate_bitrate_threshold threshold
• default: 4096
• context: http, server, location

The bitrate threshold for removing identical bitrates, streams whose bitrate differences are less than this value will be considered identical.

• syntax: vod_https_header_name name
• default: empty
• context: http, server, location

Sets the name of an HTTP header whose existence determines whether the request was issued over HTTPS. If not set, the decision is made according to the protocol used to connect to the nginx server. A common scenario for using this setting is a load-balancer placed before the nginx that performs SSL-offloading.

• syntax: vod_segments_base_url url
• default: empty
• context: http, server, location

Sets the base URL (usually domain only) that should be used for delivering video segments. When empty, the host header sent on the request will be used as the domain. The scheme (http/https) used in the returned URLs is determined by:

• the value of vod_segments_base_url, if it starts with http:// or https://
• the existence of a request header whose name matches the value of vod_https_header_name, if vod_https_header_name is not empty
• the type of connection used to connect to the nginx server The setting currently affects only HLS.

• syntax: vod_open_file_thread_pool pool_name
• default: off
• context: http, server, location

Enables the use of asynchronous file open via thread pool. The thread pool must be defined with a thread_pool directive, if no pool name is specified the default pool is used. This directive is supported only on nginx 1.7.11 or newer when compiling with --add-threads. Note: this directive currently disables the use of nginx's open_file_cache by nginx-vod-module

• syntax: vod_moov_cache zone_name zone_size
• default: off
• context: http, server, location

Configures the size and shared memory object name of the moov atom cache

• syntax: vod_response_cache zone_name zone_size
• default: off
• context: http, server, location

Configures the size and shared memory object name of the response cache. The response cache holds manifests and other non-video content (like DASH init segment, HLS encryption key etc.). Video segments are not cached.

• syntax: vod_initial_read_size size
• default: 4K
• context: http, server, location

Sets the size of the initial read operation of the MP4 file.

• syntax: vod_max_moov_size size
• default: 128MB
• context: http, server, location

Sets the maximum supported MP4 moov atom size.

• syntax: vod_cache_buffer_size size
• default: 256K
• context: http, server, location

Sets the size of the cache buffers used when reading MP4 frames.

• syntax: vod_child_request
• default: n/a
• context: location

Configures the enclosing location as handling nginx-vod module child requests (remote/mapped modes only) There should be at least one location with this command when working in remote/mapped modes. Note that multiple vod locations can point to a single location having vod_child_request.

• syntax: vod_child_request_path path
• default: none
• context: location

Sets the path of an internal location that has vod_child_request enabled (remote/mapped modes only)

• syntax: vod_upstream upstream_name
• default: none
• context: http, server, location

Sets the upstream that should be used for reading the MP4 file (remote mode) or mapping the request URI (mapped mode).

• syntax: vod_upstream_host_header host_name
• default: the host name of original request
• context: http, server, location

Sets the value of the HTTP host header that should be sent to the upstream (remote/mapped modes only).

• syntax: vod_upstream_extra_args "arg1=value1&arg2=value2&..."
• default: empty
• context: http, server, location

Extra query string arguments that should be added to the upstream request (remote/mapped modes only). The parameter value can contain variables.

• syntax: vod_connect_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for connecting to the upstream (remote/mapped modes only).

• syntax: vod_send_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for sending data to the upstream (remote/mapped modes only).

• syntax: vod_read_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for reading data from the upstream (remote/mapped modes only).

• syntax: vod_path_mapping_cache zone_name zone_size
• default: off
• context: http, server, location

Configures the size and shared memory object name of the path mapping cache (mapped mode only).

• syntax: vod_path_response_prefix prefix
• default: <?xml version="1.0" encoding="utf-8"?><xml><result>
• context: http, server, location

Sets the prefix that is expected in URI mapping responses (mapped mode only).

• syntax: vod_path_response_postfix postfix
• default: </result></xml>
• context: http, server, location

Sets the postfix that is expected in URI mapping responses (mapped mode only).

• syntax: vod_max_path_length length
• default: 1K
• context: http, server, location

Sets the maximum length of a path returned from upstream (mapped mode only).

• syntax: vod_fallback_upstream upstream_name
• default: none
• context: http, server, location

Sets an upstream to forward the request to when encountering a file not found error (local/mapped modes only).

• syntax: vod_fallback_connect_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for connecting to the fallback upstream (local/mapped modes only).

• syntax: vod_fallback_send_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for sending data to the fallback upstream (local/mapped modes only).

• syntax: vod_fallback_read_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for reading data from the fallback upstream (local/mapped modes only).

• syntax: vod_proxy_header_name name
• default: X-Kaltura-Proxy
• context: http, server, location

Sets the name of an HTTP header that is used to prevent fallback proxy loops (local/mapped modes only).

• syntax: vod_proxy_header_value name
• default: dumpApiRequest
• context: http, server, location

Sets the value of an HTTP header that is used to prevent fallback proxy loops (local/mapped modes only).

• syntax: vod_clip_to_param_name name
• default: clipTo
• context: http, server, location

The name of the clip to request parameter.

• syntax: vod_clip_from_param_name name
• default: clipFrom
• context: http, server, location

The name of the clip from request parameter.

• syntax: vod_tracks_param_name name
• default: tracks
• context: http, server, location

The name of the tracks request parameter.

• syntax: vod_speed_param_name name
• default: tracks
• context: http, server, location

The name of the speed request parameter.

• syntax: vod_performance_counters zone_name
• default: off
• context: http, server, location

Configures the shared memory object name of the performance counters

• syntax: vod_drm_enabled on/off
• default: off
• context: http, server, location

When enabled, the module encrypts the media segments according to the response it gets from the drm upstream. Currently supported only for dash.

• syntax: vod_drm_clear_lead_segment_count count
• default: 1
• context: http, server, location

Sets the number of clear (unencrypted) segments in the beginning of the stream. A clear lead enables the player to start playing without having to wait for the license response.

• syntax: vod_drm_max_info_length length
• default: 4K
• context: http, server, location

Sets the maximum length of a drm info returned from upstream.

• syntax: vod_drm_upstream upstream_name
• default: none
• context: http, server, location

Sets the upstream that should be used for getting the DRM info for the file.

• syntax: vod_drm_connect_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for connecting to the upstream.

• syntax: vod_drm_send_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for sending data to the upstream.

• syntax: vod_drm_read_timeout timeout
• default: 60s
• context: http, server, location

Sets the timeout in milliseconds for reading data from the upstream.

• syntax: vod_drm_info_cache zone_name zone_size
• default: off
• context: http, server, location

Configures the size and shared memory object name of the drm info cache.

• syntax: vod_drm_request_uri uri
• default: $uri
• context: http, server, location

Sets the uri of drm info requests, the parameter value can contain variables. In case of multi url, $uri will one of the sub URLs (a separate drm info request is issued per sub URL)

• syntax: vod_dash_absolute_manifest_urls on/off
• default: on
• context: http, server, location

When enabled the server returns absolute URLs in MPD requests

• syntax: vod_dash_manifest_file_name_prefix name
• default: manifest
• context: http, server, location

The name of the MPD file (an mpd extension is implied).

• syntax: vod_dash_init_file_name_prefix name
• default: init
• context: http, server, location

The name of the MP4 initialization file (an mp4 extension is implied).

• syntax: vod_dash_fragment_file_name_prefix name
• default: frag
• context: http, server, location

The name of the fragment files (an m4s extension is implied).

• syntax: vod_hds_manifest_file_name_prefix name
• default: manifest
• context: http, server, location

The name of the HDS manifest file (an f4m extension is implied).

• syntax: vod_hds_fragment_file_name_prefix name
• default: frag
• context: http, server, location

The prefix of fragment file names, the actual file name is frag-f<file-index>-v<video-track-index>-a<audio-track-index>-Seg1-Frag<index>.

The name of the HDS manifest file (an f4m extension is implied).

• syntax: vod_hls_absolute_master_urls on/off
• default: on
• context: http, server, location

When enabled the server returns absolute playlist URLs in master playlist requests

• syntax: vod_hls_absolute_index_urls on/off
• default: on
• context: http, server, location

When enabled the server returns absolute segment URLs in media playlist requests

• syntax: vod_hls_absolute_iframe_urls on/off
• default: off
• context: http, server, location

When enabled the server returns absolute segment URLs in iframe playlist requests

• syntax: vod_hls_master_file_name_prefix name
• default: master
• context: http, server, location

The name of the HLS master playlist file (an m3u8 extension is implied).

• syntax: vod_hls_index_file_name_prefix name
• default: index
• context: http, server, location

The name of the HLS media playlist file (an m3u8 extension is implied).

• syntax: vod_hls_iframes_file_name_prefix name
• default: iframes
• context: http, server, location

The name of the HLS I-frames playlist file (an m3u8 extension is implied).

• syntax: vod_hls_segment_file_name_prefix name
• default: seg
• context: http, server, location

The prefix of segment file names, the actual file name is seg-<index>-v<video-track-index>-a<audio-track-index>.ts.

• syntax: vod_hls_encryption_key_file_name name
• default: encryption.key
• context: http, server, location

The name of the encryption key file name (only relevant when vod_secret_key is used).

• syntax: vod_mss_manifest_file_name_prefix name
• default: manifest
• context: http, server, location

The name of the manifest file (has no extension).

http {
    upstream fallback {
        server kalhls-a-pa.origin.kaltura.com:80;
    }

    server {        
        open_file_cache          max=1000 inactive=5m;
        open_file_cache_valid    2m;
        open_file_cache_min_uses 1;
        open_file_cache_errors   on;

        aio on;

        location /content/ {
            vod hls;
            vod_mode local;
            vod_moov_cache moov_cache 512m;
            vod_fallback_upstream fallback;

            root /web/content;

            gzip on;
            gzip_types application/vnd.apple.mpegurl;

            expires 100d;
            add_header Last-Modified "Sun, 19 Nov 2000 08:52:00 GMT";
        }
    }
}

http {
    upstream kalapi {
        server www.kaltura.com:80;
    }

    upstream fallback {
        server kalhls-a-pa.origin.kaltura.com:80;
    }

    server {

        open_file_cache          max=1000 inactive=5m;
        open_file_cache_valid    2m;
        open_file_cache_min_uses 1;
        open_file_cache_errors   on;

        aio on;

        location /__child_request__/ {
            internal;
            vod_child_request;
        }

        location ~ ^/p/\d+/(sp/\d+/)?serveFlavor/ {
            vod hls;
            vod_mode mapped;
            vod_moov_cache moov_cache 512m;
            vod_secret_key mukkaukk;
            vod_child_request_path /__child_request__/;
            vod_upstream kalapi;
            vod_upstream_host_header www.kaltura.com;
            vod_upstream_extra_args "pathOnly=1";
            vod_path_mapping_cache mapping_cache 5m;
            vod_fallback_upstream fallback;

            gzip on;
            gzip_types application/vnd.apple.mpegurl;

            expires 100d;
            add_header Last-Modified "Sun, 19 Nov 2000 08:52:00 GMT";
        }
    }
}

http {
    upstream kalapi {
        server www.kaltura.com:80;
    }

    server {        
        location /__child_request__/ {
            internal;
            vod_child_request;
        }

        location ~ ^/p/\d+/(sp/\d+/)?serveFlavor/ {
            vod hls;
            vod_mode remote;
            vod_moov_cache moov_cache 512m;
            vod_secret_key mukkaukk;
            vod_child_request_path /__child_request__/;
            vod_upstream kalapi;
            vod_upstream_host_header www.kaltura.com;

            gzip on;
            gzip_types application/vnd.apple.mpegurl;

            expires 100d;
            add_header Last-Modified "Sun, 19 Nov 2000 08:52:00 GMT";
        }
    }
}

The CLI libs require PHP CLI from version 5.3.3 and above, with the CURL PHP extension.

Extract the package contents and run the setup.sh script with:

$ ./setup.sh $BASEDIR $SERVICE_URL $PARTNER_ID $ADMIN_SECRET

Where:

$BASEDIR is the prefix in which you wish to install the clientlibs

$SERVICE_URL is the Kaltura API edge point, for instance www.kaltura.com if working against Kaltura's SaaS

$PARTNER_ID is your Kaltura partner ID

$ADMIN_SECRET is your partner ID's admin_secret which can be found by going to:

KMC->Settings->Integration Settings

or by making the following DB query:

mysql> select admin_secret from partner where id=$PARTNER_ID

You can then run this sanity test to ensure all is working:

$ ./tests/sanity.sh $BASE_DIR $PARTNER_ID

Alternatively, you can follow these manual steps:

• Replace the @BASEDIR@ token with the path to kalcliAutoComplete.php in:

    kalcliAliases.sh
    kalcliAutoComplete
    logToCli

e.g. if kalcliAutoComplete was copied to /a/b/kalcliAutoComplete @BASEDIR@ should be set to /a/b

• Copy config/config.template.ini to config/config.ini and fill out the parameters:
• Secret repositories - required for the extractKs / generateKs / renewKs utilities. Two types of repositories can be configured:
• Preset repositories - contain a fixed list of (partner id, admin secret) pairs
• Database repositories - contain the connection details for a Kaltura server database, that can be used to pull the secrets of partner accounts.

NOTE: The second option is only possible if you are hosting your own Kaltura ENV. For SaaS, only the first one is viable.

• IP address salt - required for the genIpHeader utility. The salt has to match the parameter 'remote_addr_header_salt' that is configured in configuration/local.ini on the Kaltura server.

NOTE: This is only relevant when hosting your own Kaltura ENV, otherwise, leave empty.

• API Host - The default is www.kaltura.com if not defined May be uncommented and modified in order to globally point to a different api host The -u parameter may be used to override the api host via command line
• Log Dir - The log directory that contains kaltura_api_v3.log (typically /var/log or /opt/kaltura/log)

This is relevant to the --log flag, that makes kalcli print the API log instead of the API output.

Note: this works only when kalcli is executed against a Kaltura server running on the same machine

To use kalcli on Windows you'll need to install:

• Cygwin- make sure to include the bash-completion package (not included by default)
• Xampp or any other platform that provides PHP CLI 5.3 and above with the CURL extension.

Installation is the same as for Linux, but note the following:

• Perform the steps from the Cygwin bash
• The meaning of BASEDIR in step 2 is different than steps 3 & 5 - in step 2 you need to use a path relative to the drive root while in steps 3 & 5 you need to use a path relative to Cygwin root. For example:
• If you install kalcli in C:\Cygwin\cli, you'll need to use /cygwin/cli in step 2, and use /cli in 3 & 5.
• If you install kalcli in C:\cli, you'll need to use /cli in step 2, and use /cygdrive/c/cli in 3 & 5.

1. Getting the ids of 30 entries:

$ genks $PARTNER_ID | kalcli media list | awk '$1 == "id"'

Sample output:

    id      0_bvnwwuiw
    id      0_dmuzyn77
    id      0_ii3bbdq9
    id      0_nv9zbm2b
    id      0_nz4oy27t

1. Diffing access control profiles:

$ (genks $PARTNER_ID | kalcli accesscontrol get id=7003 > /tmp/a1) ; (genks $PARTNER_ID | kalcli accesscontrol get id=8005 > /tmp/a2) ; diff /tmp/a1 /tmp/a2

1. Getting the number of distinct entries in a playlist:

$ genks $PARTNER_ID | kalcli playlist execute id=1_1a2b3c | grep -P 'id\t' | sort | uniq | wc -l

Sample output:

2

1. Using a precreated session:

$ kalcli -x media list ks=MDQ2ZThjOTI0MTJmZGIxYTVlMWVhNDJlZDZhNDAyMDkyMWJhNzE0OXw0Mzc0ODE7NDM3NDgxOzEzNjI0OTI3Njc7MDsxMzYyNDA2MzY3Ljc3NzM7MDt3aWRnZXQ6MSx2aWV3Oio7Ow==

Sample output:

KalturaMediaListResponse
        objects array
                0       KalturaMediaEntry
                        mediaType       1
                        conversionQuality       6
                        sourceType      1
                        dataUrl http://54.160.105.103:80/p/101/sp/10100/playManifest/entryId/0_9b791llw/format/url/protocol/http
                        flavorParamsIds 0,2,3,4,5,6
                        plays   0
                        views   0
                        duration        33
                        msDuration      33097
                        id      0_9b791llw
                        name    Sample Big Buck Bunny Trailer (HD)
                        description     Sample Big Buck Bunny Trailer (HD)
                        partnerId       101
                        userId  template
                        creatorId       template
                        tags    hd content, video, bunny
                        categories      video,hd content
                        categoriesIds   7,8
                        status  2
                        moderationStatus        6
                        moderationCount 0
                        type    1
                        createdAt       1434218441      (2015-06-13 21:00:41)
                        updatedAt       1434218444      (2015-06-13 21:00:44)
                        rank    0
                        totalRank       0
                        votes   0
                        downloadUrl     http://54.160.105.103/p/101/sp/10100/raw/entry_id/0_9b791llw/version/0
                        searchText      _PAR_ONLY_ _101_ _MEDIA_TYPE_1|  Sample Big Buck Bunny Trailer (HD) hd content, video, bunny Sample Big Buck Bunny Trailer (HD) 
                        licenseType     -1
                        version 0
                        thumbnailUrl    http://54.160.105.103/p/101/sp/10100/thumbnail/entry_id/0_9b791llw/version/100000/acv/92
                        accessControlId 2
                        replacementStatus       0
                        partnerSortValue        0
                        conversionProfileId     6
                        rootEntryId     0_9b791llw
                        operationAttributes     array
                        entitledUsersEdit
                        entitledUsersPublish
                1       KalturaMediaEntry
                        mediaType       1
                        conversionQuality       6
                        sourceType      1
                        dataUrl http://54.160.105.103:80/p/101/sp/10100/playManifest/entryId/0_i2xs97r8/format/url/protocol/http
                        flavorParamsIds 0,3,4
                        plays   0
                        views   0
                        duration        30
                        msDuration      29853
                        id      0_i2xs97r8
                        name    Normal web quality video (400kbps)
                        description     Normal web quality video
                        partnerId       101
                        userId  template
                        creatorId       template
                        tags    fish
                        categories      fish
                        categoriesIds   5
                        status  2
                        moderationStatus        6
                        moderationCount 0
                        type    1
                        createdAt       1434218437      (2015-06-13 21:00:37)
                        updatedAt       1434218439      (2015-06-13 21:00:39)
                        rank    0
                        totalRank       0
                        votes   0
                        downloadUrl     http://54.160.105.103/p/101/sp/10100/raw/entry_id/0_i2xs97r8/version/0
                        searchText      _PAR_ONLY_ _101_ _MEDIA_TYPE_1|  Normal web quality video (400kbps) fish Normal web quality video 
                        licenseType     -1
                        version 0
                        thumbnailUrl    http://54.160.105.103/p/101/sp/10100/thumbnail/entry_id/0_i2xs97r8/version/100000/acv/62
                        accessControlId 2
                        replacementStatus       0
                        partnerSortValue        0
                        conversionProfileId     6
                        rootEntryId     0_i2xs97r8
                        operationAttributes     array
                        entitledUsersEdit
                        entitledUsersPublish

1. Parsing an array of params from the API log:

$ ./logToCli 
Paste the log portion here

[Array
(
    [service] => batch
    [action] => cleanExclusiveJobs
    [format] => 3
    [ignoreNull] => 1
    [clientTag] => batch: ip-10-154-241-19 KAsyncDbCleanup index: 0 sessionId: 1978407734
    [apiVersion] => 3.2.0
    [partnerId] => -1
    [ks] => MzZjYjRlOWM5ODcxNGZhMzY3MTNmODU2NDYyMWE1MmE0ZjViNGM5Y3wtMTs7MTQzNjgwNzg5MDsyOzE0MzQyMTU4OTAuMjQzO2JhdGNoVXNlcjtkaXNhYmxlZW5
0aXRsZW1lbnQ7LTE7
    [kalsig] => 2ec6af9816b5172dbe0c36c6c30a5ac8
)
]

Sample output:

Command lines:
kalcli -x batch cleanExclusiveJobs apiVersion=3.2.0 'clientTag=batch: ip-10-154-241-19 KAsyncDbCleanup index: 0 sessionId: 1978407734' format=3 ignoreNull=1 kalsig=2ec6af9816b5172dbe0c36c6c30a5ac8 'ks=MzZjYjRlOWM5ODcxNGZhMzY3MTNmODU2NDYyMWE1MmE0ZjViNGM5Y3wtMTs7MTQzNjgwNzg5MDsyOzE0MzQyMTU4OTAuMjQzO2JhdGNoVXNlcjtkaXNhYmxlZW5
0aXRsZW1lbnQ7LTE7' partnerId=-1

Parsing a KS:

$ extks MDQ2ZThjOTI0MTJmZGIxYTVlMWVhNDJlZDZhNDAyMDkyMWJhNzE0OXw0Mzc0ODE7NDM3NDgxOzEzNjI0OTI3Njc7MDsxMzYyNDA2MzY3Ljc3NzM7MDt3aWRnZXQ6MSx2aWV3Oio7Ow==

Sample output:

extks ZTc4ZmUxN2I5N2I5OWVjOGUwYWEyNzVlMzRhNjVkZWJiM2I1MDgxM3wxMDE7MTAxOzE0MzQzMDUxMDk7MjsxNDM0MjE4NzA5LjQzODc7YWRtaW47ZGlzYWJsZWVudGl0bGVtZW50Ozs=
Sig                 e78fe17b97b99ec8e0aa275e34a65debb3b50813
Fields              101;101;1434305109;2;1434218709.4387;admin;disableentitlement;;
---
partner_id          101
partner_pattern     101
valid_until         1434305109
type                2
rand                1434218709.4387
user                admin
privileges          disableentitlement
master_partner_id   
additional_data 

1. Using a serve action:

$ genks $PARTNER_ID | kalcli -R document_documents serve entryId=0_abcdef > /path/to/output/doc

1. Nesting requests:

$ kalcli -x session start partnerId=$PARTNER_ID secret=abcdef type=2 | awk '{print "ks "$1}' | kalcli media list

1. Uploading files:

$ ks=`genks -b $PARTNER_ID` ; kalcli -x uploadtoken add ks=$ks | awk '$1 == "id" {print "uploadTokenId "$2}' | kalcli uploadtoken upload ks=$ks fileData=@/tmp/video.mp4

Sample output:

KalturaUploadToken
        id      0_55909e3ed8b7c32d4bfd622884c5ae49
        partnerId       101
        userId  admin
        status  2
        fileName        video.mp4
        uploadedFileSize        5296812
        createdAt       1434218959      (2015-06-13 21:09:19)
        updatedAt       1434218962      (2015-06-13 21:09:22)

1. Sending the contents of a file on a string parameter:

$ genks $PARTNER_ID | kalcli caption_captionasset setContent id=0_abcd56 contentResource:objectType=KalturaStringResource contentResource:content=@@/tmp/caption.srt

1. Executing an API with a different source IP address:

$ ip=`genipheader 9.8.7.6` ; genks $PARTNER_ID | kalcli -H$ip baseentry getContextData entryId=0_abcd56