discord-api-docs icon indicating copy to clipboard operation
discord-api-docs copied to clipboard

Document Soundboard

Open advaith1 opened this issue 2 years ago • 11 comments
trafficstars

Documents soundboard sounds and management. When a soundboard sound is used, Voice Channel Effect Send is emitted, which is documented in #6025

airhorn sounds intensify

some notes:

  • Bots cannot use soundboard
  • Looks like GUILD_SOUNDBOARD_SOUND_CREATE, GUILD_SOUNDBOARD_SOUND_UPDATE, and GUILD_SOUNDBOARD_SOUND_DELETE are not tied to any intent currently, so they are sent to all bots
    • They should probably be tied to GUILD_EMOJIS_AND_STICKERS (1 << 3), which should be renamed to GUILD_EXPRESSIONS
  • There is no GET route for individual sounds or a guild's list of sounds. Guild sound lists can currently only be retrieved via the Gateway. GET routes should be added
  • PATCHing a sound currently clears the sound's volume and emoji if those aren't included in the request.
    • The PR documents this current behavior, let me know once it is fixed
  • ~~Looks like id and sound_id are always the same, but id is optional~~ id is deprecated, removed from docs edit: fixed all of these :)

advaith1 avatar Jun 28 '23 06:06 advaith1

is there a status on this?

cobaltt7 avatar Aug 18 '23 23:08 cobaltt7

What is holding this back?

MinnDevelopment avatar Sep 02 '23 21:09 MinnDevelopment

What is holding this back?

Maybe the conflicts

codeofandrin avatar Oct 21 '23 13:10 codeofandrin

override_path doesn't exist anymore. For default sounds the /soundboard-sounds/sound_id is used as well for the CDN path. E.g. https://cdn.discordapp.com/soundboard-sounds/7 is the "ba dum tss" sound. Also, there's no format. Means, if you download it you have to change the format yourself in order to play the sound, looks like this is not intended.

codeofandrin avatar Oct 22 '23 18:10 codeofandrin

soundboard_sounds field is available in the Guild Create event. Has to be added to the extra fields: https://discord.com/developers/docs/topics/gateway-events#guild-create-guild-create-extra-fields

codeofandrin avatar Oct 26 '23 20:10 codeofandrin

The SOUNDBOARD_SOUNDS event is missing in the receive events list.

codeofandrin avatar Oct 29 '23 18:10 codeofandrin

heads up we are removing the user_id field on soundboard sounds. you will still get user if you have Manage Expressions

advaith1 avatar Jul 29 '24 21:07 advaith1

GET /guilds/{guild_id}/soundboard-sounds and GET /guilds/{guild_id}/soundboard-sounds/{sound_id} are missing.

/guilds/{guild_id}/soundboard-sounds returns items which is a list of sound objects:

{
    "items": [
        {
            "available": true,
            "emoji_id": null,
            ...
        },
        ...
    ]
}

codeofandrin avatar Aug 06 '24 14:08 codeofandrin

yeah I made those endpoints last week and didn't update the pr yet because there are some other things we are changing

advaith1 avatar Aug 06 '24 16:08 advaith1

heads up we are removing the user_id field on soundboard sounds. you will still get user if you have Manage Expressions

user_id is still sent instead of user in the GUILD_CREATE event. Will this also be changed?

codeofandrin avatar Aug 07 '24 10:08 codeofandrin

I think we will only send the user field over API and gateway will eventually not include user data, like emoji and stickers

advaith1 avatar Aug 07 '24 15:08 advaith1