FMLiveSwitchRtcLocalMedia Class Reference

A WebRTC/ORTC-compatible collection of local audio/video tracks. More...

Instance Methods

(FMLiveSwitchAudioPipe *) - activeAudioConverter
 Gets the active audio converter. More...
 
(FMLiveSwitchAudioEncoder *) - activeAudioEncoder
 Gets the active audio encoder. More...
 
(FMLiveSwitchAudioPipe *) - activeAudioPacketizer
 Gets the active audio packetizer. More...
 
(FMLiveSwitchVideoPipe *) - activeVideoController
 Gets the active video controller. More...
 
(FMLiveSwitchVideoPipe *) - activeVideoConverter
 Gets the active video converter. More...
 
(FMLiveSwitchVideoEncoder *) - activeVideoEncoder
 Gets the active video encoder. More...
 
(FMLiveSwitchVideoPipe *) - activeVideoPacketizer
 Gets the active video packetizer. More...
 
(void) - addOnActiveAudioConverterChange:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes. More...
 
(FMLiveSwitchAudioPipe *) - addOnActiveAudioConverterChangeWithBlock
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes. More...
 
(void) - addOnActiveAudioConverterChangeWithBlock:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes. More...
 
(void) - addOnActiveAudioEncoderChange:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes. More...
 
(FMLiveSwitchAudioEncoder *) - addOnActiveAudioEncoderChangeWithBlock
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes. More...
 
(void) - addOnActiveAudioEncoderChangeWithBlock:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes. More...
 
(void) - addOnActiveAudioPacketizerChange:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes. More...
 
(FMLiveSwitchAudioPipe *) - addOnActiveAudioPacketizerChangeWithBlock
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes. More...
 
(void) - addOnActiveAudioPacketizerChangeWithBlock:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes. More...
 
(void) - addOnActiveVideoControllerChange:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes. More...
 
(FMLiveSwitchVideoPipe *) - addOnActiveVideoControllerChangeWithBlock
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes. More...
 
(void) - addOnActiveVideoControllerChangeWithBlock:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes. More...
 
(void) - addOnActiveVideoConverterChange:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes. More...
 
(FMLiveSwitchVideoPipe *) - addOnActiveVideoConverterChangeWithBlock
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes. More...
 
(void) - addOnActiveVideoConverterChangeWithBlock:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes. More...
 
(void) - addOnActiveVideoEncoderChange:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes. More...
 
(FMLiveSwitchVideoEncoder *) - addOnActiveVideoEncoderChangeWithBlock
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes. More...
 
(void) - addOnActiveVideoEncoderChangeWithBlock:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes. More...
 
(void) - addOnActiveVideoPacketizerChange:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes. More...
 
(FMLiveSwitchVideoPipe *) - addOnActiveVideoPacketizerChangeWithBlock
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes. More...
 
(void) - addOnActiveVideoPacketizerChangeWithBlock:
 Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes. More...
 
(FMLiveSwitchAecContext *) - aecContext
 Gets the acoustic echo cancellation context. More...
 
(bool) - aecDisabled
 Gets a value indicating whether acoustic echo cancellation is disabled. More...
 
(bool) - audioDisabled
 Gets a value indicating whether audio is disabled. More...
 
(NSMutableArray *) - audioOutputs
 Gets the audio outputs. More...
 
(bool) - automaticVideoDegradation
 Gets whether to automatically degrade video based on FMLiveSwitchRtcLocalMedia1#videoBitsPerPixel and FMLiveSwitchRtcLocalMedia1videoDegradationPreference when bitrate constraints are applied to the local encoders. More...
 
(FMLiveSwitchAudioSink *) - createAudioRecorderWithInputFormat:
 Creates an audio recorder. More...
 
(FMLiveSwitchAudioSource *) - createAudioSourceWithConfig:
 Creates an audio source. More...
 
(FMLiveSwitchVideoPipe *) - createFrameRateControllerWithOutputFormat:
 Creates a frame-rate controller. More...
 
(FMLiveSwitchAudioEncoder *) - createG722EncoderWithConfig:
 Creates a G.722 encoder. More...
 
(FMLiveSwitchAudioPipe *) - createG722PacketizerWithConfig:
 Creates a G.722 packetizer. More...
 
(FMLiveSwitchVideoEncoder *) - createH264Encoder
 Creates an H.264 encoder. More...
 
(NSMutableArray *) - createH264Encoders
 Creates H.264 encoders. More...
 
(FMLiveSwitchVideoPipe *) - createH264Packetizer
 Creates an H.264 packetizer. More...
 
(NSMutableArray *) - createH264Packetizers
 Creates H.264 packetizers. More...
 
(FMLiveSwitchVideoEncoder *) - createH265Encoder
 Creates a H.265 encoder. More...
 
(FMLiveSwitchVideoPipe *) - createH265Packetizer
 Creates a H.265 packetizer. More...
 
(FMLiveSwitchVideoPipe *) - createImageConverterWithOutputFormat:
 Creates an image converter. More...
 
(FMLiveSwitchAudioEncoder *) - createL16EncoderWithConfig:
 Creates a L16 encoder. More...
 
(FMLiveSwitchAudioPipe *) - createL16PacketizerWithConfig:
 Creates a L16 packetizer. More...
 
(FMLiveSwitchAudioEncoder *) - createOpusEncoderWithConfig:
 Creates an Opus encoder. More...
 
(FMLiveSwitchAudioPipe *) - createOpusPacketizerWithConfig:
 Creates an Opus packetizer. More...
 
(FMLiveSwitchAudioEncoder *) - createPcmaEncoderWithConfig:
 Creates a PCMA encoder. More...
 
(FMLiveSwitchAudioPipe *) - createPcmaPacketizerWithConfig:
 Creates a PCMA packetizer. More...
 
(FMLiveSwitchAudioEncoder *) - createPcmuEncoderWithConfig:
 Creates a PCMU encoder. More...
 
(FMLiveSwitchAudioPipe *) - createPcmuPacketizerWithConfig:
 Creates a PCMU packetizer. More...
 
(FMLiveSwitchAudioPipe *) - createSoundConverterWithConfig:
 Creates a sound converter. More...
 
(FMLiveSwitchVideoSink *) - createVideoRecorderWithInputFormat:
 Creates a video recorder. More...
 
(FMLiveSwitchVideoSource *) - createVideoSource
 Creates a video source. More...
 
(FMLiveSwitchViewSink< TView > *) - createViewSink
 Creates a view sink. More...
 
(FMLiveSwitchVideoEncoder *) - createVp8Encoder
 Creates a VP8 encoder. More...
 
(FMLiveSwitchVideoPipe *) - createVp8Packetizer
 Creates a VP8 packetizer. More...
 
(FMLiveSwitchVideoEncoder *) - createVp9Encoder
 Creates a VP9 encoder. More...
 
(FMLiveSwitchVideoPipe *) - createVp9Packetizer
 Creates a VP9 packetizer. More...
 
(void) - destroy
 Destroys all media tracks. More...
 
(NSMutableArray *) - doGetAudioEncodings
 Gets the local audio encodings. More...
 
(NSMutableArray *) - doGetVideoEncodings
 Gets the local video encodings. More...
 
(void) - doSetAudioEncodings:
 Sets the local audio encodings. More...
 
(void) - doSetVideoEncodings:
 Sets the local video encodings. More...
 
(FMLiveSwitchAudioPipe *) - g722Converter
 Gets the G.722 converter. More...
 
(bool) - g722Disabled
 Gets whether the G.722 codec is disabled. More...
 
(FMLiveSwitchAudioEncoder *) - g722Encoder
 Gets the G.722 encoder. More...
 
(FMLiveSwitchAudioPipe *) - g722Packetizer
 Gets the G.722 packetizer. More...
 
(FMLiveSwitchVideoPipe *) - h264Controller
 Gets the first H.264 controller. More...
 
(NSMutableArray *) - h264Controllers
 Gets the H.264 controllers. More...
 
(FMLiveSwitchVideoPipe *) - h264Converter
 Gets the first H.264 converter. More...
 
(NSMutableArray *) - h264Converters
 Gets the H.264 converters. More...
 
(NSMutableArray *) - h264ConvertersArray
 Gets the H.264 converters array. More...
 
(bool) - h264Disabled
 Gets whether the H.264 codec is disabled. More...
 
(FMLiveSwitchVideoEncoder *) - h264Encoder
 Gets the first H.264 encoder. More...
 
(NSMutableArray *) - h264Encoders
 Gets the first H.264 encoders. More...
 
(NSMutableArray *) - h264EncodersArray
 Gets the H.264 encoders array. More...
 
(FMLiveSwitchVideoPipe *) - h264Packetizer
 Gets the first H.264 packetizer. More...
 
(NSMutableArray *) - h264Packetizers
 Gets the first H.264 packetizers. More...
 
(NSMutableArray *) - h264PacketizersArray
 Gets the first H.264 packetizers array. More...
 
(NSMutableArray *) - h264PacketizersArrayArray
 Gets the H.264 packetizers array array. More...
 
(FMLiveSwitchVideoPipe *) - h265Controller
 Gets the first H265 controller. More...
 
(NSMutableArray *) - h265Controllers
 Gets the H265 controllers. More...
 
(FMLiveSwitchVideoPipe *) - h265Converter
 Gets the first H265 converter. More...
 
(NSMutableArray *) - h265Converters
 Gets the H265 converters. More...
 
(bool) - h265Disabled
 Gets whether the H.265 codec is disabled. More...
 
(FMLiveSwitchVideoEncoder *) - h265Encoder
 Gets the first H265 encoder. More...
 
(NSMutableArray *) - h265Encoders
 Gets the H265 encoders. More...
 
(FMLiveSwitchVideoPipe *) - h265Packetizer
 Gets the first H265 packetizer. More...
 
(NSMutableArray *) - h265Packetizers
 Gets the H265 packetizers. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class. More...
 
(bool) - initialize
 Initializes this instance. More...
 
(bool) - initializeWithAudioTrackConfig:videoTrackConfig:
 Initializes this instance. More...
 
(instancetype) - initWithDisableAudio:disableVideo:
 Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class. More...
 
(instancetype) - initWithDisableAudio:disableVideo:aecContext:
 Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class. More...
 
(FMLiveSwitchAudioPipe *) - l16Converter
 Gets the L16 converter. More...
 
(bool) - l16Disabled
 Gets whether the L16 codec is disabled. More...
 
(FMLiveSwitchAudioEncoder *) - l16Encoder
 Gets the L16 encoder. More...
 
(FMLiveSwitchAudioPipe *) - l16Packetizer
 Gets the L16 packetizer. More...
 
(FMLiveSwitchAudioPipe *) - opusConverter
 Gets the first Opus converter. More...
 
(NSMutableArray *) - opusConverters
 Gets the Opus converters. More...
 
(bool) - opusDisabled
 Gets whether the Opus codec is disabled. More...
 
(FMLiveSwitchAudioEncoder *) - opusEncoder
 Gets the first Opus encoder. More...
 
(NSMutableArray *) - opusEncoders
 Gets the Opus encoders. More...
 
(FMLiveSwitchAudioPipe *) - opusPacketizer
 Gets the first Opus packetizer. More...
 
(NSMutableArray *) - opusPacketizers
 Gets the Opus packetizers. More...
 
(bool) - packetizerDisabled
 Gets a value indicating whether the packetizer is disabled. More...
 
(FMLiveSwitchAudioPipe *) - pcmaConverter
 Gets the PCMA converter. More...
 
(bool) - pcmaDisabled
 Gets whether the PCMA codec is disabled. More...
 
(FMLiveSwitchAudioEncoder *) - pcmaEncoder
 Gets the PCMA encoder. More...
 
(FMLiveSwitchAudioPipe *) - pcmaPacketizer
 Gets the PCMA packetizer. More...
 
(FMLiveSwitchAudioPipe *) - pcmuConverter
 Gets the PCMU converter. More...
 
(bool) - pcmuDisabled
 Gets whether the PCMU codec is disabled. More...
 
(FMLiveSwitchAudioEncoder *) - pcmuEncoder
 Gets the PCMU encoder. More...
 
(FMLiveSwitchAudioPipe *) - pcmuPacketizer
 Gets the PCMU packetizer. More...
 
(void) - removeOnActiveAudioConverterChange:
 Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes. More...
 
(void) - removeOnActiveAudioEncoderChange:
 Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes. More...
 
(void) - removeOnActiveAudioPacketizerChange:
 Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes. More...
 
(void) - removeOnActiveVideoControllerChange:
 Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes. More...
 
(void) - removeOnActiveVideoConverterChange:
 Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes. More...
 
(void) - removeOnActiveVideoEncoderChange:
 Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes. More...
 
(void) - removeOnActiveVideoPacketizerChange:
 Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes. More...
 
(void) - setAutomaticVideoDegradation:
 Sets whether to automatically degrade video based on FMLiveSwitchRtcLocalMedia1#videoBitsPerPixel and FMLiveSwitchRtcLocalMedia1videoDegradationPreference when bitrate constraints are applied to the local encoders. More...
 
(void) - setPacketizerDisabled:
 Sets a value indicating whether the packetizer is disabled. More...
 
(void) - setVideoBitsPerPixel:
 Sets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution. More...
 
(void) - setVideoDegradationPreference:
 Sets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution. More...
 
(bool) - toggleAudioRecording
 Toggles audio recording. More...
 
(bool) - toggleVideoRecording
 Toggles video recording. More...
 
(double) - videoBitsPerPixel
 Gets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution. More...
 
(FMLiveSwitchVideoDegradationPreference) - videoDegradationPreference
 Gets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution. More...
 
(bool) - videoDisabled
 Gets a value indicating whether video is disabled. More...
 
(NSMutableArray *) - videoOutputs
 Gets the video outputs. More...
 
(TView) - view
 Gets the video view, if video is not disabled. More...
 
(FMLiveSwitchViewSink< TView > *) - viewSink
 Gets the video view sink, if video is not disabled. More...
 
(FMLiveSwitchVideoPipe *) - vp8Controller
 Gets the first VP8 controller. More...
 
(NSMutableArray *) - vp8Controllers
 Gets the VP8 controllers. More...
 
(FMLiveSwitchVideoPipe *) - vp8Converter
 Gets the first VP8 converter. More...
 
(NSMutableArray *) - vp8Converters
 Gets the VP8 converters. More...
 
(bool) - vp8Disabled
 Gets whether the VP8 codec is disabled. More...
 
(FMLiveSwitchVideoEncoder *) - vp8Encoder
 Gets the first VP8 encoder. More...
 
(NSMutableArray *) - vp8Encoders
 Gets the VP8 encoders. More...
 
(FMLiveSwitchVideoPipe *) - vp8Packetizer
 Gets the first VP8 packetizer. More...
 
(NSMutableArray *) - vp8Packetizers
 Gets the VP8 packetizers. More...
 
(FMLiveSwitchVideoPipe *) - vp9Controller
 Gets the first VP9 controller. More...
 
(NSMutableArray *) - vp9Controllers
 Gets the VP9 controllers. More...
 
(FMLiveSwitchVideoPipe *) - vp9Converter
 Gets the first VP9 converter. More...
 
(NSMutableArray *) - vp9Converters
 Gets the VP9 converters. More...
 
(bool) - vp9Disabled
 Gets whether the VP9 codec is disabled. More...
 
(FMLiveSwitchVideoEncoder *) - vp9Encoder
 Gets the first VP9 encoder. More...
 
(NSMutableArray *) - vp9Encoders
 Gets the VP9 encoders. More...
 
(FMLiveSwitchVideoPipe *) - vp9Packetizer
 Gets the first VP9 packetizer. More...
 
(NSMutableArray *) - vp9Packetizers
 Gets the VP9 packetizers. More...
 

Class Methods

(FMLiveSwitchRtcLocalMedia *) + rtcLocalMedia
 Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class. More...
 
(FMLiveSwitchRtcLocalMedia *) + rtcLocalMediaWithDisableAudio:disableVideo:
 Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class. More...
 
(FMLiveSwitchRtcLocalMedia *) + rtcLocalMediaWithDisableAudio:disableVideo:aecContext:
 Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchLocalMedia<FMLiveSwitchIViewSinkableMedia
 

Detailed Description

A WebRTC/ORTC-compatible collection of local audio/video tracks.

Method Documentation

◆ activeAudioConverter

- (FMLiveSwitchAudioPipe*) activeAudioConverter

Gets the active audio converter.

◆ activeAudioEncoder

- (FMLiveSwitchAudioEncoder*) activeAudioEncoder

Gets the active audio encoder.

◆ activeAudioPacketizer

- (FMLiveSwitchAudioPipe*) activeAudioPacketizer

Gets the active audio packetizer.

◆ activeVideoController

- (FMLiveSwitchVideoPipe*) activeVideoController

Gets the active video controller.

◆ activeVideoConverter

- (FMLiveSwitchVideoPipe*) activeVideoConverter

Gets the active video converter.

◆ activeVideoEncoder

- (FMLiveSwitchVideoEncoder*) activeVideoEncoder

Gets the active video encoder.

◆ activeVideoPacketizer

- (FMLiveSwitchVideoPipe*) activeVideoPacketizer

Gets the active video packetizer.

◆ addOnActiveAudioConverterChange:

- (void) addOnActiveAudioConverterChange: (FMLiveSwitchAction1< FMLiveSwitchAudioPipe * > *)  value

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes.

◆ addOnActiveAudioConverterChangeWithBlock

- (FMLiveSwitchAudioPipe*) addOnActiveAudioConverterChangeWithBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes.

◆ addOnActiveAudioConverterChangeWithBlock:

- (void) addOnActiveAudioConverterChangeWithBlock: (void(^)(FMLiveSwitchAudioPipe *))  valueBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes.

◆ addOnActiveAudioEncoderChange:

- (void) addOnActiveAudioEncoderChange: (FMLiveSwitchAction1< FMLiveSwitchAudioEncoder * > *)  value

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes.

◆ addOnActiveAudioEncoderChangeWithBlock

- (FMLiveSwitchAudioEncoder*) addOnActiveAudioEncoderChangeWithBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes.

◆ addOnActiveAudioEncoderChangeWithBlock:

- (void) addOnActiveAudioEncoderChangeWithBlock: (void(^)(FMLiveSwitchAudioEncoder *))  valueBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes.

◆ addOnActiveAudioPacketizerChange:

- (void) addOnActiveAudioPacketizerChange: (FMLiveSwitchAction1< FMLiveSwitchAudioPipe * > *)  value

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes.

◆ addOnActiveAudioPacketizerChangeWithBlock

- (FMLiveSwitchAudioPipe*) addOnActiveAudioPacketizerChangeWithBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes.

◆ addOnActiveAudioPacketizerChangeWithBlock:

- (void) addOnActiveAudioPacketizerChangeWithBlock: (void(^)(FMLiveSwitchAudioPipe *))  valueBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes.

◆ addOnActiveVideoControllerChange:

- (void) addOnActiveVideoControllerChange: (FMLiveSwitchAction1< FMLiveSwitchVideoPipe * > *)  value

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes.

◆ addOnActiveVideoControllerChangeWithBlock

- (FMLiveSwitchVideoPipe*) addOnActiveVideoControllerChangeWithBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes.

◆ addOnActiveVideoControllerChangeWithBlock:

- (void) addOnActiveVideoControllerChangeWithBlock: (void(^)(FMLiveSwitchVideoPipe *))  valueBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes.

◆ addOnActiveVideoConverterChange:

- (void) addOnActiveVideoConverterChange: (FMLiveSwitchAction1< FMLiveSwitchVideoPipe * > *)  value

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes.

◆ addOnActiveVideoConverterChangeWithBlock

- (FMLiveSwitchVideoPipe*) addOnActiveVideoConverterChangeWithBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes.

◆ addOnActiveVideoConverterChangeWithBlock:

- (void) addOnActiveVideoConverterChangeWithBlock: (void(^)(FMLiveSwitchVideoPipe *))  valueBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes.

◆ addOnActiveVideoEncoderChange:

- (void) addOnActiveVideoEncoderChange: (FMLiveSwitchAction1< FMLiveSwitchVideoEncoder * > *)  value

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes.

◆ addOnActiveVideoEncoderChangeWithBlock

- (FMLiveSwitchVideoEncoder*) addOnActiveVideoEncoderChangeWithBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes.

◆ addOnActiveVideoEncoderChangeWithBlock:

- (void) addOnActiveVideoEncoderChangeWithBlock: (void(^)(FMLiveSwitchVideoEncoder *))  valueBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes.

◆ addOnActiveVideoPacketizerChange:

- (void) addOnActiveVideoPacketizerChange: (FMLiveSwitchAction1< FMLiveSwitchVideoPipe * > *)  value

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes.

◆ addOnActiveVideoPacketizerChangeWithBlock

- (FMLiveSwitchVideoPipe*) addOnActiveVideoPacketizerChangeWithBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes.

◆ addOnActiveVideoPacketizerChangeWithBlock:

- (void) addOnActiveVideoPacketizerChangeWithBlock: (void(^)(FMLiveSwitchVideoPipe *))  valueBlock

Adds a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes.

◆ aecContext

- (FMLiveSwitchAecContext*) aecContext

Gets the acoustic echo cancellation context.

◆ aecDisabled

- (bool) aecDisabled

Gets a value indicating whether acoustic echo cancellation is disabled.

◆ audioDisabled

- (bool) audioDisabled

Gets a value indicating whether audio is disabled.

◆ audioOutputs

- (NSMutableArray*) audioOutputs

Gets the audio outputs.

◆ automaticVideoDegradation

- (bool) automaticVideoDegradation

Gets whether to automatically degrade video based on FMLiveSwitchRtcLocalMedia1#videoBitsPerPixel and FMLiveSwitchRtcLocalMedia1videoDegradationPreference when bitrate constraints are applied to the local encoders.

◆ createAudioRecorderWithInputFormat:

- (FMLiveSwitchAudioSink*) createAudioRecorderWithInputFormat: (FMLiveSwitchAudioFormat *)  inputFormat

Creates an audio recorder.

Parameters
inputFormatThe input format.

◆ createAudioSourceWithConfig:

- (FMLiveSwitchAudioSource*) createAudioSourceWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates an audio source.

Parameters
configThe configuration.

◆ createFrameRateControllerWithOutputFormat:

- (FMLiveSwitchVideoPipe*) createFrameRateControllerWithOutputFormat: (FMLiveSwitchVideoFormat *)  outputFormat

Creates a frame-rate controller.

Parameters
outputFormatThe video output format.

◆ createG722EncoderWithConfig:

- (FMLiveSwitchAudioEncoder*) createG722EncoderWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a G.722 encoder.

Parameters
configThe configuration.

◆ createG722PacketizerWithConfig:

- (FMLiveSwitchAudioPipe*) createG722PacketizerWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a G.722 packetizer.

Parameters
configThe configuration.

◆ createH264Encoder

- (FMLiveSwitchVideoEncoder*) createH264Encoder

Creates an H.264 encoder.

◆ createH264Encoders

- (NSMutableArray*) createH264Encoders

Creates H.264 encoders.

◆ createH264Packetizer

- (FMLiveSwitchVideoPipe*) createH264Packetizer

Creates an H.264 packetizer.

◆ createH264Packetizers

- (NSMutableArray*) createH264Packetizers

Creates H.264 packetizers.

◆ createH265Encoder

- (FMLiveSwitchVideoEncoder*) createH265Encoder

Creates a H.265 encoder.

◆ createH265Packetizer

- (FMLiveSwitchVideoPipe*) createH265Packetizer

Creates a H.265 packetizer.

◆ createImageConverterWithOutputFormat:

- (FMLiveSwitchVideoPipe*) createImageConverterWithOutputFormat: (FMLiveSwitchVideoFormat *)  outputFormat

Creates an image converter.

Parameters
outputFormatThe video output format.

◆ createL16EncoderWithConfig:

- (FMLiveSwitchAudioEncoder*) createL16EncoderWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a L16 encoder.

Parameters
configThe configuration.

◆ createL16PacketizerWithConfig:

- (FMLiveSwitchAudioPipe*) createL16PacketizerWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a L16 packetizer.

Parameters
configThe configuration.

◆ createOpusEncoderWithConfig:

- (FMLiveSwitchAudioEncoder*) createOpusEncoderWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates an Opus encoder.

Parameters
configThe configuration.

◆ createOpusPacketizerWithConfig:

- (FMLiveSwitchAudioPipe*) createOpusPacketizerWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates an Opus packetizer.

Parameters
configThe configuration.

◆ createPcmaEncoderWithConfig:

- (FMLiveSwitchAudioEncoder*) createPcmaEncoderWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a PCMA encoder.

Parameters
configThe configuration.

◆ createPcmaPacketizerWithConfig:

- (FMLiveSwitchAudioPipe*) createPcmaPacketizerWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a PCMA packetizer.

Parameters
configThe configuration.

◆ createPcmuEncoderWithConfig:

- (FMLiveSwitchAudioEncoder*) createPcmuEncoderWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a PCMU encoder.

Parameters
configThe configuration.

◆ createPcmuPacketizerWithConfig:

- (FMLiveSwitchAudioPipe*) createPcmuPacketizerWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a PCMU packetizer.

Parameters
configThe configuration.

◆ createSoundConverterWithConfig:

- (FMLiveSwitchAudioPipe*) createSoundConverterWithConfig: (FMLiveSwitchAudioConfig *)  config

Creates a sound converter.

Parameters
configThe configuration.

◆ createVideoRecorderWithInputFormat:

- (FMLiveSwitchVideoSink*) createVideoRecorderWithInputFormat: (FMLiveSwitchVideoFormat *)  inputFormat

Creates a video recorder.

Parameters
inputFormatThe output format.

◆ createVideoSource

- (FMLiveSwitchVideoSource*) createVideoSource

Creates a video source.

◆ createViewSink

- (FMLiveSwitchViewSink<TView>*) createViewSink

Creates a view sink.

◆ createVp8Encoder

- (FMLiveSwitchVideoEncoder*) createVp8Encoder

Creates a VP8 encoder.

◆ createVp8Packetizer

- (FMLiveSwitchVideoPipe*) createVp8Packetizer

Creates a VP8 packetizer.

◆ createVp9Encoder

- (FMLiveSwitchVideoEncoder*) createVp9Encoder

Creates a VP9 encoder.

◆ createVp9Packetizer

- (FMLiveSwitchVideoPipe*) createVp9Packetizer

Creates a VP9 packetizer.

◆ destroy

- (void) destroy

Destroys all media tracks.

◆ doGetAudioEncodings

- (NSMutableArray*) doGetAudioEncodings

Gets the local audio encodings.

Returns
The local audio encodings.

◆ doGetVideoEncodings

- (NSMutableArray*) doGetVideoEncodings

Gets the local video encodings.

Returns
The local video encodings.

◆ doSetAudioEncodings:

- (void) doSetAudioEncodings: (NSMutableArray *)  encodings

Sets the local audio encodings.

Parameters
encodingsThe local audio encodings.

◆ doSetVideoEncodings:

- (void) doSetVideoEncodings: (NSMutableArray *)  encodings

Sets the local video encodings.

Parameters
encodingsThe local video encodings.

◆ g722Converter

- (FMLiveSwitchAudioPipe*) g722Converter

Gets the G.722 converter.

◆ g722Disabled

- (bool) g722Disabled

Gets whether the G.722 codec is disabled.

◆ g722Encoder

- (FMLiveSwitchAudioEncoder*) g722Encoder

Gets the G.722 encoder.

◆ g722Packetizer

- (FMLiveSwitchAudioPipe*) g722Packetizer

Gets the G.722 packetizer.

◆ h264Controller

- (FMLiveSwitchVideoPipe*) h264Controller

Gets the first H.264 controller.

◆ h264Controllers

- (NSMutableArray*) h264Controllers

Gets the H.264 controllers.

◆ h264Converter

- (FMLiveSwitchVideoPipe*) h264Converter

Gets the first H.264 converter.

◆ h264Converters

- (NSMutableArray*) h264Converters

Gets the H.264 converters.

◆ h264ConvertersArray

- (NSMutableArray*) h264ConvertersArray

Gets the H.264 converters array.

◆ h264Disabled

- (bool) h264Disabled

Gets whether the H.264 codec is disabled.

◆ h264Encoder

- (FMLiveSwitchVideoEncoder*) h264Encoder

Gets the first H.264 encoder.

◆ h264Encoders

- (NSMutableArray*) h264Encoders

Gets the first H.264 encoders.

◆ h264EncodersArray

- (NSMutableArray*) h264EncodersArray

Gets the H.264 encoders array.

◆ h264Packetizer

- (FMLiveSwitchVideoPipe*) h264Packetizer

Gets the first H.264 packetizer.

◆ h264Packetizers

- (NSMutableArray*) h264Packetizers

Gets the first H.264 packetizers.

◆ h264PacketizersArray

- (NSMutableArray*) h264PacketizersArray

Gets the first H.264 packetizers array.

◆ h264PacketizersArrayArray

- (NSMutableArray*) h264PacketizersArrayArray

Gets the H.264 packetizers array array.

◆ h265Controller

- (FMLiveSwitchVideoPipe*) h265Controller

Gets the first H265 controller.

◆ h265Controllers

- (NSMutableArray*) h265Controllers

Gets the H265 controllers.

◆ h265Converter

- (FMLiveSwitchVideoPipe*) h265Converter

Gets the first H265 converter.

◆ h265Converters

- (NSMutableArray*) h265Converters

Gets the H265 converters.

◆ h265Disabled

- (bool) h265Disabled

Gets whether the H.265 codec is disabled.

◆ h265Encoder

- (FMLiveSwitchVideoEncoder*) h265Encoder

Gets the first H265 encoder.

◆ h265Encoders

- (NSMutableArray*) h265Encoders

Gets the H265 encoders.

◆ h265Packetizer

- (FMLiveSwitchVideoPipe*) h265Packetizer

Gets the first H265 packetizer.

◆ h265Packetizers

- (NSMutableArray*) h265Packetizers

Gets the H265 packetizers.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class.

◆ initialize

- (bool) initialize

Initializes this instance.

Must be called before being used.

◆ initializeWithAudioTrackConfig:videoTrackConfig:

- (bool) initializeWithAudioTrackConfig: (FMLiveSwitchRtcAudioTrackConfig *)  audioTrackConfig
videoTrackConfig: (FMLiveSwitchRtcVideoTrackConfig *)  videoTrackConfig 

Initializes this instance.

Must be called before being used.

◆ initWithDisableAudio:disableVideo:

- (instancetype) initWithDisableAudio: (bool)  disableAudio
disableVideo: (bool)  disableVideo 

Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class.

Parameters
disableAudioWhether to disable audio.
disableVideoWhether to disable video.

◆ initWithDisableAudio:disableVideo:aecContext:

- (instancetype) initWithDisableAudio: (bool)  disableAudio
disableVideo: (bool)  disableVideo
aecContext: (FMLiveSwitchAecContext *)  aecContext 

Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class.

Parameters
disableAudioWhether to disable audio.
disableVideoWhether to disable video.
aecContextThe acoustic echo cancellation context.

◆ l16Converter

- (FMLiveSwitchAudioPipe*) l16Converter

Gets the L16 converter.

◆ l16Disabled

- (bool) l16Disabled

Gets whether the L16 codec is disabled.

◆ l16Encoder

- (FMLiveSwitchAudioEncoder*) l16Encoder

Gets the L16 encoder.

◆ l16Packetizer

- (FMLiveSwitchAudioPipe*) l16Packetizer

Gets the L16 packetizer.

◆ opusConverter

- (FMLiveSwitchAudioPipe*) opusConverter

Gets the first Opus converter.

◆ opusConverters

- (NSMutableArray*) opusConverters

Gets the Opus converters.

◆ opusDisabled

- (bool) opusDisabled

Gets whether the Opus codec is disabled.

◆ opusEncoder

- (FMLiveSwitchAudioEncoder*) opusEncoder

Gets the first Opus encoder.

◆ opusEncoders

- (NSMutableArray*) opusEncoders

Gets the Opus encoders.

◆ opusPacketizer

- (FMLiveSwitchAudioPipe*) opusPacketizer

Gets the first Opus packetizer.

◆ opusPacketizers

- (NSMutableArray*) opusPacketizers

Gets the Opus packetizers.

◆ packetizerDisabled

- (bool) packetizerDisabled

Gets a value indicating whether the packetizer is disabled.

WebRTC media requires the RTP packetizer so the value must be false. Media-over-WebSockets must not use the RTP packetizer, so the value must be true. If the packetizer is not required, this value must be set in the constructor.

◆ pcmaConverter

- (FMLiveSwitchAudioPipe*) pcmaConverter

Gets the PCMA converter.

◆ pcmaDisabled

- (bool) pcmaDisabled

Gets whether the PCMA codec is disabled.

◆ pcmaEncoder

- (FMLiveSwitchAudioEncoder*) pcmaEncoder

Gets the PCMA encoder.

◆ pcmaPacketizer

- (FMLiveSwitchAudioPipe*) pcmaPacketizer

Gets the PCMA packetizer.

◆ pcmuConverter

- (FMLiveSwitchAudioPipe*) pcmuConverter

Gets the PCMU converter.

◆ pcmuDisabled

- (bool) pcmuDisabled

Gets whether the PCMU codec is disabled.

◆ pcmuEncoder

- (FMLiveSwitchAudioEncoder*) pcmuEncoder

Gets the PCMU encoder.

◆ pcmuPacketizer

- (FMLiveSwitchAudioPipe*) pcmuPacketizer

Gets the PCMU packetizer.

◆ removeOnActiveAudioConverterChange:

- (void) removeOnActiveAudioConverterChange: (FMLiveSwitchAction1< FMLiveSwitchAudioPipe * > *)  value

Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioConverter changes.

◆ removeOnActiveAudioEncoderChange:

- (void) removeOnActiveAudioEncoderChange: (FMLiveSwitchAction1< FMLiveSwitchAudioEncoder * > *)  value

Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioEncoder changes.

◆ removeOnActiveAudioPacketizerChange:

- (void) removeOnActiveAudioPacketizerChange: (FMLiveSwitchAction1< FMLiveSwitchAudioPipe * > *)  value

Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeAudioPacketizer changes.

◆ removeOnActiveVideoControllerChange:

- (void) removeOnActiveVideoControllerChange: (FMLiveSwitchAction1< FMLiveSwitchVideoPipe * > *)  value

Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoController changes.

◆ removeOnActiveVideoConverterChange:

- (void) removeOnActiveVideoConverterChange: (FMLiveSwitchAction1< FMLiveSwitchVideoPipe * > *)  value

Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoConverter changes.

◆ removeOnActiveVideoEncoderChange:

- (void) removeOnActiveVideoEncoderChange: (FMLiveSwitchAction1< FMLiveSwitchVideoEncoder * > *)  value

Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoEncoder changes.

◆ removeOnActiveVideoPacketizerChange:

- (void) removeOnActiveVideoPacketizerChange: (FMLiveSwitchAction1< FMLiveSwitchVideoPipe * > *)  value

Removes a handler that is raised when the FMLiveSwitchRtcLocalMedia`1activeVideoPacketizer changes.

◆ rtcLocalMedia

+ (FMLiveSwitchRtcLocalMedia*) rtcLocalMedia

Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class.

◆ rtcLocalMediaWithDisableAudio:disableVideo:

+ (FMLiveSwitchRtcLocalMedia*) rtcLocalMediaWithDisableAudio: (bool)  disableAudio
disableVideo: (bool)  disableVideo 

Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class.

Parameters
disableAudioWhether to disable audio.
disableVideoWhether to disable video.

◆ rtcLocalMediaWithDisableAudio:disableVideo:aecContext:

+ (FMLiveSwitchRtcLocalMedia*) rtcLocalMediaWithDisableAudio: (bool)  disableAudio
disableVideo: (bool)  disableVideo
aecContext: (FMLiveSwitchAecContext *)  aecContext 

Initializes a new instance of the FMLiveSwitchRtcLocalMedia`1 class.

Parameters
disableAudioWhether to disable audio.
disableVideoWhether to disable video.
aecContextThe acoustic echo cancellation context.

◆ setAutomaticVideoDegradation:

- (void) setAutomaticVideoDegradation: (bool)  value

Sets whether to automatically degrade video based on FMLiveSwitchRtcLocalMedia1#videoBitsPerPixel and FMLiveSwitchRtcLocalMedia1videoDegradationPreference when bitrate constraints are applied to the local encoders.

◆ setPacketizerDisabled:

- (void) setPacketizerDisabled: (bool)  value

Sets a value indicating whether the packetizer is disabled.

WebRTC media requires the RTP packetizer so the value must be false. Media-over-WebSockets must not use the RTP packetizer, so the value must be true. If the packetizer is not required, this value must be set in the constructor.

◆ setVideoBitsPerPixel:

- (void) setVideoBitsPerPixel: (double)  value

Sets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution.

◆ setVideoDegradationPreference:

- (void) setVideoDegradationPreference: (FMLiveSwitchVideoDegradationPreference)  value

Sets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution.

◆ toggleAudioRecording

- (bool) toggleAudioRecording

Toggles audio recording.

◆ toggleVideoRecording

- (bool) toggleVideoRecording

Toggles video recording.

◆ videoBitsPerPixel

- (double) videoBitsPerPixel

Gets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution.

◆ videoDegradationPreference

- (FMLiveSwitchVideoDegradationPreference) videoDegradationPreference

Gets the video degradation preference when bitrate constraints require a compromise on frame-rate and/or resolution.

◆ videoDisabled

- (bool) videoDisabled

Gets a value indicating whether video is disabled.

◆ videoOutputs

- (NSMutableArray*) videoOutputs

Gets the video outputs.

◆ view

- (TView) view

Gets the video view, if video is not disabled.

◆ viewSink

- (FMLiveSwitchViewSink<TView>*) viewSink

Gets the video view sink, if video is not disabled.

◆ vp8Controller

- (FMLiveSwitchVideoPipe*) vp8Controller

Gets the first VP8 controller.

◆ vp8Controllers

- (NSMutableArray*) vp8Controllers

Gets the VP8 controllers.

◆ vp8Converter

- (FMLiveSwitchVideoPipe*) vp8Converter

Gets the first VP8 converter.

◆ vp8Converters

- (NSMutableArray*) vp8Converters

Gets the VP8 converters.

◆ vp8Disabled

- (bool) vp8Disabled

Gets whether the VP8 codec is disabled.

◆ vp8Encoder

- (FMLiveSwitchVideoEncoder*) vp8Encoder

Gets the first VP8 encoder.

◆ vp8Encoders

- (NSMutableArray*) vp8Encoders

Gets the VP8 encoders.

◆ vp8Packetizer

- (FMLiveSwitchVideoPipe*) vp8Packetizer

Gets the first VP8 packetizer.

◆ vp8Packetizers

- (NSMutableArray*) vp8Packetizers

Gets the VP8 packetizers.

◆ vp9Controller

- (FMLiveSwitchVideoPipe*) vp9Controller

Gets the first VP9 controller.

◆ vp9Controllers

- (NSMutableArray*) vp9Controllers

Gets the VP9 controllers.

◆ vp9Converter

- (FMLiveSwitchVideoPipe*) vp9Converter

Gets the first VP9 converter.

◆ vp9Converters

- (NSMutableArray*) vp9Converters

Gets the VP9 converters.

◆ vp9Disabled

- (bool) vp9Disabled

Gets whether the VP9 codec is disabled.

◆ vp9Encoder

- (FMLiveSwitchVideoEncoder*) vp9Encoder

Gets the first VP9 encoder.

◆ vp9Encoders

- (NSMutableArray*) vp9Encoders

Gets the VP9 encoders.

◆ vp9Packetizer

- (FMLiveSwitchVideoPipe*) vp9Packetizer

Gets the first VP9 packetizer.

◆ vp9Packetizers

- (NSMutableArray*) vp9Packetizers

Gets the VP9 packetizers.

Member Data Documentation

◆ __pad0__

- __pad0__
protected