About
This module lets you control how users browse, search, and embed Kaltura media using the Browse, Search & Embed (BSE) tool. BSE allows users to embed media directly from the rich-text editor in LMS tools such as announcements, assignments, discussions, and forums.
For more information about the user workflow, see Embed Kaltura media.
Prerequisites
The hosted module must be enabled.
Configure
1. Go to your Configuration Management console and click on the Browseandembed module. You can also navigate to it 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 allow embedding from all courses the user has access to. Set to 'No' to limit embedding to the Media Gallery of the current course only.
filterTypeAttribute - LTI attribute used to determine the filter type.
disableAddNewAttribute - LTI attribute (custom_disable_add_new)* used to disable the 'Add new' option
enableNewBSEUI - Enables the new Browse and Embed experience. The theming-based 'Browse and Embed' page is supported only in v3.
EmbedSettingsButton - Controls whether users can change embed settings before embedding media:
- Show – Display the embed settings button
- Hide – Use players defined for My Media and Media Gallery
enableQuickIngest - Enables the Quick Ingest endpoint. When enabled, it can replace the standard Browse and Embed flow or run as a standalone tool at: {KAF_base_URL}/browseandembed/quick-ingest. Not available for Theming-based pages.
When set to 'Yes' additional fields display:
setBSEtoQuickIngest - Select 'Quick Ingest' in order to redirect requests from browseandembed/index/browseandembed to working with the quick ingest directly.
quickIngestLargeIcons - Click +Add "quickingestLargeIcons to add ingestion options. Select up to three options that will show up as large icons in the main page.
BSEPlayerID - Player ID used by the BSE tool. Media types other than video use players defined in their dedicated modules.
If left empty, the default BSE player is used. If that’s also empty, the KAF main player is used.
minimalBSERole - Minimum role required to browse and embed media. Relevant only for SharePoint 365.
Choose from the following options:
- anonymousRole
- viewerRole
- privateOnlyRole
- adminRole
- unmoderatedAdminRole
embedSizesDefine the default sizes for embedded players to apply when no specific dimensions are set (format: {width}x{height}). Recommended sizes for V7:
|
enableAssignmentSubmission - Select 'Yes' show a confirmation dialog when embedding media for assignments. Confirmed entries are cloned to prevent editing or deletion.
assignmentSubmissionText - Text shown in the assignment submission confirmation dialog. Default is Would you like to submit media as an assignment?
assignmentSubmissionMaxRole - Highest role that sees the assignment submission confirmation dialog. Choose from the following:
- Manager
- Moderator
- Contributor
- Member
- None
contentItemReturnUrlAttr - LTI attribute that holds the content-item return URL.
sendCimLineItem - Select an option to include CIM JSON data for any quiz entry. Enable this option only if specific gradebook integration workflows, such as those for BB Ultra, are not available. Choose from the following:
- Never
- When filtering for quiz
- For any quiz
allowEmbedFromMediaGallery - Set the minimal role that can embed MediaGallery content via BSE. Choose from the following:
- Member
- Contributor
- Moderator
- Manager
- Do not allow
autoRepublish - Set to 'Yes' to enable automatic re-publishing to ensure content remains playable, even if it was unpublished from the 'Embedded In Context' category after being embedded through BSE.
embedSettingsClick the blue Add "embedsettings" button and then enter the player information to be used for embedding. If only one player is configured for a media type, it’s used as the default. If multiple players are configured, the first player in the list is used by default.
A single player ID can hold several size options but should only be set once on this page. Configuring the same player ID multiple times might result in unexpected behavior. playerDisplayName - User-friendly name shown to users, for example “with download button” or “transcript widget enabled”. playerId - Player ID from Player Studio. entryType - Select the media type this player is relevant for. Choose from the following:
isTypeDefault - Set to 'Yes' to set as the default player type. embedSizes - Select the appropriate size for the chosen player:
embedSizeCustom - Optional custom size. Enter “width”x”height” in pixels. If left empty the default will be used. Click +Add "embedSizeCustom" to add an additional custom size.
Click X to delete the custom size embed.
To learn more about setting up dedicated players, see our article Create a player. |
adjustLmsIframeHeight - Sends the required embed height to the LMS to resize the iframe. Applies to V7 players only.
aspectRatioSource - Controls how the aspect ratio is applied for V7 embeds::
- User selected - Uses the user-selected size
- Global - Uses the admin-defined aspect ratio
BSEtableColumns - Select the columns shown in the theming-based embed table. Enable only what you need to maintain usability.
- ID
- Type
- Tags
- Plays
- Views
- Created At
- Updated At
3. Click Save to validate your setup. Any errors will be displayed in the valid field after saving.
User experience
Embed settings
The example below the embed settings with two player options available for the two departments. The player named 'Player for Marketing' has two embedding sizes configured.
Embed media table
The example below shows the Theming-based embed media table with columns.
