FMLiveSwitchRemoteMedia Class Reference

A collection of remote audio/video tracks. More...

Instance Methods

(NSMutableArray *) - arrayFromAudioTracks:
 Creates an array of tracks from a list of audio tracks. More...
 
(NSMutableArray *) - arrayFromVideoTracks:
 Creates an array of tracks from a list of video tracks. More...
 
(FMLiveSwitchAudioSink *) - audioSink
 Gets the first audio sink. More...
 
(FMLiveSwitchSinkOutput *) - audioSinkOutput
 Gets the current audio sink output of the first audio track. More...
 
(NSMutableArray *) - audioSinks
 Gets the audio sinks. More...
 
(FMLiveSwitchFuture< id > *) - changeAudioSinkOutput:
 Changes the audio sink output of the first audio track while the media is active. More...
 
(FMLiveSwitchFuture< id > *) - changeVideoSinkOutput:
 Changes the video sink output of the first video track while the media is active. More...
 
(NSMutableArray< FMLiveSwitchAudioTrack * > *) - createAudioTrackCollection
 Creates an audio track collection. More...
 
(NSMutableArray< FMLiveSwitchVideoTrack * > *) - createVideoTrackCollection
 Creates a video track collection. More...
 
(FMLiveSwitchFuture< NSMutableArray * > *) - getAudioSinkOutputs
 Gets the available audio sink outputs of the first audio track. More...
 
(FMLiveSwitchFuture< NSMutableArray * > *) - getVideoSinkOutputs
 Gets the available video sink outputs of the first video track. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchMedia`2 class. More...
 
(NSMutableArray *) - mediaSinks
 Gets the audio/video sinks. More...
 
(void) - setAudioSinkOutput:
 Sets the current audio sink output of the first audio track. More...
 
(void) - setVideoSinkOutput:
 Sets the current video sink output of the first video track. More...
 
(FMLiveSwitchVideoSink *) - videoSink
 Gets the first video sink. More...
 
(FMLiveSwitchSinkOutput *) - videoSinkOutput
 Gets the current video sink output of the first video track. More...
 
(NSMutableArray *) - videoSinks
 Gets the video sinks. More...
 
- Instance Methods inherited from FMLiveSwitchMedia
(void) - addAudioTrack:
 Adds an audio track. More...
 
(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...
 
(void) - addVideoTrack:
 Adds a video track. More...
 
(NSMutableArray *) - arrayFromAudioTracks:
 Creates an array of tracks from a list of audio tracks. More...
 
(NSMutableArray *) - arrayFromVideoTracks:
 Creates an array of tracks from a list of video tracks. More...
 
(int) - audioLevelInterval
 Gets the interval in milliseconds between FMLiveSwitchMedia`2addOnAudioLevel: events. More...
 
(NSMutableArray *) - audioTracks
 Gets all audio tracks from this media. More...
 
(void) - destroy
 Destroys all non-persistent internal objects encapsulated by the Media class. More...
 
(FMLiveSwitchFuture< FMLiveSwitchVideoBuffer * > *) - grabVideoFrame
 Gets the next frame from the video track once it is rendered. More...
 
(bool) - isRecordingAudio
 Gets whether audio is being recorded locally. More...
 
(bool) - isRecordingVideo
 Gets whether video is being recorded locally. More...
 
(bool) - removeAudioTrack:
 Removes an audio track. 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...
 
(bool) - removeVideoTrack:
 Removes a video track. More...
 
(void) - setAudioLevelInterval:
 Sets the interval in milliseconds between FMLiveSwitchMedia`2addOnAudioLevel: events. More...
 
(void) - setIsRecordingAudio:
 Sets whether audio is being recorded locally. More...
 
(void) - setIsRecordingVideo:
 Sets whether video is being recorded locally. More...
 
(FMLiveSwitchSize *) - videoSize
 Gets the size of the video track. More...
 
(NSMutableArray *) - videoTracks
 Gets all video tracks from this media. More...
 

Class Methods

(FMLiveSwitchRemoteMedia *) + remoteMedia
 
- Class Methods inherited from FMLiveSwitchMedia
(FMLiveSwitchMedia *) + media
 Initializes a new instance of the FMLiveSwitchMedia`2 class. More...
 

Additional Inherited Members

- Protected Attributes inherited from FMLiveSwitchMedia
 __pad0__: FMLiveSwitchMediaBase<TAudioTrack
 

Detailed Description

A collection of remote audio/video tracks.

Method Documentation

◆ arrayFromAudioTracks:

- (NSMutableArray*) arrayFromAudioTracks: (NSMutableArray< FMLiveSwitchAudioTrack * > *)  tracks

Creates an array of tracks from a list of audio tracks.

Parameters
tracksThe list of tracks.

◆ arrayFromVideoTracks:

- (NSMutableArray*) arrayFromVideoTracks: (NSMutableArray< FMLiveSwitchVideoTrack * > *)  tracks

Creates an array of tracks from a list of video tracks.

Parameters
tracksThe list of tracks.

◆ audioSink

- (FMLiveSwitchAudioSink*) audioSink

Gets the first audio sink.

◆ audioSinkOutput

- (FMLiveSwitchSinkOutput*) audioSinkOutput

Gets the current audio sink output of the first audio track.

◆ audioSinks

- (NSMutableArray*) audioSinks

Gets the audio sinks.

◆ changeAudioSinkOutput:

- (FMLiveSwitchFuture<id>*) changeAudioSinkOutput: (FMLiveSwitchSinkOutput *)  audioSinkOutput

Changes the audio sink output of the first audio track while the media is active.

Parameters
audioSinkOutputThe audio sink output.

◆ changeVideoSinkOutput:

- (FMLiveSwitchFuture<id>*) changeVideoSinkOutput: (FMLiveSwitchSinkOutput *)  videoSinkOutput

Changes the video sink output of the first video track while the media is active.

Parameters
videoSinkOutputThe video sink output.

◆ createAudioTrackCollection

- (NSMutableArray<FMLiveSwitchAudioTrack*>*) createAudioTrackCollection

Creates an audio track collection.

Implements FMLiveSwitchMedia.

◆ createVideoTrackCollection

- (NSMutableArray<FMLiveSwitchVideoTrack*>*) createVideoTrackCollection

Creates a video track collection.

Implements FMLiveSwitchMedia.

◆ getAudioSinkOutputs

- (FMLiveSwitchFuture<NSMutableArray*>*) getAudioSinkOutputs

Gets the available audio sink outputs of the first audio track.

Returns
A future with an array of audio sink outputs.

◆ getVideoSinkOutputs

- (FMLiveSwitchFuture<NSMutableArray*>*) getVideoSinkOutputs

Gets the available video sink outputs of the first video track.

Returns
A future with an array of video sink outputs.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchMedia`2 class.

Implements FMLiveSwitchMedia.

◆ mediaSinks

- (NSMutableArray*) mediaSinks

Gets the audio/video sinks.

◆ remoteMedia

+ (FMLiveSwitchRemoteMedia*) remoteMedia

◆ setAudioSinkOutput:

- (void) setAudioSinkOutput: (FMLiveSwitchSinkOutput *)  value

Sets the current audio sink output of the first audio track.

◆ setVideoSinkOutput:

- (void) setVideoSinkOutput: (FMLiveSwitchSinkOutput *)  value

Sets the current video sink output of the first video track.

◆ videoSink

- (FMLiveSwitchVideoSink*) videoSink

Gets the first video sink.

◆ videoSinkOutput

- (FMLiveSwitchSinkOutput*) videoSinkOutput

Gets the current video sink output of the first video track.

◆ videoSinks

- (NSMutableArray*) videoSinks

Gets the video sinks.