velvox
/
litecord
mirror of https://gitlab.com/litecord/litecord.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

lvsp: add docs for voice state create and destroy 

finishes all TODOs.
This commit is contained in:
Luna 2019-03-06 03:47:40 -03:00
parent b8c3208fa4
commit 76a8038cb4
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/lvsp.md
View File

@ -157,8 +157,6 @@ are laid on.
| 5 | VST\_UPDATE | voice state update | | 5 | VST\_UPDATE | voice state update |
| 6 | VST\_LEAVE | voice state leave | | 6 | VST\_LEAVE | voice state leave |
**TODO:** finish all infos
### CHANNEL\_REQ ### CHANNEL\_REQ
Request a channel to be created inside the voice server. Request a channel to be created inside the voice server.
@ -190,21 +188,32 @@ Same data as CHANNEL\_ASSIGN, but without `token`.
### VST\_CREATE ### VST\_CREATE
**TODO** Sent by the client to create a voice state.
| field | type | description | | field | type | description |
| --: | :-- | :-- | | --: | :-- | :-- |
| user\_id | snowflake | user id | | user\_id | snowflake | user id |
| channel\_id | snowflake | channel id | | channel\_id | snowflake | channel id |
| guild\_id | Optional[snowflake] | guild id | | guild\_id | Optional[snowflake] | guild id. not provided if dm / group dm |
### VST\_DONE ### VST\_DONE
**TODO** Sent by the server to indicate the success of a VST\_CREATE.
Has the same fields as VST\_CREATE, but with extras:
| field | type | description |
| --: | :-- | :-- |
| session\_id | string | session id for the voice state |
### VST\_DESTROY ### VST\_DESTROY
**TODO** Sent by the client when a user is leaving a channel OR moving between channels
in a guild. More on state transitions later on.
| field | type | description |
| --: | :-- | :-- |
| session\_id | string | session id for the voice state |
## Common logic scenarios ## Common logic scenarios
@ -218,7 +227,7 @@ user join is here.
- The Server MUST process CHANNEL\_REQ first, so the Server can keep - The Server MUST process CHANNEL\_REQ first, so the Server can keep
a lock on channel operations while it is initialized. a lock on channel operations while it is initialized.
- Reply with CHANNEL\_ASSIGN once initialization is done. - Reply with CHANNEL\_ASSIGN once initialization is done.
- Process VST\_CREATE **TODO** - Process VST\_CREATE
### Updating a voice channel ### Updating a voice channel
@ -236,10 +245,12 @@ user join is here.
- Client sends VST\_CREATE - Client sends VST\_CREATE
- Server sends VST\_DONE - Server sends VST\_DONE
### User moves a channel
**TODO**
### User leaves a channel ### User leaves a channel
**TODO** - Client sends VST\_DESTROY with the old fields
### User moves a channel
- Client sends VST\_DESTROY with the old fields
- Client sends VST\_CREATE with the new fields
- Server sends VST\_DONE