SoundboardSound

class SoundboardSound

A sound uploaded to a guild’s soundboard.

Properties

Property	Type	Description
available	boolean	Whether the sound can be played. Discord marks sounds unavailable when the guild loses the boost level that allowed them.
createdAt	Date	When this sound was uploaded, decoded from the sound snowflake.
emojiId	string | null	ID of the custom emoji shown next to the sound.
emojiName	string | null	Unicode emoji shown next to the sound.
guildId	string	Guild ID this sound belongs to.
id	string	Sound ID.
name	string	Sound name.
user	User | null	User who uploaded the sound. Only present when the bot has the Create Expressions or Manage Expressions permission.
volume	number	Playback volume from 0 to 1.

Methods

async SoundboardSound.delete(reason: string) → Promise<void>

Delete this sound.

Parameters:

• reason: Reason for deletion, shown in audit log.

async SoundboardSound.edit(options: SoundboardSoundEditOptions) → Promise<SoundboardSound>

Edit sound properties.

Parameters:

• options: Sound properties to update.

Returns:

The updated sound.