Skip to main content

Interface: PlayerOptions

Available options when initializing the Player. Used for enabling/disabling features and hiding/showing buttons in the control pane

Properties​

castBackground​

• Optional castBackground: string

Background image for Cast Receiver

castEnabled​

• Optional castEnabled: boolean

Enable or disable Google Cast (button and functionality). Will be disabled if device is unable to use Cast Framework

castReceiverApplicationId​

• Optional castReceiverApplicationId: string

For custom Cast Receivers, enter your Application Id here

channelSelectionEnabled​

• Optional channelSelectionEnabled: boolean

Deprecated

since 2.0.10. Use channelSelectionOptions.

Enable or disable channel selector (only available for channel groups with more than one channel)

channelSelectionOptions​

• Optional channelSelectionOptions: Object

Customize and enable channel selection interfaces. Will be disabled if not using a channel group with more than one channel.

Type declaration​

NameType
barButton?{ enabled?: boolean ; thumbnails?: boolean }
barButton.enabled?boolean
barButton.thumbnails?boolean
list?{ enabled?: boolean }
list.enabled?boolean

controlsEnabled​

• Optional controlsEnabled: boolean

Enable or disable controls

fullscreenButtonEnabled​

• Optional fullscreenButtonEnabled: boolean

Enable or disable fullscreen button

hideTimeout​

• Optional hideTimeout: number

Hide controls after this time in ms

languagesButtonEnabled​

• Optional languagesButtonEnabled: boolean

Enable or disable language selector

oneToOneButtonEnabled​

• Optional oneToOneButtonEnabled: boolean

Enable or disable one-to-one (real size, not filling the entire container)

pauseButtonEnabled​

• Optional pauseButtonEnabled: boolean

Enable or disable the pause and play button

pipButtonEnabled​

• Optional pipButtonEnabled: boolean

Enable or disable Picture-in-picture button. Will be disabled if device is unable to manually enter PiP

renditionLevelsEnabled​

• Optional renditionLevelsEnabled: boolean

Enable or disable rendition (bitrate) selector

thumbnailUpdateInterval​

• Optional thumbnailUpdateInterval: number

How often we should refresh thumbnails if used in MS. Default is 60000.