Skip to content

Document the Voice Channel Effect Send event #6025

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.

Sign up for GitHub

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

Merged
advaith1 merged 5 commits into from
Aug 15, 2024
Merged

Document the Voice Channel Effect Send event #6025

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b09782
Document the Voice Channel Effect Send event
advaith1 Mar 28, 2023
d21105c
document soundboard effect fields
advaith1 Jun 28, 2023
31081b7
Merge remote-tracking branch 'upstream/main' into vc-effect-event
advaith1 May 16, 2024
05c38d8
updates
advaith1 May 16, 2024
60520f7
fix table formatting
advaith1 May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/topics/Gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,7 @@ GUILD_INVITES (1 << 6)
- INVITE_DELETE

GUILD_VOICE_STATES (1 << 7)
- VOICE_CHANNEL_EFFECT_SEND
- VOICE_STATE_UPDATE

GUILD_PRESENCES (1 << 8) **
Expand Down
25 changes: 25 additions & 0 deletions docs/topics/Gateway_Events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,7 @@ Receive events are Gateway events encapsulated in an [event payload](#DOCS_TOPIC
| [Stage Instance Delete](#DOCS_TOPICS_GATEWAY_EVENTS/stage-instance-delete) | Stage instance was deleted or closed |
| [Typing Start](#DOCS_TOPICS_GATEWAY_EVENTS/typing-start) | User started typing in a channel |
| [User Update](#DOCS_TOPICS_GATEWAY_EVENTS/user-update) | Properties about the user changed |
| [Voice Channel Effect Send](#DOCS_TOPICS_GATEWAY_EVENTS/voice-channel-effect-send) | Someone sent an effect in a voice channel the current user is connected to |
| [Voice State Update](#DOCS_TOPICS_GATEWAY_EVENTS/voice-state-update) | Someone joined, left, or moved a voice channel |
| [Voice Server Update](#DOCS_TOPICS_GATEWAY_EVENTS/voice-server-update) | Guild's voice server was updated |
| [Webhooks Update](#DOCS_TOPICS_GATEWAY_EVENTS/webhooks-update) | Guild channel webhook was created, update, or deleted |
Expand Down Expand Up @@ -1195,6 +1196,30 @@ Sent when properties about the current bot's user change. Inner payload is a [us

### Voice

#### Voice Channel Effect Send

Sent when someone sends an effect, such as an emoji reaction or a soundboard sound, in a voice channel the current user is connected to.

###### Voice Channel Effect Send Event Fields

| Field | Type | Description |
|-----------------|-----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| channel_id | snowflake | ID of the channel the effect was sent in |
| guild_id | snowflake | ID of the guild the effect was sent in |
| user_id | snowflake | ID of the user who sent the effect |
| 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 or integer | The ID of the soundboard sound, for soundboard effects |
| sound_volume? | double | The volume of the soundboard sound, from 0 to 1, for soundboard effects |

###### Animation Types

| Type | Value | Description |
|---------|-------|---------------------------------------------|
| PREMIUM | 0 | A fun animation, sent by a Nitro subscriber |
| BASIC | 1 | The standard animation |

#### Voice State Update

Sent when someone joins/leaves/moves voice channels. Inner payload is a [voice state](#DOCS_RESOURCES_VOICE/voice-state-object) object.
Expand Down