Module webrtc.java

Package dev.onvoid.webrtc

Class RTCPeerConnectionIceErrorEvent

java.lang.Object

dev.onvoid.webrtc.RTCPeerConnectionIceErrorEvent

public class RTCPeerConnectionIceErrorEvent
extends Object

This event occurs when the RTCPeerConnection fails to gather an ICE candidate.

Author:

Alex Andres

Method Summary

Modifier and Type	Method	Description
String	getAddress()	Returns the local IP address used to communicate with the STUN or TURN server.
int	getErrorCode()	The numeric STUN error code returned by the STUN or TURN server.
String	getErrorText()	The STUN reason text returned by the STUN or TURN server.
Integer	getPort()	Returns the port used to communicate with the STUN or TURN server.
String	getUrl()	The STUN or TURN URL that identifies the STUN or TURN server for which the failure occurred.

Methods inherited from class java.lang.Object

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

Method Details

getAddress

public String getAddress()

Returns the local IP address used to communicate with the STUN or TURN server.

On a multi-homed system, multiple interfaces may be used to contact the server, and this attribute allows the application to figure out on which one the failure occurred.

If the local IP address value is not already exposed as part of a local candidate, the address attribute will be set to null.

Returns:

The local IP address or null, if the IP address is not already exposed.

getPort

public Integer getPort()

Returns the port used to communicate with the STUN or TURN server.

If the address is null, the port is also set to null.

Returns:

The port or null, if the address is null.

getUrl

public String getUrl()

The STUN or TURN URL that identifies the STUN or TURN server for which the failure occurred.

Returns:

The STUN or TURN URL.

getErrorCode

public int getErrorCode()

The numeric STUN error code returned by the STUN or TURN server.

If no host candidate can reach the server, errorCode will be set to the value 701 which is outside the STUN error code range. This error is only fired once per server URL while in the RTCIceGatheringState of "GATHERING".

Returns:

The numeric STUN error code

getErrorText

public String getErrorText()

The STUN reason text returned by the STUN or TURN server.

If the server could not be reached, errorText will be set to an implementation-specific value providing details about the error.

Returns:

The STUN reason text returned by the STUN or TURN server.