RTCRemoteOutboundRtpStreamStats
BaselineWidely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since May 2021.
* Some parts of this feature may have varying levels of support.
TheRTCRemoteOutboundRtpStreamStats
dictionary of theWebRTC API is used to report statistics from a remote endpoint about its outbound RTP stream.This will correspond to an inbound stream that is currently being received by the localRTCPeerConnection
object.
The statistics can be obtained by iterating theRTCStatsReport
returned byRTCPeerConnection.getStats()
until you find a report with thetype
ofremote-outbound-rtp
.
Instance properties
Remote outbound specific statistics
localId
OptionalA string which is used to find the local
RTCInboundRtpStreamStats
object that shares the samesynchronization source (SSRC).remoteTimestamp
OptionalA
DOMHighResTimeStamp
specifying the timestamp (on the remote device) at which the statistics in theRTCRemoteOutboundRtpStreamStats
object were sent by the remote endpoint. This is different from thetimestamp
; it represents the time at which the object's statistics were received or generated by the local endpoint.reportsSent
OptionalExperimentalA positive integer indicating the total number ofRTCP Sender Report (SR) blocks sent for thissynchronization source (SSRC).
roundTripTimeMeasurements
OptionalExperimentalA positive number that represents the total number of valid round trip time measurements received for thissynchronization source (SSRC).
totalRoundTripTime
OptionalExperimentalA number indicating the cumulative sum of all round trip time measurements since the beginning of the session, in seconds.The average round trip time can be computed by dividing
totalRoundTripTime
byroundTripTimeMeasurements
.
Sent RTP stream statistics
bytesSent
OptionalA positive integer indicating the total number of bytes sent for this SSRC, including retransmissions.
packetsSent
OptionalA positive integer indicating the total number of RTP packets sent for this SSRC, including retransmissions.
Common RTP stream statistics
codecId
OptionalA string that uniquely identifies the object that was inspected to produce the
RTCCodecStats
report associated with thisRTP stream.kind
A string indicating whether the
MediaStreamTrack
associated with the stream is an audio or a video track.ssrc
A positive integer that identifies the synchronization source (SSRC) of the RTP packets in this stream.
transportId
OptionalA string that uniquely identifies the object that was inspected to produce the
RTCTransportStats
report associated with this RTP 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
"remote-outbound-rtp"
, indicating the type of statistics that the object contains.
Usage notes
TheRTCRemoteOutboundRtpStreamStats
object'sremoteTimestamp
property provides statistics based on the received data's NTP timestamp taken from anRTCP Sender Report (SR) block.Be aware that the remote clock may not be synchronized with the local clock (either in current time or speed at which time elapses).
Specifications
Specification |
---|
Identifiers for WebRTC's Statistics API # dom-rtcstatstype-remote-outbound-rtp |