1. Home
3. Reference Docs
5. React Native
7. Instance Methods
9. getNetworkStats()

getNetworkStats()

getNetworkStats()

Returns the latest stats representing the current network, calculated from the WebRTC stats. These statistics are updated approximately once every two seconds. You can poll the getNetworkStats() method to continually read the current network performance.

Return type

Returns a Promise that resolves to an object with a set of the latest calculated stats, some overall call stats, and some high level assessments of the current overall network health.

If, for a given two second period, a value can not be determined, it will be set to null. This most commonly occurs for packetLoss calculations due to the values it relies upon being missing or stale, or media not being transmitted. For instance, if you join a call with audio and video off, your bitrates will be 0 and packetLoss will be null because it is unknown.

• networkState: 'good'|'warning'|'bad'|'unknown'

  an assessment of the current network quality. The threshold value is calculated from network stats averaged over an approximately 30-second rolling window. Calculations are based on send/recv packet loss, round trip times, and availableOutgoingBitrate. In prebuilt, we lower the bandwidth used for the call when the network quality drops to warning, and we turn off the local camera when the network quality drops to bad.

• networkStateReasons:

  an array of reasons for the current network state. Possible values are: 'sendPacketLoss', 'recvPacketLoss', 'roundTripTime', 'availableOutgoingBitrate'. If the networkState is 'good' or 'unknown', this field will be an empty array.

• averageNetworkRoundTripTime: average round trip time over the course of the call.

• worstAudioRecvPacketLoss: highest audioRecvPacketLoss number seen over a reporting interval during the call

• worstAudioSendPacketLoss: highest audioSendPacketLoss number seen over a reporting interval during the call

• worstVideoRecvPacketLoss: highest videoRecvPacketLoss number seen over a reporting interval during the call

• worstVideoSendPacketLoss: highest videoSendPacketLoss number seen over a reporting interval during the call

• worstVideoRecvJitter: highest videoRecvJitter value seen over a reporting interval during the call

• worstVideoSendJitter: highest videoSendJitter value seen over a reporting interval during the call

• worstAudioRecvJitter: highest audioRecvJitter value seen over a reporting interval during the call

• worstAudioSendJitter: highest audioSendJitter value seen over a reporting interval during the call

• threshold: [DEPRECATED in 0.77.0. Use networkState instead]

  'good'|'low'|'very-low', an assessment of the current network quality. The threshold value is calculated from network stats averaged over an approximately 30-second rolling window. In prebuilt, we lower the bandwidth used for the call when the network quality drops to low, and we turn off the local camera when the network quality drops to very-low.

• quality: [DEPRECATED in 0.77.0]

  a subjective calculation of the current network quality on a scale of 1-100, suitable for display in a user interface.

• latest: a collection of statistics from the most recent reporting interval, which occurs approximately once every two seconds. Below are the keys and descriptions of the values in the latest object:

Sample response