Represents a source for a Millicast live stream.

interface MillicastSource {
    apiUrl?: string;
    connectOptions?: MillicastConnectOptions;
    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;
    streamAccountId: string;
    subscriberToken?: string;
    timeServer?: string;
    type: "millicast";
}

Hierarchy (view full)

Properties

apiUrl?: string

The URL of the API endpoint that the SDK communicates with for authentication.

connectOptions?: MillicastConnectOptions

An optional configuration object to set additional subscriber options.

  • The available options are listed in the link below.
contentProtection?: DRMConfiguration

The content protection parameters for the media resource.

crossOrigin?: CrossOriginSetting

The cross-origin setting of the source.

Default Value

''

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

Remarks


- Ignored for non-DASH streams.

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.

The configuration for controlling playback of an HLS stream.

Remarks


- Ignored for non-HLS streams.

integration?: THEO_LIVE

The integration ID of the source.

Remarks


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

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

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
src: string

The name of the Millicast stream to subscribe to.

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

streamAccountId: string

The Millicast account identifier.

subscriberToken?: string

Token to subscribe to secure streams.

  • If you are subscribing to an unsecure stream, you can omit this param.
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: "millicast"

The content type.

Must be "millicast".