akasha.rtc

Class RTCIceTransport

java.lang.Object

akasha.EventTarget

akasha.rtc.RTCIceTransport

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="RTCIceTransport")
public class RTCIceTransport
extends EventTarget

The RTCIceTransport interface provides access to information about the ICE transport layer over which the data is being sent and received.

See Also:

RTCIceTransport - MDN, RTCIceTransport - WebRTC 1.0: Real-time Communication Between Browsers

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	ongatheringstatechange The ongatheringstatechange event handler for the RTCIceTransport interface specifies an event handler that is to be called when the gatheringstatechange event occurs on the transport.
EventHandler	onselectedcandidatepairchange The RTCIceTransport interface's onselectedcandidatepairchange event handler specifies a function to be called to handle the selectedcandidatepairchange event, which is fired when the ICE agent selects a new candidate pair to be used for the connection.
EventHandler	onstatechange The onstatechange event handler for the RTCIceTransport interface is a property which specifies a function to serve as the EventHandler for the statechange event that is fired whenever the transport's state changes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RTCIceTransport()

Method Summary

Modifier and Type	Method and Description
void	addGatheringstatechangeListener(EventListener callback)
void	addGatheringstatechangeListener(EventListener callback, AddEventListenerOptions options)
void	addGatheringstatechangeListener(EventListener callback, boolean useCapture)
void	addSelectedcandidatepairchangeListener(EventListener callback)
void	addSelectedcandidatepairchangeListener(EventListener callback, AddEventListenerOptions options)
void	addSelectedcandidatepairchangeListener(EventListener callback, boolean useCapture)
void	addStatechangeListener(EventListener callback)
void	addStatechangeListener(EventListener callback, AddEventListenerOptions options)
void	addStatechangeListener(EventListener callback, boolean useCapture)
java.lang.String	component() The read-only RTCIceTransport property component specifies whether the object is serving to transport RTP or RTCP.
java.lang.String	gatheringState() The read-only RTCIceTransport property gatheringState returns a DOMString from the enumerated type RTCIceGathererState that indicates what gathering state the ICE agent is currently in: "new", "gathering", or "complete".
JsArray<RTCIceCandidate>	getLocalCandidates() The RTCIceTransport method getLocalCandidates() returns an array of RTCIceCandidate objects, one for each of the candidates that have been gathered by the local device during the current ICE agent session.
RTCIceParameters	getLocalParameters() The RTCIceTransport method getLocalParameters() returns an RTCIceParameters object which provides information uniquely identifying the local peer for the duration of the ICE session.
JsArray<RTCIceCandidate>	getRemoteCandidates() The RTCIceTransport method getRemoteCandidates() returns an array which contains one RTCIceCandidate for each of the candidates that have been received from the remote peer so far during the current ICE gathering session.
RTCIceParameters	getRemoteParameters() The RTCIceTransport method getRemoteParameters() returns an RTCIceParameters object which provides information uniquely identifying the remote peer for the duration of the ICE session.
RTCIceCandidatePair	getSelectedCandidatePair() The RTCIceTransport method getSelectedCandidatePair() returns an RTCIceCandidatePair object containing the current best-choice pair of ICE candidates describing the configuration of the endpoints of the transport.
void	removeGatheringstatechangeListener(EventListener callback)
void	removeGatheringstatechangeListener(EventListener callback, boolean useCapture)
void	removeGatheringstatechangeListener(EventListener callback, EventListenerOptions options)
void	removeSelectedcandidatepairchangeListener(EventListener callback)
void	removeSelectedcandidatepairchangeListener(EventListener callback, boolean useCapture)
void	removeSelectedcandidatepairchangeListener(EventListener callback, EventListenerOptions options)
void	removeStatechangeListener(EventListener callback)
void	removeStatechangeListener(EventListener callback, boolean useCapture)
void	removeStatechangeListener(EventListener callback, EventListenerOptions options)
java.lang.String	role() The read-only RTCIceTransport property role indicates which ICE role the transport is fulfilling: that of the controlling agent, or the agent that is being controlled.
java.lang.String	state() The read-only RTCIceTransport property state returns the current state of the ICE transport, so you can determine the state of ICE gathering in which the ICE agent currently is operating.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ongatheringstatechange

@Nullable
public EventHandler ongatheringstatechange

The ongatheringstatechange event handler for the RTCIceTransport interface specifies an event handler that is to be called when the gatheringstatechange event occurs on the transport.

See Also:

RTCIceTransport.ongatheringstatechange - MDN, RTCIceTransport.ongatheringstatechange - WebRTC 1.0: Real-time Communication Between Browsers

onselectedcandidatepairchange

@Nullable
public EventHandler onselectedcandidatepairchange

The RTCIceTransport interface's onselectedcandidatepairchange event handler specifies a function to be called to handle the selectedcandidatepairchange event, which is fired when the ICE agent selects a new candidate pair to be used for the connection.

See Also:

RTCIceTransport.onselectedcandidatepairchange - MDN, RTCIceTransport.onselectedcandidatepairchange - WebRTC 1.0: Real-time Communication Between Browsers

onstatechange

@Nullable
public EventHandler onstatechange

The onstatechange event handler for the RTCIceTransport interface is a property which specifies a function to serve as the EventHandler for the statechange event that is fired whenever the transport's state changes.

See Also:

RTCIceTransport.onstatechange - MDN, RTCIceTransport.onstatechange - WebRTC 1.0: Real-time Communication Between Browsers

Constructor Detail

RTCIceTransport

protected RTCIceTransport()

Method Detail

component

@JsProperty(name="component")
 @Nonnull
 @RTCIceComponent
public java.lang.String component()

The read-only RTCIceTransport property component specifies whether the object is serving to transport RTP or RTCP. The value is one of the strings in RTCIceComponent.

See Also:

RTCIceTransport.component - MDN, RTCIceTransport.component - WebRTC 1.0: Real-time Communication Between Browsers

gatheringState

@JsProperty(name="gatheringState")
 @Nonnull
 @RTCIceGathererState
public java.lang.String gatheringState()

The read-only RTCIceTransport property gatheringState returns a DOMString from the enumerated type RTCIceGathererState that indicates what gathering state the ICE agent is currently in: "new", "gathering", or "complete".

See Also:

RTCIceTransport.gatheringState - MDN, RTCIceTransport.gatheringState - WebRTC 1.0: Real-time Communication Between Browsers

role

@JsProperty(name="role")
 @Nonnull
 @RTCIceRole
public java.lang.String role()

The read-only RTCIceTransport property role indicates which ICE role the transport is fulfilling: that of the controlling agent, or the agent that is being controlled.

See Also:

RTCIceTransport.role - MDN, RTCIceTransport.role - WebRTC 1.0: Real-time Communication Between Browsers

state

@JsProperty(name="state")
 @Nonnull
 @RTCIceTransportState
public java.lang.String state()

The read-only RTCIceTransport property state returns the current state of the ICE transport, so you can determine the state of ICE gathering in which the ICE agent currently is operating.

See Also:

RTCIceTransport.state - MDN, RTCIceTransportState - WebRTC 1.0: Real-time Communication Between Browsers

getLocalCandidates

@Nonnull
public JsArray<RTCIceCandidate> getLocalCandidates()

The RTCIceTransport method getLocalCandidates() returns an array of RTCIceCandidate objects, one for each of the candidates that have been gathered by the local device during the current ICE agent session.

See Also:

RTCIceTransport.getLocalCandidates - MDN, RTCIceCandidate.getLocalCandidates() - WebRTC 1.0: Real-time Communication Between Browsers

getLocalParameters

@Nullable
public RTCIceParameters getLocalParameters()

The RTCIceTransport method getLocalParameters() returns an RTCIceParameters object which provides information uniquely identifying the local peer for the duration of the ICE session.

See Also:

RTCIceTransport.getLocalParameters - MDN, RTCIceTransport.getLocalParameters - WebRTC 1.0: Real-time Communication Between Browsers

getRemoteCandidates

@Nonnull
public JsArray<RTCIceCandidate> getRemoteCandidates()

The RTCIceTransport method getRemoteCandidates() returns an array which contains one RTCIceCandidate for each of the candidates that have been received from the remote peer so far during the current ICE gathering session.

See Also:

RTCIceTransport.getRemoteCandidates - MDN, RTCIceCandidate.getRemoteCandidates() - WebRTC 1.0: Real-time Communication Between Browsers

getRemoteParameters

@Nullable
public RTCIceParameters getRemoteParameters()

The RTCIceTransport method getRemoteParameters() returns an RTCIceParameters object which provides information uniquely identifying the remote peer for the duration of the ICE session.

See Also:

RTCIceTransport.getRemoteParameters - MDN, RTCIceTransport.getRemoteParameters - WebRTC 1.0: Real-time Communication Between Browsers

getSelectedCandidatePair

@Nullable
public RTCIceCandidatePair getSelectedCandidatePair()

The RTCIceTransport method getSelectedCandidatePair() returns an RTCIceCandidatePair object containing the current best-choice pair of ICE candidates describing the configuration of the endpoints of the transport.

See Also:

RTCIceTransport.getSelectedCandidatePair - MDN, RTCIceTransport.getSelectedCandidatePair() - WebRTC 1.0: Real-time Communication Between Browsers

addGatheringstatechangeListener

@JsOverlay
public final void addGatheringstatechangeListener(@Nonnull
                                                             EventListener callback,
                                                             @Nonnull
                                                             AddEventListenerOptions options)

addGatheringstatechangeListener

@JsOverlay
public final void addGatheringstatechangeListener(@Nonnull
                                                             EventListener callback,
                                                             boolean useCapture)

addGatheringstatechangeListener

@JsOverlay
public final void addGatheringstatechangeListener(@Nonnull
                                                             EventListener callback)

removeGatheringstatechangeListener

@JsOverlay
public final void removeGatheringstatechangeListener(@Nonnull
                                                                EventListener callback,
                                                                @Nonnull
                                                                EventListenerOptions options)

removeGatheringstatechangeListener

@JsOverlay
public final void removeGatheringstatechangeListener(@Nonnull
                                                                EventListener callback,
                                                                boolean useCapture)

removeGatheringstatechangeListener

@JsOverlay
public final void removeGatheringstatechangeListener(@Nonnull
                                                                EventListener callback)

addSelectedcandidatepairchangeListener

@JsOverlay
public final void addSelectedcandidatepairchangeListener(@Nonnull
                                                                    EventListener callback,
                                                                    @Nonnull
                                                                    AddEventListenerOptions options)

addSelectedcandidatepairchangeListener

@JsOverlay
public final void addSelectedcandidatepairchangeListener(@Nonnull
                                                                    EventListener callback,
                                                                    boolean useCapture)

addSelectedcandidatepairchangeListener

@JsOverlay
public final void addSelectedcandidatepairchangeListener(@Nonnull
                                                                    EventListener callback)

removeSelectedcandidatepairchangeListener

@JsOverlay
public final void removeSelectedcandidatepairchangeListener(@Nonnull
                                                                       EventListener callback,
                                                                       @Nonnull
                                                                       EventListenerOptions options)

removeSelectedcandidatepairchangeListener

@JsOverlay
public final void removeSelectedcandidatepairchangeListener(@Nonnull
                                                                       EventListener callback,
                                                                       boolean useCapture)

removeSelectedcandidatepairchangeListener

@JsOverlay
public final void removeSelectedcandidatepairchangeListener(@Nonnull
                                                                       EventListener callback)

addStatechangeListener

@JsOverlay
public final void addStatechangeListener(@Nonnull
                                                    EventListener callback,
                                                    @Nonnull
                                                    AddEventListenerOptions options)

addStatechangeListener

@JsOverlay
public final void addStatechangeListener(@Nonnull
                                                    EventListener callback,
                                                    boolean useCapture)

addStatechangeListener

@JsOverlay
public final void addStatechangeListener(@Nonnull
                                                    EventListener callback)

removeStatechangeListener

@JsOverlay
public final void removeStatechangeListener(@Nonnull
                                                       EventListener callback,
                                                       @Nonnull
                                                       EventListenerOptions options)

removeStatechangeListener

@JsOverlay
public final void removeStatechangeListener(@Nonnull
                                                       EventListener callback,
                                                       boolean useCapture)

removeStatechangeListener

@JsOverlay
public final void removeStatechangeListener(@Nonnull
                                                       EventListener callback)