Package net.dv8tion.jda.api.entities

Interface AudioChannel

All Superinterfaces:
Channel, Comparable<GuildChannel>, Formattable, GuildChannel, IMemberContainer, IMentionable, ISnowflake
All Known Subinterfaces:
StageChannel, VoiceChannel
public interface AudioChannel extends GuildChannel, IMemberContainer
Represents a Guild Channel that is capable of handling audio.
This is a GuildChannel that contains additional methods present for audio channels
See Also:

  • Method Details

    • getManager

      @Nonnull AudioChannelManager<?,?> getManager()
      Description copied from interface: GuildChannel
      Returns the ChannelManager for this GuildChannel.
      In the ChannelManager, you can modify the name, topic and position of this GuildChannel. You modify multiple fields in one request by chaining setters before calling RestAction.queue().

      This is a lazy idempotent getter. The manager is retained after the first call. This getter is not thread-safe and would require guards by the user.

      Specified by:
      getManager in interface GuildChannel
      Returns:
      The ChannelManager of this GuildChannel

    • getBitrate

      int getBitrate()
      The audio bitrate of the voice audio that is transmitted in this channel. While higher bitrates can be sent to this channel, it will be scaled down by the client.
      Default and recommended value is 64000
      Returns:
      The audio bitrate of this audio channel.

    • getRegion

      @Nonnull default Region getRegion()
      The Region of this AudioChannel.
      This will return Region.AUTOMATIC if the region of this channel is set to Automatic.
      Returns:
      the Region of this channel.

    • getRegionRaw

      @Nullable String getRegionRaw()
      The raw region name for this AudioChannel. This will return null if the region is set to Automatic.
      Returns:
      Raw region name