Rate this page:

ConferenceStats

Methods

toString

Copy URL
fun toString(): 

String

This API is in beta and subject to change.

Returns a string representation of the object.

Returns

  • type:

    String

clone

Copy URL
@Throws
fun clone():

Any

Returns

  • type:

    Any

Props

timestamp

Copy URL
var timestamp: 

Double

This API is in beta and subject to change.

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

Returns

  • type:

    Double

networkType

Copy URL
var networkType: 

String?

This API is in beta and subject to change.

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 is possible that a connection is 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?

rtt

Copy URL
var rtt: 

Double

This API is in beta and subject to change.

The latest round trip time measured in seconds.

Returns

  • type:

    Double

availableOutgoingBitrate

Copy URL
var availableOutgoingBitrate: 

Double

This API is in beta and subject to change.

Available outgoing bitrate 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

localCandidateType

Copy URL
var localCandidateType: 

CandidateType?

This API is in beta and subject to change.

The type of the local ICE candidate.

Returns

remoteCandidateType

Copy URL
var remoteCandidateType: 

CandidateType?

This API is in beta and subject to change.

The type of the remote ICE candidate.

Returns

localAudioStats

Copy URL
var localAudioStats: 

Map<LocalAudioStream, OutboundAudioStats>?

This API is in beta and subject to change.

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

localVideoStats

Copy URL
var localVideoStats: 

Map<LocalVideoStream, OutboundVideoStats>?

This API is in beta and subject to change.

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

endpointStats

Copy URL
var endpointStats: 

Map<Endpoint, EndpointStats>?

Returns