Interface PlayerConfiguration

interface PlayerConfiguration {
    ads?: AdsConfiguration;
    cast?: CastConfiguration;
    chromeless?: boolean;
    enableTHEOlive?: boolean;
    hlsDateRange?: boolean;
    libraryLocation?: string;
    license?: string;
    licenseUrl?: string;
    liveOffset?: number;
    mediaControl?: MediaControlConfiguration;
    mutedAutoplay?: MutedAutoplayConfiguration;
    retryConfiguration?: RetryConfiguration;
    ui?: UIConfiguration;
    useMedia3?: boolean;
}

Properties

ads? cast? chromeless? enableTHEOlive? hlsDateRange? libraryLocation? license? licenseUrl? liveOffset? mediaControl? mutedAutoplay? retryConfiguration? ui? useMedia3?

Properties

Optional ads

ads?: AdsConfiguration

The ads configuration for the player.

Optional cast

cast?: CastConfiguration

The cast configuration for the player.

Optional Readonly chromeless

chromeless?: boolean

Sets whether the native player is chromeless (without UI).

Remarks


- This parameter only applies to Web platforms.

Optional enableTHEOlive

enableTHEOlive?: boolean

Sets whether support for THEOlive sources should be enabled.

Default Value

false. @deprecated: THEOlive support is always enabled, there is no need to explicitly enable it.

Optional Readonly hlsDateRange

hlsDateRange?: boolean

Sets whether DateRange tags from the playlists should be imported as a textTrack.

Optional libraryLocation

libraryLocation?: string

The directory in which the THEOplayer library worker files are located. These worker files are THEOplayer.transmux.*

Remarks


- This parameter is required when using a HLS source and has no default.

Example

`'/lib/theoplayer/'`

Optional Readonly license

license?: string

The license for the player

Optional Readonly licenseUrl

licenseUrl?: string

The url to fetch the license for the player

Optional liveOffset

liveOffset?: number

The offset in seconds used to determine the live point. This live point is the end of the manifest minus the provided offset.

Default Value

Three times the target duration of a segment, as specified by the manifest.

Remarks


- This parameter only applies to Web and Android platforms.

Optional mediaControl

mediaControl?: MediaControlConfiguration

The configuration of media controls and media sessions across platforms.

Optional mutedAutoplay

mutedAutoplay?: MutedAutoplayConfiguration

The muted autoplay policy for web.

Remarks


- The muted autoplay policy is impacted by this property and theoplayer!SourceConfiguration.mutedAutoplay.

Default Value

'none'.

Optional Readonly retryConfiguration

retryConfiguration?: RetryConfiguration

The retry configuration for the player.

Remarks


- This parameter only applies to Web and Android platforms.

Optional ui

ui?: UIConfiguration

The ui configuration for the underlying native player. Applies to Ad UI.

Optional Experimental useMedia3

useMedia3?: boolean

Sets whether the Media3 extension is used for play-out on Android.

Remarks


- This parameter only applies to Android platforms.

Default Value

false.

Settings

Member Visibility

Theme

On This Page

adscastchromelessenableTHEOlivehlsDateRangelibraryLocationlicenselicenseUrlliveOffsetmediaControlmutedAutoplayretryConfigurationuiuseMedia3