MCClientOptions Class Reference

The MCClientOptions class gathers options for the client. More...

#import <client.h>

Inheritance diagram for MCClientOptions:

Collaboration diagram for MCClientOptions:

Properties
NSString *	sourceId
	The ID of the source to publish. This option is related to the multisource feature of the millicast service. For more information refer to The Multisource Broadcasting Guide. This is a publisher only option.
NSString *	pinnedSourceId
	The receiving source to pin. Refer to The Multiview Guide to learn more about this. This is a subscriber only option.
NSArray *	excludedSourceId
	Excluded sources that you do not wish to receive. Refer to The Multiview Guide to learn more about this. This is a subscriber only option.
BOOL	dtx
	Enables discontinuous transmission on the publishing side, so audio data is only sent when a user’s voice is detected.
int	multiplexedAudioTrack
	The number of multiplxed audio tracks to receive. This is only available for the subscriber.
NSString *	videoCodec
	The video codec to use for publishing. This is only available for the publisher.
NSString *	audioCodec
	The audio codec to use for publishing. This is only available for the publisher.
MCDegradationPreferences	degradationPreferences
	The strategy the use in order to limit the bandwidth usage. Refer to the WebRTC standard
MCBitrateSettings *	bitrateSettings
	Adjust the bitrate settings. This is only available for publishing.
BOOL	stereo
	A boolean indicating whether the SDK should enable stereo audio. True enables stereo, false disables it. This is only available for publishing.
int	statsDelayMs
	The rate at which you want to receive reports with statistics in milliseconds. Defaults to 1 second.
int	videoJitterMinimumDelayMs
	The minimum video jitter buffer delay, in milliseconds. The default value is 0. For more information, refer to this document to understand more about what this field does. This is only for subscribing.
BOOL	forcePlayoutDelay
	Removes any playout delay on the media server sender side, minimizing the playout delay as much as possible. This is only available for subscribing.
BOOL	disableAudio
	Determines whether audio playback should be completely disabled. Disabling unnecessary audio helps reduce audio-to-video synchronization delays. This is only available on the subscriber.
MCScalabilityMode	svcMode
	Enables Scalable Video Coding selection. Refer to the WebRTC standard to learn which modes are supported by which codecs. This is only available when publishing.
BOOL	simulcast
	Determines whether Simulcast should be enabled (true) or not (false). This is only available for VP8 and H264 codecs, and is false by default. This is only available for publishing. Enabling this will send out 3 simulcast streams (low, medium and high).
NSString *	rtcEventLogOutputPath
	Enables logging RTC event log into a custom file path.
BOOL	recordStream
	Indicates whether the SDK should enable stream recording immediately after publishing. Make sure the recording feature is enabled for the publisher token. Recordings can then be viewed on the dashboard.
NSNumber *	priority
	The priority of redundant streams that indicates the order in which backup streams should be broadcasted in the case of any problems with the primary stream. Refer to the Redundant Ingest Guide to understand more.

Detailed Description

The MCClientOptions class gathers options for the client.

Property Documentation

audioCodec

- (NSString*) audioCodec

readwritenonatomicretain

The audio codec to use for publishing. This is only available for the publisher.

bitrateSettings

- (MCBitrateSettings*) bitrateSettings

readwritenonatomicretain

Adjust the bitrate settings. This is only available for publishing.

degradationPreferences

- (MCDegradationPreferences) degradationPreferences

readwritenonatomicassign

The strategy the use in order to limit the bandwidth usage. Refer to the WebRTC standard

disableAudio

- (BOOL) disableAudio

readwritenonatomicassign

Determines whether audio playback should be completely disabled. Disabling unnecessary audio helps reduce audio-to-video synchronization delays. This is only available on the subscriber.

dtx

- (BOOL) dtx

readwritenonatomicassign

Enables discontinuous transmission on the publishing side, so audio data is only sent when a user’s voice is detected.

excludedSourceId

- (NSArray*) excludedSourceId

readwritenonatomicretain

Excluded sources that you do not wish to receive. Refer to The Multiview Guide to learn more about this. This is a subscriber only option.

forcePlayoutDelay

- (BOOL) forcePlayoutDelay

readwritenonatomicassign

Removes any playout delay on the media server sender side, minimizing the playout delay as much as possible. This is only available for subscribing.

multiplexedAudioTrack

- (int) multiplexedAudioTrack

readwritenonatomicassign

The number of multiplxed audio tracks to receive. This is only available for the subscriber.

pinnedSourceId

- (NSString*) pinnedSourceId

readwritenonatomicretain

The receiving source to pin. Refer to The Multiview Guide to learn more about this. This is a subscriber only option.

priority

- (NSNumber*) priority

readwritenonatomicassign

The priority of redundant streams that indicates the order in which backup streams should be broadcasted in the case of any problems with the primary stream. Refer to the Redundant Ingest Guide to understand more.

recordStream

- (BOOL) recordStream

readwritenonatomicassign

Indicates whether the SDK should enable stream recording immediately after publishing. Make sure the recording feature is enabled for the publisher token. Recordings can then be viewed on the dashboard.

rtcEventLogOutputPath

- (NSString*) rtcEventLogOutputPath

readwritenonatomicretain

Enables logging RTC event log into a custom file path.

simulcast

- (BOOL) simulcast

readwritenonatomicassign

Determines whether Simulcast should be enabled (true) or not (false). This is only available for VP8 and H264 codecs, and is false by default. This is only available for publishing. Enabling this will send out 3 simulcast streams (low, medium and high).

sourceId

- (NSString*) sourceId

readwritenonatomicretain

The ID of the source to publish. This option is related to the multisource feature of the millicast service. For more information refer to The Multisource Broadcasting Guide. This is a publisher only option.

statsDelayMs

- (int) statsDelayMs

readwritenonatomicassign

The rate at which you want to receive reports with statistics in milliseconds. Defaults to 1 second.

stereo

- (BOOL) stereo

readwritenonatomicassign

A boolean indicating whether the SDK should enable stereo audio. True enables stereo, false disables it. This is only available for publishing.

svcMode

- (MCScalabilityMode) svcMode

readwritenonatomicassign

Enables Scalable Video Coding selection. Refer to the WebRTC standard to learn which modes are supported by which codecs. This is only available when publishing.

videoCodec

- (NSString*) videoCodec

readwritenonatomicretain

The video codec to use for publishing. This is only available for the publisher.

videoJitterMinimumDelayMs

- (int) videoJitterMinimumDelayMs

readwritenonatomicassign

The minimum video jitter buffer delay, in milliseconds. The default value is 0. For more information, refer to this document to understand more about what this field does. This is only for subscribing.

---

The documentation for this class was generated from the following file:

• objc/MillicastSDK/client.h