React Native THEOplayer SDK
    Preparing search index...

    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;
        hlsDateRange?: boolean;
        latencyConfiguration?: SourceLatencyConfiguration;
        liveOffset?: number;
        lowLatency?: boolean;
        src: string;
        ssai?: ServerSideAdInsertionConfiguration;
        streamAccountId: string;
        subscriberToken?: string;
        timeServer?: string;
        type: "millicast";
    }

    Hierarchy (View Summary)

    Index
    apiUrl? connectOptions? contentProtection? crossOrigin? dash? headers? hls? hlsDateRange? latencyConfiguration? liveOffset? lowLatency? src ssai? streamAccountId subscriberToken? timeServer? type
    apiUrl?: string

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

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

    connectOptions?: MillicastConnectOptions

    An optional configuration object to set additional subscriber options.

    • The available options are listed in the link below.

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

    contentProtection?: DRMConfiguration

    The content protection parameters for the media resource.

    crossOrigin?: CrossOriginSetting

    The cross-origin setting of the source.

    ''

    dash?: DashPlaybackConfiguration

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


    - Ignored for non-DASH streams.

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

    The headers included in the request when retrieving the resource.

    iOS
    Android

    React Native THEOplayer SDK v7.9.0.

    hls?: HlsPlaybackConfiguration

    The configuration for controlling playback of an HLS stream.


    - Ignored for non-HLS streams.

    hlsDateRange?: boolean

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

    false

    latencyConfiguration?: SourceLatencyConfiguration

    The source's latency configuration.

    Android
    Web


    - Ignored for VOD playback.

    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.

    Android
    Web


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

    Three times the segment's target duration.
    lowLatency?: boolean

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

    false


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

    src: string

    The name of the Millicast stream to subscribe to.

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

    ssai?: ServerSideAdInsertionConfiguration

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

    streamAccountId: string

    The Millicast account identifier.

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

    subscriberToken?: string

    Token to subscribe to secure streams.

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

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

    timeServer?: string

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


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

    Settings
    Member Visibility

    On This Page
    Properties