FMLiveSwitchBitrateRequest Class Reference

A bitrate request. More...

Instance Methods

(int) - bitrate
 Gets the bitrate (in kbps). More...
 
(void) - deserializePropertyWithKey:valueJson:
 Deserializes a property from JSON. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchBitrateRequest class. More...
 
(NSString *) - mediaDescriptionId
 Gets the media description ID. More...
 
(NSString *) - rtpStreamId
 Gets the RTP stream ID. More...
 
(long long) - senderSynchronizationSource
 Gets the sender synchronization source. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes properties to JSON. More...
 
(void) - setBitrate:
 Sets the bitrate (in kbps). More...
 
(void) - setMediaDescriptionId:
 Sets the media description ID. More...
 
(void) - setRtpStreamId:
 Sets the RTP stream ID. More...
 
(void) - setSenderSynchronizationSource:
 Sets the sender synchronization source. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 

Class Methods

(FMLiveSwitchBitrateRequest *) + bitrateRequest
 Initializes a new instance of the FMLiveSwitchBitrateRequest class. More...
 
(NSMutableArray *) + fromJsonArrayWithBitrateRequestsJson:
 Deserializes an array from JSON. More...
 
(FMLiveSwitchBitrateRequest *) + fromJsonWithBitrateRequestJson:
 Deserializes an instance from JSON. More...
 
(NSString *) + toJsonArrayWithBitrateRequests:
 Serializes an array to JSON. More...
 
(NSString *) + toJsonWithBitrateRequest:
 Serializes an instance to JSON. More...
 

Detailed Description

A bitrate request.

Method Documentation

◆ bitrate

- (int) bitrate

Gets the bitrate (in kbps).

◆ bitrateRequest

+ (FMLiveSwitchBitrateRequest*) bitrateRequest

Initializes a new instance of the FMLiveSwitchBitrateRequest class.

◆ deserializePropertyWithKey:valueJson:

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

Deserializes a property from JSON.

Parameters
keyThe property key.
valueJsonThe property value in JSON format.

◆ fromJsonArrayWithBitrateRequestsJson:

+ (NSMutableArray*) fromJsonArrayWithBitrateRequestsJson: (NSString *)  bitrateRequestsJson

Deserializes an array from JSON.

Parameters
bitrateRequestsJsonThe array in JSON format.
Returns
The array.

◆ fromJsonWithBitrateRequestJson:

+ (FMLiveSwitchBitrateRequest*) fromJsonWithBitrateRequestJson: (NSString *)  bitrateRequestJson

Deserializes an instance from JSON.

Parameters
bitrateRequestJsonThe instance in JSON format.
Returns
The instance.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchBitrateRequest class.

◆ mediaDescriptionId

- (NSString*) mediaDescriptionId

Gets the media description ID.

◆ rtpStreamId

- (NSString*) rtpStreamId

Gets the RTP stream ID.

◆ senderSynchronizationSource

- (long long) senderSynchronizationSource

Gets the sender synchronization source.

◆ serializePropertiesWithJsonObject:

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

Serializes properties to JSON.

Parameters
jsonObjectThe JSON target.

◆ setBitrate:

- (void) setBitrate: (int)  value

Sets the bitrate (in kbps).

◆ setMediaDescriptionId:

- (void) setMediaDescriptionId: (NSString *)  value

Sets the media description ID.

◆ setRtpStreamId:

- (void) setRtpStreamId: (NSString *)  value

Sets the RTP stream ID.

◆ setSenderSynchronizationSource:

- (void) setSenderSynchronizationSource: (long long)  value

Sets the sender synchronization source.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the synchronization source.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonArrayWithBitrateRequests:

+ (NSString*) toJsonArrayWithBitrateRequests: (NSMutableArray *)  bitrateRequests

Serializes an array to JSON.

Parameters
bitrateRequestsThe array.
Returns
The array in JSON format.

◆ toJsonWithBitrateRequest:

+ (NSString*) toJsonWithBitrateRequest: (FMLiveSwitchBitrateRequest *)  bitrateRequest

Serializes an instance to JSON.

Parameters
bitrateRequestThe instance.
Returns
The instance in JSON format.