@Generated(value="org.realityforge.webtack")
@JsType(isNative=true,
namespace="<global>",
name="RTCIceCandidatePairStats")
public interface RTCIceCandidatePairStats
extends RTCStats
| Modifier and Type | Interface and Description |
|---|---|
static interface |
RTCIceCandidatePairStats.Builder
The WebRTC RTCIceCandidatePairStats dictionary reports statistics which provide insight into the quality and performance of an RTCPeerConnection while connected and configured as described by the specified pair of ICE candidates.
|
| Modifier and Type | Method and Description |
|---|---|
double |
availableIncomingBitrate()
The RTCIceCandidatePairStats property availableIncomingBitrate returns a value indicative of the available inbound capacity of the network connection represented by the candidate pair.
|
double |
availableOutgoingBitrate()
The RTCIceCandidatePairStats property availableOutgoingBitrate returns a value indicative of the available outbound capacity of the network connection represented by the candidate pair.
|
int |
bytesDiscardedOnSend() |
int |
bytesReceived()
The RTCIceCandidatePairStats property bytesReceived indicates the total number of payload bytes—that is, bytes which aren't overhead such as headers or padding—that hve been received to date on the connection described by the candidate pair.
|
int |
bytesSent()
The RTCIceCandidatePairStats property bytesSent indicates the total number of payload bytes—that is, bytes which aren't overhead such as headers or padding—that hve been sent so far on the connection described by the candidate pair.
|
int |
circuitBreakerTriggerCount()
The RTCIceCandidatePairStats property circuitBreakerTriggerCount indicates the number of times the circuit-breaker has been triggered to indicate a connection timeout or other unexpected connection abort on this specific connection configuration.
|
double |
consentExpiredTimestamp()
The RTCIceCandidatePairStats property consentExpiredTimestamp indicates the time at which the most recent STUN binding response expired.
|
int |
consentRequestBytesSent() |
int |
consentRequestsSent()
The RTCIceCandidatePairStats property consentRequestsSent specifies the number of consent requests that have been sent by this peer to the remote peer on the connection described by the pair of candidates.
|
static RTCIceCandidatePairStats.Builder |
create(java.lang.String id,
double timestamp,
java.lang.String type,
java.lang.String localCandidateId,
java.lang.String remoteCandidateId,
java.lang.String state,
java.lang.String transportId) |
double |
currentRoundTripTime()
The RTCIceCandidatePairStats property currentRoundTripTime is a floating-point value indicating the number of seconds it takes for data to be sent by this peer to the remote peer and back over the connection described by this pair of ICE candidates.
|
double |
currentRtt() |
double |
firstRequestTimestamp()
The RTCIceCandidatePairStats property firstRequestTimestamp specifies the time at which the first STUN request was sent on the described candidate pair.
|
double |
lastPacketReceivedTimestamp()
The RTCIceCandidatePairStats property lastPacketReceivedTimestamp indicates the time at which the connection described by the candidate pair last received a packet.
|
double |
lastPacketSentTimestamp()
The RTCIceCandidatePairStats property lastPacketSentTimestamp indicates the time at which the connection described by the candidate pair last sent a packet, not including STUN packets.
|
double |
lastRequestTimestamp()
The RTCIceCandidatePairStats property lastRequestTimestamp indicates the time at which the most recent STUN request was sent on the described candidate pair.
|
double |
lastResponseTimestamp()
The RTCIceCandidatePairStats property lastResponseTimestamp indicates the time at which the last STUN response was received on the described candidate pair.
|
java.lang.String |
localCandidateId()
The RTCIceCandidatePairStats property localCandidateId is a string that uniquely identifies the local ICE candidate which was analyzed to generate the RTCIceCandidateStats used to compute the statistics for this pair of candidates.
|
boolean |
nominated()
The RTCIceCandidatePairStats property nominated specifies whether or not the candidate pair described by the underlying RTCIceCandidatePair has been nominated to be used as the configuration for the WebRTC connection.
|
int |
packetsDiscardedOnSend() |
int |
packetsReceived()
The RTCIceCandidatePairStats dictionary's packetsReceived property indicates the total number of packets of any kind that have been received on the connection described by the pair of candidates.
|
int |
packetsSent()
The RTCIceCandidatePairStats dictionary's packetsSent property indicates the total number of packets which have been sent on the connection described by the pair of candidates.
|
int |
priority() |
java.lang.String |
remoteCandidateId()
The RTCIceCandidatePairStats property remoteCandidateId is a string that uniquely identifies the remote ICE candidate which was analyzed to generate the RTCIceCandidateStats used to compute the statistics for this pair of candidates.
|
int |
requestBytesSent() |
int |
requestsReceived()
The RTCIceCandidatePairStats dictionary's requestsReceived property indicates the total number of STUN connectivity check requests that have been received so far on the connection described by this pairing of candidates.
|
int |
requestsSent()
The RTCIceCandidatePairStats dictionary's requestsSent property indicates the total number of STUN connectivity check requests that have been sent so far on the connection described by this pair of candidates.
|
int |
responseBytesSent() |
int |
responsesReceived()
The responsesReceived property in the RTCIceCandidatePairStats dictionary indicates the total number of STUN connectivity check responses that have been received on the connection described by this pair of candidates.
|
int |
responsesSent()
The RTCIceCandidatePairStats dictionary's responsesSent property indicates the total number of STUN connectivity check responses that have been sent so far on the connection described by this pair of candidates.
|
int |
retransmissionsReceived()
The RTCIceCandidatePairStats dictionary's retransmissionsReceived property indicates the total number of STUN connectivity check request retransmissions that have been received so far on the pair of candidates.
|
int |
retransmissionsSent()
The RTCIceCandidatePairStats dictionary's retransmissionsSent property indicates the total number of STUN connectivity check request retransmissions that have been sent so far on the pair of candidates.
|
void |
setAvailableIncomingBitrate(double availableIncomingBitrate)
The RTCIceCandidatePairStats property availableIncomingBitrate returns a value indicative of the available inbound capacity of the network connection represented by the candidate pair.
|
void |
setAvailableOutgoingBitrate(double availableOutgoingBitrate)
The RTCIceCandidatePairStats property availableOutgoingBitrate returns a value indicative of the available outbound capacity of the network connection represented by the candidate pair.
|
void |
setBytesDiscardedOnSend(int bytesDiscardedOnSend) |
void |
setBytesReceived(int bytesReceived)
The RTCIceCandidatePairStats property bytesReceived indicates the total number of payload bytes—that is, bytes which aren't overhead such as headers or padding—that hve been received to date on the connection described by the candidate pair.
|
void |
setBytesSent(int bytesSent)
The RTCIceCandidatePairStats property bytesSent indicates the total number of payload bytes—that is, bytes which aren't overhead such as headers or padding—that hve been sent so far on the connection described by the candidate pair.
|
void |
setCircuitBreakerTriggerCount(int circuitBreakerTriggerCount)
The RTCIceCandidatePairStats property circuitBreakerTriggerCount indicates the number of times the circuit-breaker has been triggered to indicate a connection timeout or other unexpected connection abort on this specific connection configuration.
|
void |
setConsentExpiredTimestamp(double consentExpiredTimestamp)
The RTCIceCandidatePairStats property consentExpiredTimestamp indicates the time at which the most recent STUN binding response expired.
|
void |
setConsentRequestBytesSent(int consentRequestBytesSent) |
void |
setConsentRequestsSent(int consentRequestsSent)
The RTCIceCandidatePairStats property consentRequestsSent specifies the number of consent requests that have been sent by this peer to the remote peer on the connection described by the pair of candidates.
|
void |
setCurrentRoundTripTime(double currentRoundTripTime)
The RTCIceCandidatePairStats property currentRoundTripTime is a floating-point value indicating the number of seconds it takes for data to be sent by this peer to the remote peer and back over the connection described by this pair of ICE candidates.
|
void |
setCurrentRtt(double currentRtt) |
void |
setFirstRequestTimestamp(double firstRequestTimestamp)
The RTCIceCandidatePairStats property firstRequestTimestamp specifies the time at which the first STUN request was sent on the described candidate pair.
|
void |
setLastPacketReceivedTimestamp(double lastPacketReceivedTimestamp)
The RTCIceCandidatePairStats property lastPacketReceivedTimestamp indicates the time at which the connection described by the candidate pair last received a packet.
|
void |
setLastPacketSentTimestamp(double lastPacketSentTimestamp)
The RTCIceCandidatePairStats property lastPacketSentTimestamp indicates the time at which the connection described by the candidate pair last sent a packet, not including STUN packets.
|
void |
setLastRequestTimestamp(double lastRequestTimestamp)
The RTCIceCandidatePairStats property lastRequestTimestamp indicates the time at which the most recent STUN request was sent on the described candidate pair.
|
void |
setLastResponseTimestamp(double lastResponseTimestamp)
The RTCIceCandidatePairStats property lastResponseTimestamp indicates the time at which the last STUN response was received on the described candidate pair.
|
void |
setLocalCandidateId(java.lang.String localCandidateId)
The RTCIceCandidatePairStats property localCandidateId is a string that uniquely identifies the local ICE candidate which was analyzed to generate the RTCIceCandidateStats used to compute the statistics for this pair of candidates.
|
void |
setNominated(boolean nominated)
The RTCIceCandidatePairStats property nominated specifies whether or not the candidate pair described by the underlying RTCIceCandidatePair has been nominated to be used as the configuration for the WebRTC connection.
|
void |
setPacketsDiscardedOnSend(int packetsDiscardedOnSend) |
void |
setPacketsReceived(int packetsReceived)
The RTCIceCandidatePairStats dictionary's packetsReceived property indicates the total number of packets of any kind that have been received on the connection described by the pair of candidates.
|
void |
setPacketsSent(int packetsSent)
The RTCIceCandidatePairStats dictionary's packetsSent property indicates the total number of packets which have been sent on the connection described by the pair of candidates.
|
void |
setPriority(int priority) |
void |
setRemoteCandidateId(java.lang.String remoteCandidateId)
The RTCIceCandidatePairStats property remoteCandidateId is a string that uniquely identifies the remote ICE candidate which was analyzed to generate the RTCIceCandidateStats used to compute the statistics for this pair of candidates.
|
void |
setRequestBytesSent(int requestBytesSent) |
void |
setRequestsReceived(int requestsReceived)
The RTCIceCandidatePairStats dictionary's requestsReceived property indicates the total number of STUN connectivity check requests that have been received so far on the connection described by this pairing of candidates.
|
void |
setRequestsSent(int requestsSent)
The RTCIceCandidatePairStats dictionary's requestsSent property indicates the total number of STUN connectivity check requests that have been sent so far on the connection described by this pair of candidates.
|
void |
setResponseBytesSent(int responseBytesSent) |
void |
setResponsesReceived(int responsesReceived)
The responsesReceived property in the RTCIceCandidatePairStats dictionary indicates the total number of STUN connectivity check responses that have been received on the connection described by this pair of candidates.
|
void |
setResponsesSent(int responsesSent)
The RTCIceCandidatePairStats dictionary's responsesSent property indicates the total number of STUN connectivity check responses that have been sent so far on the connection described by this pair of candidates.
|
void |
setRetransmissionsReceived(int retransmissionsReceived)
The RTCIceCandidatePairStats dictionary's retransmissionsReceived property indicates the total number of STUN connectivity check request retransmissions that have been received so far on the pair of candidates.
|
void |
setRetransmissionsSent(int retransmissionsSent)
The RTCIceCandidatePairStats dictionary's retransmissionsSent property indicates the total number of STUN connectivity check request retransmissions that have been sent so far on the pair of candidates.
|
void |
setState(java.lang.String state)
The state property in an RTCIceCandidatePairStats object indicates the state of the check list of which the candidate pair is a member.
|
void |
setTotalRoundTripTime(double totalRoundTripTime)
The RTCIceCandidatePairStats dictionary's totalRoundTripTime property is the total time that has elapsed between sending STUN requests and receiving the responses, for all such requests that have been made so far on the pair of candidates described by this RTCIceCandidatePairStats object.
|
void |
setTotalRtt(double totalRtt) |
void |
setTransportId(java.lang.String transportId)
The transportId property uniquely identifies the RTCIceTransport that was inspected to obtain the transport-related statistics contained in the RTCIceCandidatePairStats object.
|
java.lang.String |
state()
The state property in an RTCIceCandidatePairStats object indicates the state of the check list of which the candidate pair is a member.
|
double |
totalRoundTripTime()
The RTCIceCandidatePairStats dictionary's totalRoundTripTime property is the total time that has elapsed between sending STUN requests and receiving the responses, for all such requests that have been made so far on the pair of candidates described by this RTCIceCandidatePairStats object.
|
double |
totalRtt() |
java.lang.String |
transportId()
The transportId property uniquely identifies the RTCIceTransport that was inspected to obtain the transport-related statistics contained in the RTCIceCandidatePairStats object.
|
@JsOverlay @Nonnull static RTCIceCandidatePairStats.Builder create(@Nonnull java.lang.String id, double timestamp, @RTCStatsType @Nonnull java.lang.String type, @Nonnull java.lang.String localCandidateId, @Nonnull java.lang.String remoteCandidateId, @RTCStatsIceCandidatePairState @Nonnull java.lang.String state, @Nonnull java.lang.String transportId)
@JsProperty(name="availableIncomingBitrate") double availableIncomingBitrate()
@JsProperty void setAvailableIncomingBitrate(double availableIncomingBitrate)
@JsProperty(name="availableOutgoingBitrate") double availableOutgoingBitrate()
@JsProperty void setAvailableOutgoingBitrate(double availableOutgoingBitrate)
@JsProperty(name="bytesDiscardedOnSend") int bytesDiscardedOnSend()
@JsProperty void setBytesDiscardedOnSend(int bytesDiscardedOnSend)
@JsProperty(name="bytesReceived") int bytesReceived()
@JsProperty void setBytesReceived(int bytesReceived)
@JsProperty(name="bytesSent") int bytesSent()
@JsProperty void setBytesSent(int bytesSent)
@JsProperty(name="circuitBreakerTriggerCount") int circuitBreakerTriggerCount()
@JsProperty void setCircuitBreakerTriggerCount(int circuitBreakerTriggerCount)
@JsProperty(name="consentExpiredTimestamp") double consentExpiredTimestamp()
@JsProperty void setConsentExpiredTimestamp(double consentExpiredTimestamp)
@JsProperty(name="consentRequestBytesSent") int consentRequestBytesSent()
@JsProperty void setConsentRequestBytesSent(int consentRequestBytesSent)
@JsProperty(name="consentRequestsSent") int consentRequestsSent()
@JsProperty void setConsentRequestsSent(int consentRequestsSent)
@JsProperty(name="currentRoundTripTime") double currentRoundTripTime()
@JsProperty void setCurrentRoundTripTime(double currentRoundTripTime)
@JsProperty(name="firstRequestTimestamp") double firstRequestTimestamp()
@JsProperty void setFirstRequestTimestamp(double firstRequestTimestamp)
@JsProperty(name="lastPacketReceivedTimestamp") double lastPacketReceivedTimestamp()
@JsProperty void setLastPacketReceivedTimestamp(double lastPacketReceivedTimestamp)
@JsProperty(name="lastPacketSentTimestamp") double lastPacketSentTimestamp()
@JsProperty void setLastPacketSentTimestamp(double lastPacketSentTimestamp)
@JsProperty(name="lastRequestTimestamp") double lastRequestTimestamp()
@JsProperty void setLastRequestTimestamp(double lastRequestTimestamp)
@JsProperty(name="lastResponseTimestamp") double lastResponseTimestamp()
@JsProperty void setLastResponseTimestamp(double lastResponseTimestamp)
@JsProperty(name="localCandidateId") @Nonnull java.lang.String localCandidateId()
@JsProperty
void setLocalCandidateId(@Nonnull
java.lang.String localCandidateId)
@JsProperty(name="nominated") boolean nominated()
@JsProperty void setNominated(boolean nominated)
@JsProperty(name="packetsDiscardedOnSend") int packetsDiscardedOnSend()
@JsProperty void setPacketsDiscardedOnSend(int packetsDiscardedOnSend)
@JsProperty(name="packetsReceived") int packetsReceived()
@JsProperty void setPacketsReceived(int packetsReceived)
@JsProperty(name="packetsSent") int packetsSent()
@JsProperty void setPacketsSent(int packetsSent)
@JsProperty(name="remoteCandidateId") @Nonnull java.lang.String remoteCandidateId()
@JsProperty
void setRemoteCandidateId(@Nonnull
java.lang.String remoteCandidateId)
@JsProperty(name="requestBytesSent") int requestBytesSent()
@JsProperty void setRequestBytesSent(int requestBytesSent)
@JsProperty(name="requestsReceived") int requestsReceived()
@JsProperty void setRequestsReceived(int requestsReceived)
@JsProperty(name="requestsSent") int requestsSent()
@JsProperty void setRequestsSent(int requestsSent)
@JsProperty(name="responseBytesSent") int responseBytesSent()
@JsProperty void setResponseBytesSent(int responseBytesSent)
@JsProperty(name="responsesReceived") int responsesReceived()
@JsProperty void setResponsesReceived(int responsesReceived)
@JsProperty(name="responsesSent") int responsesSent()
@JsProperty void setResponsesSent(int responsesSent)
@JsProperty(name="retransmissionsReceived") int retransmissionsReceived()
@JsProperty void setRetransmissionsReceived(int retransmissionsReceived)
@JsProperty(name="retransmissionsSent") int retransmissionsSent()
@JsProperty void setRetransmissionsSent(int retransmissionsSent)
@JsProperty(name="state") @RTCStatsIceCandidatePairState @Nonnull java.lang.String state()
@JsProperty void setState(@RTCStatsIceCandidatePairState @Nonnull java.lang.String state)
@JsProperty(name="totalRoundTripTime") double totalRoundTripTime()
@JsProperty void setTotalRoundTripTime(double totalRoundTripTime)
@JsProperty(name="transportId") @Nonnull java.lang.String transportId()
@JsProperty
void setTransportId(@Nonnull
java.lang.String transportId)
@JsProperty(name="currentRtt") double currentRtt()
@JsProperty void setCurrentRtt(double currentRtt)
@JsProperty(name="priority") int priority()
@JsProperty void setPriority(int priority)
@JsProperty(name="totalRtt") double totalRtt()
@JsProperty void setTotalRtt(double totalRtt)