-
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 the Voice Channel Effect Send event #6025
base: main
Are you sure you want to change the base?
Conversation
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 |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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"
What's the status here, will this become usable? |
This PR documents the
VOICE_CHANNEL_EFFECT_SEND
event, 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_id
Emoji reaction and soundboard fields:
emoji
,animation_type
,animation_id
Soundboard fields:
sound_id
,sound_volume
,sound_override_path
Shared Canvas fields:
points
,streamer_id
,line_id
,emoji_hose
(these are not included in this PR)Additional notes:
animation_id
s just map to Lottie files, there appear to be no names so I just documented it as an arbitrary integer instead of an enum