Document the Voice Channel Effect Send event #6025
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.
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"
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"
@advaith1 has this been fixed/changed?
There was a problem hiding this comment.
no, this is staying as-is for now. you should treat 1 and "1" as identical in payloads of this event - do not make assumptions based on whether it is a string or not.
|
What's the status here, will this become usable? |
|
When we go to add this to the documentation we should first put them behind a different intent. This should not be bound to voice states intent |
|
Guessing there are no plans to add |
Have there been any changes in that regard yet? |
|
@valdotle we have decided to keep it in the voice states intent |
If anyone else is wondering about this see this PR for sending sounds via RPC. |
Co-authored-by: TTtie <[email protected]> Ref: discord/discord-api-docs#6025
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