search
Ctrlk

Theme Options

Name
Description

addToCalendarBehavior

stringEnum: "custom" "default"

The distinct behaviour when the add to calendar CTA is clicked.

  • custom — Custom implementation based on the emitted event.

  • default — Download the event to the user’s calendar.

Default value: default

addToCalendarIcon

string

The SVG markup of the icon displayed on the add to calendar CTA.

If left blank, the default calendar icon is displayed.

addToCalendarEnabled

boolean

Indicator, whether the add to calendar CTA should be displayed.

ctaBehavior

stringEnum: "clipboard" "modal" "newTab" "newTabWithPipNative" "none" "pip" "pipNative" "pipSpa"

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

Default value: none.

emailIcon

string

The SVG markup of the icon displayed on the email CTA.

If left blank, the default email icon is displayed.

emailLabel

object

The (multi-language) label of the email field.

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.

badgeIndicatorStyle

stringEnum: "gradient" "solid"

The distinct type of badge indicator.

carouselCloseCtaLabel

object

The (multi-language) label of the carousel close CTA.

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.

carouselOpenCtaLabel

object

The (multi-language) label of the carousel open CTA.

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.

commentsCreatorAvatarEnabled

boolean

Indicator, whether the creator avatar should be displayed.

commentsDisclaimerLabel

object

The (multi-language) label of the comments disclaimer.

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.

commentsInputPlaceholderLabel

object

The (multi-language) placeholder label of the comments input field.

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.

commentsJoinCtaLabel

object

The (multi-language) label of the comments join CTA.

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.

commentsJoinPlaceholderLabel

object

The (multi-language) placeholder label of the comments join field.

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.

commentsLinkClickBehavior

stringEnum: "clipboard" "modal" "newTab" "newTabWithPipNative" "none" "pip" "pipNative" "pipSpa"

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

Default value: none.

commentsNewCommentsLabel

object

The (multi-language) label of the new comments indicator.

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.

commentsOffIcon

string

The SVG markup of the icon displayed when comments are disabled.

If left blank, the default comments off icon is displayed.

commentsOnIcon

string

The SVG markup of the icon displayed when comments are enabled.

If left blank, the default comments on icon is displayed.

commentsSettingsLabel

object

The (multi-language) label of the comments settings.

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.

commentsSuspendedLabel

object

The (multi-language) label of the comments suspended message.

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.

commentsUsernameLabel

object

The (multi-language) label of the comments username field.

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.

commentsVisitorAvatarEnabled

boolean

Indicator, whether the visitor avatar should be displayed.

commentsWaitTimeLabel

object

The (multi-language) label of the comments wait time.

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.

creatorAvatarEnabled

boolean

Indicator, whether the creator avatar should be displayed in the player header.

creatorNameSeparatorLabel

object

The (multi-language) label of the creator name separator.

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.

customStylesheet

string

Custom stylesheet including CSS rules to be applied to the widget or player.

dateEnforcedLocale

string

The locale code, which determines the date format.

If left blank, the user agent locale is used.

dateFormatAbsoluteLabel

object

The (multi-language) label of format in which a date should be displayed.

Please use placeholders {date} and {time} where the respective values should be displayed. e.g. {date} at {time} could be displayed as Nov 18th at 9pm.

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.

dateFormatDate

stringEnum: "MMMM d" "MMM d" "MMMM d, yyyy" "MMM d, yyyy" "MMMM do" "MMM do" "MMMM do, yyyy" "MMM do, yyyy""MM/dd/yyyy" "dd/MM/yyyy" "yyyy-MM-dd"

The distinct format of the date.

  • MMMM d — Day and Month, e.g. November 18

  • MMM d — Day and Month (short), e.g. Nov 18

  • MMMM d, yyyy — Day, Month, and Year, e.g. November 18, 1981

  • MMM d, yyyy — Day, Month (short), and Year, e.g. Nov 18, 1981

  • MMMM do — Day with Ordinal and Month, e.g. November 18th

  • MMM do — Day with Ordinal, Month (short), e.g. Nov 18th

  • MMMM do, yyyy — Day with Ordinal, Month, and Year, e.g. November 18th, 1981

  • MMM do, yyyy — Day with Ordinal, Month (short), and Year, e.g. Nov 18th, 1981

  • MM/dd/yyyy — US Format (MM/DD/YYYY), e.g. 11/18/1981

  • dd/MM/yyyy — European Format (DD/MM/YYYY), e.g. 18/11/1981

  • yyyy-MM-dd — ISO Format (YYYY-MM-DD), e.g. 1981-11-18

Default value: MMM d

dateFormatDay

stringEnum: "long" "short"

The distinct format of the weekday.

  • long — e.g. Sunday

  • short — e.g. Sun

Default value: short

dateFormatRelativeDayUnitLabel

object

The (multi-language) label of the day unit label 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.

dateFormatRelativeDaysUnitLabel

object

The (multi-language) label of the days unit label 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.

dateFormatRelativeFutureLabel

object

The (multi-language) label of format in which a relative date should be displayed, if the date is in the future.

Please use placeholders {unit} and {value} where the respective time value should be displayed. e.g. In {value}{unit} could be displayed as In 4h.

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.

dateFormatRelativeHourUnitLabel

object

The (multi-language) label of the hour unit label 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.

dateFormatRelativeHoursUnitLabel

object

The (multi-language) label of the hours unit label 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.

dateFormatRelativeMinuteUnitLabel

object

The (multi-language) label of the minute unit label 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.

dateFormatRelativeMinutesUnitLabel

object

The (multi-language) label of the minutes unit label 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.

dateFormatRelativeMonthUnitLabel

object

The (multi-language) label of the month unit label 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.

dateFormatRelativeMonthsUnitLabel

object

The (multi-language) label of the months unit label 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.

dateFormatRelativePastLabel

object

The (multi-language) label of format in which a relative date should be displayed, if the date is in the past.

Please use placeholders {unit} and {value} where the respective time value should be displayed. e.g. {value}{unit} ago could be displayed as 30m ago.

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.

dateFormatRelativeYearUnitLabel

object

The (multi-language) label of the year unit label 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.

dateFormatRelativeYearsUnitLabel

object

The (multi-language) label of the years unit label 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.

dateFormatTime

stringEnum: "12h" "12hm" "24h" "24hm"

The distinct format of the time.

  • 12h — 12-hour clock, omitting minutes, e.g. 9pm

  • 12hm — 12-hour clock, including minutes, e.g. 9:00pm

  • 24h — 24-hour clock, omitting minutes, e.g. 21 Uhr

  • 24hm — 24-hour clock, including minutes, e.g. 21:00 Uhr

Default value: 24h

dateFormatTodayLabel

object

The (multi-language) label of format in which a date should be displayed, if the date is today.

Please use placeholders {day}, {date} and {time} where the respective values should be displayed. e.g. Today at {time} could be displayed as Today at 9pm.

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.

dateFormatTomorrowLabel

object

The (multi-language) label of format in which a date should be displayed, if the date is tomorrow.

Please use placeholders {day}, {date} and {time} where the respective values should be displayed. e.g. Tomorrow at {time} could be displayed as Tomorrow at 9pm.

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.

dateFormatYesterdayLabel

object

The (multi-language) label of format in which a date should be displayed, if the date was yesterday.

Please use placeholders {day}, {date} and {time} where the respective values should be displayed. e.g. Yesterday at {time} could be displayed as Yesterday at 9pm.

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.

dateFormatWithinWeekLabel

object

The (multi-language) label of format in which a date should be displayed, if the date is within the next 7 days.

Please use placeholders {day}, {date} and {time} where the respective values should be displayed. e.g. This {day} at {time} could be displayed as This Saturday at 9pm.

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.

liveIndicatorLabel

object

The (multi-language) label of the live indicator.

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.

liveViewerCounterEnabled

boolean

Indicator, whether the live viewer counter should be displayed.

livePrimaryControls

Array of strings (PrimaryControlType) Items Enum: "cart" "chat" "emoji" "products" "share"

The primary controls to be displayed in the live player.

mediaItemEmojiIconOff

string

The SVG markup of the icon displayed when the media item emoji is not selected.

If left blank, the default heart icon is displayed.

mediaItemEmojiIconOn

string

The SVG markup of the icon displayed when the media item emoji is selected.

If left blank, the default heart icon is displayed.

mediaItemEmojiLabel

object

The (multi-language) label of the media item emoji CTA.

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.

mediaItemInfoCreatorNameEnabled

boolean

Indicator, whether the creator name should be displayed.

mediaTapToUnmuteIcon

string

The SVG markup of the icon displayed on the tap-to-unmute CTA.

If left blank, the default speaker icon is displayed.

mediaTapToUnmuteLabel

object

The (multi-language) label of the tap-to-unmute CTA.

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.

notificationsMaxItems

integer <int32> [ 1 .. 5 ]

The maximum number of items to be displayed in the notifications list.

playerAmbientBackgroundEnabled

boolean

Indicator, whether the player should have an ambient background.

playerDismissCtaIcon

string

The SVG markup of the icon displayed on the player dismiss CTA.

If left blank, the default close icon is displayed.

playerDismissCtaState

stringEnum: "disabled" "enabled" "hidden"

The visibility state of the player dismiss CTA.

  • disabled — The dismiss CTA is disabled.

  • enabled — The dismiss CTA is enabled and visible.

  • hidden — The dismiss CTA is enabled but hidden.

Default value: disabled

playerOptionsIcon

string

The SVG markup of the icon displayed on the player options CTA.

If left blank, the default options icon is displayed.

pollClosedMessage

object

The (multi-language) default message to be displayed, when a poll is closed.

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.

pollResultsMessage

object

The (multi-language) default message to be displayed, when a poll's results are un-disclosed.

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.

pollThankYouMessage

object

The (multi-language) default message to be displayed, when a visitor submitted their vote.

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.

pollTotalAnswersCountEnabled

boolean

Indicator, whether the total answers count should be displayed.

pollTotalAnswersCountText

object

The (multi-language) label of the total answers count.

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.

productCardBrandEnabled

boolean

Indicator, whether the product's brand name should be displayed.

productCardClickBehavior

stringEnum: "clipboard" "modal" "newTab" "newTabWithPipNative" "none" "pip" "pipNative" "pipSpa"

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

Default value: none.

productCardCtaEnabled

boolean

Indicator, whether the product card CTA should be displayed.

productCardCtaEvent

stringEnum: "addToCart" "view"

The distinct behaviour, when the product card CTA is clicked.

  • addToCart — Add product to shopping cart

  • view — Open the product detail view

productCardCtaLabel

object

The (multi-language) label of the product card CTA.

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.

productCardCtaSoldOutLabel

object

The (multi-language) label of the product card CTA when the product is sold out.

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.

productCardEmojiEnabled

boolean

Indicator, whether the product card emoji should be displayed.

productCardEmojiEvent

stringEnum: "addToWishlist" "emoji"

The distinct behaviour, when the product emoji CTA is clicked.

  • addToWishlist — Add/remove product to/from wishlist

  • emoji — Like the product

productCardEmojiIconOff

string

The SVG markup of the icon displayed when the product card emoji is not selected.

If left blank, the default heart icon is displayed.

productCardEmojiIconOn

string

The SVG markup of the icon displayed when the product card emoji is selected.

If left blank, the default heart icon is displayed.

productCardPriceEnabled

boolean

Indicator, whether the product's price information name should be displayed.

productCardSalePricePrefixLabel

object

The (multi-language) prefix of the product card sale price.

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.

productCardThumbnailFormat

stringEnum: "9x16" "4x3" "3x4" "square"

The product card's thumbnail format.

  • 3x4 — maximum width: 60px

  • 4x3 — maximum width: 80px

  • 9x16 — maximum width: 45px

  • square — maximum width: 60px

productCardTitleLineLimit

integer <int32> [ 1 .. 2 ]

The maximum allowed number of lines a product name can occupy on the product card.

Number of characters shown varies per screen sizes and selected fonts. Further characters will be truncated.

Default value: 2

productCardVatNoteLabel

object

The (multi-language) label of the product card VAT note.

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.

productDetailPageCloseCtaLabel

object

The (multi-language) label of the product detail page close CTA.

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.

productListCtaIcon

string

The SVG markup of the icon displayed on the product list CTA.

If left blank, the default shopping cart icon is displayed.

productListCtaLabel

object

The (multi-language) label of the product list CTA.

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.

productListEmptyLabel

object

The (multi-language) label of an empty product list.

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.

productListStickerLabel

object

The (multi-language) label of the product list sticker.

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.

productVariantSelectorTriggers

Array of any (ProductCardEventType)

The list of product card event types that trigger the product variant selector.

replayFeedbackMessage

object

The (multi-language) message displayed, when a show is conducted, but the replay is not available yet.

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.

replayIndicatorLabel

object

The (multi-language) label of the replay indicator.

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.

shoppingCartCtaLabel

object

The (multi-language) label of the shopping cart CTA.

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.

shoppingCartEnabled

boolean

Indicator, whether the shopping cart CTA should be displayed.

shoppingCartIcon

string

The SVG markup of the icon displayed on the shopping cart CTA.

If left blank, the default shopping cart icon is displayed.

shoppingCartUrl

object

The (multi-language) URL of the shopping cart.

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.

socialSharingBehavior

stringEnum: "custom" "default"

The distinct behaviour when the social sharing CTA is clicked.

  • custom — Custom implementation based on the emitted event.

  • default — Open Share to Socials modal with a variety of sharing options.

Default value: default

socialSharingClipboardLabel

object

The (multi-language) label of the copy URL to clipboard option in share to socials.

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.

socialSharingCopyLabel

object

The (multi-language) label used for share to socials copy.

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.

socialSharingCopyLiveLabel

object

The (multi-language) label used for share to socials copy of live shows.

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.

socialSharingCopyReplayLabel

object

The (multi-language) label used for share to socials copy of live replays.

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.

socialSharingCopyStoryLabel

object

The (multi-language) label used for share to socials copy of stories.

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.

socialSharingEnabled

boolean

Indicator, whether the social sharing CTA should be displayed.

socialSharingIcon

string

The SVG markup of the icon displayed on the social sharing CTA.

If left blank, the default share icon is displayed.

socialSharingOtherLabel

object

The (multi-language) label of share to other socials option.

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.

socialSharingTargets

Array of SocialSharingTarget (strings) or string

The list of social sharing targets.

socialSharingTimestampLabel

object

The (multi-language) label of share to socials option to include the media timestamp.

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.

socialSharingTitleLabel

object

The (multi-language) label of the social sharing title.

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.

socialSharingUrlTemplateLive

object

The (multi-language) URL template for sharing live shows.

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.

socialSharingUrlTemplateReplay

object

The (multi-language) URL template for sharing live replays.

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.

socialSharingUrlTemplateStory

object

The (multi-language) URL template for sharing stories.

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.

sponsorBadgeLabel

object

The (multi-language) label of the sponsored content badge.

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.

stickerCardCtaClickBehavior

stringEnum: "clipboard" "modal" "newTab" "newTabWithPipNative" "none" "pip" "pipNative" "pipSpa"

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

Default value: none.

subtitlesOffIcon

string

The SVG markup of the icon displayed when subtitles are disabled.

If left blank, the default subtitles off icon is displayed.

subtitlesOnIcon

string

The SVG markup of the icon displayed when subtitles are enabled.

If left blank, the default subtitles on icon is displayed.

subtitlesAutoTranslateLabel

object

The (multi-language) label of the auto-translate subtitles menu.

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.

subtitlesSettingsLabel

object

The (multi-language) label of the subtitles settings option.

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.

videoControlsPauseIcon

string

The SVG markup of the icon displayed on the video controls pause CTA.

If left blank, the default pause icon is displayed.

videoControlsPlayIcon

string

The SVG markup of the icon displayed on the video controls play CTA.

If left blank, the default play icon is displayed.

Last updated