FMLiveSwitchDataStreamStats Class Reference

Data stream stats. More...

Instance Methods

(long long) - bytesReceived
 Gets the number of bytes received. More...
 
(long long) - bytesSent
 Gets the number of bytes sent. More...
 
(FMLiveSwitchDataChannelStats *) - channel
 Gets the first channel's stats. More...
 
(NSMutableArray *) - channels
 Gets the channels' stats. More...
 
(FMLiveSwitchDataChannelStats *) - dataChannel
 Gets the first channel's stats. More...
 
(NSMutableArray *) - dataChannels
 Gets the channels' stats. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(FMLiveSwitchDataChannelStats *) - getChannelWithChannelId:
 Gets a channel by its identifier. More...
 
(FMLiveSwitchDataChannelStats *) - getDataChannelWithDataChannelId:
 Gets a channel by its identifier. More...
 
(instancetype) - init
 
(long long) - messagesReceived
 Gets the number of messages received. More...
 
(long long) - messagesSent
 Gets the number of messages sent. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(NSString *) - toJson
 Serializes this to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchStreamStats
(bool) - isHost
 Gets whether the transport's active candidate pair has a host candidate. More...
 
(bool) - isReflexive
 Gets whether the transport's active candidate pair has a reflexive candidate. More...
 
(bool) - isRelayed
 Gets whether the transport's active candidate pair has a relayed candidate. More...
 
(FMLiveSwitchTransportStats *) - transport
 Gets the transport's stats. More...
 
(FMLiveSwitchStreamType) - type
 Gets the type. 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...
 

Class Methods

(FMLiveSwitchDataStreamStats *) + dataStreamStats
 
(NSMutableArray *) + fromJsonArrayWithDataStreamsJson:
 Derializes an array of data stream stats from JSON. More...
 
(FMLiveSwitchDataStreamStats *) + fromJsonWithDataStreamJson:
 Derializes data stream stats from JSON. More...
 
(NSString *) + toJsonArrayWithDataStreams:
 Serializes an array of data stream stats to JSON. More...
 
(NSString *) + toJsonWithDataStream:
 Serializes data stream stats to JSON. More...
 
- Class Methods inherited from FMLiveSwitchStreamStats
(FMLiveSwitchStreamStats *) + streamStats
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Data stream stats.

Method Documentation

◆ bytesReceived

- (long long) bytesReceived

Gets the number of bytes received.

◆ bytesSent

- (long long) bytesSent

Gets the number of bytes sent.

◆ channel

Gets the first channel's stats.

◆ channels

- (NSMutableArray*) channels

Gets the channels' stats.

◆ dataChannel

- (FMLiveSwitchDataChannelStats*) dataChannel

Gets the first channel's stats.

Deprecated:
Use Channel instead.

◆ dataChannels

- (NSMutableArray*) dataChannels

Gets the channels' stats.

Deprecated:
Use Channels instead.

◆ dataStreamStats

+ (FMLiveSwitchDataStreamStats*) dataStreamStats

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchStreamStats.

◆ fromJsonArrayWithDataStreamsJson:

+ (NSMutableArray*) fromJsonArrayWithDataStreamsJson: (NSString *)  dataStreamsJson

Derializes an array of data stream stats from JSON.

Parameters
dataStreamsJsonThe data streams' stats JSON.

◆ fromJsonWithDataStreamJson:

+ (FMLiveSwitchDataStreamStats*) fromJsonWithDataStreamJson: (NSString *)  dataStreamJson

Derializes data stream stats from JSON.

Parameters
dataStreamJsonThe data stream's stats JSON.

◆ getChannelWithChannelId:

- (FMLiveSwitchDataChannelStats*) getChannelWithChannelId: (NSString *)  channelId

Gets a channel by its identifier.

Parameters
channelIdThe channel identifier.

◆ getDataChannelWithDataChannelId:

- (FMLiveSwitchDataChannelStats*) getDataChannelWithDataChannelId: (NSString *)  dataChannelId

Gets a channel by its identifier.

Parameters
dataChannelIdThe channel identifier.
Deprecated:
Use GetChannel instead.

◆ init

- (instancetype) init

◆ messagesReceived

- (long long) messagesReceived

Gets the number of messages received.

◆ messagesSent

- (long long) messagesSent

Gets the number of messages sent.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchStreamStats.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonArrayWithDataStreams:

+ (NSString*) toJsonArrayWithDataStreams: (NSMutableArray *)  dataStreams

Serializes an array of data stream stats to JSON.

Parameters
dataStreamsThe data streams' stats.

◆ toJsonWithDataStream:

+ (NSString*) toJsonWithDataStream: (FMLiveSwitchDataStreamStats *)  dataStream

Serializes data stream stats to JSON.

Parameters
dataStreamThe data stream's stats.