Kaltura - Configuration Guidelines for the Kaltura Player

NOTE:This document is expressly intended for campus Kaltura Administrators. Please contact your campus designee, if you have questions.

Instructions for Kaltura administrators for the deployment of recommended player configurations.

Modifying your Main/Default KMS Player

This document describes suggested configuration settings of the main Kaltura player, also known as playerId inside the player module of the KMS admin configuration interface.

Begin by logging into your KMC admin account and navigate to the Studio -> Universal Studio tab. There, you can select the player to edit based on the playerId you identified in your KMS. Enter that number in the search box, if you have a large number of players. The fastest way to locate a given player is to search by its ID number:

locate in player studio


The player will load into the edit interface. Note that the moment you press the blue Save Player Settings button in this editor, you are updating your player and there is no undo. Its version will be updated and all the changes you made are applied without a backup file to fall back to.  The screen shots below show the relevant menus we recommend to configure. On the right hand side of these menus, a preview of the player will show. To see your edits applied in the preview, press the "Preview Changes" button at the top of the screen.


The Basic Display Menu

This first menu defines player name and various basic settings. The player size value is mostly overridden by other elements in its later use, but we recommend to set a proper 16x9 aspect ratio size here. 640 x 396 is the appropriate size for a player without a "hovering" control bar. Title your player with a meaningful name. Everything else remains unchecked for this player.

Basic Display


Look and Feel

Moving down on the left hand (black background) menu, choose the "eye" for the Look and Feel sub menu. Here we make sure the "Show Tooltips" box is checked. Leave all the details below that menu on default settings. Then if not enabled yet, we recommend you check the "Title Label" menu and configure it as shown below. This feature will display the video "title" on top of the player while it is stopped. If you feel this is unnecessary in your deployment, leave unchecked.

look and feel


Label Details


If you wish to show a logo on the player other than the default Kaltura logo, check the Logo box and configure the fields in the submenu to point at an image file. That file should be hosted on a web server other than Kaltura and serve images via HTTPS to avoid security warnings. The file should also be small in dimensions, as it will not be displayed larger than the height of the Kaltura control bar.  You can enter a link any user mouse click on the logo should execute, or leave that field blank to disable the link feature. The "Title" field in this submenu can be used to describe the URL, e.g. "campus home page," or you can use the feature to help you identify your deployed players with a simple mouse-over on your player logo image. For that purpose, we suggest to enter player type, e.g. quiz player, and player ID number. Or leave blank to disable the feature. If you uncheck the logo menu, the entire feature is disabled. 


campus logo config


Volume control should be checked with the "Show slider" sub setting enabled, as well as horizontal layout  chosen. This is generally a default setting and should need no changes.

volume slider


The Look and Feel Closed Captions menu is one of the more complex configuration areas. It should be enabled in all cases. Here are our recommended settings:

Layout on top of video - that way your player will not shrink the video display to allow room for the captions. 

Display captions should be left unchecked. Unless disabled, captions will always display of present, even for users who do not wish to see them.

Enable options menu will add a menu to the CC button drop down that allows users to set font colors and sizes to match their needs. This should be enabled to comply with accessibility requirements.

Use cookie is optional and if used will store the user's preferred captions language. If you host video with captions in various languages frequently, this feature will benefit your users. Font size and color settings are suggestions as well - use the preview function of a video with captions to see the size and effect of your settings.

The "hide when empty" check box will remove the CC button from the player if no captions exist. This is recommended, as otherwise you may receive complaints about captions not being displayed. Users generally will expect captions to be available when the menu is present.


Captions options


Analytics

Moving down on the features menu, select the trend line icon for Analytics. Some players will have Akamai Media Analytics enabled. If they do, leave that checked. It does not seem to affect any of the analytics available to you, though. The Statistics box should be checked in all players, plus we recommend to add Google Analytics to track player usage.

analytics overview


Google Analytics require that you have a unique "urchin code" from that service. Once you obtain that, the feature can be configured. We recommend one urchin code for all players, as one of the configurable fields lets us track individual players within the same set of analytics. All fields other than "Default Events Category" are configured with identical strings in all players. We recommend you create a unique name for each player that lets you easily identify the player by that string. In this case, the "Default Events Category" is called "Main Player 25945352"

Here the values hat do not change and can be carried over to other players:

Event monitor function name:  

trackFunc

Custom events list:

doPlay,relatedVideoSelect,playerReady,NoSourcesCustomError,bufferEndEvent,mediaError,embedPlayerError

Label override

{mediaProxy.entry.referenceId}|{mediaProxy.entry.name}|{mediaProxy.entry.id}|{configProxy.kw.id}|{configProxy.kw.uiConfId}

Enter those values exactly as shown above. We will provide a dedicated KB doc for how to use this feature to track your player use.


Google Analytics


The Statistics menu is easier to configure - in fact, you just enable it. There is no need for any custom strings.

stats menu overview


Monetization

The Monetization menu behind the dollar entry on the left hand menu should look like this - all unchecked:

monetization


Plugins

The final menu contains the "plugins" of which our recommended player has 4 selected. The keyboard shortcuts should be enabled and left on all the default settings within the items submenu.

plugins


The playback rate selector is very popular with students who like to save study time by speeding up content playback, while non native speakers can benefit from slower playback. Kaltura's player compensates for pitch shift, so voices sound close to natural at these altered playback speeds.  We recommend the following settings: 

Default speed should be set to "1" and the selectable speeds we fount most useful are 0.5, 1, 1.5 and 2. Those are entered in the item configuration field separated by commas. The sequence defines how they are listed in the vertical drop down menu within the player, so you could flip the order by listing it as 2,1.5,1,0.,5. Note that 1 should be included in that list, otherwise users cannot return to the normal playback speed once they select an alternate speed.

playback rate


The source selector plugin should be enabled. It allows users to select from available qualities without resizing of the screen. We also suggest the "Switch on resize" feature to be checked, as it will load the appropriate flavor for full screen playback automatically. The "Display mode" setting relates to how browsers label the available qualities, however, not all browsers seem to follow the chosen format. Also note that until a file begins playback, only Safari will show available flavors.

source selector


The strings plugin allows to feel custom values to the player and modify its behavior. One such string we suggest to use is to override what the player displays when files have just been uploaded but are not yet ready to be played. To set this up, check the strings check box and drop down the menu to configure the feature.

Click "add" to display a new Key/Value pair.

Enter ENTRY_CONVERTING into the Key field, then enter Entry is processing, please try again in a few minutes into the Value field. This change will provide a descriptive message to users should they try to play back a file that is still converting.

strings menu


Similar to the stings menu, you can customize user interface features in the UI Variables menu. One common customization in that plugin, which is configured just like the strings menu, are these two key/value pairs (which may already be in place in your player)

imageDefaultDuration / 2

EmbedPlayer.EnableIpadNativeFullscreen / true

UI vars

Various other features of the player can be customized here. More information can be found at https://knowledge.kaltura.com.

At this point you should be able to save the player and test it in your environment. If this player's ID was one of your active players, the new version of the player will take a few minutes to move to the CDN near you before you will see the changes you made.




Keywords:administrator, kaltura, studio, KMC, html5, player, configuration, plugins, analytics, look, feel, monetization, urchin, embed, bitrate, playback   Doc ID:75863
Owner:Peter B.Group:Kaltura Media Management System
Created:2017-08-18 15:28 CSTUpdated:2017-12-14 15:21 CST
Sites:Kaltura Media Management System
Feedback:  1   0