title: PlayerConfigInput

Interface: PlayerConfigInput

Input config shape — all fields optional. Accepted as inline config and from a remote config service.

interface PlayerConfigInput {    ad?: { apsTimeout?: number; autoPauseWhenInvisible?: boolean; bidding?: boolean; customClickButton?: boolean; enable?: boolean; imaUi?: boolean; intensity?: number; maxDuration?: number; maxRedirectCount?: number; maxWaterfallLength?: number; palSdk?: boolean; pauseButton?: boolean; player?: "ads-sdk" | "ima"; prebidTimeout?: number; tagConfig?: string | { url: string; errorPixels?: string[]; externalId?: string; id?: string } | { lineItems: { url: string; errorPixels?: string[]; externalId?: string; id?: string }[]; maxDuration?: number; maxFallbackAttempts?: number; name?: string }[]; vastLoadTimeout?: number; videoLoadTimeout?: number };    analytics?: { scriptUrl?: string };    context?: { deviceType?: string; extra?: Record<string, unknown>; partnerId?: string; partnerName?: string; productFormat?: string; productName?: string; publisherCountryCode?: string; publisherId?: string; userCountryCode?: string };    developmentFlags?: { configOverrides?: PlayerConfigInput; debug?: boolean; environment?: "stage"; stylesUrl?: string; [key: string]: unknown };    dock?: { allowAdClose?: boolean; bottom?: string; enable?: boolean; left?: string; position?: "top" | "right" | "bottom" | "left" | "bottomLeft" | "bottomRight" | "topLeft" | "topRight" | "stickyTop" | "stickyTopExpanded"; right?: string; snapTop?: string; targetSelector?: string; top?: string };    earlyRecommendations?: { buttonCountdownSeconds?: number; enable?: boolean; maximumVisibility?: number; minimumContentDurationSeconds?: number; showAfterSeconds?: number };    experiments?: Record<string, string>;    id?: string;    otherPlayers?: { pauseOnOtherPlay?: boolean; pauseOnOtherPlayWhenMuted?: boolean; singleDockMode?: boolean };    playback?: { anyClickUnmute?: boolean; autoplayVolume?: number; initialAutoplayPlaybackRate?: number; initialPlaybackRate?: number; noConsentNoAutoplay?: boolean; playOnVisibility?: number; preload?: "metadata" | "none" | "auto"; restoreMediaPreferences?: boolean; startBehavior?: "click-to-play" | "scroll-to-play" | "scroll-to-play-when-ad" | "scroll-to-play-with-out-to-play-fallback" | "scroll-to-play-with-silent-fallback" | "silent-scroll-to-play" | "silent-scroll-to-play-when-ad" | "scroll-out-to-play" | "scroll-out-to-play-when-ad" };    playlist?: { contentFrequencyCapping?: boolean; endBehavior?: "stop" | "loop"; endscreen?: "continue" | "none"; recommendations?: boolean; revolverPlay?: boolean; revolverPlayAutoplayCountdown?: number; revolverPlayCountdown?: number };    privacy?: { loadThirdPartyOnlyIfConsent?: boolean };    seo?: { addJsonLd?: boolean };    ui?: { contentBranding?: boolean; contentComposition?: string; contentOwnerLogo?: boolean; enable?: boolean; epgButton?: boolean; globalKeyboardEvents?: boolean; nextVideoButton?: boolean; premiumProductName?: string; tapToUnmute?: boolean; title?: boolean; upsellButton?: boolean; useInitialTeaserComposition?: boolean };    variant?: { id: string; [x: string]: unknown };}

Properties

ad?

optional ad: object

apsTimeout?

optional apsTimeout: number

autoPauseWhenInvisible?

optional autoPauseWhenInvisible: boolean

bidding?

optional bidding: boolean

customClickButton?

optional customClickButton: boolean

enable?

optional enable: boolean

imaUi?

optional imaUi: boolean

intensity?

optional intensity: number

maxDuration?

optional maxDuration: number

maxRedirectCount?

optional maxRedirectCount: number

maxWaterfallLength?

optional maxWaterfallLength: number

palSdk?

optional palSdk: boolean

pauseButton?

optional pauseButton: boolean

player?

optional player: "ads-sdk" | "ima"

prebidTimeout?

optional prebidTimeout: number

tagConfig?

optional tagConfig: string | { url: string; errorPixels?: string[]; externalId?: string; id?: string; } | object[]

vastLoadTimeout?

optional vastLoadTimeout: number

videoLoadTimeout?

optional videoLoadTimeout: number

analytics?

optional analytics: object

scriptUrl?

optional scriptUrl: string

context?

optional context: object

deviceType?

optional deviceType: string

extra?

optional extra: Record<string, unknown>

partnerId?

optional partnerId: string

partnerName?

optional partnerName: string

productFormat?

optional productFormat: string

productName?

optional productName: string

publisherCountryCode?

optional publisherCountryCode: string

publisherId?

optional publisherId: string

userCountryCode?

optional userCountryCode: string

developmentFlags?

optional developmentFlags: object

Index Signature

[key: string]: unknown

configOverrides?

optional configOverrides: PlayerConfigInput

Final-layer config override — applied on top of defaults, remote, and inline config.

debug?

optional debug: boolean

Enable debug mode. Can also be set via the ?turboDebug=true URL parameter.

environment?

optional environment: "stage"

Target the stage environment instead of production.

stylesUrl?

optional stylesUrl: string

Override the styles URL.

dock?

optional dock: object

allowAdClose?

optional allowAdClose: boolean

bottom?

optional bottom: string

enable?

optional enable: boolean

left?

optional left: string

position?

optional position: "top" | "right" | "bottom" | "left" | "bottomLeft" | "bottomRight" | "topLeft" | "topRight" | "stickyTop" | "stickyTopExpanded"

right?

optional right: string

snapTop?

optional snapTop: string

targetSelector?

optional targetSelector: string

top?

optional top: string

earlyRecommendations?

optional earlyRecommendations: object

buttonCountdownSeconds?

optional buttonCountdownSeconds: number

enable?

optional enable: boolean

maximumVisibility?

optional maximumVisibility: number

minimumContentDurationSeconds?

optional minimumContentDurationSeconds: number

showAfterSeconds?

optional showAfterSeconds: number

experiments?

optional experiments: Record<string, string>

id?

optional id: string

otherPlayers?

optional otherPlayers: object

pauseOnOtherPlay?

optional pauseOnOtherPlay: boolean

pauseOnOtherPlayWhenMuted?

optional pauseOnOtherPlayWhenMuted: boolean

singleDockMode?

optional singleDockMode: boolean

playback?

optional playback: object

anyClickUnmute?

optional anyClickUnmute: boolean

autoplayVolume?

optional autoplayVolume: number

initialAutoplayPlaybackRate?

optional initialAutoplayPlaybackRate: number

initialPlaybackRate?

optional initialPlaybackRate: number

noConsentNoAutoplay?

optional noConsentNoAutoplay: boolean

playOnVisibility?

optional playOnVisibility: number

preload?

optional preload: "metadata" | "none" | "auto"

restoreMediaPreferences?

optional restoreMediaPreferences: boolean

startBehavior?

optional startBehavior: "click-to-play" | "scroll-to-play" | "scroll-to-play-when-ad" | "scroll-to-play-with-out-to-play-fallback" | "scroll-to-play-with-silent-fallback" | "silent-scroll-to-play" | "silent-scroll-to-play-when-ad" | "scroll-out-to-play" | "scroll-out-to-play-when-ad"

playlist?

optional playlist: object

contentFrequencyCapping?

optional contentFrequencyCapping: boolean

endBehavior?

optional endBehavior: "stop" | "loop"

endscreen?

optional endscreen: "continue" | "none"

recommendations?

optional recommendations: boolean

revolverPlay?

optional revolverPlay: boolean

revolverPlayAutoplayCountdown?

optional revolverPlayAutoplayCountdown: number

revolverPlayCountdown?

optional revolverPlayCountdown: number

privacy?

optional privacy: object

loadThirdPartyOnlyIfConsent?

optional loadThirdPartyOnlyIfConsent: boolean

seo?

optional seo: object

addJsonLd?

optional addJsonLd: boolean

ui?

optional ui: object

contentBranding?

optional contentBranding: boolean

contentComposition?

optional contentComposition: string

contentOwnerLogo?

optional contentOwnerLogo: boolean

enable?

optional enable: boolean

epgButton?

optional epgButton: boolean

globalKeyboardEvents?

optional globalKeyboardEvents: boolean

nextVideoButton?

optional nextVideoButton: boolean

premiumProductName?

optional premiumProductName: string

tapToUnmute?

optional tapToUnmute: boolean

title?

optional title: boolean

upsellButton?

optional upsellButton: boolean

useInitialTeaserComposition?

optional useInitialTeaserComposition: boolean

variant?

optional variant: object

Index Signature

[x: string]: unknown

id

id: string