Support for Soundboard and VC effects

[Puncher1]

Summary

Last updated: Aug 15, 2024

• Bots can receive voice channel effects over gateway events
• Bots can receive sounds over gateway events and over API requests
• Bots can create, edit and delete sounds
• Bots can send sounds

This PR includes

• Support for voice channel effects
  • VoiceChannelEffect, VoiceChannelSoundEffect, VoiceChannelEffectAnimation models
  • VoiceChannelEffectAnimationType enum
  • on_voice_channel_effect event
• Support for soundboard sounds
  • SoundboardSound, SoundboardDefaultSound models
  • create_, edit_, delete_ sound
  • fetch_ methods (default sounds, normal sounds, specific sound)
  • Request sounds over the gateway (may be superfluous since fetch_ methods exist)
  • VoiceChannel.send_sound method
  • soundboard_sounds property and get_ methods (both for Guild and Client)
  • on_soundboard_sound_ events (create, update, delete) + GUILD_SOUNDBOARD_SOUNDS_UPDATE event (dispatches update event for every sound in the list)
• Related Audit Log events
• Intents.expressions -> emojis and emojis_and_stickers are now both aliases

Current Problems [solved]

All problems on Discord's side, which were stated in the related soundboard PR are fixed ✅

• There is no GET route for individual sounds or a guild's list of sounds. Guild sound lists can currently only be retrieved via the Gateway. GET routes should be added *
• PATCHing a sound currently clears the sound's volume and emoji if those aren't included in the request. The PR documents this current behavior, let me know once it is fixed **
• Looks like id and sound_id are always the same, but id is optional ***

* Now available
** The PR doesn't document this behaviour anymore
*** id has been removed

Others

Default sounds are identified with an id, override_path has been removed

Related PRs: discord/discord-api-docs#6025 (voice channel effects), discord/discord-api-docs#6260 (soundboard)

Checklist

Testing pending

• If code changes were made then they have been tested.
  • I have updated the documentation to reflect the changes.
• This PR fixes an issue.
• This PR adds something new (e.g. new method or parameters).
• This PR is a breaking change (e.g. methods or parameters removed/renamed)
• This PR is not a code change (e.g. documentation, README, ...)

[SvenLie]

When can we expect this to be undrafted and merged? @Puncher1

[Puncher1]

@SvenLie The GET method is still not supported which, at least for me, doesn't make sense to merge it yet.

[Puncher1]

Update

• For the current status, please refer to the PR description
• The 3.x checks are failing. Looks like there's an error in the installation, @Rapptz
• Testing is pending, after that this PR is ready for review

[Rapptz]

3.x is failing due to aiohttp not building on 3.12 and 3.x is latest Python, so CI is blocked on dependencies and not much I can do there.

[Puncher1]

This has been tested and is ready for review now.

[PaulMarisOUMary]

I believe the issues with 3.x have been resolved now. 🎉

[Rapptz]

I've only done a cursory pass at this. It has merge conflicts currently as well, though this feature is pretty complicated and definitely needs documentation on Discord's end for me to merge it.

There are a few things I'm kind of iffy about, some more important than others:

1. The name SoundboardSound is pretty silly, I'm unsure if going Soudboard is any better but it doesn't read as oddly.
2. The machinery to handle opcode 31 in the gateway seems very complicated for what it is. The chunking mechanism is the way it is because it's expected that multiple events flow in and it needs to be synced and waited. I have no reason to believe soundboard sounds operate the same way but I also have no idea if they do. I tried asking to get clarification on this though I haven't gotten a response yet. I'll update you when I do.

[Puncher1]

Alright I'm done with the changes. Because of the name, how about just Sound? And should it be also applied for properties and attributes (e.g. Client.soundboard_sounds -> Client.sounds)?

[DA-344]

This will need changes because of the latests commits on the DDevs Docs PR: discord/discord-api-docs@ec86562

[Puncher1]

...
2. The machinery to handle opcode 31 in the gateway seems very complicated for what it is. The chunking mechanism is the way it is because it's expected that multiple events flow in and it needs to be synced and waited. I have no reason to believe soundboard sounds operate the same way but I also have no idea if they do. I tried asking to get clarification on this though I haven't gotten a response yet. I'll update you when I do.

@Rapptz You can now get soundboard sounds via GET /guilds/{guild_id}/soundboard-sounds, opcode 31 is now quite superfluous.

Edit
Except for receiving sounds for multiple guilds in one request 🤷‍♂️

[Rapptz]

You can now get soundboard sounds via GET /guilds/{guild_id}/soundboard-sounds, opcode 31 is now quite superfluous.

If it's superfluous outside of multiple guilds -> sound then it should probably be removed. There isn't an immediate benefit to the complicated machinery being used for soundboards.

[Puncher1]

Messed up a bit (almost lost all changes lol), so I had to force push.