servius/songbird
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document intents for Songbird (#1061)

Browse Source
This commit is contained in:
Kyle Simpson
2020-11-05 23:25:29 +00:00
committed by GitHub
parent 7e4392ae68
commit 38a55da88b
2 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -14,6 +14,9 @@ The library offers:
handling, seeking on compatible streams, shared multithreaded audio stream caches,
and direct Opus data passthrough from DCA files.
## Intents
Songbird's gateway functionality requires you to specify the `GUILD_VOICE_STATES` intent.
## Examples
Full examples showing various types of functionality and integrations can be found as part of [serenity's examples], and in [this crate's examples directory].

3
src/lib.rs
View File

@@ -17,6 +17,9 @@
//! handling, seeking on compatible streams, shared multithreaded audio stream caches,
//! and direct Opus data passthrough from DCA files.
//!
//! ## Intents
//! Songbird's gateway functionality requires you to specify the `GUILD_VOICE_STATES` intent.
//!
//! ## Examples
//! Full examples showing various types of functionality and integrations can be found as part of [serenity's examples],
//! and in [this crate's examples directory].