The Kaltura Player Studio Admin Guide - Player Settings

Read the following guide to learn about the Player Studio player setup and customization settings menu.

Access the player edit view

To learn how to access the Player's edit view, please see The Kaltura Player Studio Edit View.

The player settings tab

The Player settings tab is the opening tab and is denoted by a gear icon.

This tab allows you to set playback options, player settings, bottom, and top bar capabilities, and interactive capabilities.

Playback options

Autoplay

1. Choose whether to enable Autoplay (start playback automatically).
2. If you enable Autoplay, choose whether to start playback automatically only when the player is in view. If a player is not in view, playback will start only when the viewer scrolls to it.

Start playback muted

Choose whether the video starts in mute mode when playback begins.

Autopause 

Choose whether the video will pause automatically when the player scrolls out of view. Playback will resume when the player comes back into view. 

Fallback to muted autoplay

Choose whether the video starts in mute mode when autoplay playback begins.

Preload

Choose whether to automatically load the video when the page loads.

Capabilities

Captions default display

You can choose whether to have captions display on the player by default when the user starts playing the video. Click the gear icon to open the caption settings:

Captions default display

• On - captions are displayed by default 
• Off - captions are turned off by default 

Default language

Choose the default captions language - Auto or Manual. 

• Auto - Will use the user-set preferences from local storage, browser language, or the default language.  
• Manual - Requires entering a language code.
  If you choose Manual, choose the desired language.

For the user manual, see Captions and Audio Tracks.

Share & Embed

Use the Share and Embed feature to allow users to share and embed the media via social websites and email.

If you choose to enable this feature, additional options display:

• Share url - type the share URL that will override the current page sharing.
• Embed url - type the embed URL in the following format - {embedBaseUrl}/p/{partnerId}/embedPlaykitJs/uiconf_id/{uiConfId}?iframeembed=true&entry_id={entryId}
• Share clip - this enables the user to share a segment of a video by choosing Share clip and then selecting the start and end position of the segment they want to share.
• Start at - this enables the user to share the link and initiate playback at the designated time. 
• Use native share - choose whether the native share dialog of the device is used.
• Social networks - you can define included networks, such as Facebook, LinkedIn, X (formerly Twitter), email, and embed.

For the user manual, see Share.

Info

Choose whether to enable an Information button in the upper right corner of the player. When a user clicks on the Information button, additional information about the video is displayed. For the user manual, see Info.

Download

Choose whether to allow downloading of the entry media (i.e., source media) (in additional flavor(s)), captions, and/or files that are attached to the entries (i.e., attachments).

Choose which assets are available for users to download. Check the desired boxes to allow each download. 

• Source media - Allow downloading of the entry media. 
• Additional flavors - Allow users to select the quality of the media they would like to download.
• Captions - Allow users to download captions files attached to the media.
• Attachments - Allow users to download files attached to the media.

For the user manual, see Download.

Moderation

1. Choose whether to enable a Moderation button in the upper right corner of the player. A user can click on this button to report content for various reasons, such as being sexually explicit, violent, or copywritten. If you choose to enable Moderation, additional options display.
2. In Moderation reasons, choose the options from which the user can choose when reporting content - Sexual Content, Violent or Repulsive, Harmful or Dangerous Act, Spam/Commercials, Copyright Violation, or Terms of Use Violation.

   

3. Optional - to custom the moderation reasons, go to Advanced Settings and edit the moderateOptions labels.
   

For the user manual, see Moderation.

Transcript

Choose whether to enable a transcript on the video. If you choose to enable transcript, additional options display:

• Position - choose the position of the transcript - Right, Left, Top, or Bottom. 
• Expand - choose whether to expand the transcript alongside the video or over the video. 
• Expand on First Play - choose whether to expand the playlist side panel on the first play of the video.
• Show time - choose whether to enable a show time. 
• Download transcript enabled - choose whether to allow the users to download the transcript. 
• Print transcript enabled - choose whether to allow the users to print the transcript. 

Call to Action

Interact directly with your audience using the Call to Action plugin. Configure interactive messages in your video which can be shown as overlays or toasts with clickable buttons. Make announcements, guide users to more content, invite them to contact you, and more, all directly from the player. Multiple CTAs can be added to each player, named sequentially as Call to Action 1, Call to Action 2, and so on.

If you choose to enable Call to Action, additional options display:

Type - Choose one of the following options:

• Overlay - The CTA displays across the entire player, pausing the video until the specified 'Hide after' duration elapses.
• Toast - The CTA appears at the bottom right corner of the player, allowing playback to continue for the specified 'Hide after' duration.

Hide After - Check the box to enable. Enter the desired duration in seconds for the CTA message. 

Title - Type a title for the CTA message.

Description - Type your message. 

Button - Enable/disable the button by clicking the box. If enabled, provide the following information:

• Label - Enter the text that will appear on the button.
• URL - Input the link that the button will direct the user to.

Secondary button - Click the box to add a secondary button.

Position - Choose from the following options:

• Start (enabled by default) - CTA will appear at the start of video playback.
• Time from start (in seconds) - Enter a time in seconds from the start of playback until CTA appears.

  If the start position is greater than the video length, the CTA will not be displayed.

• Time from end - Enter a time in seconds counting back from the end of the video when the CTA should appear.
• End - Click the box to enable.

  If left empty, the CTA will be displayed until closed out by the user.

Delete Call to Action - Click to delete the CTA. A message displays: “Are you sure you want to permanently delete this CTA?”. Click Delete. 

+ Add call to action - Click to add additional CTAs.

CTA as toast 

CTA as overlay 

Floating

Choose whether a floating player appears when the viewer scrolls the player out of view. This keeps the video accessible while allowing engagement with other content. If you opt for the floating player, click the arrow next to Floating for more options.

• Choose where to display the floating player: Top Right, Bottom Right, Top Left, or Bottom Left. 
• Choose player behavior:
  • Dismissible - choose whether the viewer can dismiss the floating player so that it doesn't display while they scroll the page. Users can dismiss the floating video by clicking 'Back to video' to return to the main player, or by clicking the 'X' icon to close the floating player.
  • Draggable - choose whether the viewer may drag the floating player. When unchecked, the floating player has a fixed location.
• Choose dimensions and margins:
  • Width - type the width of the floating player in pixels.
  • Height - type the height of the floating player in pixels.
  • Margin-X - type the margin, in pixels, from the selected edge, on the X-Axis.
  • Margin-Y - type the margin, in pixels, from the selected edge, on the Y-Axis.

Skip intro/outro

Choose whether a pop-up skip control display allows viewers to skip certain content segments. This is useful in skipping intros and end credits, for example. If you choose to enable this feature, additional options display to set default values for the Intro and Outro durations. These default values will be used on all entries that are played on the player. 

• Intro duration - the Intro will start at the beginning of the video and last the duration you set.  
• Outro duration - the outro will start at the time counting back from the end of the video. For example, if the video is one minute long and you set the Outro duration to 10 seconds, the outro will begin at the 50-second mark in your video.

• Hide skip control - type the duration of time (in seconds) before the skip control is automatically hidden from view.
  
  

Ad Blocker Detection

The Ad Blocker Detection plugin detects ad blockers enabled on users' devices. 

Choose whether to enable ad blocker. If you choose to enable ad blocker, additional options display.

• Allow playback - Choose to allow playback with an ad blocker on. When the Ad Blocker Detection plugin detects an ad blocker, a message displays to the user giving them the choice to disable the ad blocker or keep it on. They may then continue playback.

  Applicable to Allow playback only:  Detection is performed just once at the beginning of a browser session, therefore, if a user enables ad blocker in the said browser tab after the one-time detection is performed, Ad Blocker Detection will not display a subsequent message to the user. 

• Block playback - Choose not to allow playback with an ad blocker on. When the Ad Blocker Detection plugin detects an ad blocker, a message displays to the user informing them they must disable ad blocker in order to continue playback. 
• Add custom overlay message - A default message is displayed to viewers for whom an ad blocker was detected. You may customize this message. Check to customize the overlay message, thereby overriding the default message. 
  • Title - Type a title for your custom overlay message.
  • Description - Type a description for your custom overlay message.
  • Close without disabling ad blocker - If you are allowing playback with an ad blocker on, you may type a label for the button users will click to signal they want to continue playback with an ad blocker on.
  • Close after disabling ad blocker - Type a label for the button users will click to confirm they've disabled their ad blocker.
    

Live

Choose whether to enable live streaming on the player. If you choose to enable this feature, additional options are displayed:

Pre broadcast slate - Add an image or video before a live broadcast has started. 

• Entry - Insert a video or image entry ID. Entry will be broadcasted in a loop until the live stream starts. (By default, the entry thumbnail image is used as a background image for this slate.)
• URL -  Image only. Insert an image URL that will be displayed until the live broadcast begins. A post slate image or video will play after the live broadcast ends. (By default, the entry thumbnail image is used as a background image for this slate.)

Pre broadcast slate - Add an image or video after the live broadcast has ended.

• Entry - Insert a video or image entry ID. Entry will be broadcasted in a loop after the live stream ends.
• URL - Image only. Insert an image URL that will be displayed after the live broadcast has ended.
   

For the user manual, refer to Live.

360 & VR

360 & VR lets you specify whether the player should support 360 and VR. This menu item also lets you configure its behavior for playing spherical 360 videos and immersive VR mode.

Select whether to enable this feature. If you choose to enable this feature, additional options display:

• Toggle Stereo - choose whether to show the Stereo Toggle button (relevant only to mobile devices).
• Start in Stereo Mode - choose whether to start the video in stereo mode.
• Move Multiplier - define the sensitivity of the mouse and touch movement by specifying the move multiplier.
• Device Motion Multiplier - define the sensitivity of the device motion.

Camera Options 

• Camera frustum field of view - type camera frustum field of view.
• Camera frustum near plane - type camera frustum near plane.
• Camera frustum far plane - type camera frustum far plane.

For the user manual, see 360 & VR.

Playlist

Select whether to enable Playlist. If you choose to enable Playlist, additional options display:

• Auto continue - choose whether to continue to the next item automatically.
• Loop - choose whether to play the playlist in a loop. When selected, the playlist will play automatically, even if Auto continue is not selected.
• Countdown - choose whether to show the countdown.
  In the Duration field, type how long the countdown will display.

Playlist side panel

1. Choose whether to enable a playlist side panel in the player. If you choose to enable a playlist side panel, additional options display.
2. In Position, choose the position of the playlist side panel - Right, Left, Top, or Bottom. 
3. In Expand, choose whether to expand the playlist side panel alongside the video or over the video. 
4. In Expand on First Play, choose whether to expand the playlist side panel on the first play of the video.

For the user manual, see Playlist.

Related

1. Choose whether the Related Videos screen is added to the end of the video to attract users to watch other videos. If you choose to enable the Related Videos Screen, additional options are displayed.
2. In Auto continue after, choose whether the next item is automatically played.
3. Type the time to wait before playing the next item (in seconds).
4. In Display when playback is paused, choose whether the Related Videos Screen is displayed when playback is paused.
5. Choose the source for the related entries - Related to Entry, Playlist ID, or Entries List. 
   • Related to Entry - Entries related to the current entry will be displayed. If there are no related entries, the plugin is disabled.
   • Playlist ID - Select the desired playlist. 
   • Entries List - Type a comma-delimited list of entries. 

Navigation

1. Choose whether to display navigation in the player. Navigation allows the user to search the video and click on and view specific times in the video. 
2. In Position, choose the position of the navigation - Right, Left, Top, or Bottom. 
3. In Expand, choose whether to expand the navigation alongside the video or over the video.
4. In Expand on First Play, choose whether to expand the transcript on the first play of the video.

For the user manual, see Navigation.

Download

Choose whether to allow users to download the video for a media entry hosted by Kaltura.

• Click on the right of the toggle to enable. 
• Click on the left of the toggle to disable. 

The default setting is to have download disabled.

Quiz

Choose whether to enable the creation of quizzes on the player. For the user manual, see Quiz.

Hotspots

Choose whether to enable the creation of hotspots on the player. To learn more about hotspots, see Hotspots. To learn how to create and edit hotspots, see Kaltura Video Editing Tools - Hotspots Tab.

Dual screen

1. Choose whether to enable dual screen on the player. When enabled, additional options display. 
2. In the Default layout, choose Picture in picture, Side by Side, or Single Media. 
3. In the Position of Picture in picture, choose Top Right, Bottom Right, Top Left, or Bottom Left. 

For the user manual, see Dual Screen.

Live Q&A

1. Choose whether to enable live Q&A in the video.
2. In Position, choose the position of the live Q&A - Right, Left, Top, or Bottom. 
3. In Expand, choose whether to expand the live Q&A alongside the video or over the video. 
4. In Expand on First Play, choose whether to expand the live Q&A on the first play of the video.

For the user manual, see Live Q&A.

Documents

Choose whether to enable document entry support on the Kaltura Player. When enabled, if a document has been loaded in a Kaltura player (for example, as part of a playlist), a slate will appear instructing the user how to view the document.

Allow download - Enabled by default to allow document download when a document is not available for viewing. Uncheck the box to disable. 

For the user manual, see Documents.

Image playback

Choose whether to support image playback. For full APIs see: Image player usage guide.

General

Localization

1. Click the gear next to Localization to display configuration options. (You may also hover over Localization and click on the display arrow.)
2. In Languages, select all languages to be bundled with the player. 
3. In Default Player Language, select the default language for the player.

Apply user preferences

Select whether to use the user-set preferences from local storage, session storage, browser language or default language, or other specified preferences.

When "Apply user preferences" is enabled, the player first looks for saved settings in local storage and uses them if found. When disabled, the player uses the uiconf definitions or fallback to its default but doesn't look in the local storage for saved settings.

Following is the list of cookies that the Kaltura Player saves to Local Storage:

When the user configures the player according to his or her preference (e.g., starting up the player in mute), these user preferences (i.e., actions that are triggered by the user) create a configurable value, which is saved in the browser's local storage. The player then uses those saved values to enable the user to retain the last choices they made when playing media.

For example, if the last played media was muted, the next media will begin muted also, even if the user refreshed the page.

The following values are saved under user preferences:

• Muted
• Volume
• Audio language track
• Text language track (i.e., captions)
• Captions text style (this is the style of the text used in the captions)

The following cookies are saved to Session Storage:

The difference between session storage and local storage is that local storage settings will persist between visits while session storage will be erased when the browsing session is over. Meaning if a user selects speed x2 and then leaves the site and comes back the next day, the video will start playing at the default speed (normally x1).

The following value is saved under user preferences: 

• speed control 

Mobile screen lock orientation

1. Choose whether to enable Mobile Screen Lock Orientation.
2. If you enable Mobile Screen Lock Orientation, select the default screen lock orientation for the player when in full screen - None, Any, Natural, Landscape, Portrait, Portrait primary, Portrait secondary, Landscape primary, or Landscape secondary.

Keep Player on Current Version [Version Number]

Choose whether to prevent the player from automatically updating when a new version becomes available.

Advanced Settings

Edit your player’s configuration file using advanced settings. Recommended only for advanced player developers.

For the next Player Settings guide, please visit The Kaltura Player Studio Admin Guide - Visual Tab.