FMLiveSwitchVideoEncodingConfig Class Reference

Video encoding configuration. More...

Instance Methods

(NSString *) - description
 Returns a string that represents this instance. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(double) - frameRate
 Gets the frame-rate, in fps. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class. More...
 
(instancetype) - initWithEncoding:
 Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class. More...
 
(double) - scale
 Gets the target scale. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setFrameRate:
 Sets the frame-rate, in fps. More...
 
(void) - setScale:
 Sets the target scale. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchEncodingConfig
(int) - bitrate
 Gets the bitrate, in kbps. More...
 
(bool) - deactivated
 Gets whether this encoding is deactivated. More...
 
(NSString *) - rtpStreamId
 Gets the RTP stream identifier. 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

(NSMutableArray *) + fromJsonArrayWithEncodingConfigsJson:
 Deserializes an array from JSON. More...
 
(FMLiveSwitchVideoEncodingConfig *) + fromJsonWithEncodingConfigJson:
 Deserializes an instance from JSON. More...
 
(NSString *) + toJsonArrayWithEncodingConfigs:
 Serializes an array to JSON. More...
 
(NSString *) + toJsonWithEncodingConfig:
 Serializes an instance to JSON. More...
 
(FMLiveSwitchVideoEncodingConfig *) + videoEncodingConfig
 Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class. More...
 
(FMLiveSwitchVideoEncodingConfig *) + videoEncodingConfigWithEncoding:
 Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class. More...
 
- Class Methods inherited from FMLiveSwitchEncodingConfig
(FMLiveSwitchEncodingConfig *) + encodingConfig
 Initializes a new instance of the FMLiveSwitchEncodingConfig class. More...
 
(FMLiveSwitchEncodingConfig *) + encodingConfigWithEncoding:
 Initializes a new instance of the FMLiveSwitchEncodingConfig class. More...
 

Detailed Description

Video encoding configuration.

Method Documentation

◆ description

- (NSString*) description

Returns a string that represents this instance.

Returns
A string that represents this instance.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchEncodingConfig.

◆ frameRate

- (double) frameRate

Gets the frame-rate, in fps.

◆ fromJsonArrayWithEncodingConfigsJson:

+ (NSMutableArray*) fromJsonArrayWithEncodingConfigsJson: (NSString *)  encodingConfigsJson

Deserializes an array from JSON.

Parameters
encodingConfigsJsonThe serialized JSON.
Returns
The deserialized array.

◆ fromJsonWithEncodingConfigJson:

+ (FMLiveSwitchVideoEncodingConfig*) fromJsonWithEncodingConfigJson: (NSString *)  encodingConfigJson

Deserializes an instance from JSON.

Parameters
encodingConfigJsonThe serialized JSON.
Returns
The deserialized instance.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class.

Implements FMLiveSwitchEncodingConfig.

◆ initWithEncoding:

- (instancetype) initWithEncoding: (FMLiveSwitchEncodingInfo *)  encoding

Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class.

Parameters
encodingThe encoding.

Implements FMLiveSwitchEncodingConfig.

◆ scale

- (double) scale

Gets the target scale.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchEncodingConfig.

◆ setFrameRate:

- (void) setFrameRate: (double)  value

Sets the frame-rate, in fps.

◆ setScale:

- (void) setScale: (double)  value

Sets the target scale.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonArrayWithEncodingConfigs:

+ (NSString*) toJsonArrayWithEncodingConfigs: (NSMutableArray *)  encodingConfigs

Serializes an array to JSON.

Parameters
encodingConfigsThe array to serialize.
Returns
The serialized JSON.

◆ toJsonWithEncodingConfig:

+ (NSString*) toJsonWithEncodingConfig: (FMLiveSwitchVideoEncodingConfig *)  encodingConfig

Serializes an instance to JSON.

Parameters
encodingConfigThe instance to serialize.
Returns
The serialized JSON.

◆ videoEncodingConfig

+ (FMLiveSwitchVideoEncodingConfig*) videoEncodingConfig

Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class.

◆ videoEncodingConfigWithEncoding:

+ (FMLiveSwitchVideoEncodingConfig*) videoEncodingConfigWithEncoding: (FMLiveSwitchEncodingInfo *)  encoding

Initializes a new instance of the FMLiveSwitchVideoEncodingConfig class.

Parameters
encodingThe encoding.