About

You can use the Browseandembed module to control how users find and embed Kaltura media in the Embed Kaltura Media window.

Users open the window from the rich-text editor in LMS tools, such as announcements, assignments, discussions, and forums.

Before you start

This feature requires the Hosted module to be enabled.

Configure

1. Go to your Configuration Management console, locate the Browseandembed module in the left panel, then select it. You can also navigate directly using a link: https://{your_site_url}/admin/config/tab/browseandembed

The Browseandembed page displays.

2. Configure the following:

• enabled - Set to Yes to enable the module.
• returnUrlMethod - Select the return URL method: GET or POST.
• allowEmbedFromMultipleCourses - Set to Yes to let users embed media from all the courses they have access to. Set to No to limit embedding to the Media Gallery of the current course.
• filterTypeAttribute - Enter the LTI attribute used to determine the filter type.
• disableAddNewAttribute - Enter the LTI attribute (custom_disable_add_new) used to disable the Add new option.
• enableNewBSEUI - Enables the new version of the Embed Kaltura Media window. On sites with Theming enabled, the window is only supported in v3.
• EmbedSettingsButton - Controls whether users can change embed settings before they embed media:
  • Show: Shows the embed settings button.
  • Hide: Uses the players defined for My Media and Media Gallery.
• enableQuickIngest - Enables the Quick Ingest endpoint. When enabled, it can replace the standard Embed Kaltura Media flow, or run as a standalone tool at {KAF_base_URL}/browseandembed/quick-ingest. It isn't available on sites with Theming enabled.

  When set to Yes, more fields appear.

  

  • setBSEtoQuickIngest - Select Quick Ingest to redirect requests from browseandembed/index/browseandembed straight to Quick Ingest.
  • quickIngestLargeIcons - Click +Add "quickingestLargeIcons" to add ingestion options. Select up to three options to show as large icons on the main page.

    

• BSEPlayerID - Enter the player ID used in the Embed Kaltura Media window. Media types other than video use the players defined in their own modules. If this field is empty, the default BSE player is used. If that's also empty, the KAF main player is used.
• minimalBSERole - Select the minimum role required to use the Embed Kaltura Media window. This setting only applies to SharePoint 365. Choose from the following options:
  • anonymousRole
  • viewerRole
  • privateOnlyRole
  • adminRole
  • unmoderatedAdminRole
• embedSizes - Define the default sizes for embedded players, used when no specific size is set, in the format {width}x{height}. Recommended sizes for V7 players:
  • large: 608x342
  • medium: 400x225
  • small: 304x171
• enableAssignmentSubmission - Set to Yes to show a confirmation dialog when users embed media for assignments. Confirmed media entries are cloned so they can't be edited or deleted.
• assignmentSubmissionText - Enter the text shown in the assignment submission confirmation dialog. The default is Would you like to submit media as an assignment?
• assignmentSubmissionMaxRole - Select the highest role that sees the assignment submission confirmation dialog. Choose from the following options:
  • Manager
  • Moderator
  • Contributor
  • Member
  • None
• contentItemReturnUrlAttr - Enter the LTI attribute that holds the content-item return URL.
• sendCimLineItem - Select when to include CIM JSON data for quiz entries. Only enable this if specific gradebook integration workflows, such as those for Blackboard Ultra, aren't available. Choose from the following options:
  • Never
  • When filtering for quiz
  • For any quiz
• allowEmbedFromMediaGallery - Select the minimum role that can embed Media Gallery content from the Embed Kaltura Media window. Choose from the following options:
  • Member
  • Contributor
  • Moderator
  • Manager
  • Do not allow
• autoRepublish - Set to Yes to republish media automatically, so it stays playable even if it was unpublished from the Embedded In Context category after it was embedded from the Embed Kaltura Media window.
• embedSettings - Click Add "embedsettings", and enter the details of the player to use for embedding. If only one player is configured for a media type, it's the default. If several players are configured, the first player in the list is the default.

  

  You can set several sizes for one player ID, but only add each player ID once on this page. Adding the same player ID more than once can cause unexpected behavior.

  For each player, configure the following:

  • playerDisplayName - Enter a name users see, for example "with download button" or "transcript widget enabled".
  • playerId - Enter the player ID from Player Studio.
  • entryType - Select the media type this player is for. Choose from the following options:
    • Video
    • Quiz
    • Audio
    • Playlists
    • Document
    • Draft
    • Image
    • Live
    • Meeting
    • Interactive video

    Configure several players to give users options for different uses, for example a player for audio, a player for accessibility, or a player for interactivity. The following example shows how these options appear in the player dropdown.

    

  • isTypeDefault - Set to Yes to make this player the default for its media type.
  • embedSizes - Select the sizes for this player:
    • For a V2 player: Choose from the V2 size options (16:9 ratio). Keep in mind the default 30 px set for playerBarHeightPixels in the Player module.
    • For a V7 player: Choose from the V7 size options (16:9 ratio). The Audio entry type only has one V7 option.
  • embedSizeCustom - Optional. Enter a custom size in pixels, in the format {width}x{height}. If this field is empty, the default is used.

    To add another custom size, click +Add "embedSizeCustom".

    

    To delete a custom size, click X.

    

  For more information about setting up dedicated players, see Create a player.

• adjustLmsIframeHeight - Sends the required embed height to the LMS so it can resize the iframe. This setting only applies to V7 players.
• aspectRatioSource - Controls how the aspect ratio is applied to V7 embeds:
  • User selected: Uses the size the user selects.
  • Global: Uses the aspect ratio the admin defines.
• BSEtableColumns - Select the columns that appear in the embed table on sites with Theming enabled. To keep the table easy to use, only enable the columns you need.
  • ID
  • Type
  • Tags
  • Plays
  • Views
  • Created At
  • Updated At

3. Click Save. Your setup is validated, and any errors appear in the valid field.

User experience

Embed settings

The following example shows the embed settings with two player options, one for each department. The player named Player for Marketing has two embed sizes.

Embed media table

The following example shows the embed media table, with columns, on a site with Theming enabled.