Skip to content
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

Update Docs #1074

Closed
wants to merge 1 commit into from
Closed

Update Docs #1074

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 14 additions & 10 deletions docs/api/websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Dispatched every x seconds (configurable in `application.yml`) with the current
```json
{
"op": "playerUpdate",
"guildId": "...",
"guildId": "1082302532421943407",
"state": {
"time": 1500467109,
"position": 60000,
Expand Down Expand Up @@ -243,7 +243,7 @@ Dispatched when a track starts playing.
{
"op": "event",
"type": "TrackStartEvent",
"guildId": "...",
"guildId": "1082302532421943407",
"track": {
"encoded": "QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==",
"info": {
Expand All @@ -259,7 +259,8 @@ Dispatched when a track starts playing.
"isrc": null,
"sourceName": "youtube"
},
"pluginInfo": {}
"pluginInfo": {},
"userData": {}
}
}
```
Expand Down Expand Up @@ -294,7 +295,7 @@ Dispatched when a track ends.
{
"op": "event",
"type": "TrackEndEvent",
"guildId": "...",
"guildId": "1082302532421943407",
"track": {
"encoded": "QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==",
"info": {
Expand All @@ -310,7 +311,8 @@ Dispatched when a track ends.
"isrc": null,
"sourceName": "youtube"
},
"pluginInfo": {}
"pluginInfo": {},
"userData": {}
},
"reason": "finished"
}
Expand Down Expand Up @@ -352,7 +354,7 @@ Dispatched when a track throws an exception.
{
"op": "event",
"type": "TrackExceptionEvent",
"guildId": "...",
"guildId": "1082302532421943407",
"track": {
"encoded": "QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==",
"info": {
Expand All @@ -368,7 +370,8 @@ Dispatched when a track throws an exception.
"isrc": null,
"sourceName": "youtube"
},
"pluginInfo": {}
"pluginInfo": {},
"userData": {}
},
"exception": {
"message": "...",
Expand Down Expand Up @@ -398,7 +401,7 @@ Dispatched when a track gets stuck while playing.
{
"op": "event",
"type": "TrackStuckEvent",
"guildId": "...",
"guildId": "1082302532421943407",
"track": {
"encoded": "QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==",
"info": {
Expand All @@ -414,7 +417,8 @@ Dispatched when a track gets stuck while playing.
"isrc": null,
"sourceName": "youtube"
},
"pluginInfo": {}
"pluginInfo": {},
"userData": {}
},
"thresholdMs": 123456789
}
Expand Down Expand Up @@ -444,7 +448,7 @@ See the [Discord Docs](https://discord.com/developers/docs/topics/opcodes-and-st
{
"op": "event",
"type": "WebSocketClosedEvent",
"guildId": "...",
"guildId": "1082302532421943407",
"code": 4006,
"reason": "Your session is no longer valid.",
"byRemote": true
Expand Down