Rate this page:

CallStats

Class that represents statistics for the ICall. Reported via ICallListener.onCallStatsReceived(ICall, CallStats) with interval specified by ClientConfig.statsCollectionInterval

Props

audioBytesReceived

Copy URL
public 

long

audioBytesReceived

Total number of audio bytes received for the call.

Returns

  • type:

    long

audioBytesSent

Copy URL
public 

long

audioBytesSent

Total number of audio bytes sent for the call.

Returns

  • type:

    long

audioLoss

Copy URL
public 

double

audioLoss

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.

Returns

  • type:

    double

audioPacketsLost

Copy URL
public 

int

audioPacketsLost

Total number of audio packets lost for the call.

Returns

  • type:

    int

audioPacketsReceived

Copy URL
public 

long

audioPacketsReceived

Total number of audio packets received for the call.

Returns

  • type:

    long

audioPacketsSent

Copy URL
public 

long

audioPacketsSent

Total number of audio packets sent for the call.

Returns

  • type:

    long

availableOutgoingBitrate

Copy URL
public 

double

availableOutgoingBitrate

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.

Returns

  • type:

    double

endpointStats

Copy URL
public 

Map<IEndpoint, EndpointStats>

endpointStats

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

Returns

localAudioStats

Copy URL
public 

Map<IAudioStream, OutboundAudioStats>

localAudioStats

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

localCandidateType

Copy URL
public 

String

localCandidateType

The type of the local ICE candidate.

Possible values:

  • "host" - A host candidate
  • "srflx" - A server reflexive candidate
  • "prflx" - A peer reflexive candidate
  • "relay" - A relay candidate

Returns

  • type:

    String

localVideoStats

Copy URL
public 

Map<IVideoStream, OutboundVideoStats>

localVideoStats

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

networkType

Copy URL
public 

String

networkType

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.

Possible values:

  • cellular - A cellular connection (e.g., EDGE, HSPA, LTE, etc.).
  • ethernet - An Ethernet connection.
  • wifi - A Wi-Fi connection.
  • wimax - A WiMAX connection.
  • vpn - The connection runs over a VPN. The underlying network type is not available.
  • unknown - The user agent is unable or unwilling to identify the underlying connection technology.

Returns

  • type:

    String

remoteCandidateType

Copy URL
public 

String

remoteCandidateType

The type of the remote ICE candidate.

Possible values:

  • "host" - A host candidate
  • "srflx" - A server reflexive candidate
  • "prflx" - A peer reflexive candidate
  • "relay" - A relay candidate

Returns

  • type:

    String

rtt

Copy URL
public 

double

rtt

The latest round trip time measured in seconds.

Returns

  • type:

    double

timestamp

Copy URL
public 

double

timestamp

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

Returns

  • type:

    double

totalBytesReceived

Copy URL
public 

long

totalBytesReceived

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

Returns

  • type:

    long

totalBytesSent

Copy URL
public 

long

totalBytesSent

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

Returns

  • type:

    long

totalLoss

Copy URL
public 

double

totalLoss

Total incoming packet loss for the call.

Returns

  • type:

    double

totalPacketsLost

Copy URL
public 

int

totalPacketsLost

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

Returns

  • type:

    int

totalPacketsReceived

Copy URL
public 

long

totalPacketsReceived

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

Returns

  • type:

    long

totalPacketsSent

Copy URL
public 

long

totalPacketsSent

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

Returns

  • type:

    long

videoBytesReceived

Copy URL
public 

long

videoBytesReceived

Total number of video bytes received for the call.

Returns

  • type:

    long

videoBytesSent

Copy URL
public 

long

videoBytesSent

Total number of video bytes sent for the call.

Returns

  • type:

    long

videoLoss

Copy URL
public 

double

videoLoss

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.

Returns

  • type:

    double

videoPacketsLost

Copy URL
public 

int

videoPacketsLost

Total number of video packets lost for the call.

Returns

  • type:

    int

videoPacketsReceived

Copy URL
public 

long

videoPacketsReceived

Total number of video packets received for the call.

Returns

  • type:

    long

videoPacketsSent

Copy URL
public 

long

videoPacketsSent

Total number of video packets sent for the call.

Returns

  • type:

    long