RTCOutboundRtpStreamStats
The RTCOutboundRtpStreamStats
dictionary of the WebRTC API is used to report metrics and statistics related to an outbound RTP stream being sent by an RTCRtpSender
.
The statistics can be obtained by iterating the RTCStatsReport
returned by RTCPeerConnection.getStats()
or RTCRtpSender.getStats()
until you find a report with the type
of outbound-rtp
.
Instance properties
averageRtcpInterval
-
A floating-point value indicating the average RTCP interval between two consecutive compound RTCP packets.
firCount
-
An integer value which indicates the total number of Full Intra Request (FIR) packets which this
RTCRtpSender
has sent to the remoteRTCRtpReceiver
. This is an indicator of how often the stream has lagged, requiring frames to be skipped in order to catch up. Valid only for video streams. framesEncoded
-
The number of frames that have been successfully encoded so far for sending on this RTP stream. Only valid for video streams.
lastPacketSentTimestamp
-
A
DOMHighResTimeStamp
indicating the time at which the last packet was sent for this SSRC. Thetimestamp
property, on the other hand, indicates the time at which theRTCOutboundRtpStreamStats
object was generated. nackCount
-
An integer value indicating the total number of Negative ACKnolwedgement (NACK) packets this
RTCRtpSender
has received from the remoteRTCRtpReceiver
. perDscpPacketsSent
-
A record of key-value pairs with strings as the keys mapped to 32-bit integer values, each indicating the total number of packets this
RTCRtpSender
has transmitted for this source for each Differentiated Services Code Point (DSCP). pliCount
-
An integer specifying the number of times the remote receiver has notified this
RTCRtpSender
that some amount of encoded video data for one or more frames has been lost, using Picture Loss Indication (PLI) packets. Only available for video streams. qpSum
-
A 64-bit value containing the sum of the QP values for every frame encoded by this
RTCRtpSender
. Valid only for video streams. qualityLimitationDurations
-
A record mapping each of the quality limitation reasons in the
RTCRemoteInboundRtpStreamStats
enumeration to a floating-point value indicating the number of seconds the stream has spent with its quality limited for that reason. qualityLimitationReason
-
One of the string
none
,cpu
,bandwidth
, orother
, explaining why the resolution and/or frame rate is being limited for this RTP stream. Valid only for video streams. remoteId
-
A string which identifies the
RTCRemoteInboundRtpStreamStats
object that provides statistics for the remote peer for this same SSRC. This ID is stable across multiple calls togetStats()
. retransmittedBytesSent
-
The total number of bytes that have been retransmitted for this source as of the time the statistics were sampled. These retransmitted bytes comprise the packets included in the value returned by
retransmittedPacketsSent
. retransmittedPacketsSent
-
The total number of packets that have needed to be retransmitted for this source as of the time the statistics were sampled. These retransmitted packets are included in the value returned by
packetsSent
. senderId
-
The
id
of theRTCAudioSenderStats
orRTCVideoSenderStats
object containing statistics about this stream'sRTCRtpSender
. sliCount
-
An integer indicating the number of times this sender received a Slice Loss Indication (SLI) frame from the remote peer, indicating that one or more consecutive video macroblocks have been lost or corrupted. Available only for video streams.
targetBitrate
-
A value indicating the bit rate the
RTCRtpSender
's codec is configured to attempt to achieve in its output media. totalEncodedBytesTarget
-
A cumulative sum of the target frame sizes (the targeted maximum size of the frame in bytes when the codec is asked to compress it) for all of the frames encoded so far. This will likely differ from the total of the actual frame sizes.
totalEncodeTime
-
A floating-point value indicating the total number of seconds that have been spent encoding the frames encoded so far by this
RTCRtpSender
. trackId
-
The
id
of theRTCSenderAudioTrackAttachmentStats
orRTCSenderVideoTrackAttachmentStats
object containing the current track attachment to theRTCRtpSender
responsible for this stream.
Common instance properties
The following properties are common to all WebRTC statistics objects.
id
-
A string that uniquely identifies the object that is being monitored to produce this set of statistics.
timestamp
-
A
DOMHighResTimeStamp
object indicating the time at which the sample was taken for this statistics object. type
-
A string with the value
"outbound-rtp"
, indicating the type of statistics that the object contains.
Examples
Specifications
Specification |
---|
Identifiers for WebRTC's Statistics API # dom-rtcstatstype-outbound-rtp |
Browser compatibility
BCD tables only load in the browser