Interface BaseSource

Represents the common properties of a media resource.

interface BaseSource {
    crossOrigin?: CrossOriginSetting;
    dash?: DashPlaybackConfiguration;
    hls?: HlsPlaybackConfiguration;
    integration?: THEO_LIVE;
    liveOffset?: number;
    lowLatency?: boolean;
    timeServer?: string;
}

Hierarchy (view full)

Properties

crossOrigin? dash? hls? integration? liveOffset? lowLatency? timeServer?

Properties

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 hls

hls?: HlsPlaybackConfiguration

The configuration for controlling playback of an HLS stream.

Remarks


- Ignored for non-HLS streams.

Optional integration

integration?: THEO_LIVE

The integration ID of the source.

Remarks


- This can be used to signal that a source is specific to an integration.

Deprecated

use TypedSource.type instead.

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

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

Settings

Member Visibility

Theme

On This Page

crossOrigindashhlsintegrationliveOffsetlowLatencytimeServer