Encoding information. More...

Instance Methods
(int)	- bitrate
	Gets the bitrate, in kbps. More...

(bool)	- deactivated
	Gets whether this encoding is deactivated. More...

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

(int)	- height
	Gets the height. More...

(instancetype)	- init

(bool)	- isEmpty
	Gets whether this encoding is empty. More...

(bool)	- isEquivalentWithEncoding:
	Determines whether the specified encoding is equivalent. More...

(bool)	- isEquivalentWithEncoding:restrictionsOnly:
	Determines whether the specified encoding is equivalent. More...

(NSString *)	- rtpStreamId
	Gets the RTP stream identifier. More...

(double)	- scale
	Gets the target scale. More...

(int)	- scaledHeight
	Gets the scaled height. More...

(FMLiveSwitchSize *)	- scaledSize
	Gets the scaled size. More...

(int)	- scaledWidth
	Gets the scaled width. More...

(void)	- serializePropertiesWithJsonObject:
	Serializes the properties. More...

(void)	- setBitrate:
	Sets the bitrate, in kbps. More...

(void)	- setDeactivated:
	Sets whether this encoding is deactivated. More...

(void)	- setFrameRate:
	Sets the frame-rate, in fps. More...

(void)	- setRtpStreamId:
	Sets the RTP stream identifier. More...

(void)	- setScale:
	Sets the target scale. More...

(void)	- setSize:
	Sets the size. More...

(void)	- setSynchronizationSource:
	Sets the synchronization source. More...

(FMLiveSwitchSize *)	- size
	Gets the size. More...

(long long)	- synchronizationSource
	Gets the synchronization source. More...

(NSString *)	- toJson
	Serializes this instance to JSON. More...

(FMLiveSwitchSdpRtpRidAttribute *)	- toSdpRidAttributeWithDirection:
	Converts this instance into an SDP RID attribute. More...

(FMLiveSwitchSdpRtpRidAttribute *)	- toSdpRidAttributeWithDirection:includeRestrictions:
	Converts this instance into an SDP RID attribute. More...

(int)	- width
	Gets the width. More...

Instance Methods inherited from FMLiveSwitchInfo
(NSString *)	- id
	Gets the identifier. More...

(void)	- setId:
	Sets the identifier. More...

Class Methods
(FMLiveSwitchEncodingInfo *)	+ encodingInfo

(NSMutableArray *)	+ fromJsonArrayWithEncodingInfosJson:
	Deserializes an array from JSON. More...

(FMLiveSwitchEncodingInfo *)	+ fromJsonWithEncodingInfoJson:
	Deserializes an instance from JSON. More...

(FMLiveSwitchEncodingInfo *)	+ fromSdpRidAttribute:
	Converts an SDP RID attribute into an instance. More...

(bool)	+ isEquivalentWithEncoding1:encoding2:
	Determines whether the two encodings are equivalent. More...

(bool)	+ isEquivalentWithEncoding1:encoding2:restrictionsOnly:
	Determines whether the two encodings are equivalent. More...

(FMLiveSwitchEncodingInfo *)	+ maxWithEncoding1:encoding2:
	Returns a new encoding with each value being the maximum of two input encodings. More...

(FMLiveSwitchEncodingInfo *)	+ minWithEncoding1:encoding2:
	Returns a new encoding with each value being the minimum of two input encodings. More...

(NSString *)	+ toJsonArrayWithEncodingInfos:
	Serializes an array to JSON. More...

(NSString *)	+ toJsonWithEncodingInfo:
	Serializes an instance to JSON. More...

(FMLiveSwitchSdpRtpRidAttribute *)	+ toSdpRidAttributeWithEncoding:direction:
	Converts an instance into an SDP RID attribute. More...

(FMLiveSwitchSdpRtpRidAttribute *)	+ toSdpRidAttributeWithEncoding:direction:includeRestrictions:
	Converts an instance into an SDP RID attribute. More...

Class Methods inherited from FMLiveSwitchInfo
(FMLiveSwitchInfo *)	+ info

(NSMutableArray *)	+ processArrayWithNewValues:oldValues:
	Processes an array for an info. More...

(NSMutableArray *)	+ processBooleanArrayWithNewValues:oldValues:
	Processes a boolean array for an info. More...

(FMLiveSwitchNullableBool *)	+ processBooleanWithNewValue:oldValue:
	Processes a boolean for an info. More...

(FMLiveSwitchNullableDouble *)	+ processDoubleWithNewValue:oldValue:
	Processes a double for an info. More...

(NSMutableArray *)	+ processFloatArrayWithNewValues:oldValues:
	Processes a float array for an info. More...

(FMLiveSwitchNullableFloat *)	+ processFloatWithNewValue:oldValue:
	Processes a float for an info. More...

(NSMutableArray *)	+ processIntegerArrayWithNewValues:oldValues:
	Processes a integer array for an info. More...

(FMLiveSwitchNullableInt *)	+ processIntegerWithNewValue:oldValue:
	Processes an integer for an info. More...

(NSMutableArray *)	+ processLongArrayWithNewValues:oldValues:
	Processes a long array for an info. More...

(FMLiveSwitchNullableLong *)	+ processLongWithNewValue:oldValue:
	Processes a long for an info. More...

(NSObject< FMLiveSwitchIEquivalent > *)	+ processObjectWithNewValue:oldValue:
	Processes an object for an info. More...

(NSMutableArray *)	+ processShortArrayWithNewValues:oldValues:
	Processes a short array for an info. More...

(FMLiveSwitchNullableShort *)	+ processShortWithNewValue:oldValue:
	Processes a short for an info. More...

(NSString *)	+ processStringWithNewValue:oldValue:
	Processes a string for an info. More...

Detailed Description

Encoding information.

Method Documentation

◆ bitrate

- (int) bitrate

Gets the bitrate, in kbps.

◆ deactivated

- (bool) deactivated

Gets whether this encoding is deactivated.

◆ 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

key	The key.
valueJson	The value in JSON format.

Implements FMLiveSwitchInfo.

◆ encodingInfo

+ (FMLiveSwitchEncodingInfo*) encodingInfo

◆ frameRate

- (double) frameRate

Gets the frame-rate, in fps.

◆ fromJsonArrayWithEncodingInfosJson:

+ (NSMutableArray*) fromJsonArrayWithEncodingInfosJson: (NSString *) encodingInfosJson

Deserializes an array from JSON.

Parameters

encodingInfosJson The serialized JSON.

Returns: The deserialized array.

◆ fromJsonWithEncodingInfoJson:

+ (FMLiveSwitchEncodingInfo*) fromJsonWithEncodingInfoJson: (NSString *) encodingInfoJson

Deserializes an instance from JSON.

Parameters

encodingInfoJson The serialized JSON.

Returns: The deserialized instance.

◆ fromSdpRidAttribute:

+ (FMLiveSwitchEncodingInfo*) fromSdpRidAttribute: (FMLiveSwitchSdpRtpRidAttribute *) ridAttribute

Converts an SDP RID attribute into an instance.

Parameters

ridAttribute The SDP RID attribute.

◆ height

- (int) height

Gets the height.

◆ init

- (instancetype) init

Implements FMLiveSwitchInfo.

◆ isEmpty

- (bool) isEmpty

Gets whether this encoding is empty.

◆ isEquivalentWithEncoding1:encoding2:

+ (bool) isEquivalentWithEncoding1:	(FMLiveSwitchEncodingInfo *)	encoding1
encoding2:	(FMLiveSwitchEncodingInfo *)	encoding2

Determines whether the two encodings are equivalent.

Parameters

encoding1	The first encoding.
encoding2	The second encoding.

◆ isEquivalentWithEncoding1:encoding2:restrictionsOnly:

+ (bool) isEquivalentWithEncoding1:	(FMLiveSwitchEncodingInfo *)	encoding1
encoding2:	(FMLiveSwitchEncodingInfo *)	encoding2
restrictionsOnly:	(bool)	restrictionsOnly

Determines whether the two encodings are equivalent.

Parameters

encoding1	The first encoding.
encoding2	The second encoding.
restrictionsOnly	Whether to check restrictions only.

◆ isEquivalentWithEncoding:

- (bool) isEquivalentWithEncoding: (FMLiveSwitchEncodingInfo *) encoding

Determines whether the specified encoding is equivalent.

Parameters

encoding The encoding.

◆ isEquivalentWithEncoding:restrictionsOnly:

- (bool) isEquivalentWithEncoding:	(FMLiveSwitchEncodingInfo *)	encoding
restrictionsOnly:	(bool)	restrictionsOnly

Determines whether the specified encoding is equivalent.

Parameters

encoding	The encoding.
restrictionsOnly	Whether to check restrictions only.

◆ maxWithEncoding1:encoding2:

+ (FMLiveSwitchEncodingInfo*) maxWithEncoding1:	(FMLiveSwitchEncodingInfo *)	encoding1
encoding2:	(FMLiveSwitchEncodingInfo *)	encoding2

Returns a new encoding with each value being the maximum of two input encodings.

Parameters

encoding1	The first encoding.
encoding2	The second encoding.

Returns: A new encoding.

◆ minWithEncoding1:encoding2:

+ (FMLiveSwitchEncodingInfo*) minWithEncoding1:	(FMLiveSwitchEncodingInfo *)	encoding1
encoding2:	(FMLiveSwitchEncodingInfo *)	encoding2

Returns a new encoding with each value being the minimum of two input encodings.

Parameters

encoding1	The first encoding.
encoding2	The second encoding.

Returns: A new encoding.

◆ rtpStreamId

- (NSString*) rtpStreamId

Gets the RTP stream identifier.

◆ scale

- (double) scale

Gets the target scale.

◆ scaledHeight

- (int) scaledHeight

Gets the scaled height.

◆ scaledSize

- (FMLiveSwitchSize*) scaledSize

Gets the scaled size.

◆ scaledWidth

- (int) scaledWidth

Gets the scaled width.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters

jsonObject The JSON object.

Implements FMLiveSwitchInfo.

◆ setBitrate:

- (void) setBitrate: (int) value

Sets the bitrate, in kbps.

◆ setDeactivated:

- (void) setDeactivated: (bool) value

Sets whether this encoding is deactivated.

◆ setFrameRate:

- (void) setFrameRate: (double) value

Sets the frame-rate, in fps.

◆ setRtpStreamId:

- (void) setRtpStreamId: (NSString *) value

Sets the RTP stream identifier.

◆ setScale:

- (void) setScale: (double) value

Sets the target scale.

◆ setSize:

- (void) setSize: (FMLiveSwitchSize *) value

Sets the size.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long) value

Sets the synchronization source.

◆ size

- (FMLiveSwitchSize*) size

Gets the size.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonArrayWithEncodingInfos:

+ (NSString*) toJsonArrayWithEncodingInfos: (NSMutableArray *) encodingInfos

Serializes an array to JSON.

Parameters

encodingInfos The array to serialize.

Returns: The serialized JSON.

◆ toJsonWithEncodingInfo:

+ (NSString*) toJsonWithEncodingInfo: (FMLiveSwitchEncodingInfo *) encodingInfo

Serializes an instance to JSON.

Parameters

encodingInfo The instance to serialize.

Returns: The serialized JSON.

◆ toSdpRidAttributeWithDirection:

- (FMLiveSwitchSdpRtpRidAttribute*) toSdpRidAttributeWithDirection: (NSString *) direction

Converts this instance into an SDP RID attribute.

Parameters

direction The direction.

◆ toSdpRidAttributeWithDirection:includeRestrictions:

- (FMLiveSwitchSdpRtpRidAttribute*) toSdpRidAttributeWithDirection:	(NSString *)	direction
includeRestrictions:	(bool)	includeRestrictions

Converts this instance into an SDP RID attribute.

Parameters

direction	The direction.
includeRestrictions	Whether to include restrictions.

◆ toSdpRidAttributeWithEncoding:direction:

+ (FMLiveSwitchSdpRtpRidAttribute*) toSdpRidAttributeWithEncoding:	(FMLiveSwitchEncodingInfo *)	encoding
direction:	(NSString *)	direction

Converts an instance into an SDP RID attribute.

Parameters

encoding	The encoding.
direction	The direction.

◆ toSdpRidAttributeWithEncoding:direction:includeRestrictions:

+ (FMLiveSwitchSdpRtpRidAttribute*) toSdpRidAttributeWithEncoding:	(FMLiveSwitchEncodingInfo *)	encoding
direction:	(NSString *)	direction
includeRestrictions:	(bool)	includeRestrictions

Converts an instance into an SDP RID attribute.

Parameters

encoding	The encoding.
direction	The direction.
includeRestrictions	Whether to include restrictions.

◆ width

- (int) width

Gets the width.

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ bitrate

◆ deactivated

◆ description

◆ deserializePropertiesWithKey:valueJson:

◆ encodingInfo

◆ frameRate

◆ fromJsonArrayWithEncodingInfosJson:

◆ fromJsonWithEncodingInfoJson:

◆ fromSdpRidAttribute:

◆ height

◆ init

◆ isEmpty

◆ isEquivalentWithEncoding1:encoding2:

◆ isEquivalentWithEncoding1:encoding2:restrictionsOnly:

◆ isEquivalentWithEncoding:

◆ isEquivalentWithEncoding:restrictionsOnly:

◆ maxWithEncoding1:encoding2:

◆ minWithEncoding1:encoding2:

◆ rtpStreamId

◆ scale

◆ scaledHeight

◆ scaledSize

◆ scaledWidth

◆ serializePropertiesWithJsonObject:

◆ setBitrate:

◆ setDeactivated:

◆ setFrameRate:

◆ setRtpStreamId:

◆ setScale:

◆ setSize:

◆ setSynchronizationSource:

◆ size

◆ synchronizationSource

◆ toJson

◆ toJsonArrayWithEncodingInfos:

◆ toJsonWithEncodingInfo:

◆ toSdpRidAttributeWithDirection:

◆ toSdpRidAttributeWithDirection:includeRestrictions:

◆ toSdpRidAttributeWithEncoding:direction:

◆ toSdpRidAttributeWithEncoding:direction:includeRestrictions:

◆ width