About
Embed code is used to embed Kaltura media in a website, HTML page, or any other online tool. The Embed module allows administrators to make this functionality available to users (depending on their role) through the Share tab located on the Media Page in MediaSpace and KAF applications.
Configure
Enable the Module
enabled - When enabled, the Share tab is displayed alongside the Details tab for users on a Media page in MediaSpace and KAF applications. Users can click on the Share tab to find various sharing media options. See the example below.
Secure Embed
secureEmbed - Setting secureEmbed to Yes, provides an additional layer of protection, by which users will first have to log in to view the content. Kaltura MediaSpace entitlements will be enforced on media that is embedded in external sites. When embedding restricted or private media to your sites and blogs, you will be prompted to authenticate (if not already authenticated). The media will play if a user is authorized to watch the media according to the entitlements defined in MediaSpace. Otherwise, a message will be displayed that they are not authorized to watch the media.
In the iframe embed example below, secureEmbed is set to No.
<iframe id="kaltura_player" src="http://cdnapi.kaltura.com/p/2311101/sp/231110100/embedIframeJs/uiconf_id/40179251/partner_id/2311101?iframeembed=true&playerId=kaltura_player&entry_id=1_3inimdwj&flashvars[streamerType]=auto&flashvars[localizationCode]=en&flashvars[leadWithHTML5]=true&flashvars[sideBarContainer.plugin]=true&flashvars[sideBarContainer.position]=left&flashvars[sideBarContainer.clickToClose]=true&flashvars[chapters.plugin]=true&flashvars[chapters.layout]=vertical&flashvars[chapters.thumbnailRotator]=false&flashvars[streamSelector.plugin]=true&flashvars[EmbedPlayer.SpinnerTarget]=videoHolder&flashvars[dualScreen.plugin]=true&&wid=1_nl9vrlrr" width="400" height="285" allowfullscreen webkitallowfullscreen mozAllowFullScreen frameborder="0" title="Kaltura Player"></iframe>
In the iframe embed example below, secureEmbed is set to Yes.
<iframe id="kmsembed-1_3inimdwj" width="400" height="285" src="http://2311101.mediaspace.kaltura.com/embed/secure/iframe/entryId/1_3inimdwj/uiConfId/40179251?flashvars[streamerType]=auto&flashvars[localizationCode]=en&flashvars[leadWithHTML5]=true&flashvars[sideBarContainer.plugin]=true&flashvars[sideBarContainer.position]=left&flashvars[sideBarContainer.clickToClose]=true&flashvars[chapters.plugin]=true&flashvars[chapters.layout]=vertical&flashvars[chapters.thumbnailRotator]=false&flashvars[streamSelector.plugin]=true&flashvars[EmbedPlayer.SpinnerTarget]=videoHolder&flashvars[dualScreen.plugin]=true&" class="kmsembed" allowfullscreen webkitallowfullscreen mozAllowFullScreen frameborder="0" title="Kaltura Player"></iframe>
As you can see from the above examples, when secureEmbed is set to No, the iframe embed code displays a direct link to the media. When secureEmbed is set to Yes, the iframe embed code displays a direct link to MediaSpace which requires the user to enter login credentials to view the content.
For additional information about this feature, see Enhanced Settings for Secure Embed in KMS/KAF.
If secureEmbed is set to Yes, additional functionality is displayed.
Additional Functionality for Secure Embed
autoRedirect -
Select Yes to automatically redirect the user to the SSO login page in case the user is not authenticated with MediaSpace. (If the user is globally authenticated, they will be auto-authenticated by MediaSpace and then redirected back to the page with the video.) In the example below, the user is not globally authenticated, therefore the Sign In page displays.
Select No to display a message to the user so that the user can manually select when/whether to re-authenticate. In the example below, the user has not been automatically redirected and must manually click "Click here to login" to log in to MediaSpace.
autoReirectiframe -
When autoRedirect is set to Yes and autoRedirectIframe is set to No (default), the redirect for authentication will use the top browser window.
When autoRedirect is set to Yes and autoRedirectIframe is set to Yes, the redirect will occur in the iframe.
autoRedirectMessageHTML - HTML text to display while the user is auto-redirected to the login page. In the example below, the HTML text was set to "Please login with your MediaSpace credentials."
notAuthenticatedHTML - HTML text (may include links) to display inside the iFrame if autoRedirect is set to No. In the example below, the HTML text was set to "Not authenticated".
notAuthorizedHTML - HTML text (may include links) to display inside the iFrame in case Kaltura Entitlement authorization fails.
In the example below, the HTML text was set to "You are not authorized to view this media". The user was prompted to log into KMS and authentication was successful, but upon doing so, was unable to access the media because the user did not have the authorization to view the media.
Note: If you wish to further restrict users from viewing media in KMS, you may consider disabling allowAnonomous in the Auth module.
noCategoryEmbedAccessHTML - HTML text (may include links) to display inside the Embed tab of an entry page accessed not via a category/channel/gallery when requireCategoryContext is set to Yes.
In the example below, requireCategoryContext was set to Yes and the user did not access the entry page via a category/channel/gallery. In other words, the user attempted to grab an embed of an entry from a category/channel that prevents embed grabbing. The HTML text was set to that shown in the orange shaded box.
noCategoryPlayAccessHTML - HTML text (may include links) to display inside the iFrame when category-level embed grab and play are disabled for the category/gallery from where embed was originally grabbed, and/or when requireCategoryContext is set to Yes and a (legacy) secured embed is missing a category context. In the example below, the HTML text was set to "Playback of this content is only allowed on its original publishing destination. Please contact owner or support".
overrideCSSURL - URL to an alternate Cascading Style Sheet (CSS) to allow a customer to customize the iFrame design to fit the corporate style guide.
categoryLevelEmbed - Allow KMS category/channel (or KAF course gallery) managers to prevent grabbing and playing embed content from a specific category. Depends on CategoryEmbed/ChannelEmbed modules. For more information see Enhanced Settings for Secure Embed in KMS/KAF.
requireCategoryContext - Set to Yes, in conjunction with categoryLevelEmbed set to Yes, to make sure embeds are only grabbed from category/gallery contexts. Grabbing an embed from a regular (context-less) entry page will not be allowed. NOTE: Setting this to Yes will cause secured embeds that lack a category context to stop authorizing playback. The requireCategoryContext field should only be enabled for customers not already using the secureEmbed feature. Otherwise, secured embeds already embedded will play content that was previously accessible. Again, for more information see Enhanced Settings for Secure Embed in KMS/KAF.
Allow/Restrict Sharing Using iFrame
allowEmbedIframeShare - Allow/Restrict sharing using iFrame. This configuration is only supported for non-v2 supported players. When allowEmbedIframeShare is set to No, the option to choose iframe embed is eliminated.
Enable/Disable Responsive Sizing
embedResponsiveness - Enable/Disable the' Responsive Sizing' option in the embed view. When enabled, the Responsive Sizing toggle button is displayed on the Share > Embed tab.
Select the User Roles Allowed to Embed
embedAllowed - Select one or more roles that can use the Embed functionality. In the following example, viewerRole, privateOnlyRole, adminRole, and unmoderatedAdminRole are all allowed to use the Embed functionality.
Define Skins For the Embedded Players
embedSkins - Define skins that can be used for embedded players. When configured, the Player Skin options are displayed on the Share > Embed tab.
Additional Information on Skins
name - What is the name of the skin? The skin name is displayed when the user selects an embedded skin.
imgFile - What is the relative path to the image file on the server? The image file represents how the skin looks.
uiConfId - What is the numerical value of the player ID to use in the embed code?
Define Sizes For the Embedded Players
embedSizes - Define sizes that can be used for embedded players. Define the player size in the following format: {width}x{height}
- large 608x402
- medium 400x285
- small 304x231
Save
Save - Click Save to save your configuration settings.
For the user manual, please see Share & Embed Media Via Media Page.
