<FMLiveSwitchIMedia> Protocol Reference

Media interface. More...

Instance Methods
(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

Media interface.

Method Documentation

addOnAudioDestroyed:

- (void) addOnAudioDestroyed:

(FMLiveSwitchAction0 *)

value

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

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

addOnAudioLevel:

- (void) addOnAudioLevel:

(FMLiveSwitchAction1 *)

value

Adds a handler that is raised periodically when the audio's level is calculated.

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

addOnAudioLevelWithBlock

- (double) addOnAudioLevelWithBlock

Adds a handler that is raised periodically when the audio's level is calculated.

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

addOnAudioLevelWithBlock:

- (void) addOnAudioLevelWithBlock:

(void(^)(double))

valueBlock

Adds a handler that is raised periodically when the audio's level is calculated.

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

addOnVideoDestroyed:

- (void) addOnVideoDestroyed:

(FMLiveSwitchAction0 *)

value

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

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

addOnVideoSize:

- (void) addOnVideoSize:

(FMLiveSwitchAction1 *)

value

Adds a handler that is raised whenever the video's frame size is known, once per frame.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

addOnVideoSizeChange:

- (void) addOnVideoSizeChange:

(FMLiveSwitchAction1 *)

value

Adds a handler that is raised whenever the video's frame size changes.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

addOnVideoSizeChangeWithBlock

- (FMLiveSwitchSize*) addOnVideoSizeChangeWithBlock

Adds a handler that is raised whenever the video's frame size changes.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

addOnVideoSizeChangeWithBlock:

- (void) addOnVideoSizeChangeWithBlock:

(void(^)(FMLiveSwitchSize *))

valueBlock

Adds a handler that is raised whenever the video's frame size changes.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

addOnVideoSizeWithBlock

- (FMLiveSwitchSize*) addOnVideoSizeWithBlock

Adds a handler that is raised whenever the video's frame size is known, once per frame.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

addOnVideoSizeWithBlock:

- (void) addOnVideoSizeWithBlock:

(void(^)(FMLiveSwitchSize *))

valueBlock

Adds a handler that is raised whenever the video's frame size is known, once per frame.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

audioGain

- (double) audioGain

Gets a value indicating the audio gain (input amplification).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

audioLevelInterval

- (int) audioLevelInterval

Gets the interval in milliseconds between FMLiveSwitchIMedia`2addOnAudioLevel: events.

audioMuted

- (bool) audioMuted

Gets a value indicating whether the audio is muted.

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

audioTrack

- (NSObject<FMLiveSwitchIAudioTrack>*) audioTrack

Gets the audio track.

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

audioTracks

- (NSMutableArray*) audioTracks

Gets the audio tracks.

audioVolume

- (double) audioVolume

Gets a value indicating the audio volume (output resistance).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

destroy

- (void) destroy

Destroys this media stack.

grabVideoFrame

- (FMLiveSwitchFuture*) grabVideoFrame

Gets the next raw video frame.

If there are multiple video tracks in a custom media stack, this method calls into the first video track.

Returns

A future video buffer.

id

- (NSString*) id

Gets the identifier.

removeOnAudioDestroyed:

- (void) removeOnAudioDestroyed:

(FMLiveSwitchAction0 *)

value

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

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

removeOnAudioLevel:

- (void) removeOnAudioLevel:

(FMLiveSwitchAction1 *)

value

Removes a handler that is raised periodically when the audio's level is calculated.

If there are multiple audio tracks in a custom media stack, this event is only triggered by the first audio track.

removeOnVideoDestroyed:

- (void) removeOnVideoDestroyed:

(FMLiveSwitchAction0 *)

value

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

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

removeOnVideoSize:

- (void) removeOnVideoSize:

(FMLiveSwitchAction1 *)

value

Removes a handler that is raised whenever the video's frame size is known, once per frame.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

removeOnVideoSizeChange:

- (void) removeOnVideoSizeChange:

(FMLiveSwitchAction1 *)

value

Removes a handler that is raised whenever the video's frame size changes.

If there are multiple video tracks in a custom media stack, this event is only triggered by the first video track.

setAudioGain:

- (void) setAudioGain:

(double)

value

Sets a value indicating the audio gain (input amplification).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

setAudioLevelInterval:

- (void) setAudioLevelInterval:

(int)

value

Sets the interval in milliseconds between FMLiveSwitchIMedia`2addOnAudioLevel: events.

setAudioMuted:

- (void) setAudioMuted:

(bool)

value

Sets a value indicating whether the audio is muted.

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

setAudioVolume:

- (void) setAudioVolume:

(double)

value

Sets a value indicating the audio volume (output resistance).

If there are multiple audio tracks in a custom media stack, this property is bound to the first audio track.

setId:

- (void) setId:

(NSString *)

value

Sets the identifier.

setVideoMuted:

- (void) setVideoMuted:

(bool)

value

Sets a value indicating whether the video is muted.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

videoMuted

- (bool) videoMuted

Gets a value indicating whether the video is muted.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

videoSize

- (FMLiveSwitchSize*) videoSize

Gets the size of the last processed video frame, if known.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

videoTrack

- (NSObject<FMLiveSwitchIVideoTrack>*) videoTrack

Gets the video track.

If there are multiple video tracks in a custom media stack, this property is bound to the first video track.

videoTracks

- (NSMutableArray*) videoTracks

Gets the video tracks.