Share via


Statistics API

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

The Statistics API enables retrieval of statistics relating to RTCRtpSender, RTCRtpReceiver, RTCDtlsTransport, RTCIceGathererand RTCIceTransport objects. For detailed information on the Statistics API, consult [WEBRTC-STATS].

interface RTCStatsProvider {
    Promise<RTCStatsReport> getStats ();
};

Statistics API Members

Objects Description
RTCStatsReport The getStats() method delivers a successful result in the form of a RTCStatsReport object. A RTCStatsReport object represents a map between strings, identifying the inspected objects (RTCStats.id), and their corresponding RTCStats objects.

 

Methods Description
getStats Gathers stats for the given object and reports the result asynchronously.
msGetStats Gathers stats for the given object and reports the result asynchronously. (Microsoft-specific extension)

 

Microsoft-specific extensions

Microsoft statistics extensions enable retrieval of end-of-call statistics relating to RTCRtpSender, RTCRtpReceiver and RTCIceTransport objects.

Dictionary Description
RTCStats extension The Microsoft Edge statistics extension extends the RTCStats dictionary to support new statistics types.
MSStatsType The Microsoft statistics type.
MSIceType Contains information about the media path.
MSIceWarningFlags Contains information about the ICE process described in bit flags.
MSRelayAddress Contains IP address related information of the relay server.
MSConnectivity Contains ICE connectivity information.
MSNetworkConnectivityInfo Contains information specific to the network connection.
MSIPAddressInfo Contains information on the endpoint addresses.
MSDescription Contains basic information relating to the endpoint.
MSLocalClientEventBase Contains information about the quality events detected by the endpoint.
MSAudioLocalClientEvent Contains information about the quality events detected by the endpoint.
MSJitter Contains metrics related to jitter.
MSDelay Contains metrics related to delays.
MSPacketLoss Contains metrics related to packet loss.
MSUtilization Contains metrics related to network utilization.
MSNetwork Contains network-based metrics.
MSOutboundNetwork Contains additional information on outband bandwidth, in addition to the information provided in the MSNetwork base class.
MSPayloadBase The base object containing payload information.
MSAudioRecvSignal Contains information relating to the audio signal.
MSAudioSendSignal Contains information relating to the audio signal being sent.
MSAudioSendPayload Contains information relating to audio payloads being sent.
MSVideoResolutionDistribution Contains metrics representing the distribution of video resolutions.
MSVideoPayload Contains information about video-based payload metrics.
MSVideoSendPayload Contains information relating to video-based payload metrics.
MSIceAddrType Describes how an ICE candidate was obtained.
MSNetworkInterfaceType Contains information on interface types disabled by browser privacy policy.
MSTransportDiagnosticsStats Contains metrics relating to connectivity.
MSAudioRecvPayload Contains information relating to audio reception.
MSVideoRecvPayload Contains information relating to incoming video.

 

Members