Interface TypedSource

Represents a media resource characterized by a URL to the resource and optionally information about the resource.

interface TypedSource {
    contentProtection?: DRMConfiguration;
    crossOrigin?: CrossOriginSetting;
    dash?: DashPlaybackConfiguration;
    headers?: {
        [key: string]: string;
    };
    hls?: HlsPlaybackConfiguration;
    integration?: THEO_LIVE;
    liveOffset?: number;
    lowLatency?: boolean;
    playbackPipeline?: PlaybackPipeline;
    src?: string;
    ssai?: ServerSideAdInsertionConfiguration;
    timeServer?: string;
    type?: string;
}

Hierarchy (view full)

Properties

contentProtection? crossOrigin? dash? headers? hls? integration? liveOffset? lowLatency? playbackPipeline? 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 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.

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 playbackPipeline

playbackPipeline?: PlaybackPipeline

The playback pipeline to use for this stream.

Default Value

[PlaybackPipeline.MEDIA3]

Since

React Native THEOplayer SDK v9.0.0.

Since

Native THEOplayer SDK v9.0.0.

Platform

Android

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.

Optional type

type?: string

The content type (MIME type) of the media resource, represented by a value from the following list:
- 'application/dash+xml': The media resource is an MPEG-DASH stream.
- 'application/x-mpegURL' or 'application/vnd.apple.mpegurl': The media resource is an HLS stream.
- 'video/mp4', 'video/webm' and other formats: The media resource should use native HTML5 playback if supported by the browser.
- 'application/vnd.theo.hesp+json': The media resource is an HESP stream.

Settings

Member Visibility

Theme

On This Page

contentProtectioncrossOrigindashheadershlsintegrationliveOffsetlowLatencyplaybackPipelinesrcssaitimeServertype