Package net.dv8tion.jda.api.audio

Enum SpeakingMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SpeakingMode>
    public enum SpeakingMode
extends java.lang.Enum<SpeakingMode>
    Flags representing the speaking modes used by discord users.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.EnumSet<SpeakingMode> getModes​(int mask)
      Parses the active modes represented by the provided bitmask
      int getRaw()
      The raw bitmask for this mode
      static int getRaw​(java.util.Collection<SpeakingMode> modes)
      Converts the given speaking modes into raw its bitmask.
      static int getRaw​(SpeakingMode... modes)
      Converts the given speaking modes into raw its bitmask.
      static SpeakingMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static SpeakingMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

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

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

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

      • valueOf

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

      • getRaw

        public int getRaw()
        The raw bitmask for this mode
        Returns:
        bitmask

      • getModes

        @Nonnull
public static java.util.EnumSet<SpeakingMode> getModes​(int mask)
        Parses the active modes represented by the provided bitmask
        Parameters:
        mask - The bitmask containing the active speaking modes
        Returns:
        EnumSet containing the speaking modes

      • getRaw

        public static int getRaw​(@Nullable
                         SpeakingMode... modes)
        Converts the given speaking modes into raw its bitmask. This is only useful for sending speaking updates.
        Parameters:
        modes - The modes
        Returns:
        The bitmask for the provided speaking modes

      • getRaw

        public static int getRaw​(@Nullable
                         java.util.Collection<SpeakingMode> modes)
        Converts the given speaking modes into raw its bitmask. This is only useful for sending speaking updates.
        Parameters:
        modes - The modes
        Returns:
        The bitmask for the provided speaking modes