Interface PlayerConfiguration

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

Properties

The ads configuration for the player.

The cast configuration for the player.

hlsDateRange?: boolean

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

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/'`
license?: string

The license for the player

licenseUrl?: string

The url to fetch the license for the player

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.

The configuration of media controls and media sessions across platforms.

The muted autoplay policy for web.

Remarks


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

Default Value

'none'.

retryConfiguration?: RetryConfiguration

The retry configuration for the player.

Remarks


- This parameter only applies to Web and Android platforms.

The THEOlive configuration for the player.

tunnelingEnabled?: boolean

Whether multimedia tunneling is enabled for the player or not.

  • Only supported with the Media3 integration.
  • Only supported if the media being played includes both audio and video.
  • Only supported on limited number of video codecs and devices.

Default Value

false

Remarks


- This parameter only applies to Android platforms.

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