Interface TheoLiveSource

Represents a source for the THEOlive integration.

interface TheoLiveSource {
    contentProtection?: DRMConfiguration;
    crossOrigin?: CrossOriginSetting;
    dash?: DashPlaybackConfiguration;
    headers?: {
        [key: string]: string;
    };
    hls?: HlsPlaybackConfiguration;
    hlsDateRange?: boolean;
    integration: THEO_LIVE;
    latencyConfiguration?: SourceLatencyConfiguration;
    liveOffset?: number;
    lowLatency?: boolean;
    profile?: string;
    src?: string;
    ssai?: ServerSideAdInsertionConfiguration;
    timeServer?: string;
    type: "theolive";
}

Hierarchy (view full)

Properties

contentProtection? crossOrigin? dash? headers? hls? hlsDateRange? integration latencyConfiguration? liveOffset? lowLatency? profile? src? ssai? timeServer? type

Properties

Optional contentProtection

contentProtection?: DRMConfiguration

The content protection parameters for the media resource.

Optional crossOrigin

crossOrigin?: CrossOriginSetting

The cross-origin setting of the source.

Default Value

''

Optional dash

dash?: DashPlaybackConfiguration

The configuration for controlling playback of an MPEG-DASH stream.

Remarks


- Ignored for non-DASH streams.

Optional headers

headers?: {
    [key: string]: string;
}

The headers included in the request when retrieving the resource.

Type declaration

  • [key: string]: string

Platform

iOS
Android

Since

React Native THEOplayer SDK v7.9.0.

Optional hls

hls?: HlsPlaybackConfiguration

The configuration for controlling playback of an HLS stream.

Remarks


- Ignored for non-HLS streams.

Optional hlsDateRange

hlsDateRange?: boolean

Whether the player should parse and expose date ranges from HLS manifests.

Default Value

false

integration

integration: THEO_LIVE

Deprecated

use TypedSource.type instead.

Optional latencyConfiguration

latencyConfiguration?: SourceLatencyConfiguration

The source's latency configuration.

Platform

Android
Web

Remarks


- Ignored for VOD playback.

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.

Platform

Android
Web

Remarks


- Will be overridden by SourceLatencyConfiguration.targetOffset if it is specified.

Default Value

Three times the segment's target duration.

Optional lowLatency

lowLatency?: boolean

Whether the source should be played in the low-latency-mode of the player.

Default Value

false

Remarks


- This setting must be true when using Low-Latency CMAF with ABR.

Optional profile

profile?: string

The profile identifier is included as a query parameter in the discovery request to obtain a response specific to that profile.

Optional src

src?: string

The source URL of the media resource.

Remarks


- Required if the ssai property is absent.

Optional ssai

ssai?: ServerSideAdInsertionConfiguration

The Server-side Ad Insertion parameters for the media resource.

Optional timeServer

timeServer?: string

The URL of a time server used by the player to synchronise the time in DASH sources.

Remarks


- The time server should return time in ISO-8601 format.
- Overrides the time server provided the DASH manifest's <UTCTiming>.
- Only this source will use the time server. Alternatively, for all source use SourceConfiguration.timeServer.

type

type: "theolive"

The content type.

Settings

Member Visibility

Theme

On This Page

contentProtectioncrossOrigindashheadershlshlsDateRangeintegrationlatencyConfigurationliveOffsetlowLatencyprofilesrcssaitimeServertype