TVIIceCandidatePairStats Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | TVIIceCandidatePairStats.h |
activeCandidatePair
A boolean to indicate if the candidate pair is active.
@property (nonatomic, assign, readonly, getter=isActiveCandidatePair) BOOL activeCandidatePairDeclared In
TVIIceCandidatePairStats.h
relayProtocol
The relay protocol.
@property (nonatomic, copy, readonly, nullable) NSString *relayProtocolDeclared In
TVIIceCandidatePairStats.h
transportId
The unique identifier used for TVIIceCandidateStats associated with this candidate.
@property (nonatomic, copy, readonly, nullable) NSString *transportIdDeclared 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 *localCandidateIdDeclared In
TVIIceCandidatePairStats.h
localCandidateIp
The IP address of the local candidate associated with this candidate pair.
@property (nonatomic, copy, readonly, nullable) NSString *localCandidateIpDeclared 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 *remoteCandidateIdDeclared In
TVIIceCandidatePairStats.h
remoteCandidateIp
The IP address of the remote candidate associated with this candidate pair.
@property (nonatomic, copy, readonly, nullable) NSString *remoteCandidateIpDeclared In
TVIIceCandidatePairStats.h
state
Represents the state of the checklist for the local and remote candidates in a pair.
@property (nonatomic, assign, readonly) TVIIceCandidatePairState stateDeclared 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 priorityDeclared 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 nominatedDeclared In
TVIIceCandidatePairStats.h
writable
Has gotten ACK to an ICE request.
@property (nonatomic, assign, readonly, getter=isWritable) BOOL writableDeclared In
TVIIceCandidatePairStats.h
readable
Has gotten a valid incoming ICE request.
@property (nonatomic, assign, readonly, getter=isReadable) BOOL readableDeclared 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 bytesSentDeclared 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 bytesReceivedDeclared In
TVIIceCandidatePairStats.h
totalRoundTripTime
Total round trip time.
@property (nonatomic, assign, readonly) CFTimeInterval totalRoundTripTimeDiscussion
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 currentRoundTripTimeDiscussion
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 availableOutgoingBitrateDiscussion
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 availableIncomingBitrateDiscussion
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 requestsReceivedDeclared In
TVIIceCandidatePairStats.h
requestsSent
Represents the total number of connectivity check requests sent (not including retransmissions).
@property (nonatomic, assign, readonly) uint64_t requestsSentDeclared In
TVIIceCandidatePairStats.h
responsesReceived
Represents the total number of connectivity check responses received.
@property (nonatomic, assign, readonly) uint64_t responsesReceivedDeclared In
TVIIceCandidatePairStats.h
responsesSent
Represents the total number of connectivity check responses sent.
@property (nonatomic, assign, readonly) uint64_t responsesSentDeclared In
TVIIceCandidatePairStats.h
retransmissionsReceived
Represents the total number of connectivity check retransmissions received.
@property (nonatomic, assign, readonly) uint64_t retransmissionsReceivedDeclared In
TVIIceCandidatePairStats.h
retransmissionsSent
Represents the total number of connectivity check retransmissions sent.
@property (nonatomic, assign, readonly) uint64_t retransmissionsSentDeclared In
TVIIceCandidatePairStats.h
consentRequestsReceived
Represents the total number of consent requests received.
@property (nonatomic, assign, readonly) uint64_t consentRequestsReceivedDeclared In
TVIIceCandidatePairStats.h
consentRequestsSent
Represents the total number of consent requests sent.
@property (nonatomic, assign, readonly) uint64_t consentRequestsSentDeclared In
TVIIceCandidatePairStats.h
consentResponsesReceived
Represents the total number of consent responses received.
@property (nonatomic, assign, readonly) uint64_t consentResponsesReceivedDeclared In
TVIIceCandidatePairStats.h
consentResponsesSent
Represents the total number of consent responses sent.
@property (nonatomic, assign, readonly) uint64_t consentResponsesSentDeclared In
TVIIceCandidatePairStats.h
– init
Developers shouldn’t initialize this class directly.
- (null_unspecified instancetype)initDiscussion
Ice candidate pair stats cannot be created explicitly.
Declared In
TVIIceCandidatePairStats.h