Browseandembed


About

Use the Browse, Search & Embed (BSE) tool to embed media in announcements, assignments, discussions, forums, etc within your LMS course. Typically, the BSE tool can be found within your rich-text editor or in the CK editor in the case of Sakai LMS.

Follow this guide to learn how to controls the way users can use the Browse, Search & Embed (BSE) tool in the Kaltura Application Framework. Note that depending on the LMS/CMS used, the feature set might be different.

For additional information for users, see Using the Browse Search and Embed (BSE) Feature.

Prerequisites

The hosted module should be enabled beforehand.

Configure

Fields

Description

enabled

Enable the Browseandembed module.

returnUrlMethod

Which method to use for the return url action. GET or POST.

allowEmbedFromMultipleCourses

Defines how many categories to include when embedding media. When set to Yes, users will be able to embed videos from Media Galleries of all the courses they have access to. Set to No if you want to limit users to the Media Gallery of the current course only.

filterTypeAttribute

custom_filter_type* The LTI attribute the get the filter type from.

disableAddNewAttribute

custom_disable_add_new*. The LTI attribute the get the disable-add-new from.

enableNewBSEUI

This field enables the new Browse and Embed UI and functionality. Select v3 for the latest version.

v2

The following parameters are for configuring the Browseandembed module for KAF versions previous to 5.82.

enableQuickIngestTurn on the Quick Ingest endpoint. When set to Yes, it can either replace the existing Browse and Embed endpoint, or can be used as a standalone tool using this URL:
{KAF_Base_URL}/browseandembed/quick-ingest

BSEPlayerID

Media types other than ‘video’ will load with players set in the 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.

minimalBSERole

Minimal KMS/KAF role allowing browsing and embedding media.

embedSizes

Define sizes that can be used for embedded players. Define the player size in the following format: {width}x{height}

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

assignmentSubmissionTextDetermines the text that will appear on the pop up message when submitting an assignment. In case left empty, the default message will appear.
assignmentSubmissionMaxRoleThis sets the highest role level which will see the pop up upon selecting an entry in Browse, Search and Embed.

contentItemReturnUrlAttr

The LTI attribute that holds the content-item return URL.

sendCimLineItem

allowEmbedFromMediaGalleryChoose the minimal role that can embed MediaGallery content via BSE - Member, Contributor, Moderator, Manager, or Do not allow.
autoRepublishEnable the automatic re-publishing feature to make content playable even when it was un-published from the \“Embedded In Context\” category after it was embedded via BSE.
v3

The following parameters are for configuring the Browseandembed module for KAF version 5.82 and forward.

EmbedSettingsButton

Select ‘Show  to present the Embed Settings button, allowing users to change the embed settings before embedding media. 

Do not use for playlist embeds. For playlists, define custom embed with aspect ratio of 16:9 (e.g. 640x360 or 960x540).

enableQuickIngestTurn on the Quick Ingest endpoint. Once on, it can either replace the existing Browse and Embed endpoint, or can be used as a standalone tool using this URL:
{KAF_Base_URL}/browseandembed/quick-ingest
BSEPlayerId

Media types other than ‘video’ will load with players set in the 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.

minimalBSERoleMinimal KMS Role allowing browsing and embedding media - anonymousRole, viewerRole, privateOnlyRole, adminRole, or unmoderatedAdminRole. This is only relevant for SharePoint 365. 

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.

contentItemReturnUrlAttr

The LTI attribute that holds the content-item return url.

sendCimLineItem

allowEmbedFromMediaGalleryChoose the minimal role that can embed MediaGallery content via BSE - Member, Contributor, Moderator, Manager, or Do not allow.
autoRepublishEnable the automatic re-publishing feature to make content playable even when it was un-published from the \“Embedded In Context\” category after it was embedded via BSE.
embedSettings

Enter the player's information to be used for embedding. If only one player per type is available, it will be set as the default for that type. If more than one play is available, the first in the list will be the default.

playerDisplayName

Player Display Name

playerId

Player ID

entryType

The media type this player is relevant for.

  • Video
  • Quiz
  • Audio
  • Playlists
  • Image
  • Interactive videos

isTypeDefault

Check the box to set this player as the default player type.

embedSizes

Select embed size.

Do not use for playlist embeds. For playlists, define custom embed with aspect ratio of 16:9 (e.g. 640x360 or 960x540).

embedSizeCustom

Use “width”x”height” in pixels to add a new embed sizes. If left empty the default will be used.

Click 'Add Embed Size Custom' to add the custom size. Click X to delet the custom size embed.

Was this article helpful?
Thank you for your feedback!
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