diff --git a/webrtc-stats.html b/webrtc-stats.html index 4ba83cdd..8da1a409 100644 --- a/webrtc-stats.html +++ b/webrtc-stats.html @@ -452,7 +452,9 @@
@@ -670,12 +672,21 @@
stunserverconnection
+ ice-server
+
+ Information about the connection to an ICE server (e.g. STUN or TURN). It is accessed by the
+ RTCIceServerStats.
+
encoding-parameters
- Information about the connection to a STUN or TURN server. It is accessed by the
- RTCStunServerConnectionStats.
+ Information about RTP encodings of media. It is accessed by the
+ RTCEncodingParameterStats.
+ The metrics exposed here correspond to local measurements and those reported by RTCP packets. + Compound RTCP packets contain multiple RTCP report blocks, such as Sender Report (SR) and + Receiver Report (RR). Wheras, a non-compound RTCP packets may contain just a single + RTCP SR or RR block. +
The lifetime of all RTP monitored objects starts when the RTP stream is first used: When the first RTP packet is sent or received on the SSRC it represents, or when @@ -712,7 +729,7 @@
RTCReceivedRtpStreamStats: Stats measured at the receiving end of an RTP stream, known either because they're measured locally or transmitted via an RTCP - Receiver Report (RR) or Extended Report (XR). + Receiver Report (RR) or Extended Report (XR) block.
RTCRemoteInboundRtpStreamStats: Stats relevant to the remote receiving end of an RTP stream - usually computed by combining local data with data received - via an RTCP RR or XR. + via an RTCP RR or XR block.
dictionary RTCCodecStats : RTCStats {
- unsigned long payloadType;
+ octet payloadType;
RTCCodecType codecType;
DOMString transportId;
DOMString mimeType;
@@ -833,8 +850,7 @@
-
-
payloadType of type unsigned
- long
+ payloadType of type octet
-
@@ -965,6 +981,9 @@
double burstDiscardRate;
double gapLossRate;
double gapDiscardRate;
+ unsigned long framesDropped;
+ unsigned long partialFramesLost;
+ unsigned long fullFramesLost;
};
framesDropped of type unsigned
+ long
+ + Only valid for video. The total number of frames dropped prior to decode or dropped + because the frame missed its display deadline for this receiver's track. The measurement + begins when the receiver is created and is a cumulative metric as defined in + Appendix A (g) of [[!RFC7004]]. +
+partialFramesLost of type unsigned long
+ + Only valid for video. The cumulative number of partial frames lost. The measurement + begins when the receiver is created and is a cumulative metric as defined in + Appendix A (j) of [[!RFC7004]]. This metric is incremented when the frame is sent + to the decoder. If the partial frame is received and recovered via retransmission + or FEC before decoding, the framesReceived counter is incremented. +
+fullFramesLost of type unsigned
+ long
+ + Only valid for video. The cumulative number of full frames lost. The measurement + begins when the receiver is created and is a cumulative metric as defined in + Appendix A (i) of [[!RFC7004]]. +
+The average RTCP interval between two consecutive compound RTCP packets. This is calculated by the sending endpoint when sending compound RTCP reports. Compound - packets must contain at least a RTCP RR or SR packet and an SDES packet with the + packets must contain at least a RTCP RR or SR block and an SDES packet with the CNAME item.
@@ -1646,39 +1698,6 @@framesDropped of type unsigned
- long
- - Only valid for video. The total number of frames dropped prior to decode or dropped - because the frame missed its display deadline for this receiver's track. As defined - in Appendix A (g) of [[!RFC7004]]. -
-partialFramesLost of type unsigned long
- - Only valid for video. The cumulative number of partial frames lost, as defined in - Appendix A (j) of [[!RFC7004]]. This metric is incremented when the frame is sent - to the decoder. If the partial frame is received and recovered via retransmission - or FEC before decoding, the framesReceived counter is incremented. -
-fullFramesLost of type unsigned
- long
- - Only valid for video. The cumulative number of full frames lost, as defined in - Appendix A (i) of [[!RFC7004]]. -
-decoderImplementation of type DOMString
@@ -1762,10 +1781,7 @@ dictionary RTCSentRtpStreamStats : RTCRtpStreamStats {
unsigned long packetsSent;
- unsigned long packetsDiscardedOnSend;
- unsigned long fecPacketsSent;
unsigned long long bytesSent;
- unsigned long long bytesDiscardedOnSend;
};
packetsDiscardedOnSend of type unsigned long
- - Total number of RTP packets for this SSRC that have been discarded due to socket - errors, i.e. a socket error occured when handing the packets to the socket. This - might happen due to various reasons, including full buffer or no available - memory. -
-fecPacketsSent of type unsigned
- long
- - Total number of RTP FEC packets sent for this SSRC. This counter can also be - incremented when sending FEC packets in-band with media packets (e.g., with - Opus). -
-bytesSent of type unsigned long
long
@@ -1816,18 +1809,6 @@ bytesDiscardedOnSend of type unsigned long long
- - Total number of bytes for this SSRC that have been discarded due to socket - errors, i.e. a socket error occured when handing the packets containing the bytes - to the socket. This might happen due to various reasons, including full buffer or - no available memory. Calculated as defined in [[!RFC3550]] section 6.4.1. -
-packetsDiscardedOnSend of type unsigned long
+ + Total number of RTP packets for this SSRC that have been discarded due to socket + errors, i.e. a socket error occured when handing the packets to the socket. This + might happen due to various reasons, including full buffer or no available + memory. +
+bytesDiscardedOnSend of type unsigned long long
+ + Total number of bytes for this SSRC that have been discarded due to socket + errors, i.e. a socket error occured when handing the packets containing the bytes + to the socket. This might happen due to various reasons, including full buffer or + no available memory. Calculated as defined in [[!RFC3550]] section 6.4.1. +
+fecPacketsSent of type unsigned
+ long
+ + Total number of RTP FEC packets sent for this SSRC. This counter can also be + incremented when sending FEC packets in-band with media packets (e.g., with + Opus). +
+retransmittedPacketsSent of type unsigned long long
@@ -2059,6 +2079,18 @@ framesDiscardedOnSend of type unsigned long
+ + Total number of video frames that have been discarded for this SSRC due to socket + errors, i.e. a socket error occured when handing the packets to the socket. This + might happen due to various reasons, including full buffer or no available + memory. +
+qpSum of type unsigned long
long
@@ -2135,7 +2167,7 @@ The average RTCP interval between two consecutive compound RTCP packets. This is calculated by the sending endpoint when sending compound RTCP reports. Compound - packets must contain at least a RTCP RR or SR packet and an SDES packet with the + packets must contain at least a RTCP RR or SR block and an SDES packet with the CNAME item.
@@ -3671,6 +3703,8 @@packetsDiscardedOnSend of type unsigned long
+ + Total number of packets for this candidate pair that have been discarded due to socket + errors, i.e. a socket error occured when handing the packets to the socket. This + might happen due to various reasons, including full buffer or no available + memory. +
+bytesDiscardedOnSend of type unsigned long long
+ + Total number of bytes for this candidate pair that have been discarded due to socket + errors, i.e. a socket error occured when handing the packets containing the bytes + to the socket. This might happen due to various reasons, including full buffer or + no available memory. Calculated as defined in [[!RFC3550]] section 6.4.1. +
+dictionary RTCStunServerConnectionStats : RTCStats {
+ dictionary RTCIceServerStats : RTCStats {
DOMString url;
long port;
DOMString protocol;
@@ -4138,16 +4196,16 @@
};
- Dictionary RTCStunServerConnectionStats Members
+ Dictionary RTCIceServerStats Members
-
+
-
url of type DOMString
-
- The URL of the TURN or STUN server.
+ The URL of the ICE server (e.g. TURN or STUN server).
-
@@ -4209,6 +4267,331 @@
dictionary RTCEncodingParameterStats : RTCStats {
+ DOMString rid;
+ octet payloadType;
+ boolean active;
+ unsigned long ptime;
+ unsigned long maxBitrate;
+ double maxFramerate;
+ double scaleResolutionDownBy;
+ sequence<DOMString> scalabilityModes;
+ };
+ rid of type DOMString
+ + Restriction Identifier(rid) of the encoding. +
+payloadType of type octet
+ + Payload type as used in RTP encoding. +
+active of type boolean
+ + Indicates that this encoding is actively being sent or not sent. +
+ptime of type unsigned long
+ + Indicates the preferred duration of media represented by a packet in milliseconds for this encoding. + Typically, this is only relevant for audio encoding. +
+maxBitrate of type unsigned long
+ + Indicates the maximum bitrate that can be used by this encoding. +
+maxFramerate of type double
+ + Indicates the maximum framerate that can be used by this encoding. +
+scaleResolutionDownBy of type double
+ + The video's resolution will be scaled down in each dimension by the given value. +
+scalabilityModes of type DOMString
+ Scalability mode identifiers and characteristics are indicated in the table below, which is based + on the pre-defined scalability modes in [[AV1]] Section 6.7.5.
+| Scalability Mode | +Spatial Layers | +Resolution Ratio | +Temporal Layers | +Inter-layer dependency | +
|---|---|---|---|---|
| L1T2 | +1 | ++ | 2 | ++ |
| L1T3 | +1 | ++ | 3 | ++ |
| L2T1 | +2 | +2:1 | +1 | +Yes | +
| L2T2 | +2 | +2:1 | +2 | +Yes | +
| L2T3 | +2 | +2:1 | +3 | +Yes | +
| L3T1 | +3 | +2:1 | +1 | +Yes | +
| L3T2 | +3 | +2:1 | +2 | +Yes | +
| L3T3 | +3 | +2:1 | +3 | +Yes | +
| L2T1h | +2 | +1.5:1 | +1 | +Yes | +
| L2T2h | +2 | +1.5:1 | +2 | +Yes | +
| L2T3h | +2 | +1.5:1 | +3 | +Yes | +
| S2T1 | +2 | +2:1 | +1 | +No | +
| S2T2 | +2 | +2:1 | +2 | +No | +
| S2T3 | +2 | +2:1 | +3 | +No | +
| S2T1h | +2 | +1.5:1 | +1 | +No | +
| S2T2h | +2 | +1.5:1 | +2 | +No | +
| S2T3h | +2 | +1.5:1 | +3 | +No | +
| S3T1 | +3 | +2:1 | +1 | +No | +
| S3T2 | +3 | +2:1 | +2 | +No | +
| S3T3 | +3 | +2:1 | +3 | +No | +
| S3T1h | +3 | +1.5:1 | +1 | +No | +
| S3T2h | +3 | +1.5:1 | +2 | +No | +
| S3T3h | +3 | +1.5:1 | +3 | +No | +
| L3T2_KEY | +3 | +2:1 | +2 | +Yes | +
| L3T3_KEY | +3 | +2:1 | +3 | +Yes | +
| L4T5_KEY | +4 | +2:1 | +5 | +Yes | +
| L4T7_KEY | +4 | +2:1 | +7 | +Yes | +
| L3T2_KEY_SHIFT | +3 | +2:1 | +2 | +Yes | +
| L3T3_KEY_SHIFT | +3 | +2:1 | +3 | +Yes | +
| L4T5_KEY_SHIFT | +4 | +2:1 | +5 | +Yes | +
| L4T7_KEY_SHIFT | +4 | +2:1 | +7 | +Yes | +