1. References
  2. IOS SDK
  3. call
  4. VICallStats
Rate this page:

VICallStats

Class that represents statistics for VICall. Reported via [VICallDelegate call:didReceiveStatistics:]

Props

audioBytesReceived

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 audioBytesReceived

Total number of audio bytes received for the call.

Returns

  • type:

    NSUInteger

audioBytesSent

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 audioBytesSent

Total number of audio bytes sent for the call.

Returns

  • type:

    NSUInteger

audioLoss

Copy URL
@property (assign, readonly, nonatomic) 
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
@property (assign, readonly, nonatomic) 
NSUInteger
 audioPacketsLost

Total number of audio packets lost for the call.

Returns

  • type:

    NSUInteger

audioPacketsReceived

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 audioPacketsReceived

Total number of audio packets received for the call.

Returns

  • type:

    NSUInteger

audioPacketsSent

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 audioPacketsSent

Total number of audio packets sent for the call.

Returns

  • type:

    NSUInteger

availableOutgoingBitrate

Copy URL
@property (assign, readonly, nonatomic) 
double
 availableOutgoingBitrate

Available outgoing bitrate calculated by the underlying congestion control by combining the available bitrate for all the outgoing RTP streams with the 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
@property (strong, readonly, nonatomic) 
NSDictionary<NSString *, VIEndpointStats *> *
endpointStats

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

Returns

localAudioStats

Copy URL
@property (strong, readonly, nonatomic) 
NSDictionary<NSString *, VIOutboundAudioStats *> *
localAudioStats

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

Returns

localCandidateType

Copy URL
@property (strong, readonly, nonatomic) 
NSString *
localCandidateType

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:

    NSString *

localVideoStats

Copy URL
@property (strong, readonly, nonatomic) 
NSDictionary<NSString *, VIOutboundVideoStats *> *
localVideoStats

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

Returns

networkType

Copy URL
@property (strong, readonly, nonatomic) 
NSString *
networkType

Type of network interface used by the base of a local candidate (the address the ICE agent sends from).

This stat only tells 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:

    NSString *

remoteCandidateType

Copy URL
@property (strong, readonly, nonatomic) 
NSString *
remoteCandidateType

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:

    NSString *

rtt

Copy URL
@property (assign, readonly, nonatomic) 
NSTimeInterval
 rtt

Represents the latest round trip time measured in seconds.

Returns

  • type:

    NSTimeInterval

timestamp

Copy URL
@property (assign, readonly, nonatomic) 
NSTimeInterval
 timestamp

Time at which the call statistics are collected, relative to the UNIX epoch (Jan 1, 1970, UTC), in microseconds.

Returns

  • type:

    NSTimeInterval

totalBytesReceived

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 totalBytesReceived

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

Returns

  • type:

    NSUInteger

totalBytesSent

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 totalBytesSent

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

Returns

  • type:

    NSUInteger

totalLoss

Copy URL
@property (assign, readonly, nonatomic) 
double
 totalLoss

Total incoming packet loss for the call.

Returns

  • type:

    double

totalPacketsLost

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 totalPacketsLost

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

Returns

  • type:

    NSUInteger

totalPacketsReceived

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 totalPacketsReceived

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

Returns

  • type:

    NSUInteger

totalPacketsSent

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 totalPacketsSent

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

Returns

  • type:

    NSUInteger

videoBytesReceived

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 videoBytesReceived

Total number of video bytes received for the call.

Returns

  • type:

    NSUInteger

videoBytesSent

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 videoBytesSent

Total number of video bytes sent for the call.

Returns

  • type:

    NSUInteger

videoLoss

Copy URL
@property (assign, readonly, nonatomic) 
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
@property (assign, readonly, nonatomic) 
NSUInteger
 videoPacketsLost

Total number of video packets lost for the call.

Returns

  • type:

    NSUInteger

videoPacketsReceived

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 videoPacketsReceived

Total number of video packets received for the call.

Returns

  • type:

    NSUInteger

videoPacketsSent

Copy URL
@property (assign, readonly, nonatomic) 
NSUInteger
 videoPacketsSent

Total number of video packets sent for the call.

Returns

  • type:

    NSUInteger