 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
Media track stats. More...
Instance Methods | |
| (int) | - bitrate |
| Gets the bitrate. More... | |
| (void) | - deserializePropertiesWithKey:valueJson: |
| Deserializes the properties. More... | |
| (bool) | - detached |
| Gets whether the track is detached. More... | |
| (double) | - expectedFrameRate |
| Gets the expected frame rate. More... | |
| (int) | - frameHeight |
| Gets the frame height. More... | |
| (double) | - frameRate |
| Gets the number of decoded frames in the last second. More... | |
| (long long) | - framesCorrupted |
| Gets the number of corrupted frames. More... | |
| (long long) | - framesDecoded |
| Gets the number of frames decoded. More... | |
| (long long) | - framesDropped |
| Gets the number of frames dropped. More... | |
| (long long) | - framesEncoded |
| Gets the number of frames encoded. More... | |
| (long long) | - framesReceived |
| Gets the number of frames received. More... | |
| (long long) | - framesSent |
| Gets the number of frames sent. More... | |
| (int) | - frameWidth |
| Gets the frame width. More... | |
| (double) | - getMediaQualityWithAudio: |
| Gets the track's estimated media quality. More... | |
| (instancetype) | - init |
| (bool) | - isEquivalentWithInstance: |
| Checks if a track is equivalent to this one. More... | |
| (int) | - maxBitrate |
| Gets the maximum bitrate. More... | |
| (int) | - minBitrate |
| Gets the minimum bitrate. More... | |
| (bool) | - muted |
| Gets whether the track is muted. More... | |
| (NSString *) | - repairedRtpStreamId |
| Gets the first repaired RTP stream identifier. More... | |
| (NSMutableArray *) | - repairedRtpStreamIds |
| Gets the repaired RTP stream identifiers. More... | |
| (NSString *) | - rtpStreamId |
| Gets the first RTP stream identifier. More... | |
| (NSMutableArray *) | - rtpStreamIds |
| Gets the RTP stream identifiers. More... | |
| (void) | - serializePropertiesWithJsonObject: |
| Serializes the properties. More... | |
| (bool) | - stopped |
| Gets whether the track is stopped. More... | |
| (long long) | - synchronizationSource |
| Gets the first synchronization source. More... | |
| (NSMutableArray *) | - synchronizationSources |
| Gets the synchronization sources. More... | |
| (NSString *) | - toJson |
| Serializes this 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 | |
| (NSMutableArray *) | + fromJsonArrayWithMediaTracksJson: |
| Derializes an array of media track stats from JSON. More... | |
| (FMLiveSwitchMediaTrackStats *) | + fromJsonWithMediaTrackJson: |
| Derializes media track stats from JSON. More... | |
| (FMLiveSwitchMediaTrackStats *) | + mediaTrackStats |
| (NSString *) | + toJsonArrayWithMediaTracks: |
| Serializes an array of media track stats to JSON. More... | |
| (NSString *) | + toJsonWithMediaTrack: |
| Serializes media track stats to JSON. More... | |
| Class Methods inherited from FMLiveSwitchBaseStats | |
| (FMLiveSwitchBaseStats *) | + baseStats |
Media track stats.
| - (int) bitrate |
Gets the bitrate.
Set by the encoder.
Deserializes the properties.
| key | The key. |
| valueJson | The value in JSON format. |
Implements FMLiveSwitchBaseStats.
| - (bool) detached |
Gets whether the track is detached.
| - (double) expectedFrameRate |
Gets the expected frame rate.
Video-only. Set by the stream.
| - (int) frameHeight |
Gets the frame height.
Video-only. Set by the encoder or decoder.
| - (double) frameRate |
Gets the number of decoded frames in the last second.
Video-only. Set by the encoder or decoder.
| - (long long) framesCorrupted |
Gets the number of corrupted frames.
Video-only. Set by the depacketizer.
| - (long long) framesDecoded |
Gets the number of frames decoded.
Set by the decoder.
| - (long long) framesDropped |
Gets the number of frames dropped.
Video-only. Set by the depacketizer.
| - (long long) framesEncoded |
Gets the number of frames encoded.
Set by the encoder.
| - (long long) framesReceived |
Gets the number of frames received.
Set by the depacketizer.
| - (long long) framesSent |
Gets the number of frames sent.
Set by the packetizer.
| - (int) frameWidth |
Gets the frame width.
Video-only. Set by the encoder or decoder.
| + (NSMutableArray*) fromJsonArrayWithMediaTracksJson: | (NSString *) | mediaTracksJson |
Derializes an array of media track stats from JSON.
| mediaTracksJson | The media tracks' stats JSON. |
| + (FMLiveSwitchMediaTrackStats*) fromJsonWithMediaTrackJson: | (NSString *) | mediaTrackJson |
Derializes media track stats from JSON.
| mediaTrackJson | The media track's stats JSON. |
| - (double) getMediaQualityWithAudio: | (bool) | audio |
Gets the track's 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.
| audio | Whether these are audio stats. |
| - (instancetype) init |
Implements FMLiveSwitchBaseStats.
| - (bool) isEquivalentWithInstance: | (FMLiveSwitchMediaTrackStats *) | instance |
Checks if a track is equivalent to this one.
| instance | The track. |
| - (int) maxBitrate |
Gets the maximum bitrate.
Set by the encoder.
| + (FMLiveSwitchMediaTrackStats*) mediaTrackStats |
| - (int) minBitrate |
Gets the minimum bitrate.
Set by the encoder.
| - (bool) muted |
Gets whether the track is muted.
| - (NSString*) repairedRtpStreamId |
Gets the first repaired RTP stream identifier.
| - (NSMutableArray*) repairedRtpStreamIds |
Gets the repaired RTP stream identifiers.
| - (NSString*) rtpStreamId |
Gets the first RTP stream identifier.
| - (NSMutableArray*) rtpStreamIds |
Gets the RTP stream identifiers.
| - (bool) stopped |
Gets whether the track is stopped.
Set by source.
| - (long long) synchronizationSource |
Gets the first synchronization source.
| - (NSMutableArray*) synchronizationSources |
Gets the synchronization sources.
| - (NSString*) toJson |
Serializes this to JSON.
| + (NSString*) toJsonArrayWithMediaTracks: | (NSMutableArray *) | mediaTracks |
Serializes an array of media track stats to JSON.
| mediaTracks | The media tracks' stats. |
| + (NSString*) toJsonWithMediaTrack: | (FMLiveSwitchMediaTrackStats *) | mediaTrack |
Serializes media track stats to JSON.
| mediaTrack | The media track's stats. |