Amazon Kinesis Webrtc C SDK
RtcIceCandidatePairDiagnostics Struct Reference

#include <IceAgent.h>

Collaboration diagram for RtcIceCandidatePairDiagnostics:
Collaboration graph

Public Attributes

CHAR localCandidateId [MAX_CANDIDATE_ID_LENGTH+1]
 Local candidate that is inspected in RTCIceCandidateStats. More...
 
CHAR remoteCandidateId [MAX_CANDIDATE_ID_LENGTH+1]
 Remote candidate that is inspected in RTCIceCandidateStats. More...
 
ICE_CANDIDATE_PAIR_STATE state
 State of checklist for the local-remote candidate pair. More...
 
BOOL nominated
 
NullableUint32 circuitBreakerTriggerCount
 
UINT32 packetsDiscardedOnSend
 Total number of packets discarded for candidate pair due to socket errors,. More...
 
UINT64 packetsSent
 Total number of packets sent on this candidate pair;. More...
 
UINT64 packetsReceived
 Total number of packets received on this candidate pair. More...
 
UINT64 bytesSent
 Total number of bytes (minus header and padding) sent on this candidate pair. More...
 
UINT64 bytesReceived
 Total number of bytes (minus header and padding) received on this candidate pair. More...
 
UINT64 lastPacketSentTimestamp
 
UINT64 lastPacketReceivedTimestamp
 
UINT64 firstRequestTimestamp
 Represents the timestamp at which the first STUN request was sent on this particular candidate pair. More...
 
UINT64 lastRequestTimestamp
 
UINT64 lastResponseTimestamp
 Represents the timestamp at which the last STUN response was received on this particular candidate pair. More...
 
DOUBLE totalRoundTripTime
 
DOUBLE currentRoundTripTime
 Latest round trip time (seconds) More...
 
DOUBLE availableOutgoingBitrate
 
DOUBLE availableIncomingBitrate
 
UINT64 requestsReceived
 Total number of connectivity check requests received (including retransmission) More...
 
UINT64 requestsSent
 The total number of connectivity check requests sent (without retransmissions). More...
 
UINT64 responsesReceived
 The total number of connectivity check responses received. More...
 
UINT64 responsesSent
 The total number of connectivity check responses sent. More...
 
UINT64 bytesDiscardedOnSend
 Total number of bytes for this candidate pair discarded due to socket errors. More...
 

Member Data Documentation

◆ availableIncomingBitrate

DOUBLE RtcIceCandidatePairDiagnostics::availableIncomingBitrate

TODO: Total available bit rate for all the outgoing RTP streams on this candidate pair. Calculated by underlying congestion control

◆ availableOutgoingBitrate

DOUBLE RtcIceCandidatePairDiagnostics::availableOutgoingBitrate

TODO: Total available bit rate for all the outgoing RTP streams on this candidate pair. Calculated by underlying congestion control

◆ bytesDiscardedOnSend

UINT64 RtcIceCandidatePairDiagnostics::bytesDiscardedOnSend

Total number of bytes for this candidate pair discarded due to socket errors.

◆ bytesReceived

UINT64 RtcIceCandidatePairDiagnostics::bytesReceived

Total number of bytes (minus header and padding) received on this candidate pair.

◆ bytesSent

UINT64 RtcIceCandidatePairDiagnostics::bytesSent

Total number of bytes (minus header and padding) sent on this candidate pair.

◆ circuitBreakerTriggerCount

NullableUint32 RtcIceCandidatePairDiagnostics::circuitBreakerTriggerCount

Represents number of times circuit breaker is triggered during media transmission It is undefined if the user agent does not use this

◆ currentRoundTripTime

DOUBLE RtcIceCandidatePairDiagnostics::currentRoundTripTime

Latest round trip time (seconds)

◆ firstRequestTimestamp

UINT64 RtcIceCandidatePairDiagnostics::firstRequestTimestamp

Represents the timestamp at which the first STUN request was sent on this particular candidate pair.

◆ lastPacketReceivedTimestamp

UINT64 RtcIceCandidatePairDiagnostics::lastPacketReceivedTimestamp

Represents the timestamp at which the last packet was sent on this particular candidate pair, excluding STUN packets.

◆ lastPacketSentTimestamp

UINT64 RtcIceCandidatePairDiagnostics::lastPacketSentTimestamp

Represents the timestamp at which the last packet was sent on this particular candidate pair, excluding STUN packets.

◆ lastRequestTimestamp

UINT64 RtcIceCandidatePairDiagnostics::lastRequestTimestamp

Represents the timestamp at which the last STUN request was sent on this particular candidate pair. The average interval between two consecutive connectivity checks sent can be calculated: (lastRequestTimestamp - firstRequestTimestamp) / requestsSent.

◆ lastResponseTimestamp

UINT64 RtcIceCandidatePairDiagnostics::lastResponseTimestamp

Represents the timestamp at which the last STUN response was received on this particular candidate pair.

◆ localCandidateId

CHAR RtcIceCandidatePairDiagnostics::localCandidateId[MAX_CANDIDATE_ID_LENGTH+1]

Local candidate that is inspected in RTCIceCandidateStats.

◆ nominated

BOOL RtcIceCandidatePairDiagnostics::nominated

Flag is TRUE if the agent is a controlling agent and FALSE otherwise. The agent role is based on the STUN_ATTRIBUTE_TYPE_USE_CANDIDATE flag

◆ packetsDiscardedOnSend

UINT32 RtcIceCandidatePairDiagnostics::packetsDiscardedOnSend

Total number of packets discarded for candidate pair due to socket errors,.

◆ packetsReceived

UINT64 RtcIceCandidatePairDiagnostics::packetsReceived

Total number of packets received on this candidate pair.

◆ packetsSent

UINT64 RtcIceCandidatePairDiagnostics::packetsSent

Total number of packets sent on this candidate pair;.

◆ remoteCandidateId

CHAR RtcIceCandidatePairDiagnostics::remoteCandidateId[MAX_CANDIDATE_ID_LENGTH+1]

Remote candidate that is inspected in RTCIceCandidateStats.

◆ requestsReceived

UINT64 RtcIceCandidatePairDiagnostics::requestsReceived

Total number of connectivity check requests received (including retransmission)

◆ requestsSent

UINT64 RtcIceCandidatePairDiagnostics::requestsSent

The total number of connectivity check requests sent (without retransmissions).

◆ responsesReceived

UINT64 RtcIceCandidatePairDiagnostics::responsesReceived

The total number of connectivity check responses received.

◆ responsesSent

UINT64 RtcIceCandidatePairDiagnostics::responsesSent

The total number of connectivity check responses sent.

◆ state

ICE_CANDIDATE_PAIR_STATE RtcIceCandidatePairDiagnostics::state

State of checklist for the local-remote candidate pair.

◆ totalRoundTripTime

DOUBLE RtcIceCandidatePairDiagnostics::totalRoundTripTime

The sum of all round trip time (seconds) since the beginning of the session, based on STUN connectivity check responses (responsesReceived), including those that reply to requests that are sent in order to verify consent. The average round trip time can be computed from totalRoundTripTime by dividing it by responsesReceived.


The documentation for this struct was generated from the following file: