Enable calls to action (CTAs) in the player


About

Enable this option to engage your audience with interactive Call to Action (CTA) messages. Add overlays or toasts with clickable buttons for announcements, content recommendations, and more - right from the player.

Multiple CTAs can be added per player, labeled sequentially as Call to Action 1, Call to Action 2, and so on. 

Set the CTAs

VOD

1. In the KMC, open your player, then go to the settings tab (look for the gear icon).

2. Scroll down to the Capabilities section and find Call to action.

3. Click the toggle to open the settings.

You can set up CTAs manually for each video or automate them using metadata:

  • Manual CTAs: Set up predefined messages and buttons for each video.
  • Metadata-Based CTAs: When enabled, video CTAs dynamically update their text and destination based on the entry's metadata. When disabled, all videos in this player show the same CTA. 

When you enable Call to action, additional options display:

4. Configure the following:

Metadata based CTA – See below for setup details.

To create a standard CTA instead, simply skip the Metadata based CTA field and continue with the following configuration:

Standard CTA

Type - Choose one of the following options:

  • Overlay - The CTA displays across the entire player, pausing the video until the specified 'Hide after' duration elapses.
  • Toast - The CTA appears at the bottom right corner of the player, allowing playback to continue for the specified 'Hide after' duration.

Hide After - Click the box to enable. Enter the desired duration in seconds for the CTA message. If left blank, the CTA will remain until the user closes it.

Title - Enter a custom title for the CTA message. You can replace the default text "New call to action" with your own.

Description - Type your message. 

Button - Enable/disable the button by clicking the box. If enabled, provide the following information:

  • Label - Enter the text that will appear on the button.
  • URL - Input the link that the button will direct the user to.

Secondary button - Click the box to add a secondary button (optional).

Position - Choose from the options. If left empty, the CTA will be displayed until closed out by the user.

  • Start (enabled by default) - CTA will appear at the start of video playback.
  • Time from start (in seconds) - Enter a time in seconds from the start of playback until CTA appears.

    If the start position is greater than the video length, the CTA will not be displayed.

  • Time from end - Enter a time in seconds counting back from the end of the video when the CTA should appear.
  • End - Click the box to enable.

If the CTA duration exceeds the video length, it will be displayed until the end of the video.

Delete Call to Action - Click to delete the CTA. A message displays: “Are you sure you want to permanently delete this CTA?”. Click Delete

+ Add call to action - Click to add additional CTAs.

Only one CTA configuration can be opened at once. When clicking to open a specific CTA, the rest will be minimized.

The CTA text and design (font family, font size, font color, button shape, button color etc.) can be customized with external CSS. The default color is the player primary color.

CTA as toast
CTA as overlay

Metadata-based CTA

To use metadata-based CTAs, start by creating a custom metadata schema. Check out our guide Create a custom metadata schema for CTAs for step-by-step instructions.

Configure the following:

Metadata based CTA - Click to enable.

Additional options display.

Metadata profile ID - Enter the ID of the metadata profile containing the CTA fields. Need help finding it? Check out Create a custom metadata schema for CTAs.

Type - Choose one of the following options:

  • Overlay - The CTA displays across the entire player, pausing the video until the specified 'Hide after' duration elapses.
  • Toast - The CTA appears at the bottom right corner of the player, allowing playback to continue for the specified 'Hide after' duration.

Hide After - Click the box to enable. Enter the desired duration in seconds for the CTA message. If left blank, the CTA will remain until the user closes it.

Title metadata field - Enter the metadata field that the CTA title should be taken from (replace the default text "New call to action" with your own). Be sure to use the system name shown in the edit custom schema window as it may differ slightly from the field label you entered (as shown in the image below).

Need help finding it? Check out Create a custom metadata schema for CTAs.

Example taken from the Edit Custom Schema window in KMC

Description metadata field - Enter the metadata field for the CTA description. Use the system name from your schema.

Button - Enable by checking the box, then enter:

  • Label - Enter the text (use the system name).
  • URL - Enter the destination link (use the system name).

Secondary button - Check the box to add a second button (optional) and repeat the steps above.

Example configuration

Position - Continue with the steps for standard CTA above.

For the user guide, see Call to action (CTA) plugin.

Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted.

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