akasha.rtc

Interface RTCIceCandidatePairStats.Builder

All Superinterfaces:

RTCIceCandidatePairStats, RTCStats

Enclosing interface:

RTCIceCandidatePairStats

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public static interface RTCIceCandidatePairStats.Builder
extends RTCIceCandidatePairStats

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.

See Also:

RTCIceCandidatePairStats - MDN, # dom-rtcicecandidatepairstats

Nested Class Summary

Nested classes/interfaces inherited from interface akasha.rtc.RTCIceCandidatePairStats

RTCIceCandidatePairStats.Builder, RTCIceCandidatePairStats.Step1, RTCIceCandidatePairStats.Step2, RTCIceCandidatePairStats.Step3, RTCIceCandidatePairStats.Step4, RTCIceCandidatePairStats.Step5, RTCIceCandidatePairStats.Step6

Method Summary

Modifier and Type	Method and Description
default RTCIceCandidatePairStats.Builder	availableIncomingBitrate(double availableIncomingBitrate) The RTCIceCandidatePairStats property availableIncomingBitrate returns a value indicative of the available inbound capacity of the network connection represented by the candidate pair.
default RTCIceCandidatePairStats.Builder	availableOutgoingBitrate(double availableOutgoingBitrate) The RTCIceCandidatePairStats property availableOutgoingBitrate returns a value indicative of the available outbound capacity of the network connection represented by the candidate pair.
default RTCIceCandidatePairStats.Builder	bytesDiscardedOnSend(int bytesDiscardedOnSend)
default RTCIceCandidatePairStats.Builder	bytesReceived(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.
default RTCIceCandidatePairStats.Builder	bytesSent(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.
default RTCIceCandidatePairStats.Builder	circuitBreakerTriggerCount(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.
default RTCIceCandidatePairStats.Builder	consentExpiredTimestamp(double consentExpiredTimestamp) The RTCIceCandidatePairStats property consentExpiredTimestamp indicates the time at which the most recent STUN binding response expired.
default RTCIceCandidatePairStats.Builder	consentRequestBytesSent(int consentRequestBytesSent)
default RTCIceCandidatePairStats.Builder	consentRequestsSent(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.
default RTCIceCandidatePairStats.Builder	currentRoundTripTime(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.
default RTCIceCandidatePairStats.Builder	currentRtt(double currentRtt)
default RTCIceCandidatePairStats.Builder	firstRequestTimestamp(double firstRequestTimestamp) The RTCIceCandidatePairStats property firstRequestTimestamp specifies the time at which the first STUN request was sent on the described candidate pair.
default RTCIceCandidatePairStats.Builder	lastPacketReceivedTimestamp(double lastPacketReceivedTimestamp) The RTCIceCandidatePairStats property lastPacketReceivedTimestamp indicates the time at which the connection described by the candidate pair last received a packet.
default RTCIceCandidatePairStats.Builder	lastPacketSentTimestamp(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.
default RTCIceCandidatePairStats.Builder	lastRequestTimestamp(double lastRequestTimestamp) The RTCIceCandidatePairStats property lastRequestTimestamp indicates the time at which the most recent STUN request was sent on the described candidate pair.
default RTCIceCandidatePairStats.Builder	lastResponseTimestamp(double lastResponseTimestamp) The RTCIceCandidatePairStats property lastResponseTimestamp indicates the time at which the last STUN response was received on the described candidate pair.
default RTCIceCandidatePairStats.Builder	nominated(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.
default RTCIceCandidatePairStats.Builder	packetsDiscardedOnSend(int packetsDiscardedOnSend)
default RTCIceCandidatePairStats.Builder	packetsReceived(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.
default RTCIceCandidatePairStats.Builder	packetsSent(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.
default RTCIceCandidatePairStats.Builder	priority(int priority)
default RTCIceCandidatePairStats.Builder	requestBytesSent(int requestBytesSent)
default RTCIceCandidatePairStats.Builder	requestsReceived(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.
default RTCIceCandidatePairStats.Builder	requestsSent(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.
default RTCIceCandidatePairStats.Builder	responseBytesSent(int responseBytesSent)
default RTCIceCandidatePairStats.Builder	responsesReceived(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.
default RTCIceCandidatePairStats.Builder	responsesSent(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.
default RTCIceCandidatePairStats.Builder	retransmissionsReceived(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.
default RTCIceCandidatePairStats.Builder	retransmissionsSent(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.
default RTCIceCandidatePairStats.Builder	totalRoundTripTime(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.
default RTCIceCandidatePairStats.Builder	totalRtt(double totalRtt)

Methods inherited from interface akasha.rtc.RTCIceCandidatePairStats

availableIncomingBitrate, availableOutgoingBitrate, bytesDiscardedOnSend, bytesReceived, bytesSent, circuitBreakerTriggerCount, consentExpiredTimestamp, consentRequestBytesSent, consentRequestsSent, currentRoundTripTime, currentRtt, firstRequestTimestamp, lastPacketReceivedTimestamp, lastPacketSentTimestamp, lastRequestTimestamp, lastResponseTimestamp, localCandidateId, nominated, packetsDiscardedOnSend, packetsReceived, packetsSent, priority, remoteCandidateId, requestBytesSent, requestsReceived, requestsSent, responseBytesSent, responsesReceived, responsesSent, retransmissionsReceived, retransmissionsSent, setAvailableIncomingBitrate, setAvailableOutgoingBitrate, setBytesDiscardedOnSend, setBytesReceived, setBytesSent, setCircuitBreakerTriggerCount, setConsentExpiredTimestamp, setConsentRequestBytesSent, setConsentRequestsSent, setCurrentRoundTripTime, setCurrentRtt, setFirstRequestTimestamp, setLastPacketReceivedTimestamp, setLastPacketSentTimestamp, setLastRequestTimestamp, setLastResponseTimestamp, setLocalCandidateId, setNominated, setPacketsDiscardedOnSend, setPacketsReceived, setPacketsSent, setPriority, setRemoteCandidateId, setRequestBytesSent, setRequestsReceived, setRequestsSent, setResponseBytesSent, setResponsesReceived, setResponsesSent, setRetransmissionsReceived, setRetransmissionsSent, setState, setTotalRoundTripTime, setTotalRtt, setTransportId, state, timestamp, totalRoundTripTime, totalRtt, transportId

Methods inherited from interface akasha.rtc.RTCStats

id, setId, setTimestamp, setType, timestamp, type

Method Detail

availableIncomingBitrate

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder availableIncomingBitrate(double availableIncomingBitrate)

The RTCIceCandidatePairStats property availableIncomingBitrate returns a value indicative of the available inbound capacity of the network connection represented by the candidate pair.

See Also:

RTCIceCandidatePairStats.availableIncomingBitrate - MDN, The definition of 'RTCIceCandidatePairStats.availableIncomingBitrate' in Identifiers for WebRTC's Statistics API.

availableOutgoingBitrate

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder availableOutgoingBitrate(double availableOutgoingBitrate)

The RTCIceCandidatePairStats property availableOutgoingBitrate returns a value indicative of the available outbound capacity of the network connection represented by the candidate pair.

See Also:

RTCIceCandidatePairStats.availableOutgoingBitrate - MDN, The definition of 'RTCIceCandidatePairStats.availableoutgoingbitrate' in Identifiers for WebRTC's Statistics API.

bytesDiscardedOnSend

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder bytesDiscardedOnSend(int bytesDiscardedOnSend)

bytesReceived

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder bytesReceived(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.

See Also:

RTCIceCandidatePairStats.bytesReceived - MDN, The definition of 'RTCIceCandidatePairStats.bytesReceived' in Identifiers for WebRTC's Statistics API.

bytesSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder bytesSent(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.

See Also:

RTCIceCandidatePairStats.bytesSent - MDN, The definition of 'RTCIceCandidatePairStats.bytesSent' in Identifiers for WebRTC's Statistics API.

circuitBreakerTriggerCount

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder circuitBreakerTriggerCount(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.

See Also:

RTCIceCandidatePairStats.circuitBreakerTriggerCount - MDN, The definition of 'RTCIceCandidatePairStats.circuitBreakerTriggerCount' in Identifiers for WebRTC's Statistics API.

consentExpiredTimestamp

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder consentExpiredTimestamp(double consentExpiredTimestamp)

The RTCIceCandidatePairStats property consentExpiredTimestamp indicates the time at which the most recent STUN binding response expired.

See Also:

RTCIceCandidatePairStats.consentExpiredTimestamp - MDN, The definition of 'RTCIceCandidatePairStats.consentExpiredTimestamp' in Identifiers for WebRTC's Statistics API.

consentRequestBytesSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder consentRequestBytesSent(int consentRequestBytesSent)

consentRequestsSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder consentRequestsSent(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.

See Also:

RTCIceCandidatePairStats.consentRequestsSent - MDN, The definition of 'RTCIceCandidatePairStats.consentRequestsSent' in Identifiers for WebRTC's Statistics API.

currentRoundTripTime

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder currentRoundTripTime(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.

See Also:

RTCIceCandidatePairStats.currentRoundTripTime - MDN, The definition of 'RTCIceCandidatePairStats.currentRoundTripTime' in Identifiers for WebRTC's Statistics API.

firstRequestTimestamp

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder firstRequestTimestamp(double firstRequestTimestamp)

The RTCIceCandidatePairStats property firstRequestTimestamp specifies the time at which the first STUN request was sent on the described candidate pair.

See Also:

RTCIceCandidatePairStats.firstRequestTimestamp - MDN, The definition of 'RTCIceCandidatePairStats.firstRequestTimestamp' in Identifiers for WebRTC's Statistics API.

lastPacketReceivedTimestamp

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder lastPacketReceivedTimestamp(double lastPacketReceivedTimestamp)

The RTCIceCandidatePairStats property lastPacketReceivedTimestamp indicates the time at which the connection described by the candidate pair last received a packet. STUN packets are not included.

See Also:

RTCIceCandidatePairStats.lastPacketReceivedTimestamp - MDN, The definition of 'RTCIceCandidatePairStats.lastPacketReceivedTimestamp' in Identifiers for WebRTC's Statistics API.

lastPacketSentTimestamp

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder lastPacketSentTimestamp(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.

See Also:

RTCIceCandidatePairStats.lastPacketSentTimestamp - MDN, The definition of 'RTCIceCandidatePairStats.lastPacketSentTimestamp' in Identifiers for WebRTC's Statistics API.

lastRequestTimestamp

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder lastRequestTimestamp(double lastRequestTimestamp)

The RTCIceCandidatePairStats property lastRequestTimestamp indicates the time at which the most recent STUN request was sent on the described candidate pair.

See Also:

RTCIceCandidatePairStats.lastRequestTimestamp - MDN, The definition of 'RTCIceCandidatePairStats.lastRequestTimestamp' in Identifiers for WebRTC's Statistics API.

lastResponseTimestamp

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder lastResponseTimestamp(double lastResponseTimestamp)

The RTCIceCandidatePairStats property lastResponseTimestamp indicates the time at which the last STUN response was received on the described candidate pair.

See Also:

RTCIceCandidatePairStats.lastResponseTimestamp - MDN, RTCIceCandidatePairStats.lastResponseTimestamp - Identifiers for WebRTC's Statistics API

nominated

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder nominated(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.

See Also:

RTCIceCandidatePairStats.nominated - MDN, The definition of 'RTCIceCandidatePairStats.nominated' in Identifiers for WebRTC's Statistics API.

packetsDiscardedOnSend

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder packetsDiscardedOnSend(int packetsDiscardedOnSend)

packetsReceived

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder packetsReceived(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.

See Also:

RTCIceCandidatePairStats.packetsReceived - MDN, The definition of 'RTCIceCandidatePairStats.packetsReceived' in Identifiers for WebRTC's Statistics API.

packetsSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder packetsSent(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.

See Also:

RTCIceCandidatePairStats.packetsSent - MDN, The definition of 'RTCIceCandidatePairStats.packetsSent' in Identifiers for WebRTC's Statistics API.

requestBytesSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder requestBytesSent(int requestBytesSent)

requestsReceived

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder requestsReceived(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.

See Also:

RTCIceCandidatePairStats.requestsReceived - MDN, The definition of 'RTCIceCandidatePairStats.requestsReceived' in Identifiers for WebRTC's Statistics API.

requestsSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder requestsSent(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.

See Also:

RTCIceCandidatePairStats.requestsSent - MDN, The definition of 'RTCIceCandidatePairStats.requestsSent' in Identifiers for WebRTC's Statistics API.

responseBytesSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder responseBytesSent(int responseBytesSent)

responsesReceived

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder responsesReceived(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.

See Also:

RTCIceCandidatePairStats.responsesReceived - MDN, The definition of 'RTCIceCandidatePairStats.responsesReceived' in Identifiers for WebRTC's Statistics API.

responsesSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder responsesSent(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.

See Also:

RTCIceCandidatePairStats.responsesSent - MDN, The definition of 'RTCIceCandidatePairStats.responsesSent' in Identifiers for WebRTC's Statistics API.

retransmissionsReceived

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder retransmissionsReceived(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.

See Also:

RTCIceCandidatePairStats.retransmissionsReceived - MDN, The definition of 'RTCIceCandidatePairStats.retransmissionsReceived' in Identifiers for WebRTC's Statistics API.

retransmissionsSent

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder retransmissionsSent(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.

See Also:

RTCIceCandidatePairStats.retransmissionsSent - MDN, The definition of 'RTCIceCandidatePairStats.retransmissionsSent' in Identifiers for WebRTC's Statistics API.

totalRoundTripTime

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder totalRoundTripTime(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.

See Also:

RTCIceCandidatePairStats.totalRoundTripTime - MDN, The definition of 'RTCIceCandidatePairStats.totalRoundTripTime' in Identifiers for WebRTC's Statistics API.

currentRtt

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder currentRtt(double currentRtt)

priority

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder priority(int priority)

totalRtt

@JsOverlay
 @Nonnull
default RTCIceCandidatePairStats.Builder totalRtt(double totalRtt)