FMLiveSwitchMediaStreamInfo Class Reference

Media stream information. More...

Instance Methods

(NSString *) - controlTransportId
 Gets the control transport id. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(NSString *) - direction
 Gets the media stream direction. More...
 
(instancetype) - init
 
(int) - localBandwidth
 Gets the media stream's local bandwidth. More...
 
(int) - maxFrameHeight
 Gets the media stream's maximum frame height. More...
 
(int) - maxFrameWidth
 Gets the media stream's maximum frame width. More...
 
(NSString *) - receiveContent
 Gets the media stream's receive content. More...
 
(bool) - receiveDisabled
 Gets whether the media stream has the receive direction disabled. More...
 
(NSMutableArray *) - receiveEncodings
 Gets the media stream receive encodings. More...
 
(NSMutableArray *) - receiveFormats
 Gets the media stream receive formats. More...
 
(FMLiveSwitchMediaReceiverInfo *) - receiver
 Gets the first media stream receiver information. More...
 
(NSMutableArray *) - receivers
 Gets the media stream receivers information. More...
 
(int) - remoteBandwidth
 Gets the media stream's remote bandwidth. More...
 
(NSString *) - sendContent
 Gets the media stream's send content. More...
 
(bool) - sendDisabled
 Gets whether the media stream has the send direction disabled. More...
 
(NSMutableArray *) - sendEncodings
 Gets the media stream send encodings. More...
 
(FMLiveSwitchMediaSenderInfo *) - sender
 Gets the first media stream sender information. More...
 
(NSMutableArray *) - senders
 Gets the media stream senders information. More...
 
(NSMutableArray *) - sendFormats
 Gets the media stream send formats. More...
 
(bool) - sendMuted
 Gets whether the sender is muted. More...
 
(bool) - sendUnmuteDisabled
 Gets whether the sender cannot be unmuted. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setControlTransportId:
 Sets the control transport id. More...
 
(void) - setDirection:
 Sets the media stream direction. More...
 
(void) - setLocalBandwidth:
 Sets the media stream's local bandwidth. More...
 
(void) - setMaxFrameHeight:
 Sets the media stream's maximum frame height. More...
 
(void) - setMaxFrameWidth:
 Sets the media stream's maximum frame width. More...
 
(void) - setReceiveContent:
 Sets the media stream's receive content. More...
 
(void) - setReceiveDisabled:
 Sets whether the media stream has the receive direction disabled. More...
 
(void) - setReceiveEncodings:
 Sets the media stream receive encodings. More...
 
(void) - setReceiveFormats:
 Sets the media stream receive formats. More...
 
(void) - setReceivers:
 Sets the media stream receivers information. More...
 
(void) - setRemoteBandwidth:
 Sets the media stream's remote bandwidth. More...
 
(void) - setSendContent:
 Sets the media stream's send content. More...
 
(void) - setSendDisabled:
 Sets whether the media stream has the send direction disabled. More...
 
(void) - setSendEncodings:
 Sets the media stream send encodings. More...
 
(void) - setSenders:
 Sets the media stream senders information. More...
 
(void) - setSendFormats:
 Sets the media stream send formats. More...
 
(void) - setSendMuted:
 Sets whether the sender is muted. More...
 
(void) - setSendUnmuteDisabled:
 Sets whether the sender cannot be unmuted. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchStreamInfo
(void) - setTag:
 Sets the tag. More...
 
(void) - setTransportId:
 Sets the transport id. More...
 
(NSString *) - tag
 Gets the tag. More...
 
(NSString *) - transportId
 Gets the transport id. More...
 
- Instance Methods inherited from FMLiveSwitchInfo
(NSString *) - id
 Gets the identifier. More...
 
(void) - setId:
 Sets the identifier. More...
 

Class Methods

(NSMutableArray *) + fromJsonArrayWithMediaStreamInfosJson:
 Deserializes an array from JSON. More...
 
(FMLiveSwitchMediaStreamInfo *) + fromJsonWithMediaStreamInfoJson:
 Deserializes an instance from JSON. More...
 
(FMLiveSwitchMediaStreamInfo *) + mediaStreamInfo
 
(NSString *) + toJsonArrayWithMediaStreamInfos:
 Serializes an array to JSON. More...
 
(NSString *) + toJsonWithMediaStreamInfo:
 Serializes an instance to JSON. More...
 
- Class Methods inherited from FMLiveSwitchStreamInfo
(FMLiveSwitchStreamInfo *) + streamInfo
 
- 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

Media stream information.

Method Documentation

◆ controlTransportId

- (NSString*) controlTransportId

Gets the control transport id.

This will be null if BUNDLE is active.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchStreamInfo.

◆ direction

- (NSString*) direction

Gets the media stream direction.

◆ fromJsonArrayWithMediaStreamInfosJson:

+ (NSMutableArray*) fromJsonArrayWithMediaStreamInfosJson: (NSString *)  mediaStreamInfosJson

Deserializes an array from JSON.

Parameters
mediaStreamInfosJsonThe serialized JSON.
Returns
The deserialized array.

◆ fromJsonWithMediaStreamInfoJson:

+ (FMLiveSwitchMediaStreamInfo*) fromJsonWithMediaStreamInfoJson: (NSString *)  mediaStreamInfoJson

Deserializes an instance from JSON.

Parameters
mediaStreamInfoJsonThe serialized JSON.
Returns
The deserialized instance.

◆ init

- (instancetype) init

◆ localBandwidth

- (int) localBandwidth

Gets the media stream's local bandwidth.

◆ maxFrameHeight

- (int) maxFrameHeight

Gets the media stream's maximum frame height.

◆ maxFrameWidth

- (int) maxFrameWidth

Gets the media stream's maximum frame width.

◆ mediaStreamInfo

+ (FMLiveSwitchMediaStreamInfo*) mediaStreamInfo

◆ receiveContent

- (NSString*) receiveContent

Gets the media stream's receive content.

◆ receiveDisabled

- (bool) receiveDisabled

Gets whether the media stream has the receive direction disabled.

◆ receiveEncodings

- (NSMutableArray*) receiveEncodings

Gets the media stream receive encodings.

◆ receiveFormats

- (NSMutableArray*) receiveFormats

Gets the media stream receive formats.

◆ receiver

Gets the first media stream receiver information.

◆ receivers

- (NSMutableArray*) receivers

Gets the media stream receivers information.

◆ remoteBandwidth

- (int) remoteBandwidth

Gets the media stream's remote bandwidth.

◆ sendContent

- (NSString*) sendContent

Gets the media stream's send content.

◆ sendDisabled

- (bool) sendDisabled

Gets whether the media stream has the send direction disabled.

◆ sendEncodings

- (NSMutableArray*) sendEncodings

Gets the media stream send encodings.

◆ sender

Gets the first media stream sender information.

◆ senders

- (NSMutableArray*) senders

Gets the media stream senders information.

◆ sendFormats

- (NSMutableArray*) sendFormats

Gets the media stream send formats.

◆ sendMuted

- (bool) sendMuted

Gets whether the sender is muted.

Returns true if the sender is muted and false otherwise.

◆ sendUnmuteDisabled

- (bool) sendUnmuteDisabled

Gets whether the sender cannot be unmuted.

Returns true if the sender cannot be unmuted and false otherwise.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchStreamInfo.

◆ setControlTransportId:

- (void) setControlTransportId: (NSString *)  value

Sets the control transport id.

This will be null if BUNDLE is active.

◆ setDirection:

- (void) setDirection: (NSString *)  value

Sets the media stream direction.

◆ setLocalBandwidth:

- (void) setLocalBandwidth: (int)  value

Sets the media stream's local bandwidth.

◆ setMaxFrameHeight:

- (void) setMaxFrameHeight: (int)  value

Sets the media stream's maximum frame height.

◆ setMaxFrameWidth:

- (void) setMaxFrameWidth: (int)  value

Sets the media stream's maximum frame width.

◆ setReceiveContent:

- (void) setReceiveContent: (NSString *)  value

Sets the media stream's receive content.

◆ setReceiveDisabled:

- (void) setReceiveDisabled: (bool)  value

Sets whether the media stream has the receive direction disabled.

◆ setReceiveEncodings:

- (void) setReceiveEncodings: (NSMutableArray *)  value

Sets the media stream receive encodings.

◆ setReceiveFormats:

- (void) setReceiveFormats: (NSMutableArray *)  value

Sets the media stream receive formats.

◆ setReceivers:

- (void) setReceivers: (NSMutableArray *)  value

Sets the media stream receivers information.

◆ setRemoteBandwidth:

- (void) setRemoteBandwidth: (int)  value

Sets the media stream's remote bandwidth.

◆ setSendContent:

- (void) setSendContent: (NSString *)  value

Sets the media stream's send content.

◆ setSendDisabled:

- (void) setSendDisabled: (bool)  value

Sets whether the media stream has the send direction disabled.

◆ setSendEncodings:

- (void) setSendEncodings: (NSMutableArray *)  value

Sets the media stream send encodings.

◆ setSenders:

- (void) setSenders: (NSMutableArray *)  value

Sets the media stream senders information.

◆ setSendFormats:

- (void) setSendFormats: (NSMutableArray *)  value

Sets the media stream send formats.

◆ setSendMuted:

- (void) setSendMuted: (bool)  value

Sets whether the sender is muted.

Returns true if the sender is muted and false otherwise.

◆ setSendUnmuteDisabled:

- (void) setSendUnmuteDisabled: (bool)  value

Sets whether the sender cannot be unmuted.

Returns true if the sender cannot be unmuted and false otherwise.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonArrayWithMediaStreamInfos:

+ (NSString*) toJsonArrayWithMediaStreamInfos: (NSMutableArray *)  mediaStreamInfos

Serializes an array to JSON.

Parameters
mediaStreamInfosThe array to serialize.
Returns
The serialized JSON.

◆ toJsonWithMediaStreamInfo:

+ (NSString*) toJsonWithMediaStreamInfo: (FMLiveSwitchMediaStreamInfo *)  mediaStreamInfo

Serializes an instance to JSON.

Parameters
mediaStreamInfoThe instance to serialize.
Returns
The serialized JSON.