-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document Soundboard #6260
base: main
Are you sure you want to change the base?
Document Soundboard #6260
Conversation
docs/resources/Soundboard.md
Outdated
| emoji_id | ?snowflake | the id of this sound's custom emoji | | ||
| emoji_name | ?string | the unicode character of this sound's standard emoji | | ||
| override_path | ?string | the filename of this sound (for default sounds) | | ||
| guild_id? | snowflake | the id of the guild this sound is in | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| guild_id? | snowflake | the id of the guild this sound is in | | |
| guild_id? | snowflake | the id of the guild this sound belongs to | |
|
||
Users can play soundboard sounds in voice channels, triggering a Voice Channel Effect Send Gateway event for users connected to the voice channel. Bots cannot play soundboard sounds. Soundboard use is controlled by the `USE_SOUNDBOARD` and `USE_EXTERNAL_SOUNDS` [permissions](#DOCS_TOPICS_PERMISSIONS). | ||
|
||
There is a set of [default sounds](#DOCS_RESOURCES_SOUNDBOARD/list-soundboard-default-sounds) available to all users. Soundboard sounds can also be [created in a guild](#DOCS_RESOURCES_SOUNDBOARD/create-guild-soundboard-sound); users will be able to use the sounds in the guild, and Nitro subscribers can use them in all guilds. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a set of [default sounds](#DOCS_RESOURCES_SOUNDBOARD/list-soundboard-default-sounds) available to all users. Soundboard sounds can also be [created in a guild](#DOCS_RESOURCES_SOUNDBOARD/create-guild-soundboard-sound); users will be able to use the sounds in the guild, and Nitro subscribers can use them in all guilds. | |
There is a set of [default sounds](#DOCS_RESOURCES_SOUNDBOARD/list-soundboard-default-sounds) available to all users. Soundboard sounds can also be [created in a guild](#DOCS_RESOURCES_SOUNDBOARD/create-guild-soundboard-sound); users will be able to use the sounds in this guild, and Nitro subscribers can use them in any guild. |
docs/resources/Soundboard.md
Outdated
| Field | Type | Description | | ||
| ------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------- | | ||
| name | string | the name of this sound | | ||
| sound_id | snowflake | the id of this sound | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| sound_id | snowflake | the id of this sound | | |
| sound_id | snowflake | the id of this [sound](#DOCS_RESOURCES_SOUNDBOARD/sound-files) | |
@@ -0,0 +1,90 @@ | |||
# Soundboard Resource | |||
|
|||
Users can play soundboard sounds in voice channels, triggering a Voice Channel Effect Send Gateway event for users connected to the voice channel. Bots cannot play soundboard sounds. Soundboard use is controlled by the `USE_SOUNDBOARD` and `USE_EXTERNAL_SOUNDS` [permissions](#DOCS_TOPICS_PERMISSIONS). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Users can play soundboard sounds in voice channels, triggering a Voice Channel Effect Send Gateway event for users connected to the voice channel. Bots cannot play soundboard sounds. Soundboard use is controlled by the `USE_SOUNDBOARD` and `USE_EXTERNAL_SOUNDS` [permissions](#DOCS_TOPICS_PERMISSIONS). | |
Users can play soundboard sounds in voice channels, triggering a [Voice Channel Effect Send](#DOCS_TOPICS_GATEWAY_EVENTS/voice-channel-effect-send) Gateway event for users connected to the voice channel. Bots cannot play soundboard sounds. Soundboard use is controlled by the `USE_SOUNDBOARD` and `USE_EXTERNAL_SOUNDS` [permissions](#DOCS_TOPICS_PERMISSIONS). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this will make the ci fail until #6025 gets merged
| available? | boolean | whether this sound can be used (for guild sounds), may be false due to loss of Server Boosts | | ||
| user? | [user](#DOCS_RESOURCES_USER/user-object) object | the user who created this sound | | ||
|
||
### Sound Files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe that could be integrated into the reference section somehow, since that's the only place where CDN endpoints are currently listed...
is there a status on this? |
What is holding this back? |
Maybe the conflicts |
|
|
The |
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:
GUILD_SOUNDBOARD_SOUND_CREATE
,GUILD_SOUNDBOARD_SOUND_UPDATE
, andGUILD_SOUNDBOARD_SOUND_DELETE
are not tied to any intent currently, so they are sent to all botsid
andsound_id
are always the same, butid
is optional