Browse Search and Embed Administrator's Guide

This guide provides information on how to enable and setup the Kaltura Browse Search and Embed feature and is intended for KAF administrators.

The Kaltura Browse Search and Embed feature offers different embed options that Admins can configure in the Browseandembed module.

Admins can allow end users to select from on of the preconfigured players and sizes and allow admins to determine players and customize player sizes according to media types.

Best Practices for Upgrading BSE Versions

How to upgrade the BSE version to v3?
  1. Login to the application Configuration Management window.
  2. Go to the Browseandembed module.
  3. Check your v1 or v2 configuration. Take a note of the players set in the uiConfId and BSEPlayerID fields and sizes under embedSizes.
  4. Use this opportunity to update the players in the KMC studio to the latest player version. 
  5. Set the enableNewBSEUI field to v3.

Now, it's decision time.

What players would you like to use in the BSE.

If you want to use the players that are used for My-Media and Media Gallery as the BSE player do the following:

  1. Set the EmbedSettingsButton to Hide. Media types other than ‘video’ will load with players set in the dedicated modules (e.g. audioEntry, imageEntry, Quiz, kwebcast). 
  2. If left empty, the BSE Player will become the default.
  3. If the BSE Player is also empty, the KAF main player will be used.

If you want to set a dedicated player as the BSE player ( or for each media type):

  1. Set the EmbedSettingsButton field to Show.
  2. Navigate to the EmbedSettings section and click addEmbedSettings for each type of media you want to set with a dedicated player.
  3. Enter values for the fields in the EmbedSettings section.
  4. Be certain to provide a meaningful player name for the users to be able to understand what type of the player is being used. For example “with download button” or “transcript widget enabled”. 

For more information see Setting a Dedicated Player for a Specific Media Type for MediaSpace and KAF Applications.

You can have some types of media that use the default, and other types of media that have more than one embed setting configured.

Some LMSs do not support the thumbnail embed and auto-play features.

Enable the Browseandembed Module in KAF

  1. Login to your KAF application and go to the Kaltura Configuration Management window.
  2. Scroll down and select the Browseandembed module in the ModulesCustom/core/kaf section.
    The Browseandembed Administration page is displayed.
  3. In the Enabled field, select Yes to enable the Browseandembed module.
    For all the Browseandembed module configuration parameters and additional information, see the article Custom/Core Modules/KAF Browseandembed module. This article focus on how to set up the Browse Search and Embed Settings icon.

Configure the Embed Players and Sizes

  1. In the enableNewBSEUI field, set the value to v3.
  2. Display or Hide the Embed Settings icon.  Set the EmbedSettingsButton. Select ‘Yes’ to display the Embed Settings button, allowing users to change the embed settings before embedding media. If not set, users will not have the option of changing the embed players or their sizes.
  3. Enter the BSEPlayerID. You can use an existing player ID. Media types other than ‘video’ will load with players set in their dedicated modules (e.g. audioEntry, imageEntry, Quiz, kwebcast). If left empty, the BSE Player will become the default. If the BSE Player is also empty, the KAF main player will be used.
  4. (Optional for Assignments) - Configure the Assignment Submission Features.  

    enableAssignmentSubmission

    This feature enables an additional pop up screen when selecting media in Browse, Search and Embed to verify if the user is submitting an assignment. If confirmed, the selected entry will be cloned under a different user name to prevent editing and deletion.

    assignmentSubmissionText

    Determines the text that will appear on the pop up message when submitting an assignment. In case left empty, the default message will appear.

    assignmentSubmissionMaxRole

    This sets the highest role level which will see the pop up upon selecting an entry in Browse, Search and Embed.

  5. Configure the EmbedSettings. The field in this section determine how many players and their respective sizes will be available for embedding media, per the type of media.
  6. Click +Add Embed Settings.
  7. Enter the playerDisplayName. In this example, "Player for Marketing".
  8. Enter the playerId.  If the playerID is not set for an entry type in the BSE module, the default entry’s module playerID is used.  If that module player is also empty, the main ‘BSEPlayerId’ for that type is used.
  9. Select the entryType. 
  10. Select whether to set this player as the default player for this type of media.
  11. Select the embedSizes. Preconfigured sizes are set for you. In the above example, two sizes are checked. If you want to customize the player size, go to the next step.
  12. (Optional) Click +Add embedSize Custom and enter a value for the  “width”x”height” in pixels to add a new embed size. If left empty, the default will be used.
  13. After configuring one or more embed players, click Save to save the module's configuration.

For example, you can configure multiple players, each with different dimensions. Each player may be configured for a specific type of media entry. The following screen displays two players have been configured for users.
The player named "Player for Marketing" has two sizes configured for embedding. (shown in the figure in Step 7.)

 Users can:

  • Determine the display of the embed (whether the display is Auto Play or Thumbnail Embed. Either option should be toggled on/off by the user.
  • Set as their default settings for the type of media they are embedding. ( Check the Default settings box to save as default).

Example of Autoplay

Example of Thumbnail Embed

In This Article
Was this article helpful?
Thank you for your feedback!