Enum Class IceCandidatePairState

java.lang.Object
java.lang.Enum<IceCandidatePairState>
com.twilio.video.IceCandidatePairState
All Implemented Interfaces:
Serializable, Comparable<IceCandidatePairState>, Constable

public enum IceCandidatePairState extends Enum<IceCandidatePairState>
ICE candidate pair state as defined in RFC 5245.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Failed: A check for this pair was already done and failed, either never producing any response or producing an unrecoverable failure response.
    Frozen: A check for this pair hasn't been performed, and it can't yet be performed until some other check succeeds, allowing this pair to unfreeze and move into the Waiting state.
    In-Progress: A check has been sent for this pair, but the transaction is in progress.
    Succeeded: A check for this pair was already done and produced a successful result.
    Waiting: A check has not been performed for this pair, and can be performed as soon as it is the highest-priority Waiting pair on the check list.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • STATE_SUCCEEDED

      public static final IceCandidatePairState STATE_SUCCEEDED
      Succeeded: A check for this pair was already done and produced a successful result.
    • STATE_FROZEN

      public static final IceCandidatePairState STATE_FROZEN
      Frozen: A check for this pair hasn't been performed, and it can't yet be performed until some other check succeeds, allowing this pair to unfreeze and move into the Waiting state.
    • STATE_WAITING

      public static final IceCandidatePairState STATE_WAITING
      Waiting: A check has not been performed for this pair, and can be performed as soon as it is the highest-priority Waiting pair on the check list.
    • STATE_IN_PROGRESS

      public static final IceCandidatePairState STATE_IN_PROGRESS
      In-Progress: A check has been sent for this pair, but the transaction is in progress.
    • STATE_FAILED

      public static final IceCandidatePairState STATE_FAILED
      Failed: A check for this pair was already done and failed, either never producing any response or producing an unrecoverable failure response.
  • Method Details

    • values

      public static IceCandidatePairState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static IceCandidatePairState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null