Document the Voice Channel Effect Send event #6025
Open
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
8 tasks
DonovanDMC
added a commit
to OceanicJS/Oceanic
that referenced
this pull request
Apr 2, 2023
6 tasks
37 tasks
|
since soundboard has been released, I've added the soundboard effect fields to this PR. The shared canvas fields are still omitted soundboard sound details and management will be in another pr |
7 tasks
Puncher1
reviewed
Oct 21, 2023
docs/topics/Gateway_Events.md
Outdated
| | emoji? | ?[emoji](#DOCS_RESOURCES_EMOJI/emoji-object) object | The emoji sent, for emoji reaction and soundboard effects | | ||
| | animation_type? | integer | The [type of emoji animation](#DOCS_TOPICS_GATEWAY_EVENTS/voice-channel-effect-send-animation-types), for emoji reaction and soundboard effects | | ||
| | animation_id? | integer | The ID of the emoji animation, for emoji reaction and soundboard effects | | ||
| | sound_id? | snowflake | The ID of the soundboard sound, for soundboard effects | |
There was a problem hiding this comment.
The sound_id does not necessarily have to be a snowflake. It's an integer when it's a default sound.
There was a problem hiding this comment.
looks like for default sounds the id is in a string (e.g. "1") in the API but a number in this gw event 🫠
updated to "snowflake or integer"
Puncher1
reviewed
Oct 21, 2023
|
What's the status here, will this become usable? |
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.
This PR documents the
VOICE_CHANNEL_EFFECT_SENDevent, which is sent when a user sends a voice channel effect in a vc that the bot is connected to. Voice channel effects are used for emoji reactions, Soundboard, and Shared Canvas.As only emoji reactions are fully released, I only documented fields relevant for those here.This event is part of theGUILD_VOICE_STATES(1 << 7) intent.Core fields:
channel_id,guild_id,user_idEmoji reaction and soundboard fields:
emoji,animation_type,animation_idSoundboard fields:
sound_id,sound_volume,sound_override_pathShared Canvas fields:
points,streamer_id,line_id,emoji_hose(these are not included in this PR)Additional notes:
animation_ids just map to Lottie files, there appear to be no names so I just documented it as an arbitrary integer instead of an enum