FMLiveSwitchLocalMediaBase Class Reference

A collection of local audio/video track base methods. More...

Instance Methods

(void) - abortStartWithPromise:exception:
 Aborts the start. 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...
 
(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...
 
(FMLiveSwitchFuture< TLocalMedia > *) - doStart
 Starts the local media. More...
 
(FMLiveSwitchFuture< TLocalMedia > *) - doStop
 Stops the local media. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchLocalMediaBase`3 class. More...
 
(void) - lockAudioEncodings
 Locks the audio encodings in prior to initialization. More...
 
(void) - lockVideoEncodings
 Locks the video encodings in prior to initialization. More...
 
(void) - lockVideoEncodingsWithSourceType:
 Locks the video encodings in prior to initialization. More...
 
(void) - lockVideoEncodingsWithSourceType:sourceWidth:sourceHeight:sourceFrameRate:
 Locks the video encodings in prior to initialization. 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) - 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...
 
(FMLiveSwitchFuture< TLocalMedia > *) - start
 Starts the media track sources. More...
 
(FMLiveSwitchLocalMediaState) - state
 Gets the state. More...
 
(FMLiveSwitchFuture< TLocalMedia > *) - 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...
 

Class Methods

(double) + defaultVideoBitsPerPixel
 Gets the default bits-per-pixel for video. More...
 
(FMLiveSwitchLocalMediaBase *) + localMediaBase
 Initializes a new instance of the FMLiveSwitchLocalMediaBase`3 class. More...
 
(void) + setDefaultVideoBitsPerPixel:
 Sets the default bits-per-pixel for video. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchMedia<TAudioTrack
 

Detailed Description

A collection of local audio/video track base methods.

Method Documentation

◆ abortStartWithPromise:exception:

- (void) abortStartWithPromise: (FMLiveSwitchPromise< TLocalMedia > *)  promise
exception: (NSException *)  exception 

Aborts the start.

Parameters
promiseThe promise.
exceptionThe exception.

◆ 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.

◆ defaultVideoBitsPerPixel

+ (double) defaultVideoBitsPerPixel

Gets the default bits-per-pixel for video.

◆ doGetAudioEncodings

- (NSMutableArray*) doGetAudioEncodings

Gets the local audio encodings.

Returns
The local audio encodings.

Implemented in FMLiveSwitchLocalMedia.

◆ doGetVideoEncodings

- (NSMutableArray*) doGetVideoEncodings

Gets the local video encodings.

Returns
The local video encodings.

Implemented in FMLiveSwitchLocalMedia.

◆ doSetAudioEncodings:

- (void) doSetAudioEncodings: (NSMutableArray *)  encodings

Sets the local audio encodings.

Parameters
encodingsThe local audio encodings.

Implemented in FMLiveSwitchLocalMedia.

◆ doSetVideoEncodings:

- (void) doSetVideoEncodings: (NSMutableArray *)  encodings

Sets the local video encodings.

Parameters
encodingsThe local video encodings.

Implemented in FMLiveSwitchLocalMedia.

◆ doStart

- (FMLiveSwitchFuture<TLocalMedia>*) doStart

Starts the local media.

Implemented in FMLiveSwitchLocalMedia.

◆ doStop

- (FMLiveSwitchFuture<TLocalMedia>*) doStop

Stops the local media.

Implemented in FMLiveSwitchLocalMedia.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchLocalMediaBase`3 class.

Implemented in FMLiveSwitchLocalMedia.

◆ localMediaBase

+ (FMLiveSwitchLocalMediaBase*) localMediaBase

Initializes a new instance of the FMLiveSwitchLocalMediaBase`3 class.

◆ lockAudioEncodings

- (void) lockAudioEncodings

Locks the audio encodings in prior to initialization.

◆ lockVideoEncodings

- (void) lockVideoEncodings

Locks the video encodings in prior to initialization.

◆ lockVideoEncodingsWithSourceType:

- (void) lockVideoEncodingsWithSourceType: (FMLiveSwitchVideoType)  sourceType

Locks the video encodings in prior to initialization.

◆ lockVideoEncodingsWithSourceType:sourceWidth:sourceHeight:sourceFrameRate:

- (void) lockVideoEncodingsWithSourceType: (FMLiveSwitchVideoType)  sourceType
sourceWidth: (int)  sourceWidth
sourceHeight: (int)  sourceHeight
sourceFrameRate: (double)  sourceFrameRate 

Locks the video encodings in prior to initialization.

◆ 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.

◆ setDefaultVideoBitsPerPixel:

+ (void) setDefaultVideoBitsPerPixel: (double)  value

Sets the default bits-per-pixel for video.

◆ setVideoEncodings:

- (void) setVideoEncodings: (NSMutableArray *)  value

Sets the local video encodings.

◆ setVideoSimulcastBitsPerPixel:

- (void) setVideoSimulcastBitsPerPixel: (double)  value

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

If this value is set and the video source has declared a target width, height, and frame-rate, encoding bitrates will be automatically calculated using this value instad of using preferred bitrate.

◆ 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.

◆ start

- (FMLiveSwitchFuture<TLocalMedia>*) start

Starts the media track sources.

◆ state

- (FMLiveSwitchLocalMediaState) state

Gets the state.

◆ stop

- (FMLiveSwitchFuture<TLocalMedia>*) 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).

If this value is set and the video source has declared a target width, height, and frame-rate, encoding bitrates will be automatically calculated using this value instad of using preferred bitrate.

◆ 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.

Member Data Documentation

◆ __pad0__

- __pad0__
protected