Interface ISoundboardSoundChannel

All Superinterfaces:

AudioChannel, Channel, Comparable<GuildChannel>, Formattable, GuildChannel, ICategorizableChannel, ICopyableChannel, IDetachableEntity, IInviteContainer, IMemberContainer, IMentionable, IPermissionContainer, IPositionableChannel, ISnowflake, StandardGuildChannel

All Known Subinterfaces:

VoiceChannel

public interface ISoundboardSoundChannel
extends AudioChannel

Channel in which you can send soundboard sounds.

Field Summary

Fields inherited from interface Channel

MAX_NAME_LENGTH

Fields inherited from interface GuildChannel

JUMP_URL

Method Summary

Modifier and Type	Method	Description
default RestAction<Void>	sendSoundboardSound(SoundboardSoundSnowflake sound, long sourceGuildId)	Sends this sound to this audio channel.
RestAction<Void>	sendSoundboardSound(SoundboardSoundSnowflake sound, String sourceGuildId)	Sends this sound to this audio channel.

Methods inherited from interface AudioChannel

getBitrate, getManager, getRegion, getRegionRaw, getUserLimit

Methods inherited from interface Channel

formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface Comparable

compareTo

Methods inherited from interface GuildChannel

delete, getGuild, getJumpUrl, getPermissionContainer

Methods inherited from interface ICategorizableChannel

getParentCategory, getParentCategoryId, getParentCategoryIdLong, getPositionInCategory, isSynced

Methods inherited from interface IDetachableEntity

isDetached

Methods inherited from interface IInviteContainer

createInvite, retrieveInvites

Methods inherited from interface IMemberContainer

getMembers

Methods inherited from interface IPermissionContainer

getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

Methods inherited from interface IPositionableChannel

getPosition, getPositionRaw

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface StandardGuildChannel

createCopy, createCopy

Method Details

sendSoundboardSound

@Nonnull
@CheckReturnValue
RestAction<Void> sendSoundboardSound(@Nonnull
 SoundboardSoundSnowflake sound,
 @Nullable
 String sourceGuildId)

Sends this sound to this audio channel.
The bot must be connected to the voice channel to use this method, as well as be unmuted and undefeaned.

The returned RestAction can encounter the following ErrorResponses:

• MISSING_PERMISSIONS
  The sound cannot be sent due to a permission discrepancy
• CANNOT_SEND_VOICE_EFFECT
  The sound cannot be sent as the bot is either muted, deafened or suppressed
• UNKNOWN_SOUND
  The sound was deleted/does not exist

Parameters:

sound - The sound to send

sourceGuildId - The guild ID from which this sound is from, null for default sounds

Returns:

RestAction - Type: Void

Throws:

InsufficientPermissionException - If the bot does not have the following permissions:

• VOICE_SPEAK, VOICE_USE_SOUNDBOARD
• If the sound comes from other guilds, VOICE_USE_EXTERNAL_SOUNDS permission

IllegalArgumentException - If the provided sound is null, or the source guild ID is not null and not a snowflake

IllegalStateException -

• If the bot is not connected to this channel
• If the bot is deafened, muted or suppressed in this channel's guild

DetachedEntityException - If this entity is detached

sendSoundboardSound

@Nonnull
@CheckReturnValue
default RestAction<Void> sendSoundboardSound(@Nonnull
 SoundboardSoundSnowflake sound,
 long sourceGuildId)

Sends this sound to this audio channel.
The bot must be connected to the voice channel to use this method, as well as be unmuted and undefeaned.

The returned RestAction can encounter the following ErrorResponses:

• MISSING_PERMISSIONS
  The sound cannot be sent due to a permission discrepancy
• CANNOT_SEND_VOICE_EFFECT
  The sound cannot be sent as the bot is either muted, deafened or suppressed
• UNKNOWN_SOUND
  The sound was deleted/does not exist

Parameters:

sound - The sound to send

sourceGuildId - The guild ID from which this sound is from, 0 for default sounds

Returns:

RestAction - Type: Void

Throws:

InsufficientPermissionException - If the bot does not have the following permissions:

• VOICE_SPEAK, VOICE_USE_SOUNDBOARD
• If the sound comes from other guilds, VOICE_USE_EXTERNAL_SOUNDS permission

IllegalArgumentException - If the provided sound is null

IllegalStateException -

• If the bot is not connected to this channel
• If the bot is deafened, muted or suppressed in this channel's guild

DetachedEntityException - If this entity is detached