Browseandembed

This module controls the way users can use the Browse, Search & Embed (BSE) tool.

  • Please make sure players are set. We recommend to make sure that a value for the ‘BSEPlayerId’ field is entered.
  • 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.

The BSE tool is available within the Rich-text (if installed) editor wherever it is available for example:

  • Assignments
  • Forums
  • Announcements

Sakai: This tool is available within the CK editor wherever it is available.

The Browse Search and Embed Administrator's Guide includes a comprehensive description on how to configure this module.

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.

enableQuickIngest
Turn 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

contentItemReturnUrlAttr

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

sendCimLineItem

autoRepublish
Enable 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.

enableQuickIngest
Turn 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.

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

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.

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.


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