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 aGuildChannelthat contains additional methods present for audio channels- See Also:
VoiceChannel,StageChannel,Guild.getVoiceChannelCache(),IGuildChannelContainer.getVoiceChannels(),IGuildChannelContainer.getVoiceChannelsByName(String, boolean),IGuildChannelContainer.getVoiceChannelById(long),Guild.getStageChannelCache(),IGuildChannelContainer.getStageChannels(),IGuildChannelContainer.getStageChannelsByName(String, boolean),IGuildChannelContainer.getStageChannelById(long),IGuildChannelContainer.getVoiceChannelById(long),IGuildChannelContainer.getStageChannelById(long)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description intgetBitrate()The audio bitrate of the voice audio that is transmitted in this channel.AudioChannelManager<?,?>getManager()Returns theChannelManagerfor this GuildChannel.default RegiongetRegion()TheRegionof thisAudioChannel.StringgetRegionRaw()The raw region name for thisAudioChannel.-
Methods inherited from interface net.dv8tion.jda.api.entities.Channel
formatTo, getAsMention, getJDA, getName, getType
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface net.dv8tion.jda.api.entities.GuildChannel
delete, getGuild, getPermissionContainer
-
Methods inherited from interface net.dv8tion.jda.api.entities.IMemberContainer
getMembers
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Method Detail
-
getManager
@Nonnull AudioChannelManager<?,?> getManager()
Description copied from interface:GuildChannelReturns theChannelManagerfor 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 callingRestAction.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:
getManagerin interfaceGuildChannel- 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()
TheRegionof thisAudioChannel.
This will returnRegion.AUTOMATICif the region of this channel is set to Automatic.- Returns:
- the
Regionof this channel.
-
getRegionRaw
@Nullable String getRegionRaw()
The raw region name for thisAudioChannel. This will return null if the region is set to Automatic.- Returns:
- Raw region name
-
-