Types

Color

A color can either be specified as:

  • Named color according to CSS Colors definitionarrow-up-right — e.g. DeepPink

  • RGB Hexadecimal — e.g. #ff1493

  • RGB (Red, Green, Blue) — e.g. rgb(255, 20, 147)

  • RGBA (Red, Green, Blue, Alpha) — e.g. rgba(255, 20, 147, 1)

CtaBehavior

Determines how a CTA target should be opened. Allowed values are:

  • clipboard — The CTA target URL/value is copied to clipboard

  • modal — The CTA target URL/value are rendered in a player internal component

  • newTab — The CTA target URL is opened a new window

  • newTabWithPipNative — The CTA target URL is opened a new window with the video following in native PiP — if supported by the viewers OS

  • none — Event message is sent only

  • pip — The CTA target URL is loaded in the current page with the media player resuming in sticky minimized state

  • pipNative — Event message is sent only with the video following in native PiP — if supported by the viewers OS

  • pipSpa — The CTA target URL is loaded in the current page with the media player resuming in minimized state

LocalizedString

A map of key-value pairs for multi-lingual texts.

  • Key is either a lower-cased language code identifier (LCID Locale ID, e.g. en-us) or *, which acts as a fallback, if no language specific value is specified.

  • Value is a text in a distinct language.

SvgIconString

The SVG Markup of a custom icon.

circle-exclamation

Example

Last updated