Package org.javacord.api.audio

Enum SpeakingFlag

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SpeakingFlag>
    public enum SpeakingFlag
extends java.lang.Enum<SpeakingFlag>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int asInt()
      Gets the integer value of the flag.
      static SpeakingFlag valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SpeakingFlag[] 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

      • SPEAKING

        public static final SpeakingFlag SPEAKING
        The speaking flag. This flag indicates whether a client is or is not sending audio.

      • SOUNDSHARE

        public static final SpeakingFlag SOUNDSHARE
        The soundshare flag. This flag is used for sending audio while sharing screens. Not useful to bot accounts.

      • PRIORITY_SPEAKER

        public static final SpeakingFlag PRIORITY_SPEAKER
        The priority speaker flag. This flag is used for sending audio as a priority speaker (Louder than other clients).

    • Method Detail

      • values

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

      • valueOf

        public static SpeakingFlag 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

      • asInt

        public int asInt()
        Gets the integer value of the flag.
        Returns:
        The integer value of the flag.