Player - Advanced settings

Last Modified on 12/17/2024 4:54 pm IST

About

The Advanced Setting widget allows you to manually edit the player configuration by adding/removing properties that are not exposed in the studio interface.
This guide demonstrates several examples of how to control the core capabilities of the Kaltura player via advanced settings.

Access the advanced settings

  1. Log in to your KMC and navigate to the Studio > Kaltura Player Studio tab. 
  2. Create a new Smart player or select an existing player from the table and open its Edit View. 
  3. At the bottom of the Player Settings tab, select Advanced Settings.
    The Advanced Configuration window is displayed.

Full screen

Gives the ability to choose an in-browser fullscreen experience. For the viewer guide, see Full Screen.

Useful on iOS devices which will replace the native fullscreen of the AV player.

How to configure the Full Screen

  1. Go to the Player's Advanced Settings tab.
  2. Hover over the playback object and click on the + icon. to add the followings:
    • Name [boolean]: inBrowserFullscreen
    • Value= true
  3. Click Save.

To disable entering to full screen by double clicking the player, see config.components.fullscreen.disableDoubleClick.

Seek bar

Defines the seek bar component optional configuration.

Passing an empty string will disable the thumbnail on the seek bar.


Volume

Defines the initial volume value. For the viewer guide, see Playback Functionality.

Example:

var config = {
  playback: {
    volume: 0.5
  }
};

How to configure the volume

  1. Go to the Player's Advanced Settings tab.
  2. Hover over the playback object and click on the + icon. to add the followings:
    • Name [text]: volume 
    • Value: must be between 0 to 1 [0-1]
  3. Click Save.

The following graphic demonstrates the player's Advances Settings with the volume set to 0.5.

The following graphic demonstrates the player volume set to 0.5.

Speed

Sets the available rates at which the media can be played back. This is an Array attribute that is used to implement user controls for fast forward, slow motion, and so forth. The normal playback rate is multiplied by this value to obtain the current rate, so a value of 1.0 indicates normal speed. For the viewer guide, see Playback Functionality.

How do you configure the playback speed?

  1. In the Player Studio, click on a player to open its Player Settings window.
  2. Scroll to the end of the page and select Advanced Settings.

  3. The Advanced Configuration opens where you can add objects, values, and arrays.

    Click on the plus icon near the playback object:

  4. Type in the name: playbackRates, after that click on the edit icon:

  5. Remove the null value and set the array like:
    [0.5, 1, 1.5, 1.75, 2, 3]

    The result looks like this

  6. Click Save.

Audio language

Sets the default audio track language.

Example:

var config = {  playback: {    audioLanguage: 'eng' // Start playback with english audio  }
};

If the value "auto" is set, i.e:

var config = {  playback: {    audioLanguage: 'auto'  }
};

If an audio track with the defined language exists, this audio track will be selected as the initial audio track.

How to configure the Audio Language?

  1. Go to the Player's Advanced Settings tab.
  2. Hover over the playback object and click on the + icon. to add the following:
    • Name [text]= audioLanguage, 
    • value = en for English / es for Spanish / etc.
  3. Click Save.

The following graphic demonstrates the default audio track set to English. 

The following graphic reflects the player audio language selector.

Using multi-audio tracks requires configuring a designated audio flavor for each language under the account transcoding profile priorly. This configuration requires PS setup; please get in touch with your CSM for assistance.

Autoplay

Start playback automatically.

  • Object: config.playback.autoplay
  • Type: boolean
  • Value: The default value of this property is false.
    If set to true, playback will start automatically when the player receives the content.
    If set to 'inview', playback will start automatically when the player is in view.
    If set to false, a user action will be required to start playback.

How to configure the Autoplay?

  1. Go to the Player's Advanced Settings tab.
  2. Under the playback object, hover over the Autoplay object and click on the + icon. to edit the settings:
    • If set to True ('Always') - The video will play automatically when the page loads.
    • if set to 'In View' - the video will play automatically only if the player is in view. If a player is not in view, playback will start only when the viewer scrolls to it.
    • If set to False ('Off') - (default) the video will NOT play automatically and wait for user interaction.
  3. Click Save.

Autopause

The field Indicates whether the video should be automatically paused when not in view.

How to configure Autopause?

  1. Go to the Player's Advanced Settings tab.
  2. Hover over the playback object and click on the + icon. to add the following:
    • Name [text]= Autopause
    • value = true/false/in view
  3. Click Save.

Download

The download plugin enables video, image, and file download for a media entry that is hosted by Kaltura.

The download options can be customized via the Advanced Settings tab in the Kaltura Player Studio. See December 24, 2023 Player release notes. Due to the immense request for this feature, it is expected to be added as part of the GUI in future versions of this product.

The following fields are available: 

plugins: {
  download: {}
}
plugins: {
  download: {
    flavorParamId: null, // id of the flavor type to be downloaded. optional.
    flavorId: null, // id of the specific flavor type for a specific entry. optional.
    preDownloadHook: null, // function to be called before download is initiated. optional.
    displayFlavors: boolean, // a flag indicating whether to display flavors to download. optional. default is true.
    displayCaptions: boolean, // a flag indicating whether to display captions to download. optional. default is true.
    displayAttachments: boolean // a flag indicating whether to display attachments to download. optional. default is true.
    displaySources: boolean // a flag indicating whether to display media sources to download. optional. default is true.
  }
}

For more information, click here.

Example: How to remove the download attachments capability

  1. Enable the Download plugin on the player.
  2. Go to the Player's Advanced Settings tab.
  3. Hover over the download object and click on the + icon. to add the following:
    • Name [text]= displayAttachments
    • value = false
  4. Click Save.

    On the left, is the download plugin with the attachments. On the right, the download plugin without the attachments.

Video resolution

When using the Kaltura Player exclusively in Safari on Mac, in order to adjust video resolution, you must insert a section into Advanced settings called "preferNative".  

Once "preferNative" is added, video resolution adjustment may be performed as follows: 

Custom error message 

Go to How to custom the player error message.


Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

In This Article
Related Articles
Back to top

Never miss a thing!

Subscribe to our customer newsletter and our release notes updates, so you always get the best out of Kaltura.
Newsletter