discord-api-docs icon indicating copy to clipboard operation
discord-api-docs copied to clipboard

Document the Voice Channel Effect Send event

Open advaith1 opened this issue 2 years ago • 2 comments
trafficstars

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 the GUILD_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_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
  • Bots cannot send vc effects

advaith1 avatar Mar 28 '23 08:03 advaith1

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

advaith1 avatar Jun 28 '23 03:06 advaith1

What's the status here, will this become usable?

Talcon2 avatar Dec 03 '23 22:12 Talcon2

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

DV8FromTheWorld avatar Jul 18 '24 17:07 DV8FromTheWorld

Guessing there are no plans to add VOICE_CHANNEL_EFFECT_SEND to the RPC API right?

Hacksore avatar Jul 18 '24 18:07 Hacksore

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

Have there been any changes in that regard yet?

valdotle avatar Aug 15 '24 21:08 valdotle

@valdotle we have decided to keep it in the voice states intent

advaith1 avatar Aug 15 '24 21:08 advaith1

Guessing there are no plans to add VOICE_CHANNEL_EFFECT_SEND to the RPC API right?

If anyone else is wondering about this see this PR for sending sounds via RPC. https://github.com/overlayeddev/overlayed/pull/183

Hacksore avatar Aug 15 '24 21:08 Hacksore