Local media interface. More...

Instance Methods
(void)	- addOnAudioMuted:
	Adds a handler that is raised when the audio track is muted. More...

(void)	- addOnAudioStarted:
	Adds a handler that is raised when the audio track is started. More...

(void)	- addOnAudioStopped:
	Adds a handler that is raised when the audio track is stopped. More...

(void)	- addOnAudioUnmuted:
	Adds a handler that is raised when the audio track is unmuted. More...

(void)	- addOnVideoMuted:
	Adds a handler that is raised when the video track is muted. More...

(void)	- addOnVideoStarted:
	Adds a handler that is raised when the video track is started. More...

(void)	- addOnVideoStopped:
	Adds a handler that is raised when the video track is stopped. More...

(void)	- addOnVideoUnmuted:
	Adds a handler that is raised when the video track is unmuted. More...

(FMLiveSwitchAudioEncodingConfig *)	- audioEncoding
	Gets the first (primary) local audio encoding. More...

(NSMutableArray *)	- audioEncodings
	Gets the local audio encodings. More...

(bool)	- audioSimulcastDisabled
	Gets whether audio simulcast is disabled. More...

(int)	- audioSimulcastEncodingCount
	Gets the number of audio simulcast encodings. More...

(int)	- audioSimulcastPreferredBitrate
	Gets the preferred audio simulcast bitrate, in kbps. More...

(FMLiveSwitchSourceInput *)	- audioSourceInput
	Gets the current audio source input of the first audio track. More...

(FMLiveSwitchFuture *)	- changeAudioSourceInput:
	Changes the audio source input of the first audio track while the media is active. More...

(FMLiveSwitchFuture *)	- changeVideoSourceInput:
	Changes the video source input of the first video track while the media is active. More...

(FMLiveSwitchFuture *)	- getAudioSourceInputs
	Gets the available audio source inputs of the first audio track. More...

(FMLiveSwitchFuture *)	- getVideoSourceInputs
	Gets the available video source inputs of the first video track. More...

(void)	- removeOnAudioMuted:
	Removes a handler that is raised when the audio track is muted. More...

(void)	- removeOnAudioStarted:
	Removes a handler that is raised when the audio track is started. More...

(void)	- removeOnAudioStopped:
	Removes a handler that is raised when the audio track is stopped. More...

(void)	- removeOnAudioUnmuted:
	Removes a handler that is raised when the audio track is unmuted. More...

(void)	- removeOnVideoMuted:
	Removes a handler that is raised when the video track is muted. More...

(void)	- removeOnVideoStarted:
	Removes a handler that is raised when the video track is started. More...

(void)	- removeOnVideoStopped:
	Removes a handler that is raised when the video track is stopped. More...

(void)	- removeOnVideoUnmuted:
	Removes a handler that is raised when the video track is unmuted. More...

(void)	- setAudioEncodings:
	Sets the local audio encodings. More...

(void)	- setAudioSimulcastDisabled:
	Sets whether audio simulcast is disabled. More...

(void)	- setAudioSimulcastEncodingCount:
	Sets the number of audio simulcast encodings. More...

(void)	- setAudioSimulcastPreferredBitrate:
	Sets the preferred audio simulcast bitrate, in kbps. More...

(void)	- setAudioSourceInput:
	Sets the current audio source input of the first audio track. More...

(void)	- setVideoEncodings:
	Sets the local video encodings. More...

(void)	- setVideoSimulcastBitsPerPixel:
	Sets the desired video simulcast bits-per-pixel (bpp). More...

(void)	- setVideoSimulcastDegradationPreference:
	Sets the video simulcast degradation preference. More...

(void)	- setVideoSimulcastDisabled:
	Sets whether video simulcast is disabled. More...

(void)	- setVideoSimulcastEncodingCount:
	Sets the number of video simulcast encodings. More...

(void)	- setVideoSimulcastPreferredBitrate:
	Sets the preferred video simulcast bitrate, in kbps. More...

(void)	- setVideoSourceInput:
	Sets the current video source input of the first video track. More...

(FMLiveSwitchFuture *)	- start
	Starts the media track sources. More...

(FMLiveSwitchLocalMediaState)	- state
	Gets the current state. More...

(FMLiveSwitchFuture *)	- stop
	Stops the media track sources. More...

(FMLiveSwitchVideoEncodingConfig *)	- videoEncoding
	Gets the first (primary) local video encoding. More...

(NSMutableArray *)	- videoEncodings
	Gets the local video encodings. More...

(double)	- videoSimulcastBitsPerPixel
	Gets the desired video simulcast bits-per-pixel (bpp). More...

(FMLiveSwitchVideoDegradationPreference)	- videoSimulcastDegradationPreference
	Gets the video simulcast degradation preference. More...

(bool)	- videoSimulcastDisabled
	Gets whether video simulcast is disabled. More...

(int)	- videoSimulcastEncodingCount
	Gets the number of video simulcast encodings. More...

(int)	- videoSimulcastPreferredBitrate
	Gets the preferred video simulcast bitrate, in kbps. More...

(FMLiveSwitchSourceInput *)	- videoSourceInput
	Gets the current video source input of the first video track. More...

Instance Methods inherited from <FMLiveSwitchIMedia>
(void)	- addOnAudioDestroyed:
	Adds a handler that is raised when the audio track is destroyed. More...

(void)	- addOnAudioLevel:
	Adds a handler that is raised periodically when the audio's level is calculated. More...

(double)	- addOnAudioLevelWithBlock
	Adds a handler that is raised periodically when the audio's level is calculated. More...

(void)	- addOnAudioLevelWithBlock:
	Adds a handler that is raised periodically when the audio's level is calculated. More...

(void)	- addOnVideoDestroyed:
	Adds a handler that is raised when the video track is destroyed. More...

(void)	- addOnVideoSize:
	Adds a handler that is raised whenever the video's frame size is known, once per frame. More...

(void)	- addOnVideoSizeChange:
	Adds a handler that is raised whenever the video's frame size changes. More...

(FMLiveSwitchSize *)	- addOnVideoSizeChangeWithBlock
	Adds a handler that is raised whenever the video's frame size changes. More...

(void)	- addOnVideoSizeChangeWithBlock:
	Adds a handler that is raised whenever the video's frame size changes. More...

(FMLiveSwitchSize *)	- addOnVideoSizeWithBlock
	Adds a handler that is raised whenever the video's frame size is known, once per frame. More...

(void)	- addOnVideoSizeWithBlock:
	Adds a handler that is raised whenever the video's frame size is known, once per frame. More...

(double)	- audioGain
	Gets a value indicating the audio gain (input amplification). More...

(int)	- audioLevelInterval
	Gets the interval in milliseconds between FMLiveSwitchIMedia`2addOnAudioLevel: events. More...

(bool)	- audioMuted
	Gets a value indicating whether the audio is muted. More...

(NSObject< FMLiveSwitchIAudioTrack > *)	- audioTrack
	Gets the audio track. More...

(NSMutableArray *)	- audioTracks
	Gets the audio tracks. More...

(double)	- audioVolume
	Gets a value indicating the audio volume (output resistance). More...

(void)	- destroy
	Destroys this media stack. More...

(FMLiveSwitchFuture *)	- grabVideoFrame
	Gets the next raw video frame. More...

(NSString *)	- id
	Gets the identifier. More...

(void)	- removeOnAudioDestroyed:
	Removes a handler that is raised when the audio track is destroyed. More...

(void)	- removeOnAudioLevel:
	Removes a handler that is raised periodically when the audio's level is calculated. More...

(void)	- removeOnVideoDestroyed:
	Removes a handler that is raised when the video track is destroyed. More...

(void)	- removeOnVideoSize:
	Removes a handler that is raised whenever the video's frame size is known, once per frame. More...

(void)	- removeOnVideoSizeChange:
	Removes a handler that is raised whenever the video's frame size changes. More...

(void)	- setAudioGain:
	Sets a value indicating the audio gain (input amplification). More...

(void)	- setAudioLevelInterval:
	Sets the interval in milliseconds between FMLiveSwitchIMedia`2addOnAudioLevel: events. More...

(void)	- setAudioMuted:
	Sets a value indicating whether the audio is muted. More...

(void)	- setAudioVolume:
	Sets a value indicating the audio volume (output resistance). More...

(void)	- setId:
	Sets the identifier. More...

(void)	- setVideoMuted:
	Sets a value indicating whether the video is muted. More...

(bool)	- videoMuted
	Gets a value indicating whether the video is muted. More...

(FMLiveSwitchSize *)	- videoSize
	Gets the size of the last processed video frame, if known. More...

(NSObject< FMLiveSwitchIVideoTrack > *)	- videoTrack
	Gets the video track. More...

(NSMutableArray *)	- videoTracks
	Gets the video tracks. More...

Detailed Description

Local media interface.

Method Documentation

◆ addOnAudioMuted:

- (void) addOnAudioMuted: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the audio track is muted.

◆ addOnAudioStarted:

- (void) addOnAudioStarted: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the audio track is started.

◆ addOnAudioStopped:

- (void) addOnAudioStopped: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the audio track is stopped.

◆ addOnAudioUnmuted:

- (void) addOnAudioUnmuted: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the audio track is unmuted.

◆ addOnVideoMuted:

- (void) addOnVideoMuted: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the video track is muted.

◆ addOnVideoStarted:

- (void) addOnVideoStarted: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the video track is started.

◆ addOnVideoStopped:

- (void) addOnVideoStopped: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the video track is stopped.

◆ addOnVideoUnmuted:

- (void) addOnVideoUnmuted: (FMLiveSwitchAction0 *) value

Adds a handler that is raised when the video track is unmuted.

◆ audioEncoding

- (FMLiveSwitchAudioEncodingConfig*) audioEncoding

Gets the first (primary) local audio encoding.

◆ audioEncodings

- (NSMutableArray*) audioEncodings

Gets the local audio encodings.

◆ audioSimulcastDisabled

- (bool) audioSimulcastDisabled

Gets whether audio simulcast is disabled.

◆ audioSimulcastEncodingCount

- (int) audioSimulcastEncodingCount

Gets the number of audio simulcast encodings.

◆ audioSimulcastPreferredBitrate

- (int) audioSimulcastPreferredBitrate

Gets the preferred audio simulcast bitrate, in kbps.

◆ audioSourceInput

- (FMLiveSwitchSourceInput*) audioSourceInput

Gets the current audio source input of the first audio track.

◆ changeAudioSourceInput:

- (FMLiveSwitchFuture*) changeAudioSourceInput: (FMLiveSwitchSourceInput *) audioSourceInput

Changes the audio source input of the first audio track while the media is active.

Parameters

audioSourceInput The audio source input.

◆ changeVideoSourceInput:

- (FMLiveSwitchFuture*) changeVideoSourceInput: (FMLiveSwitchSourceInput *) videoSourceInput

Changes the video source input of the first video track while the media is active.

Parameters

videoSourceInput The video source input.

◆ getAudioSourceInputs

- (FMLiveSwitchFuture*) getAudioSourceInputs

Gets the available audio source inputs of the first audio track.

Returns: A future with an array of audio source inputs.

◆ getVideoSourceInputs

- (FMLiveSwitchFuture*) getVideoSourceInputs

Gets the available video source inputs of the first video track.

Returns: A future with an array of video source inputs.

◆ removeOnAudioMuted:

- (void) removeOnAudioMuted: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the audio track is muted.

◆ removeOnAudioStarted:

- (void) removeOnAudioStarted: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the audio track is started.

◆ removeOnAudioStopped:

- (void) removeOnAudioStopped: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the audio track is stopped.

◆ removeOnAudioUnmuted:

- (void) removeOnAudioUnmuted: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the audio track is unmuted.

◆ removeOnVideoMuted:

- (void) removeOnVideoMuted: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the video track is muted.

◆ removeOnVideoStarted:

- (void) removeOnVideoStarted: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the video track is started.

◆ removeOnVideoStopped:

- (void) removeOnVideoStopped: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the video track is stopped.

◆ removeOnVideoUnmuted:

- (void) removeOnVideoUnmuted: (FMLiveSwitchAction0 *) value

Removes a handler that is raised when the video track is unmuted.

◆ setAudioEncodings:

- (void) setAudioEncodings: (NSMutableArray *) value

Sets the local audio encodings.

◆ setAudioSimulcastDisabled:

- (void) setAudioSimulcastDisabled: (bool) value

Sets whether audio simulcast is disabled.

◆ setAudioSimulcastEncodingCount:

- (void) setAudioSimulcastEncodingCount: (int) value

Sets the number of audio simulcast encodings.

◆ setAudioSimulcastPreferredBitrate:

- (void) setAudioSimulcastPreferredBitrate: (int) value

Sets the preferred audio simulcast bitrate, in kbps.

◆ setAudioSourceInput:

- (void) setAudioSourceInput: (FMLiveSwitchSourceInput *) value

Sets the current audio source input of the first audio track.

◆ setVideoEncodings:

- (void) setVideoEncodings: (NSMutableArray *) value

Sets the local video encodings.

◆ setVideoSimulcastBitsPerPixel:

- (void) setVideoSimulcastBitsPerPixel: (double) value

Sets the desired video simulcast bits-per-pixel (bpp).

◆ setVideoSimulcastDegradationPreference:

- (void) setVideoSimulcastDegradationPreference: (FMLiveSwitchVideoDegradationPreference) value

Sets the video simulcast degradation preference.

◆ setVideoSimulcastDisabled:

- (void) setVideoSimulcastDisabled: (bool) value

Sets whether video simulcast is disabled.

◆ setVideoSimulcastEncodingCount:

- (void) setVideoSimulcastEncodingCount: (int) value

Sets the number of video simulcast encodings.

◆ setVideoSimulcastPreferredBitrate:

- (void) setVideoSimulcastPreferredBitrate: (int) value

Sets the preferred video simulcast bitrate, in kbps.

◆ setVideoSourceInput:

- (void) setVideoSourceInput: (FMLiveSwitchSourceInput *) value

Sets the current video source input of the first video track.

◆ start

- (FMLiveSwitchFuture*) start

Starts the media track sources.

◆ state

- (FMLiveSwitchLocalMediaState) state

Gets the current state.

◆ stop

- (FMLiveSwitchFuture*) stop

Stops the media track sources.

◆ videoEncoding

- (FMLiveSwitchVideoEncodingConfig*) videoEncoding

Gets the first (primary) local video encoding.

◆ videoEncodings

- (NSMutableArray*) videoEncodings

Gets the local video encodings.

◆ videoSimulcastBitsPerPixel

- (double) videoSimulcastBitsPerPixel

Gets the desired video simulcast bits-per-pixel (bpp).

◆ videoSimulcastDegradationPreference

- (FMLiveSwitchVideoDegradationPreference) videoSimulcastDegradationPreference

Gets the video simulcast degradation preference.

◆ videoSimulcastDisabled

- (bool) videoSimulcastDisabled

Gets whether video simulcast is disabled.

◆ videoSimulcastEncodingCount

- (int) videoSimulcastEncodingCount

Gets the number of video simulcast encodings.

◆ videoSimulcastPreferredBitrate

- (int) videoSimulcastPreferredBitrate

Gets the preferred video simulcast bitrate, in kbps.

◆ videoSourceInput

- (FMLiveSwitchSourceInput*) videoSourceInput

Gets the current video source input of the first video track.

Instance Methods