Package net.dv8tion.jda.api.managers.channel.middleman

Interface AudioChannelManager<T extends AudioChannel,M extends AudioChannelManager<T,M>>

Type Parameters:

T - The channel type

M - The manager type

All Superinterfaces:

AuditableRestAction<Void>, ChannelManager<T,M>, ICategorizableChannelManager<T,M>, IPermissionContainerManager<T,M>, IPositionableChannelManager<T,M>, Manager<M>, RestAction<Void>, StandardGuildChannelManager<T,M>

All Known Subinterfaces:

StageChannelManager, VoiceChannelManager

public interface AudioChannelManager<T extends AudioChannel,M extends AudioChannelManager<T,M>>
extends StandardGuildChannelManager<T,M>

Manager providing functionality common for all AudioChannels.

Example

 manager.setBitrate(48000)
        .setRegion(Region.AUTOMATIC)
        .queue();
 manager.reset(ChannelManager.REGION | ChannelManager.BITRATE)
        .setRegion(Region.BRAZIL)
        .queue();
 

See Also:

• AudioChannel.getManager()

Field Summary

Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

MAX_REASON_LENGTH

Fields inherited from interface net.dv8tion.jda.api.managers.channel.ChannelManager

APPLIED_TAGS, ARCHIVED, AUTO_ARCHIVE_DURATION, AVAILABLE_TAGS, BITRATE, DEFAULT_LAYOUT, DEFAULT_REACTION, DEFAULT_SORT_ORDER, DEFAULT_THREAD_SLOWMODE, HIDE_MEDIA_DOWNLOAD_OPTIONS, INVITEABLE, LOCKED, NAME, NSFW, PARENT, PERMISSION, PINNED, POSITION, REGION, REQUIRE_TAG, SLOWMODE, TOPIC, TYPE, USERLIMIT

Method Summary

Modifier and Type	Method	Description
M	setBitrate(int bitrate)	Sets the bitrate of the selected AudioChannel.
M	setRegion(Region region)	Sets the Region of the selected AudioChannel.
M	setUserLimit(int userLimit)	Sets the user-limit of the selected AudioChannel.

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

reason

Methods inherited from interface net.dv8tion.jda.api.managers.channel.ChannelManager

getChannel, getGuild, reset, reset, setName

Methods inherited from interface net.dv8tion.jda.api.managers.channel.attribute.ICategorizableChannelManager

setParent, sync, sync

Methods inherited from interface net.dv8tion.jda.api.managers.channel.attribute.IPermissionContainerManager

clearOverridesAdded, clearOverridesRemoved, putMemberPermissionOverride, putMemberPermissionOverride, putPermissionOverride, putPermissionOverride, putRolePermissionOverride, putRolePermissionOverride, removePermissionOverride, removePermissionOverride

Methods inherited from interface net.dv8tion.jda.api.managers.channel.attribute.IPositionableChannelManager

setPosition

Methods inherited from interface net.dv8tion.jda.api.managers.Manager

deadline, reset, setCheck, timeout

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Method Details

setBitrate

@Nonnull
@CheckReturnValue
M setBitrate(int bitrate)

Sets the bitrate of the selected AudioChannel.
The default value is 64000

A channel bitrate must not be less than 8000 nor greater than Guild.getMaxBitrate()!
This is only available to AudioChannels

Parameters:

bitrate - The new bitrate for the selected AudioChannel

Returns:

ChannelManager for chaining convenience

Throws:

IllegalStateException - If the selected channel is not an AudioChannel

IllegalArgumentException - If the provided bitrate is less than 8000 or greater than Guild.getMaxBitrate().

See Also:

• Guild.getFeatures()

setUserLimit

@Nonnull
@CheckReturnValue
M setUserLimit(int userLimit)

Sets the user-limit of the selected AudioChannel.
Provide 0 to reset the user-limit of the AudioChannel

A channel user-limit must not be negative nor greater than 99 for VoiceChannel and not greater than 10000 for StageChannel!
This is only available to AudioChannels

Parameters:

userLimit - The new user-limit for the selected AudioChannel

Returns:

ChannelManager for chaining convenience

Throws:

IllegalStateException - If the selected channel is not an AudioChannel

IllegalArgumentException - If the provided user-limit is negative or greater than the permitted maximum

setRegion

@Nonnull
@CheckReturnValue
M setRegion(@Nonnull
 Region region)

Sets the Region of the selected AudioChannel.
The default value is Region.AUTOMATIC Possible values are:

• Region.AUTOMATIC
• Region.US_WEST
• Region.US_EAST
• Region.US_CENTRAL
• Region.US_SOUTH
• Region.SINGAPORE
• Region.SOUTH_AFRICA
• Region.SYDNEY
• Region.INDIA
• Region.SOUTH_KOREA
• Region.BRAZIL
• Region.JAPAN
• Region.RUSSIA

This is only available to AudioChannels!

Parameters:

region - The new Region

Returns:

ChannelManager for chaining convenience

Throws:

IllegalStateException - If the selected channel is not an AudioChannel

IllegalArgumentException - If the provided Region is not in the list of usable values