- java.lang.Object
-
- java.lang.Enum<RTCIceTransportPolicy>
-
- dev.onvoid.webrtc.RTCIceTransportPolicy
-
- All Implemented Interfaces:
Serializable,Comparable<RTCIceTransportPolicy>
public enum RTCIceTransportPolicy extends Enum<RTCIceTransportPolicy>
Defines the ICE candidate policy the application uses to surface the permitted candidates to the application; only these candidates will be used for connectivity checks.- Author:
- Alex Andres
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static RTCIceTransportPolicyvalueOf(String name)Returns the enum constant of this type with the specified name.static RTCIceTransportPolicy[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final RTCIceTransportPolicy NONE
-
RELAY
public static final RTCIceTransportPolicy RELAY
The ICE Agent uses only media relay candidates such as candidates passing through a TURN server.NOTE: This can be used to prevent the remote endpoint from learning the user's IP addresses, which may be desired in certain use cases. For example, in a "call"-based application, the application may want to prevent an unknown caller from learning the callee's IP addresses until the callee has consented in some way.
-
NO_HOST
public static final RTCIceTransportPolicy NO_HOST
-
ALL
public static final RTCIceTransportPolicy ALL
The ICE Agent can use any type of candidate when this value is specified.NOTE: The implementation can still use its own candidate filtering policy in order to limit the IP addresses exposed to the application, as noted in the description of RTCIceCandidate.address.
-
-
Method Detail
-
values
public static RTCIceTransportPolicy[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (RTCIceTransportPolicy c : RTCIceTransportPolicy.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RTCIceTransportPolicy valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
-