Interface PlayerConfiguration

Describes a player's configuration.

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;
    useHttpEngine?: boolean;
}

Properties

ads? cast? hlsDateRange? libraryLocation? license? licenseUrl? liveOffset? mediaControl? mutedAutoplay? retryConfiguration? theoLive? tunnelingEnabled? ui? useHttpEngine?

Properties

Optional ads

ads?: AdsConfiguration

The ads configuration for the player.

Optional cast

cast?: CastConfiguration

The cast configuration for the player.

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.

Platform

Android
Web

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.

Platform

Android
Web

Optional theoLive

theoLive?: TheoLiveConfiguration

The THEOlive configuration for the player.

Optional tunnelingEnabled

tunnelingEnabled?: boolean

Whether multimedia tunneling is enabled for the player or not.

Default Value

false

Platform

Android

Remarks


- 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.

Optional ui

ui?: UIConfiguration

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

Optional useHttpEngine

useHttpEngine?: boolean

Whether the player should use android.net.http.HttpEngine or Cronet for its network stack, if available.

Default Value

true

Platform

Android

Remarks


- Only supported with the Media3 integration.
- When set to true, the player will attempt to use either android.net.http.HttpEngine or Cronet for its network requests.
- When set to false, the player will always use java.net.HttpURLConnection.

Settings

Member Visibility

Theme

On This Page

adscasthlsDateRangelibraryLocationlicenselicenseUrlliveOffsetmediaControlmutedAutoplayretryConfigurationtheoLivetunnelingEnableduiuseHttpEngine