TVIIceCandidatePairStats Class Reference

Inherits from NSObject
Declared in TVIIceCandidatePairStats.h

Overview

TVIIceCandidatePairStats reflects the properties of a Ice candidate pair

  activeCandidatePair

A boolean to indicate if the candidate pair is active.

@property (nonatomic, assign, readonly, getter=isActiveCandidatePair) BOOL activeCandidatePair

Declared In

TVIIceCandidatePairStats.h

  relayProtocol

The relay protocol.

@property (nonatomic, copy, readonly, nullable) NSString *relayProtocol

Declared In

TVIIceCandidatePairStats.h

  transportId

The unique identifier used for TVIIceCandidateStats associated with this candidate.

@property (nonatomic, copy, readonly, nullable) NSString *transportId

Declared In

TVIIceCandidatePairStats.h

  localCandidateId

The unique identifier that is associated to the object that was inspected to produce the Ice candidate attributes for the local candidate associated with this candidate pair.

@property (nonatomic, copy, readonly, nullable) NSString *localCandidateId

Declared In

TVIIceCandidatePairStats.h

  localCandidateIp

The IP address of the local candidate associated with this candidate pair.

@property (nonatomic, copy, readonly, nullable) NSString *localCandidateIp

Declared In

TVIIceCandidatePairStats.h

  remoteCandidateId

The unique identifier that is associated to the object that was inspected to produce the Ice candidate attributes for the remote candidate associated with this candidate pair.

@property (nonatomic, copy, readonly, nullable) NSString *remoteCandidateId

Declared In

TVIIceCandidatePairStats.h

  remoteCandidateIp

The IP address of the remote candidate associated with this candidate pair.

@property (nonatomic, copy, readonly, nullable) NSString *remoteCandidateIp

Declared In

TVIIceCandidatePairStats.h

  state

Represents the state of the checklist for the local and remote candidates in a pair.

@property (nonatomic, assign, readonly) TVIIceCandidatePairState state

Declared In

TVIIceCandidatePairStats.h

  priority

The priority of the candidate. Priority is calculated as defined in [RFC5245] section 15.1.

@property (nonatomic, assign, readonly) uint64_t priority

Declared In

TVIIceCandidatePairStats.h

  nominated

This booean is related to updating the nominated flag described in Section 7.1.3.2.4 of [ RFC5245].

@property (nonatomic, assign, readonly, getter=isNominated) BOOL nominated

Declared In

TVIIceCandidatePairStats.h

  writable

Has gotten ACK to an ICE request.

@property (nonatomic, assign, readonly, getter=isWritable) BOOL writable

Declared In

TVIIceCandidatePairStats.h

  readable

Has gotten a valid incoming ICE request.

@property (nonatomic, assign, readonly, getter=isReadable) BOOL readable

Declared In

TVIIceCandidatePairStats.h

  bytesSent

Represents the total number of payload bytes sent on this candidate pair, i.e., not including headers or padding.

@property (nonatomic, assign, readonly) uint64_t bytesSent

Declared In

TVIIceCandidatePairStats.h

  bytesReceived

Represents the total number of payload bytes received on this candidate pair, i.e., not including headers or padding.

@property (nonatomic, assign, readonly) uint64_t bytesReceived

Declared In

TVIIceCandidatePairStats.h

  totalRoundTripTime

Total round trip time.

@property (nonatomic, assign, readonly) CFTimeInterval totalRoundTripTime

Discussion

Represents the sum of all round trip time measurements in seconds since the beginning of the session, based on both STUN connectivity check [ STUN-PATH-CHAR] responses (responsesReceived) and consent [ RFC7675] responses (consentResponsesReceived). The average round trip time can be computed from totalRoundTripTime by dividing it by (responsesReceived + consentResponsesReceived).

Declared In

TVIIceCandidatePairStats.h

  currentRoundTripTime

Current round trip time.

@property (nonatomic, assign, readonly) CFTimeInterval currentRoundTripTime

Discussion

Represents the latest round trip time measured in seconds, computed from both STUN connectivity checks [STUN-PATH-CHAR] and consent responses [RFC7675].

Declared In

TVIIceCandidatePairStats.h

  availableOutgoingBitrate

Available outgoing bitrate

@property (nonatomic, assign, readonly) double availableOutgoingBitrate

Discussion

It is calculated by the underlying congestion control by combining the available bitrate for all the outgoing RTP streams using this candidate pair. The bitrate measurement does not count the size of the IP or other transport layers like TCP or UDP. It is similar to the TIAS defined in [RFC3890], i.e., it is measured in bits per second and the bitrate is calculated over a 1 second window.

Declared In

TVIIceCandidatePairStats.h

  availableIncomingBitrate

Available incoming bitrate

@property (nonatomic, assign, readonly) double availableIncomingBitrate

Discussion

It is calculated by the underlying congestion control by combining the available bitrate for all the incoming RTP streams using this candidate pair. The bitrate measurement does not count the size of the IP or other transport layers like TCP or UDP. It is similar to the TIAS defined in [RFC3890], i.e., it is measured in bits per second and the bitrate is calculated over a 1 second window.

Declared In

TVIIceCandidatePairStats.h

  requestsReceived

Represents the total number of connectivity check requests received (including retransmissions).

@property (nonatomic, assign, readonly) uint64_t requestsReceived

Declared In

TVIIceCandidatePairStats.h

  requestsSent

Represents the total number of connectivity check requests sent (not including retransmissions).

@property (nonatomic, assign, readonly) uint64_t requestsSent

Declared In

TVIIceCandidatePairStats.h

  responsesReceived

Represents the total number of connectivity check responses received.

@property (nonatomic, assign, readonly) uint64_t responsesReceived

Declared In

TVIIceCandidatePairStats.h

  responsesSent

Represents the total number of connectivity check responses sent.

@property (nonatomic, assign, readonly) uint64_t responsesSent

Declared In

TVIIceCandidatePairStats.h

  retransmissionsReceived

Represents the total number of connectivity check retransmissions received.

@property (nonatomic, assign, readonly) uint64_t retransmissionsReceived

Declared In

TVIIceCandidatePairStats.h

  retransmissionsSent

Represents the total number of connectivity check retransmissions sent.

@property (nonatomic, assign, readonly) uint64_t retransmissionsSent

Declared In

TVIIceCandidatePairStats.h

  consentRequestsReceived

Represents the total number of consent requests received.

@property (nonatomic, assign, readonly) uint64_t consentRequestsReceived

Declared In

TVIIceCandidatePairStats.h

  consentRequestsSent

Represents the total number of consent requests sent.

@property (nonatomic, assign, readonly) uint64_t consentRequestsSent

Declared In

TVIIceCandidatePairStats.h

  consentResponsesReceived

Represents the total number of consent responses received.

@property (nonatomic, assign, readonly) uint64_t consentResponsesReceived

Declared In

TVIIceCandidatePairStats.h

  consentResponsesSent

Represents the total number of consent responses sent.

@property (nonatomic, assign, readonly) uint64_t consentResponsesSent

Declared In

TVIIceCandidatePairStats.h

– init

Developers shouldn’t initialize this class directly.

- (null_unspecified instancetype)init

Discussion

Ice candidate pair stats cannot be created explicitly.

Declared In

TVIIceCandidatePairStats.h