Player module


About

The Player module is used to set the default main player in the video portal and KAF applications. The height of the player UI may be configured as well as the ratio of the video inside of the player.

All player IDs are taken from the KMC Player Studio tab. Please visit Kaltura Player Studio to learn more about how to manage, create and personalize your Kaltura Players via the KMC.

Configure

1. Go to your Configuration Management console and click on the Player module. You can also navigate to it directly using a link: https://{your_KMS_URL}/admin/config/tab/player.

The 'Player' page displays.

2. Configure the following:

playerId - Enter the player ID (uiConf ID) for the instance’s main default player used in all media pages. This is also the fallback for many modules, in case no specific player is entered.

Set the visual display of the player

Use the following fields to determine the player's display on your screen.

playerBarHeightPixels - Enter the height (in pixels) of the player UI that is not part of the actual video (for example - the bottom bar.)

playerVideoRatioPercent - The ratio (in percent) of the video inside the player. Standard values: 16:9 = 56.25 , 4:3 = 75 , 16:10 = 62.5.

Set a player for editing purposes

playerEditId - You may choose to edit entries using a different player. Enter the Player ID for editing data. If left empty the default Player ID is used.

autoPlayOnLoad - Controls whether players start playing automatically on media pages (applies to VOD and playlist players on media pages; does not apply to embedded players).

Choose one of the options:

  • Yes – The player starts playing automatically each time the page loads. This overrides the player settings.
  • No – The player does not start playing automatically. This overrides the player settings.
  • Use Player Settings – Uses the autoplay setting defined in the player.
  • Autoplay runs when a user first opens the Video Portal and whenever a new page loads (for example, when moving from 'My Playlists' to a gallery).
  • When a user clicks a video in a gallery, the video always starts playing, regardless of the autoPlayOnLoad setting.

Set a player for moderated content

playerModerationId - The player ID for the player used in Channel and Gallery moderation tabs. If left empty the default player ID is used. For more information about moderation in Video Portal, see Channel moderation - Theming.

Where can you set player IDs for different types of media?

Media Players are created and configured in the KMC Studio tab. You can apply the same player across the application or customize multiple players for different types of media/repositories/components. In the KMC, navigate to the Kaltura Player Studio tab to find the Players List. Please visit Introduction to the Player Studio to learn more.

The following lists the types of media and where you may override the default player's id:

  • Video - uses the playerId from the Player module.
  • Quiz - uses the quizPlayerId or the BSEPlayerId from the Quiz module.
  • Audio - uses the customPlayerId  from the Audioentry module.
  • Playlists - uses the playerId from the PlaylistPage module.
  • Image - uses the customPlayerId from the Imageentry module.
  • Webcast/Live - uses the PlayerUiconfId from the Kwebcast module.
  • Rapt Media - uses the playerId from the Raptmedia module.
  • Youtube - uses the previewPlayer from the Youtube module.
  • Twitter - uses the tPlayerId from the Twitter module.
  • Facebook - uses the fPlayerId from the Facebook module.
  • Oembed - uses the PlayerId from the Oembed module. For more information, see the article about MediaSpace oEmbed Integration.
  • Embed - uses the uiConfId from the Embed module.
  • Browseandembed - uses the BSEPlayerId from the Browseandembed module. 

Related modules

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

Thank you! Your comment has been submitted.

In this article
Related articles