Package com.amazonaws.ivs.broadcast

Enum Stage.SubscribeState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Stage.SubscribeState>
    Enclosing class:
    Stage
    public static enum Stage.SubscribeState
extends java.lang.Enum<Stage.SubscribeState>
    The various potential subscribe states for a participant

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ATTEMPTING_SUBSCRIBE
      An subscription is being established to the remote participant
      NOT_SUBSCRIBED
      The participant is not being subscribed to
      SUBSCRIBED
      There is a connected subscription to the remote participant

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Stage.SubscribeState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Stage.SubscribeState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NOT_SUBSCRIBED

        public static final Stage.SubscribeState NOT_SUBSCRIBED
        The participant is not being subscribed to

      • ATTEMPTING_SUBSCRIBE

        public static final Stage.SubscribeState ATTEMPTING_SUBSCRIBE
        An subscription is being established to the remote participant

      • SUBSCRIBED

        public static final Stage.SubscribeState SUBSCRIBED
        There is a connected subscription to the remote participant

    • Method Detail

      • values

        public static Stage.SubscribeState[] 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 (Stage.SubscribeState c : Stage.SubscribeState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Stage.SubscribeState valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null