About
The channelEmbed module allows you to control how the share and embed feature behaves within specific channels, providing more granular permissions and flexibility compared to the main Embed module.
With channelEmbed, you can customize embed settings to allow or restrict access based on the channel’s context. For example, you can prevent users from grabbing the embed code in private channels while still enabling it for public channels, or limit embed access to published content only.
This module is ideal for managing copyrighted or sensitive content that should only be shared under certain conditions.
Check our Embed a channel playlist user guide.
This module is only relevant for use with the video portal.
Configure
- Go to your Configuration Management console, and click the Channelembed module. Or navigate directly using a link: https://{your_KMS_URL}/admin/config/tab/channelembed
- Configure the following:
The Channelembed page displays.
enabled - Set to 'Yes' to enable the module.
enableEmbedOnByDefault - Set to 'Yes'.
embedRoles - Select one or more roles that can grab an embed code if enabled. Choose from the following options:
- owner only
- co-editor
- co-publisher
- specific users / groups
- anonymous role
- viewer role
- private only role
- admin role
- unmoderated admin role
allowManagerOverride - Set to 'Yes' to allow a channel manager to override the default behavior of 'enable embed'.
User experience
When enabled, a checkbox appears on the channel details page, allowing the channel manager to toggle the setting as needed.
When the allowManagerOverride field is set to 'No', the Enable Embed Grab checkbox is displayed but will be disabled.
When an end-user attempts to grab an embed of an entry from a channel that prevents embed grabbing, the following message is displayed: Grabbing of this content is possible only from locations which allow it. Please see the *Appears In* field under the Details tab for potential locations which may allow publishing. If no allowing location is found, please contact your administrator, or reach out to the content owner directly.
