Channelembed

Overview

This module allows you to decide on the default behavior of the embed when an entry is accessed in the context of a channel.
This module enhances the Secure Embed feature in the Embed module, and is a prerequisite for turning this module on.

Use this module to allow channel managers to block embed-grabbing from their channel (useful when managing copy-righted content whose consumption should be confined to the portal). For more information read here.

You can also limit embed-grabbing to published content only.

The channelEmbed and categoryEmbed modulesallow theKMSadmin to decide on the default behavior of the Embed tab when an entry is accessed in the context of a channel or category.

The modules:

  • Allow channel/category managers to block embed-grabbing from their channel/category.
  • Override the default role permissions set by the main Embed module, allowing finer grain control differentiated between categories andchannels.
  • Both modules depend on the Embed module to be enabled. In case the Embed module is disabled, embeds will not be allowed regardless of these modules’ settings, and the “Enable embed” checkbox will not appear in the category/channel settings.
  • Per the module’s logic as described above, should the embedRoles in the Embed module be set differently than the one in the category/channel modules, the latter will take effect.

For playlistembed, please refer to Embed a Channel/Media Gallery Playlist.

For the KMS Admin

The channelEmbed and categoryEmbed modules are located in the Modules/category and Modules/channel, respectively.

enabled - Enable the Channelembed Module.

enableEmbedOnByDefault - What should be the default "Enable Embed" in the Channel settings page, affecting whether users can grab an embed of an entry in the context of a channel?

embedRoles - Select one or more roles that can grab an embed if enabled.

allowManagerOverride - Can a channel manager override the default behavior of Enable Embed?

For the Channel/Category Manager

When enabled, a checkbox is added to the category/channel settings page.

In a channel:


In a category:


When the allowManagerOverride field is set to 'No', the  “Enable embed grab” checkbox is displayed with the default value, as set in the module’s configuration by the KMS admin, but will be disabled.

For End-users Trying to Grab an Embed

When an end-user attempts to grab an embed of an entry from a category/channel that prevents embed grabbing, the following message is displayed:


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