RTCStatsType

The RTCStatsType enumerated type (enum) is a set of strings which define the type of statistics reported in an RTCStats object.

Values

"candidate-pair"
An RTCIceCandidatePairStats object providing statistics related to an RTCIceTransport. Candidate pairs other than the currently active pair for the transport are deleted when the RTCPeerCandidate changes its RTCPeerConnection.iceGatheringState to "new" during an ICE restart. The active candidate pair is deleted after the transport switches to another candidate pair; this change cannot be detected otherwise.
"certificate"
An RTCCertificateStats object providing statistics related to a certificate being used by an RTCIceTransport.
"codec"
An RTCCodecStats object containing statistics about a codec currently being used by RTP streams to send or receive data for the RTCPeerConnection.
"csrc"
An RTCContributingSourceStats object which contains statistics related to a contributing source (CSRC) that contributed to an inbound RTP stream.
"data-channel"
An RTCDataChannelStats object which contains statistics about each RTCDataChannel on the connection.
"inbound-rtp"
Statistics about an inbound RTP stream that's currently in use by this RTCPeerConnection, in an RTCInboundRtpStreamStats object.
"local-candidate"
An RTCIceCandidateStats object giving statistics about an ICE local candidate; these candidates are found in the output from RTCIceTransport.getLocalCandidates().
"outbound-rtp"
An RTCOutboundRtpStreamStats object giving statistics about an outbound RTP stream being sent from the RTCPeerConnection.
"peer-connection"
A RTCPeerConnectionStats object provides statistics related to the overall peer connection's RTCPeerConnection.
"receiver"
Provides statistics about a specific RTCRtpReceiver. The statistics object is an RTCAudioReceiverStats object if kind is "audio"; if kind is "video", the object is an RTCVideoReceiverStats object.
"remote-candidate"
The object is an RTCIceCandidateStats object containing statistics about the remote candidate's RTCIceTransport. This may include information such as the type of network, the protocol, the URL, the type of relay being used, and so forth.
"remote-inbound-rtp"
Contains statistics about the remote endpoint's inbound RTP stream; that stream corresponds to the local endpoint's outbound RTP stream. Using this RTCRemoteInboundRtpStreamStats object, you can learn how the well the remote peer is receiving data.
"remote-outbound-rtp"
An RTCRemoteOutboundRtpStreamStats object that contains information about the RTCRtpSender on the remote peer that corresponds to an RTCRtpReceiver on the local peer. This lets you measure statistics at the remote endpoint.
"sender"
An object containing statistics about the RTCRtpSender for a stream on the RTCPeerConnection. If kind is "audio", this object is of type RTCAudioSenderStats; if kind is "video", this is an RTCVideoSenderStats object.
"stream"
An object of type RTCMediaStreamStats, providing statistics and information about a MediaStream which is part of the RTCPeerConnection.
"track"
The object is one of the types based on RTCMediaHandlerStats: for audio tracks, the type is RTCSenderAudioTrackAttachmentStats and for video tracks, the type is RTCSenderVideoTrackAttachmentStats. The data within provides statistics related to a particular MediaStreamTrack's attachment to an RTCRtpSender; also included are the media level metrics that go along with the track.
"transport"
An object that contains statistics related to a transport for an RTCPeerConnection. The object is of type RTCTransportStats.

Specifications

Specification Status Comment
Identifiers for WebRTC's Statistics API
The definition of 'RTCStatsType' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

No compatibility data found. Please contribute data for "api.RTCStatsType" (depth: 1) to the MDN compatibility data repository.

Document Tags and Contributors

Contributors to this page: Sheppy
Last updated by: Sheppy,