SubscriberKit.SubscriberVideoStats

public static class SubscriberVideoStats

Enclosing class: SubscriberKit

Defines video statistics for a subscriber.

Nested types: SubscriberKit.SubscriberVideoStats.SenderQualityRestriction

Properties

Name Type Description
videoPacketsLost int The total number of video packets lost by the subscriber.
videoPacketsReceived int The total number of video packets received by the subscriber.
videoBytesReceived int The total number of video bytes received by the subscriber.
timeStamp double The timestamp, in milliseconds since the Unix epoch, for when these stats were gathered.
senderStats SubscriberKit.SenderStats Deprecated: Use subscriber media link stats (SubscriberMediaLinkStats) instead for complete network metrics including remote publisher transport and network degradation source information. Sender-side network estimation stats. This may be null if stats are not available. Due to network latency, sender statistics may not be immediately available after the initial stats request.
width int The width of the video frame, in pixels.
height int The height of the video frame, in pixels.
decodedFrameRate double The decoded video frame rate (in frames per second)
bitrate long The bitrate, in bits per second.
totalBitrate long The total bitrate (including RTP headers, padding, and payload).
pauseCount long Number of times the subscriber’s video playback has paused. Video is considered paused if the time since the last rendered frame exceeds 5 seconds.
totalPausesDuration long Cumulative duration (in milliseconds) of all video pauses.
freezeCount long Number of times the subscriber’s video has frozen. A freeze is defined according to https://www.w3.org/TR/webrtc-stats/#dom-rtcinboundrtpstreamstats-freezecount
totalFreezesDuration long Cumulative duration (in milliseconds) of all video freezes.
codec String Codec used for the video stream. This value may be null if the information is not available.
senderQualityRestriction int Indicates any sender-imposed video quality restrictions affecting the stream, if any. This reflects limitations applied at the current sending hop (e.g., the Media Router or direct publisher in a P2P topology). May be limited if sender-side stats are disabled.
remotePublisherQualityRestriction int Indicates any remote sender-imposed video quality restrictions affecting the stream, if any. This reflects limitations applied by the upstream originating publisher that ultimately affect the received stream quality. May be limited if sender-side stats are disabled.
QUALITY_RESTRICTION_UNKNOWN int static final Constant value: 0
QUALITY_RESTRICTION_NONE int static final Constant value: 1
QUALITY_RESTRICTION_SPATIAL int static final Constant value: 2
QUALITY_RESTRICTION_TEMPORAL int static final Constant value: 3
QUALITY_RESTRICTION_SPATIAL_AND_TEMPORAL int static final Constant value: 4