Document Soundboard #6260
Open
Document Soundboard #6260
+173
−26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
valdotle
reviewed
Jun 28, 2023
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.
Suggested change
| | 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.
Suggested change
| 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.
Suggested change
| | 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.
Suggested change
| 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.
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.
maybe that could be integrated into the reference section somehow, since that's the only place where CDN endpoints are currently listed...
valdotle
reviewed
Jun 28, 2023
8 tasks
9 tasks
7 tasks
|
is there a status on this? |
|
What is holding this back? |
Maybe the conflicts |
|
|
|
|
|
The |
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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_DELETEare not tied to any intent currently, so they are sent to all botsidandsound_idare always the same, butidis optional