FMLiveSwitchMediaSourceStats Class Reference

Media source stats. More...

Instance Methods

(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(instancetype) - init
 
(NSString *) - inputId
 Gets the input identifier. More...
 
(NSString *) - inputName
 Gets the input name. More...
 
(bool) - isEquivalentWithInstance:
 Checks if a source is equivalent to this one. More...
 
(NSString *) - label
 Gets the label. More...
 
(bool) - muted
 Gets the muted flag. More...
 
(FMLiveSwitchFormatInfo *) - outputFormat
 Gets the output format. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setInputId:
 Sets the input identifier. More...
 
(void) - setInputName:
 Sets the input name. More...
 
(void) - setLabel:
 Sets the label. More...
 
(void) - setMuted:
 Sets the muted flag. More...
 
(void) - setOutputFormat:
 Sets the output format. More...
 
(void) - setTag:
 Sets the tag. More...
 
(NSString *) - tag
 Gets the tag. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchBaseStats
(NSString *) - id
 Gets the identifier of the object generating these stats. More...
 
(NSDate *) - timestamp
 Gets the timestamp when these stats were generated. More...
 
- Instance Methods inherited from <FMLiveSwitchIEquivalent>
(bool) - isEquivalentWithInstance:
 Checks if an instance is equivalent to this one. More...
 

Class Methods

(FMLiveSwitchMediaSourceStats *) + fromJsonWithInstanceJson:
 Deserializes an instance from JSON. More...
 
(FMLiveSwitchMediaSourceStats *) + mediaSourceStats
 
(NSString *) + toJsonWithInstance:
 Serializes an instance to JSON. More...
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Media source stats.

Method Documentation

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchBaseStats.

◆ fromJsonWithInstanceJson:

+ (FMLiveSwitchMediaSourceStats*) fromJsonWithInstanceJson: (NSString *)  instanceJson

Deserializes an instance from JSON.

Parameters
instanceJsonThe serialized Json.
Returns
The deserialized VideoSourceInfo.

◆ init

- (instancetype) init

Implements FMLiveSwitchBaseStats.

◆ inputId

- (NSString*) inputId

Gets the input identifier.

◆ inputName

- (NSString*) inputName

Gets the input name.

◆ isEquivalentWithInstance:

- (bool) isEquivalentWithInstance: (FMLiveSwitchMediaSourceStats *)  instance

Checks if a source is equivalent to this one.

Parameters
instanceThe source.

◆ label

- (NSString*) label

Gets the label.

◆ mediaSourceStats

+ (FMLiveSwitchMediaSourceStats*) mediaSourceStats

◆ muted

- (bool) muted

Gets the muted flag.

◆ outputFormat

- (FMLiveSwitchFormatInfo*) outputFormat

Gets the output format.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchBaseStats.

◆ setInputId:

- (void) setInputId: (NSString *)  value

Sets the input identifier.

◆ setInputName:

- (void) setInputName: (NSString *)  value

Sets the input name.

◆ setLabel:

- (void) setLabel: (NSString *)  value

Sets the label.

◆ setMuted:

- (void) setMuted: (bool)  value

Sets the muted flag.

◆ setOutputFormat:

- (void) setOutputFormat: (FMLiveSwitchFormatInfo *)  value

Sets the output format.

◆ setTag:

- (void) setTag: (NSString *)  value

Sets the tag.

◆ tag

- (NSString*) tag

Gets the tag.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonWithInstance:

+ (NSString*) toJsonWithInstance: (FMLiveSwitchMediaSourceStats *)  instance

Serializes an instance to JSON.

Parameters
instanceThe instance to serialize.
Returns
Serialized Json.