Kaltura - Configuration Guidelines for Kaltura Playlist Players

This document describes suggested administrator level configurations of Kaltura playlist players.

Creating Playlist Players from a copy of your main KMS Player

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

This document describes suggested configuration settings that turn your main Kaltura player into two different playlist players. To begin, visit the Universal Studio in your KMC, where you find your current main KMS player. Instead of opening that player in the editor, create a duplicate from the Actions menu column and name it appropriately (suggested names "Playlist Horizontal" and "Playlist Vertical") once it opens into the editor.

At this point we need to clarify the meaning of "Vertical" and "Horizontal" in the context of this document, as these terms refer to two different aspects of the configuration depending on where within the Kaltura environment it is used. Within the player studio these terms refer to the orientation of the playlist items as they scroll within the player, while in the KMS admin Embedplaylist module as well as the KMS embed screen, horizontal and vertical refer to the aspect ratio of the entire player embed frame, rather than the playlist scrolling orientation.

It is important to keep horizontal and vertical consistent across player naming and the KMS configuration. For the sake of clarity, we configured two example players to match the playlist embed preview offered in the KMS, although you can use any layout you wish for either player.

00_defining_horizontal_vertical.png


You cannot edit these preview images in the KMS interface, which is why we recommend to configure layouts to be close to the preview layouts. This will avoid user confusion when they are faced with the above menu choice. As a result, within the Player Studio, we will configure both players to use a horizontal playlist layout, but located below or along the side to create two players that offer the expected configurations based on the menu preview.


00a_vertical_layout_configuration.pngbr>


Horizontal Playlist Player

The Basic Display Menu

After renaming your player copy on the Basic Display menu, change the follwing settings on this menu: First, change the Preview entry/playlist toggle to "Playlist" and if possible choose an existing playlist from the pulldown menu to populate the preview with an example playlist. For the horizontal playlist layout, set width and height to the suggested values of 804 x 308 pixels. This will create a player canvas space that will fit both video and a list of clips either on the side or below the player. Again, note our example players are named after that direction the playlist scrolls, not their aspect ratio. If your player does not look exactly like the example below, don't worry - it may need a few tweaks in the playlist configuration menu.

01_basic_display_playlist.png


Look and Feel

Under Look and Feel, the main area you need to edit is the Playlist Configuration. Our example players both use a vertical playlist layout. The "horizontal player" uses the vertical playlist on the right hand side of the main player canvas.

Include in layout should be checked. Unchecked, the entire playlist disappears.

Show controls should be checked, unless you want to display the playlist forward/backward buttons in the player control bar (different menu), or if you want both to be displayed

Include header is optional. This setting places the playlist title, count and skip forward/back controls on top of the playlist.

Check Auto continue - that is the generally accepted behavior of playlist players.

Auto play and Loop unchecked, unless you feel some of these settings work better for your users.

Hide clip poster should be checked - if unchecked, the poster image will be displayed for each clip for about 1 second before the autoplay then buffers the video and continues. This behavior adds an additional playback interruption between clips.

Render on the publisher's page stays unchecked. This ensures the player and playlist remain within an iframe when embedded. It is unclear to use what else could be happening if checked. In our embed tests we observed no difference in player behavior.

Min and max clips count values have some impact on the player layout. Our recommended players require a value of 4 as minimum to properly position player and list within the iframe. The max value should be left or set to a blank field. This value globally will limit any playlist from offering more than the set number of clips.

All other values and fields in this menu should be blank.

02_look_and_feel_playlist_configuration.png


The Playlist Controls menu item configures where to place additional skip buttons for playlist control. If enabled, for the horizontal playlist player in this example, we recommend to choose "Controls Container" for it's placement.

03_look_and_feel_playlist_controls.png


And before moving on to Analytics, you may want to change one more detail - open Logo and change the Title field to incldue this player's ID to facilitate future trouble shooting.

The only change to be made in the Analytics menu is the name of the "Events default category" to separate the player from the original player it is based of when it writes events to Google analytics. In this example we named it "Playlist Player 40296111" after its function and ID. Don't forget to save your player before exiting the editor.

04_google_analytics.png

The only other edit in the Look and Feel menu is again the title for the Logo of the player to expose its ID number for mouse-over display. This is optional, but it saves time when trying to identify active players during troubleshooting. Save the player and exit the editor.

07_look_and_feel_logo_title.png

Vertical Playlist Player


The "Vertical" Playlist player setup begins by copying the freshly configured horizontal playlist player to a new player and begin your changes with that player. Click duplicate in the Player list in the Universal studio to edit a copy of your horizontal playlist player. Rename it to indicate its type by changing the Player's Name field.

The Basic Display Menu

Edit the width and height to set up for a vertical aspect ratio. which we will place below the player canvas in the look and feel menu. This results in the vertical aspect ratio of the entire player, which it is named after. Suggested values for our demo layout are 640 x 676 pixels. During this configuration phase while changing the dimensions, the player will look strange with large black areas. This is normal and will disappear once you change the location of the playlist.

05_basic_display_horizontal.png

Look and Feel

Change the playlist position to below the video using the pulldown menu in Playlist Configuration. We recommend one more change in layout from the horizontal player: the "Show Controls" and "Include Header" check boxes in the playlist configuration need to be unchecked to regain vertical space for the main player, where the controls are also duplicated. If you wish to add the header to the player, you will need to increase the vertical dimensions of the player to 736 pixels and edit your KMS player configuration accordingly. In our example, we will continue without the header.

06_look_and_feel_playlist_configuration_horizontal.png

The only other edit in the Look and Feel menu is again the Title for the Logo of the player to expose its ID number for mouse-over display. Save the player and exit the editor.

07_look_and_feel_logo_title.png




Keywords:kaltura, playlist, admin, configuration, layout, KMC, studio, horizontal, vertical   Doc ID:78495
Owner:Peter B.Group:Kaltura Media Management System
Created:2017-12-01 17:12 CSTUpdated:2017-12-04 12:03 CST
Sites:Kaltura Media Management System
Feedback:  0   0