React Native THEOplayer SDK
    Preparing search index...

    Interface MillicastConnectOptions

    The additional options that can be configured when connecting to a Millicast live stream.

    For additional addition information on each underlying SDK, see the docs:

    interface MillicastConnectOptions {
        absCaptureTime?: boolean;
        bweMonitorDurationUs?: number;
        bweRateChangePercentage?: number;
        disableAudio?: boolean;
        disableVideo?: boolean;
        drm?: boolean;
        dtx?: boolean;
        enableDRM?: boolean;
        events?: string[];
        excludedSourceIds?: string[];
        forcePlayoutDelay?: MillicastForcePlayoutDelay;
        forceSmooth?: boolean;
        jitterMinimumDelayMs?: number;
        layer?: MillicastLayerInfo;
        maximumBitrate?: number;
        metadata?: boolean;
        multiplexedAudioTracks?: number;
        peerConfig?: RTCConfiguration;
        pinnedSourceId?: string;
        priority?: number;
        rtcEventLogOutputPath?: string;
        statsDelayMs?: number;
        stereo?: boolean;
        upwardsLayerWaitTimeMs?: number;
    }
    Index
    absCaptureTime? bweMonitorDurationUs? bweRateChangePercentage? disableAudio? disableVideo? drm? dtx? enableDRM? events? excludedSourceIds? forcePlayoutDelay? forceSmooth? jitterMinimumDelayMs? layer? maximumBitrate? metadata? multiplexedAudioTracks? peerConfig? pinnedSourceId? priority? rtcEventLogOutputPath? statsDelayMs? stereo? upwardsLayerWaitTimeMs?
    absCaptureTime?: boolean

    True to modify SDP for supporting absolute capture time header extension. Otherwise, False.

    Web
    bweMonitorDurationUs?: number

    Overrides the duration of time over which bandwidth-estimate-calculations occur in usec. By default, this is 150 msec, increasing this may smooth out transitions a little at the cost of not reacting to changes in the network as fast.

    iOS
    Android
    bweRateChangePercentage?: number

    What percentage of the estimated larger bitrate will we increase by when we think the network is good. So if the previous estimate was 1mbps and the new estimate is 10mbps, and bweRateChangePercentage is 0.05, then 0.05*10mbps = 0.5mbps, so the new target at the end of the tick will be 1 + 0.5 = 1.5mbps. This value can be reduced to increase more slowly under good conditions.

    iOS
    Android
    disableAudio?: boolean

    A boolean option that determines whether audio playback should be completely disabled. Disabling unnecessary audio helps reduce audio-to-video synchronization delays.

    iOS
    Android
    Web 
    false
    disableVideo?: boolean

    Disable the opportunity to receive video stream.

    Web 
    false
    drm?: boolean

    Enable the DRM protected stream playback.

    Web 
    false
    dtx?: boolean

    Enables Discontinuous Transmission (DTX) on the publishing side to send audio only when a user’s voice is detected.

    iOS
    Android
    Web 
    false
    enableDRM?: boolean

    Enable DRM, default is false.

    Web
    events?: string[]

    Override which events will be delivered by the server.

    Web

    Possible values are: 'active','inactive','vad','layers','viewercount' and 'updated'

    excludedSourceIds?: string[]

    Do not receive media from these source ids.

    iOS
    Android
    Web

    Maps to the property excludedSourceId on iOS and Android.

    forcePlayoutDelay?: MillicastForcePlayoutDelay

    Sets the minimum and maximum values for the playout delay.

    iOS
    Android
    Web
    forceSmooth?: boolean

    Forces video to be sent on downlink when switching from higher quality layers.

    iOS
    Android 
    false
    jitterMinimumDelayMs?: number

    The minimum jitter delay that packets of incoming audio/video streams will experience before being played out. This can be tuned to help with networks with higher latency, but be careful using it as it will introduce this delay.

    iOS
    Android
    layer?: MillicastLayerInfo

    Select the simulcast encoding layer and svc layers for the main video track, leave empty for automatic layer selection based on bandwidth estimation.

    Web

    See LayerInfo for more details

    maximumBitrate?: number

    Sets the maximum bitrate in KBps that the subscriber can receive.

    iOS
    Android
    metadata?: boolean

    Enable metadata extraction if stream is compatible.

    Web 
    false
    multiplexedAudioTracks?: number

    Number of audio tracks to receive VAD multiplexed audio for secondary sources.

    iOS
    Android
    Web

    Maps to the property multiplexedAudioTrack on iOS and Android.

    peerConfig?: RTCConfiguration

    Options to configure the new RTCPeerConnection.

    Web
    pinnedSourceId?: string

    A specific source to pin to prioritize its audio and video tracks for playback.

    iOS
    Android
    Web
    priority?: number

    The priority of redundant streams that indicates the order in which backup streams should be broadcast in the case of any problems with the primary stream.

    iOS
    rtcEventLogOutputPath?: string

    The file path for storing Real-Time Communication (RTC) event logs. Using this option requires having the rights upon the destination file path.

    iOS
    Android 
    ''
    statsDelayMs?: number

    The delay for collecting and reporting statistical information, in milliseconds.

    iOS
    Android 
    1000
    stereo?: boolean

    A boolean option that determines whether stereo audio playback should be enabled or disabled.

    iOS
    Android 
    true
    upwardsLayerWaitTimeMs?: number

    Duration the Transponder will wait before switching back to a higher layer in msec.

    iOS
    Android

    Settings
    Member Visibility

    On This Page
    Properties