Rate this page:

CallStats

Statistics for a Call. Reported in a handler function for CallEvents.CallStatsReceived.

Props

audioBytesReceived

Optional
Copy URL
audioBytesReceived: 

number

Total number of audio bytes received for the call.

audioBytesSent

Optional
Copy URL
audioBytesSent: 

number

Total number of audio bytes sent for the call.

audioLoss

Optional
Copy URL
audioLoss: 

number

Total packet loss in the audio stream(s) related to the call session. Values are in the range 0..1, where 0 means no loss and 1 means full loss.

audioPacketsLost

Optional
Copy URL
audioPacketsLost: 

number

Total number of audio packets lost for the call.

audioPacketsReceived

Optional
Copy URL
audioPacketsReceived: 

number

Total number of audio packets received for the call.

audioPacketsSent

Optional
Copy URL
audioPacketsSent: 

number

Total number of audio packets sent for the call.

availableOutgoingBitrate

Optional
Copy URL
availableOutgoingBitrate: 

number

It is calculated by the underlying congestion control by combining the available bitrate for all the outgoing RTP streams using a current selected candidate pair. It is measured in bits per second and the bitrate is calculated over a 1 second window. Only in Chrome

endpointStats

Optional
Copy URL
endpointStats: 

Map<string, EndpointStats>

Statistics for endpoints existing in the call at the moment of the stats collection.

localAudioStats

Optional
Copy URL
localAudioStats: 

Map<string, OutboundAudioStats>

Statistics for all active outgoing audio streams of the call at the moment of the stats collection.

localCandidateType

Optional
Copy URL
localCandidateType: 

string

The type of the local ICE candidate. Only in Chrome and Firefox

localVideoStats

Optional
Copy URL
localVideoStats: 

Map<string, OutboundVideoStats>

Statistics for all active outgoing video streams of the call at the moment of the stats collection.

networkType

Optional
Copy URL
networkType: 

string

The type of network interface used by the base of a local candidate (the address the ICE agent sends from). This stat only tells you about the network interface used by the first "hop"; it's possible that a connection will be bottlenecked by another type of network. For example, when using Wi-Fi tethering, the networkType of the relevant candidate would be "wifi", even when the next hop is over a cellular connection. Only in Chrome and Firefox

remoteCandidateType

Optional
Copy URL
remoteCandidateType: 

string

The type of the remote ICE candidate. Only in Chrome and Firefox

rtt

Optional
Copy URL
rtt: 

number

The latest round trip time measured in seconds. Only in Chrome

timestamp

Optional
Copy URL
timestamp: 

number

The time at which the call statistics are collected (in UNIX timestamp format, microseconds).

totalBytesReceived

Optional
Copy URL
totalBytesReceived: 

number

Total number of bytes (audio and video) received in the call.

totalBytesSent

Optional
Copy URL
totalBytesSent: 

number

Total number of bytes (audio and video) sent in the call.

totalLoss

Optional
Copy URL
totalLoss: 

number

Total incoming packet loss for the call.

totalPacketsLost

Optional
Copy URL
totalPacketsLost: 

number

Total number of incoming packets lost (audio and video) in the call.

totalPacketsReceived

Optional
Copy URL
totalPacketsReceived: 

number

Total number of packets (audio and video) received in the call.

totalPacketsSent

Optional
Copy URL
totalPacketsSent: 

number

Total number of packets (audio and video) sent in the call.

videoBytesReceived

Optional
Copy URL
videoBytesReceived: 

number

Total number of video bytes received for the call.

videoBytesSent

Optional
Copy URL
videoBytesSent: 

number

Total number of video bytes sent for the call.

videoLoss

Optional
Copy URL
videoLoss: 

number

Total packet loss in the video stream(s) related to the call session. Values are in the range 0..1, where 0 means no loss and 1 means full loss.

videoPacketsLost

Optional
Copy URL
videoPacketsLost: 

number

Total number of video packets lost for the call.

videoPacketsReceived

Optional
Copy URL
videoPacketsReceived: 

number

Total number of video packets received for the call.

videoPacketsSent

Optional
Copy URL
videoPacketsSent: 

number

Total number of video packets sent for the call.