akasha.rtc

Interface RTCIceCandidateStats

All Superinterfaces:

RTCStats

All Known Subinterfaces:

RTCIceCandidateStats.Builder

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public interface RTCIceCandidateStats
extends RTCStats

The WebRTC API's RTCIceCandidateStats dictionary provides statistics related to an RTCIceCandidate.

See Also:

RTCIceCandidateStats - MDN, (WebRTC Statistics) # icecandidate-dict*

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RTCIceCandidateStats.Builder The WebRTC API's RTCIceCandidateStats dictionary provides statistics related to an RTCIceCandidate.

Method Summary

Modifier and Type	Method and Description
@JsNullable java.lang.String	address() The address property of the RTCIceCandidateStats dictionary indicates the address of the ICE candidate.
@JsNonNull java.lang.String	candidateType() The RTCIceCandidateStats interface's candidateType property is a string which indicates the type of ICE candidate the object represents.
static RTCIceCandidateStats.Builder	create(double timestamp, java.lang.String type, java.lang.String id, java.lang.String candidateType, java.lang.String transportId)
boolean	deleted() The RTCIceCandidateStats dictionary's deleted property indicates whether or not the candidate has been deleted or released.
boolean	isRemote()
int	port() The RTCIceCandidateStats dictionary's port property specifies the network port used by the candidate.
int	priority() The RTCIceCandidateStats dictionary's priority property is a positive integer value indicating the priority (or desirability) of the described candidate.
java.lang.String	protocol() The RTCIceCandidateStats dictionary's protocol property specifies the protocol the specified candidate would use for communication with the remote peer.
java.lang.String	relayProtocol() The RTCIceCandidateStats dictionary's relayProtocol property specifies the protocol being used by a local ICE candidate to communicate with the TURN server.
void	setAddress(@JsNullable java.lang.String address) The address property of the RTCIceCandidateStats dictionary indicates the address of the ICE candidate.
void	setCandidateType(@JsNonNull java.lang.String candidateType) The RTCIceCandidateStats interface's candidateType property is a string which indicates the type of ICE candidate the object represents.
void	setDeleted(boolean deleted) The RTCIceCandidateStats dictionary's deleted property indicates whether or not the candidate has been deleted or released.
void	setIsRemote(boolean isRemote)
void	setPort(int port) The RTCIceCandidateStats dictionary's port property specifies the network port used by the candidate.
void	setPriority(int priority) The RTCIceCandidateStats dictionary's priority property is a positive integer value indicating the priority (or desirability) of the described candidate.
void	setProtocol(@JsNonNull java.lang.String protocol) The RTCIceCandidateStats dictionary's protocol property specifies the protocol the specified candidate would use for communication with the remote peer.
void	setRelayProtocol(@JsNonNull java.lang.String relayProtocol) The RTCIceCandidateStats dictionary's relayProtocol property specifies the protocol being used by a local ICE candidate to communicate with the TURN server.
void	setTransportId(@JsNonNull java.lang.String transportId) The RTCIceCandidateStats dictionary's transportId property is a string that uniquely identifies the transport that produced the RTCTransportStats from which information about this candidate was taken.
void	setUrl(@JsNonNull java.lang.String url) The RTCIceCandidateStats dictionary's url property specifies the URL of the ICE server from which the described candidate was obtained.
@JsNonNull java.lang.String	transportId() The RTCIceCandidateStats dictionary's transportId property is a string that uniquely identifies the transport that produced the RTCTransportStats from which information about this candidate was taken.
java.lang.String	url() The RTCIceCandidateStats dictionary's url property specifies the URL of the ICE server from which the described candidate was obtained.

Methods inherited from interface akasha.rtc.RTCStats

create, id, setId, setTimestamp, setType, timestamp, type

Method Detail

create

@JsOverlay
 @Nonnull
static RTCIceCandidateStats.Builder create(double timestamp,
                                                                @RTCStatsType @Nonnull
                                                                java.lang.String type,
                                                                @Nonnull
                                                                java.lang.String id,
                                                                @RTCIceCandidateType @Nonnull
                                                                java.lang.String candidateType,
                                                                @Nonnull
                                                                java.lang.String transportId)

address

@JsProperty(name="address")
@JsNullable java.lang.String address()

The address property of the RTCIceCandidateStats dictionary indicates the address of the ICE candidate. While it's preferred that the address be specified as an IPv4 or IPv6 numeric address, a fully-qualified domain name can be used as well.

See Also:

RTCIceCandidateStats.address - MDN, RTCIceCandidateStats.address - Identifiers for WebRTC's Statistics API

setAddress

@JsProperty
void setAddress(@JsNullable java.lang.String address)

The address property of the RTCIceCandidateStats dictionary indicates the address of the ICE candidate. While it's preferred that the address be specified as an IPv4 or IPv6 numeric address, a fully-qualified domain name can be used as well.

See Also:

RTCIceCandidateStats.address - MDN, RTCIceCandidateStats.address - Identifiers for WebRTC's Statistics API

candidateType

@JsProperty(name="candidateType")
 @RTCIceCandidateType
@JsNonNull java.lang.String candidateType()

The RTCIceCandidateStats interface's candidateType property is a string which indicates the type of ICE candidate the object represents.

See Also:

RTCIceCandidateStats.candidateType - MDN, RTCIceCandidateStats.candidateType - Identifiers for WebRTC's Statistics API

setCandidateType

@JsProperty
void setCandidateType(@RTCIceCandidateType
                                  @JsNonNull java.lang.String candidateType)

The RTCIceCandidateStats interface's candidateType property is a string which indicates the type of ICE candidate the object represents.

See Also:

RTCIceCandidateStats.candidateType - MDN, RTCIceCandidateStats.candidateType - Identifiers for WebRTC's Statistics API

port

@JsProperty(name="port")
int port()

The RTCIceCandidateStats dictionary's port property specifies the network port used by the candidate.

See Also:

RTCIceCandidateStats.port - MDN, RTCIceCandidateStats.port - Identifiers for WebRTC's Statistics API

setPort

@JsProperty
void setPort(int port)

The RTCIceCandidateStats dictionary's port property specifies the network port used by the candidate.

See Also:

RTCIceCandidateStats.port - MDN, RTCIceCandidateStats.port - Identifiers for WebRTC's Statistics API

priority

@JsProperty(name="priority")
int priority()

The RTCIceCandidateStats dictionary's priority property is a positive integer value indicating the priority (or desirability) of the described candidate.

See Also:

RTCIceCandidateStats.priority - MDN, RTCIceCandidateStats.port - Identifiers for WebRTC's Statistics API

setPriority

@JsProperty
void setPriority(int priority)

The RTCIceCandidateStats dictionary's priority property is a positive integer value indicating the priority (or desirability) of the described candidate.

See Also:

RTCIceCandidateStats.priority - MDN, RTCIceCandidateStats.port - Identifiers for WebRTC's Statistics API

protocol

@JsProperty(name="protocol")
java.lang.String protocol()

The RTCIceCandidateStats dictionary's protocol property specifies the protocol the specified candidate would use for communication with the remote peer.

See Also:

RTCIceCandidateStats.protocol - MDN, RTCIceCandidateStats.protocol - Identifiers for WebRTC's Statistics API

setProtocol

@JsProperty
void setProtocol(@JsNonNull java.lang.String protocol)

The RTCIceCandidateStats dictionary's protocol property specifies the protocol the specified candidate would use for communication with the remote peer.

See Also:

RTCIceCandidateStats.protocol - MDN, RTCIceCandidateStats.protocol - Identifiers for WebRTC's Statistics API

relayProtocol

@JsProperty(name="relayProtocol")
java.lang.String relayProtocol()

The RTCIceCandidateStats dictionary's relayProtocol property specifies the protocol being used by a local ICE candidate to communicate with the TURN server.

See Also:

RTCIceCandidateStats.relayProtocol - MDN, RTCIceCandidateStats.relayProtocol - Identifiers for WebRTC's Statistics API

setRelayProtocol

@JsProperty
void setRelayProtocol(@JsNonNull java.lang.String relayProtocol)

The RTCIceCandidateStats dictionary's relayProtocol property specifies the protocol being used by a local ICE candidate to communicate with the TURN server.

See Also:

RTCIceCandidateStats.relayProtocol - MDN, RTCIceCandidateStats.relayProtocol - Identifiers for WebRTC's Statistics API

transportId

@JsProperty(name="transportId")
@JsNonNull java.lang.String transportId()

The RTCIceCandidateStats dictionary's transportId property is a string that uniquely identifies the transport that produced the RTCTransportStats from which information about this candidate was taken.

See Also:

RTCIceCandidateStats.transportId - MDN, RTCIceCandidateStats.transportId - Identifiers for WebRTC's Statistics API

setTransportId

@JsProperty
void setTransportId(@JsNonNull java.lang.String transportId)

The RTCIceCandidateStats dictionary's transportId property is a string that uniquely identifies the transport that produced the RTCTransportStats from which information about this candidate was taken.

See Also:

RTCIceCandidateStats.transportId - MDN, RTCIceCandidateStats.transportId - Identifiers for WebRTC's Statistics API

url

@JsProperty(name="url")
java.lang.String url()

The RTCIceCandidateStats dictionary's url property specifies the URL of the ICE server from which the described candidate was obtained. This property is only available for local candidates.

See Also:

RTCIceCandidateStats.url - MDN, RTCIceCandidateStats.url - Identifiers for WebRTC's Statistics API

setUrl

@JsProperty
void setUrl(@JsNonNull java.lang.String url)

The RTCIceCandidateStats dictionary's url property specifies the URL of the ICE server from which the described candidate was obtained. This property is only available for local candidates.

See Also:

RTCIceCandidateStats.url - MDN, RTCIceCandidateStats.url - Identifiers for WebRTC's Statistics API

deleted

@JsProperty(name="deleted")
boolean deleted()

The RTCIceCandidateStats dictionary's deleted property indicates whether or not the candidate has been deleted or released.

See Also:

RTCIceCandidateStats.deleted - MDN, RTCIceCandidateStats.deleted - Identifiers for WebRTC's Statistics API

setDeleted

@JsProperty
void setDeleted(boolean deleted)

The RTCIceCandidateStats dictionary's deleted property indicates whether or not the candidate has been deleted or released.

See Also:

RTCIceCandidateStats.deleted - MDN, RTCIceCandidateStats.deleted - Identifiers for WebRTC's Statistics API

isRemote

@JsProperty(name="isRemote")
boolean isRemote()

setIsRemote

@JsProperty
void setIsRemote(boolean isRemote)