Interface: AdvancedOptions

Hierarchy

• AdvancedOptions

Index

Properties

• cmp
• disableCookieBanner
• disableLiveSeek
• disablePlaybackButtons
• disableScrubber
• enableIframeMessaging
• localeRootUrl
• numberOfUnlockers
• onDemandItem
• playLocked
• tracking

Properties

Optional cmp

• cmp? : CmpConfig

Config for the Consent Management Platform (UserCentrics) if the broadcaster is using one.

Optional disableCookieBanner

• disableCookieBanner? : undefined | false | true

Disable the Radioplayer cookie consent handling. The player will assume that the listener has opted-in to all cookie types. You should ensure that you have your own cookie consent handling to comply with GDPR if you do.

Optional disableLiveSeek

• disableLiveSeek? : undefined | false | true

Disable advanced transport controls for DASH

Optional disablePlaybackButtons

• disablePlaybackButtons? : undefined | false | true

Disable the transport control buttons

Optional disableScrubber

• disableScrubber? : undefined | false | true

Disable the transport control scrubber

Optional enableIframeMessaging

• enableIframeMessaging? : undefined | false | true

Enable messaging between player and iframe widget

Optional localeRootUrl

• localeRootUrl? : undefined | string

Root URL for the locale files. Useful if you are using a CDN. e.g. https://cdn.example/radioplayerassets Default is the same directory as the HTML file. A path such as locales/en/translation.json will be appended to the URL. Do not include a trailing slash.

Optional numberOfUnlockers

• numberOfUnlockers? : undefined | number

Playback will be unlocked once the number of received events equals numberOfUnlockers

Optional onDemandItem

• onDemandItem? : OnDemandItem | "awaiting" | "failed"

Override playback of streams, and play this On Demand item instead.

Optional playLocked

• playLocked? : undefined | false | true

Lock play on page load

Optional tracking

• tracking? : TrackingConfig | TrackingConfig[]