Interface MillicastSource

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? connectOptions? contentProtection? crossOrigin? dash? headers? hls? integration? liveOffset? lowLatency? playbackPipeline? src ssai? streamAccountId subscriberToken? timeServer? type

Properties

Optional apiUrl

apiUrl?: string

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

See

https://millicast.github.io/millicast-sdk/module-Director.html#~setEndpoint

Optional connectOptions

connectOptions?: MillicastConnectOptions

An optional configuration object to set additional subscriber options.

  • The available options are listed in the link below.

See

https://millicast.github.io/millicast-sdk/View.html#connect

Optional contentProtection

contentProtection?: DRMConfiguration

The content protection parameters for the media resource.

Remarks


- Available since v2.15.0.

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


- Available since v2.79.0.
- 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

Remarks


- Available on iOS and Android.
- Available since v7.9.0.

Optional hls

hls?: HlsPlaybackConfiguration

The configuration for controlling playback of an HLS stream.

Remarks


- Available since v2.82.0.
- 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.

Remarks


- Available on Web and Android.

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.
- Available since v2.62.0.

Optional playbackPipeline

playbackPipeline?: PlaybackPipeline

The playback pipeline to use for this stream.

Default Value

[PlaybackPipeline.MEDIA3]

Since

v9.0.0

Remarks


- Available on Android only.

src

src: string

The name of the Millicast stream to subscribe to.

See

https://millicast.github.io/millicast-sdk/global.html#DirectorSubscriberOptions

Optional ssai

ssai?: ServerSideAdInsertionConfiguration

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

Remarks


- Available since v2.12.0.

streamAccountId

streamAccountId: string

The Millicast account identifier.

See

https://millicast.github.io/millicast-sdk/global.html#DirectorSubscriberOptions

Optional subscriberToken

subscriberToken?: string

Token to subscribe to secure streams.

  • If you are subscribing to an unsecure stream, you can omit this param.

See

https://millicast.github.io/millicast-sdk/global.html#DirectorSubscriberOptions

Optional timeServer

timeServer?: string

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

Remarks


- Available since v2.47.0.
- 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: "millicast"

The content type.

Must be "millicast".

Settings

Member Visibility

Theme

On This Page

apiUrlconnectOptionscontentProtectioncrossOrigindashheadershlsintegrationliveOffsetlowLatencyplaybackPipelinesrcssaistreamAccountIdsubscriberTokentimeServertype