Interface SoundboardSound

All Superinterfaces:

ISnowflake, SoundboardSoundSnowflake

public interface SoundboardSound
extends SoundboardSoundSnowflake

Represents a soundboard sound, can be used in voice channels if they are available.

See Also:

• JDA.retrieveDefaultSoundboardSounds()
• Guild.getSoundboardSounds()
• Discord's Soundboard Docs

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<Void>	delete()	Deletes this soundboard sound.
EmojiUnion	getEmoji()	The emoji of this sound, or null if none is set.
Guild	getGuild()	The guild this sound is from, or null if this is a default soundboard sound.
JDA	getJDA()	Returns the JDA instance related to this SoundboardSound.
SoundboardSoundManager	getManager()	The SoundboardSoundManager for this soundboard sound, in which you can modify values.
String	getName()	The name of this sound.
User	getUser()	The user which created this sound, or null if this is a default soundboard sound.
double	getVolume()	The volume of this sound, from 0 to 1.
boolean	isAvailable()	Whether this sound can be used, may be false due to loss of server boosts.
RestAction<Void>	sendTo(ISoundboardSoundChannel channel)	Sends this sound to the specified voice channel.

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface SoundboardSoundSnowflake

getUrl

Method Details

getJDA

@Nonnull
JDA getJDA()

Returns the JDA instance related to this SoundboardSound.

Returns:

the corresponding JDA instance

getName

@Nonnull
String getName()

The name of this sound.

Returns:

The name of this sound

getVolume

double getVolume()

The volume of this sound, from 0 to 1.

Returns:

The volume of this sound, from 0 to 1

getEmoji

@Nullable
EmojiUnion getEmoji()

The emoji of this sound, or null if none is set.

Returns:

The emoji of this sound, or null

getGuild

@Nullable
Guild getGuild()

The guild this sound is from, or null if this is a default soundboard sound.

Returns:

The guild this sound is from, or null

isAvailable

boolean isAvailable()

Whether this sound can be used, may be false due to loss of server boosts.

Returns:

true if the sound can be used, false otherwise

getUser

@Nullable
User getUser()

The user which created this sound, or null if this is a default soundboard sound.

This is present only if the self member has the CREATE_GUILD_EXPRESSIONS or MANAGE_GUILD_EXPRESSIONS permission.

Returns:

The user which created this sound, or null

sendTo

@Nonnull
@CheckReturnValue
RestAction<Void> sendTo(@Nonnull
 ISoundboardSoundChannel channel)

Sends this sound to the specified voice 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

Parameters:

channel - The channel to send this sound on

Returns:

RestAction - Type: Void

Throws:

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

• VOICE_SPEAK, VOICE_USE_SOUNDBOARD
• When used in other guilds, VOICE_USE_EXTERNAL_SOUNDS permission

IllegalArgumentException - If the provided channel is null

IllegalStateException -

• If the sound is not available
• If the bot is not connected to the specified channel
• If the bot is deafened, muted or suppressed in the target guild

DetachedEntityException - If the provided channel is detached

delete

@Nonnull
@CheckReturnValue
AuditableRestAction<Void> delete()

Deletes this soundboard sound.

The returned RestAction can encounter the following ErrorResponses:

• MISSING_PERMISSIONS
  The sound cannot be deleted due to a permission discrepancy
• UNKNOWN_SOUND
  The sound was deleted

Returns:

RestAction - Type: Void

Throws:

InsufficientPermissionException -

• If the bot does not own this sound and does not have Permission.MANAGE_GUILD_EXPRESSIONS
• If the bot owns this sound and does not have Permission.MANAGE_GUILD_EXPRESSIONS or Permission.CREATE_GUILD_EXPRESSIONS

getManager

@Nonnull
@CheckReturnValue
SoundboardSoundManager getManager()

The SoundboardSoundManager for this soundboard sound, in which you can modify values.
You modify multiple fields in one request by chaining setters before calling RestAction.queue().

The returned RestAction can encounter the following ErrorResponses:

• MISSING_PERMISSIONS
  The sound cannot be edited due to a permission discrepancy
• INVALID_EMOJI
  The emoji is invalid
• UNKNOWN_SOUND
  The sound was deleted

Returns:

The SoundboardSoundManager of this soundboard sound

Throws:

InsufficientPermissionException -

• If the bot does not own this sound and does not have Permission.MANAGE_GUILD_EXPRESSIONS
• If the bot owns this sound and does not have Permission.MANAGE_GUILD_EXPRESSIONS or Permission.CREATE_GUILD_EXPRESSIONS