FMLiveSwitchEncodingConfig Class Reference

Encoding configuration. More...

Instance Methods

(int) - bitrate
 Gets the bitrate, in kbps. More...
 
(bool) - deactivated
 Gets whether this encoding is deactivated. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchEncodingConfig class. More...
 
(instancetype) - initWithEncoding:
 Initializes a new instance of the FMLiveSwitchEncodingConfig class. More...
 
(NSString *) - rtpStreamId
 Gets the RTP stream identifier. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setBitrate:
 Sets the bitrate, in kbps. More...
 
(void) - setDeactivated:
 Sets whether this encoding is deactivated. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 

Class Methods

(FMLiveSwitchEncodingConfig *) + encodingConfig
 Initializes a new instance of the FMLiveSwitchEncodingConfig class. More...
 
(FMLiveSwitchEncodingConfig *) + encodingConfigWithEncoding:
 Initializes a new instance of the FMLiveSwitchEncodingConfig class. More...
 

Detailed Description

Encoding configuration.

Method Documentation

◆ bitrate

- (int) bitrate

Gets the bitrate, in kbps.

◆ deactivated

- (bool) deactivated

Gets whether this encoding is deactivated.

◆ deserializePropertiesWithKey:valueJson:

- (void) deserializePropertiesWithKey: (NSString *)  key
valueJson: (NSString *)  valueJson 

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implemented in FMLiveSwitchVideoEncodingConfig.

◆ encodingConfig

+ (FMLiveSwitchEncodingConfig*) encodingConfig

Initializes a new instance of the FMLiveSwitchEncodingConfig class.

◆ encodingConfigWithEncoding:

+ (FMLiveSwitchEncodingConfig*) encodingConfigWithEncoding: (FMLiveSwitchEncodingInfo *)  encoding

Initializes a new instance of the FMLiveSwitchEncodingConfig class.

Parameters
encodingThe encoding.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchEncodingConfig class.

Implemented in FMLiveSwitchVideoEncodingConfig, and FMLiveSwitchAudioEncodingConfig.

◆ initWithEncoding:

- (instancetype) initWithEncoding: (FMLiveSwitchEncodingInfo *)  encoding

Initializes a new instance of the FMLiveSwitchEncodingConfig class.

Parameters
encodingThe encoding.

Implemented in FMLiveSwitchVideoEncodingConfig, and FMLiveSwitchAudioEncodingConfig.

◆ rtpStreamId

- (NSString*) rtpStreamId

Gets the RTP stream identifier.

◆ serializePropertiesWithJsonObject:

- (void) serializePropertiesWithJsonObject: (NSMutableDictionary< NSString *, NSString * > *)  jsonObject

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implemented in FMLiveSwitchVideoEncodingConfig.

◆ setBitrate:

- (void) setBitrate: (int)  value

Sets the bitrate, in kbps.

◆ setDeactivated:

- (void) setDeactivated: (bool)  value

Sets whether this encoding is deactivated.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.