Interface MillicastConnectOptions

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

Remarks

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;
}

Properties

absCaptureTime? bweMonitorDurationUs? bweRateChangePercentage? disableAudio? disableVideo? drm? dtx? enableDRM? events? excludedSourceIds? forcePlayoutDelay? forceSmooth? jitterMinimumDelayMs? layer? maximumBitrate? metadata? multiplexedAudioTracks? peerConfig? pinnedSourceId? priority? rtcEventLogOutputPath? statsDelayMs? stereo? upwardsLayerWaitTimeMs?

Properties

Optional absCaptureTime

absCaptureTime?: boolean

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

Platform

Web

Optional bweMonitorDurationUs

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.

Platform

iOS
Android

Optional bweRateChangePercentage

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.

Platform

iOS
Android

Optional disableAudio

disableAudio?: boolean

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

Platform

iOS
Android
Web

Default Value

false

Optional disableVideo

disableVideo?: boolean

Disable the opportunity to receive video stream.

Platform

Web

Default Value

false

Optional drm

drm?: boolean

Enable the DRM protected stream playback.

Platform

Web

Default Value

false

Optional dtx

dtx?: boolean

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

Platform

iOS
Android
Web

Default Value

false

Optional enableDRM

enableDRM?: boolean

Enable DRM, default is false.

Platform

Web

Optional events

events?: string[]

Override which events will be delivered by the server.

Platform

Web

Remarks

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

Optional excludedSourceIds

excludedSourceIds?: string[]

Do not receive media from these source ids.

Platform

iOS
Android
Web

Remarks

Maps to the property excludedSourceId on iOS and Android.

Optional forcePlayoutDelay

forcePlayoutDelay?: MillicastForcePlayoutDelay

Sets the minimum and maximum values for the playout delay.

Platform

iOS
Android
Web

Optional forceSmooth

forceSmooth?: boolean

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

Platform

iOS
Android

Default Value

false

Optional jitterMinimumDelayMs

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.

Platform

iOS
Android

Optional layer

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.

Platform

Web

Remarks

See LayerInfo for more details

Optional maximumBitrate

maximumBitrate?: number

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

Platform

iOS
Android

Optional metadata

metadata?: boolean

Enable metadata extraction if stream is compatible.

Platform

Web

Default Value

false

Optional multiplexedAudioTracks

multiplexedAudioTracks?: number

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

Platform

iOS
Android
Web

Remarks

Maps to the property multiplexedAudioTrack on iOS and Android.

Optional peerConfig

peerConfig?: RTCConfiguration

Options to configure the new RTCPeerConnection.

Platform

Web

Optional pinnedSourceId

pinnedSourceId?: string

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

Platform

iOS
Android
Web

Optional priority

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.

Platform

iOS

Optional rtcEventLogOutputPath

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.

Platform

iOS
Android

Default Value

''

Optional statsDelayMs

statsDelayMs?: number

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

Platform

iOS
Android

Default Value

1000

Optional stereo

stereo?: boolean

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

Platform

iOS
Android

Default Value

true

Optional upwardsLayerWaitTimeMs

upwardsLayerWaitTimeMs?: number

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

Platform

iOS
Android

Settings

Member Visibility

Theme

On This Page

absCaptureTimebweMonitorDurationUsbweRateChangePercentagedisableAudiodisableVideodrmdtxenableDRMeventsexcludedSourceIdsforcePlayoutDelayforceSmoothjitterMinimumDelayMslayermaximumBitratemetadatamultiplexedAudioTrackspeerConfigpinnedSourceIdpriorityrtcEventLogOutputPathstatsDelayMsstereoupwardsLayerWaitTimeMs