Package net.dv8tion.jda.api.entities

Interface VoiceChannel

All Superinterfaces:

AbstractChannel, java.lang.Comparable<GuildChannel>, java.util.Formattable, GuildChannel, IMentionable, ISnowflake

All Known Subinterfaces:

StageChannel

public interface VoiceChannel
extends GuildChannel

Represents a Discord Voice GuildChannel.
Adds additional information specific to voice channels in Discord.

See Also:

GuildChannel, TextChannel, Category, Guild.getVoiceChannelCache(), Guild.getVoiceChannels(), Guild.getVoiceChannelsByName(String, boolean), Guild.getVoiceChannelById(long), JDA.getVoiceChannelCache(), JDA.getVoiceChannels(), JDA.getVoiceChannelsByName(String, boolean), JDA.getVoiceChannelById(long)

Method Summary

Modifier and Type	Method	Description
ChannelAction<VoiceChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<VoiceChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
int	getBitrate()	The audio bitrate of the voice audio that is transmitted in this channel.
Region	getRegion()	The Region of this VoiceChannel.
java.lang.String	getRegionRaw()	The raw region name for this VoiceChannel.
int	getUserLimit()	The maximum amount of Members that can be in this VoiceChannel at once.

Methods inherited from interface net.dv8tion.jda.api.entities.AbstractChannel

getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.dv8tion.jda.api.entities.GuildChannel

createInvite, createPermissionOverride, delete, getGuild, getManager, getMemberPermissionOverrides, getMembers, getParent, getPermissionOverride, getPermissionOverrides, getPosition, getPositionRaw, getRolePermissionOverrides, isSynced, putPermissionOverride, retrieveInvites, upsertPermissionOverride

Methods inherited from interface net.dv8tion.jda.api.entities.IMentionable

formatTo, getAsMention

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Detail

getUserLimit

int getUserLimit()

The maximum amount of Members that can be in this VoiceChannel at once.
0 - No limit

This is meaningless for StageChannels.

Returns:

The maximum amount of members allowed in this channel at once.

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 voice channel.

getRegion

@Nonnull
Region getRegion()

The Region of this VoiceChannel.
This will return Region.AUTOMATIC if the region of this channel is set to Automatic.

Returns:

the Region of this channel.

getRegionRaw

@Nullable
java.lang.String getRegionRaw()

The raw region name for this VoiceChannel. This will return null if the region is set to Automatic.

Returns:

Raw region name

createCopy

@Nonnull
ChannelAction<VoiceChannel> createCopy(@Nonnull
                                       Guild guild)

Description copied from interface: GuildChannel

Creates a copy of the specified GuildChannel in the specified Guild.
If the provided target guild is not the same Guild this channel is in then the parent category and permissions will not be copied due to technical difficulty and ambiguity.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface GuildChannel

Parameters:

guild - The Guild to create the channel in

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!

createCopy

@Nonnull
ChannelAction<VoiceChannel> createCopy()

Description copied from interface: GuildChannel

Creates a copy of the specified GuildChannel.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface GuildChannel

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!