 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
Connection stats. More...
Instance Methods | |
| (double) | - audioMediaQuality |
| Gets the audio streams' minimum estimated media quality. More... | |
| (double) | - audioNetworkQuality |
| Gets the audio streams' minimum estimated network quality. More... | |
| (double) | - audioReceiverNetworkScore |
| Gets the audio receiver streams' estimated network score. More... | |
| (FMLiveSwitchMediaStreamStats *) | - audioStream |
| Gets the first audio stream's stats. More... | |
| (NSMutableArray *) | - audioStreams |
| Gets the audio streams' stats. More... | |
| (FMLiveSwitchDataStreamStats *) | - dataStream |
| Gets the data stream's stats. More... | |
| (void) | - deserializePropertiesWithKey:valueJson: |
| Deserializes the properties. More... | |
| (NSString *) | - externalId |
| Gets the external identifier. More... | |
| (FMLiveSwitchMediaStreamStats *) | - getMediaStreamWithMediaStreamId: |
| Gets a media stream by its identifier. More... | |
| (instancetype) | - init |
| (bool) | - isHost |
| Gets whether any of the streams are using a transport whose active candidate pair has a host candidate. More... | |
| (bool) | - isReflexive |
| Gets whether any of the streams are using a transport whose active candidate pair has a reflexive candidate. More... | |
| (bool) | - isRelayed |
| Gets whether any of the streams are using a transport whose active candidate pair has a relayed candidate. More... | |
| (double) | - mediaQuality |
| Gets the connection's estimated media quality as the minimum of the audioMediaQuality and the videoMediaQuality. More... | |
| (FMLiveSwitchMediaStreamStats *) | - mediaStream |
| Gets the first media stream's stats. More... | |
| (NSMutableArray *) | - mediaStreams |
| Gets the media streams' stats. More... | |
| (double) | - networkQuality |
| Gets the connection's estimated network quality as the minimum of the audioNetworkQuality and the videoNetworkQuality. More... | |
| (double) | - receiverNetworkScore |
| Gets the connection's estimated network score as the minimum of the audioReceiverNetworkScore and the videoReceiverNetworkScore. More... | |
| (void) | - serializePropertiesWithJsonObject: |
| Serializes the properties. More... | |
| (void) | - setExternalId: |
| Sets the external identifier. More... | |
| (void) | - setState: |
| Sets the state. More... | |
| (FMLiveSwitchConnectionState) | - state |
| Gets the state. More... | |
| (NSMutableArray *) | - streams |
| Gets the streams' stats. More... | |
| (NSString *) | - toJson |
| Serializes this to JSON. More... | |
| (double) | - videoMediaQuality |
| Gets the video streams' minimum estimated media quality. More... | |
| (double) | - videoNetworkQuality |
| Gets the video streams' minimum estimated network quality. More... | |
| (double) | - videoReceiverNetworkScore |
| Gets the video receiver streams' estimated network score. More... | |
| (FMLiveSwitchMediaStreamStats *) | - videoStream |
| Gets the first video stream's stats. More... | |
| (NSMutableArray *) | - videoStreams |
| Gets the video streams' stats. 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 | |
| (FMLiveSwitchConnectionStats *) | + connectionStats |
| (FMLiveSwitchConnectionStats *) | + fromJsonWithConnectionJson: |
| Derializes connection stats from JSON. More... | |
| (NSString *) | + toJsonWithConnection: |
| Serializes connection stats to JSON. More... | |
| Class Methods inherited from FMLiveSwitchBaseStats | |
| (FMLiveSwitchBaseStats *) | + baseStats |
Connection stats.
| - (double) audioMediaQuality |
Gets the audio streams' minimum estimated media quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.
| - (double) audioNetworkQuality |
Gets the audio streams' minimum estimated network quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.
| - (double) audioReceiverNetworkScore |
Gets the audio receiver streams' estimated network score.
The value ranges from 1.0 to 5.0, where 1.0 is the lowest score and 5.0 is the highest score.
| - (FMLiveSwitchMediaStreamStats*) audioStream |
Gets the first audio stream's stats.
| - (NSMutableArray*) audioStreams |
Gets the audio streams' stats.
| + (FMLiveSwitchConnectionStats*) connectionStats |
| - (FMLiveSwitchDataStreamStats*) dataStream |
Gets the data stream's stats.
Deserializes the properties.
| key | The key. |
| valueJson | The value in JSON format. |
Implements FMLiveSwitchBaseStats.
| - (NSString*) externalId |
Gets the external identifier.
| + (FMLiveSwitchConnectionStats*) fromJsonWithConnectionJson: | (NSString *) | connectionJson |
Derializes connection stats from JSON.
| connectionJson | The connection's stats JSON. |
| - (FMLiveSwitchMediaStreamStats*) getMediaStreamWithMediaStreamId: | (NSString *) | mediaStreamId |
Gets a media stream by its identifier.
| mediaStreamId | The media stream identifier. |
| - (instancetype) init |
Implements FMLiveSwitchBaseStats.
| - (bool) isHost |
Gets whether any of the streams are using a transport whose active candidate pair has a host candidate.
| - (bool) isReflexive |
Gets whether any of the streams are using a transport whose active candidate pair has a reflexive candidate.
| - (bool) isRelayed |
Gets whether any of the streams are using a transport whose active candidate pair has a relayed candidate.
| - (double) mediaQuality |
Gets the connection's estimated media quality as the minimum of the audioMediaQuality and the videoMediaQuality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.
| - (FMLiveSwitchMediaStreamStats*) mediaStream |
Gets the first media stream's stats.
| - (NSMutableArray*) mediaStreams |
Gets the media streams' stats.
| - (double) networkQuality |
Gets the connection's estimated network quality as the minimum of the audioNetworkQuality and the videoNetworkQuality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.
| - (double) receiverNetworkScore |
Gets the connection's estimated network score as the minimum of the audioReceiverNetworkScore and the videoReceiverNetworkScore.
The value ranges from 1.0 to 5.0, where 1.0 is the lowest score and 5.0 is the highest score.
| - (void) setExternalId: | (NSString *) | value |
Sets the external identifier.
| - (void) setState: | (FMLiveSwitchConnectionState) | value |
Sets the state.
| - (FMLiveSwitchConnectionState) state |
Gets the state.
| - (NSMutableArray*) streams |
Gets the streams' stats.
| - (NSString*) toJson |
Serializes this to JSON.
| + (NSString*) toJsonWithConnection: | (FMLiveSwitchConnectionStats *) | connection |
Serializes connection stats to JSON.
| connection | The connection's stats. |
| - (double) videoMediaQuality |
Gets the video streams' minimum estimated media quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.
| - (double) videoNetworkQuality |
Gets the video streams' minimum estimated network quality.
The value ranges from 0.0 to 1.0, where 0.0 is the lowest quality and 1.0 is the highest quality.
| - (double) videoReceiverNetworkScore |
Gets the video receiver streams' estimated network score.
The value ranges from 1.0 to 5.0, where 1.0 is the lowest score and 5.0 is the highest score.
| - (FMLiveSwitchMediaStreamStats*) videoStream |
Gets the first video stream's stats.
| - (NSMutableArray*) videoStreams |
Gets the video streams' stats.