Get All Queued Songs
JSON Body
| Parameter | Description |
|---|---|
| songId | The ID of the song to add. This is required when "nonlistSong" is not provided |
| nonlistSong | A "live-learn" request, replaces the "title" and "artist" of the song associated with "songId" |
| requests | An array of requests consisting of "name" and "amount" properties |
| note (optional) | A note that is only visible to the streamer or mods |
Websocket Events
| Event | Payload | Description |
|---|---|---|
| queue-update | QueueResponse | Sends the full response to all connected clients |
| queue-event | QueueMessageEvent | The relevant data to construct a message to explain how the queue was modified |
| reload-song-list | N/A | A song was updated, client should reload the songlist |
| update-song | songId | Only sent if the song that was removed was a live-learn (nonlistSong) |
JSON Body
| Parameter | Description |
|---|---|
| id | The ID of the queue entity to update |
| songId | The ID of the song to add. This is required when "nonlistSong" is not provided |
| nonlistSong | A "live-learn" request, replaces the "title" and "artist" of the song associated with "songId" |
| requests | An array of requests consisting of "name" and "amount" properties |
| note (optional) | A note that is only visible to the streamer or mods |
Websocket Events
| Event | Payload | Description |
|---|---|---|
| queue-update | QueueResponse | Sends the full response to all connected clients |
| queue-event | QueueMessageEvent | The relevant data to construct a message to explain how the queue was modified |
Remove song from queue
Websocket Events
| Event | Payload | Description |
|---|---|---|
| queue-update | QueueResponse | Sends the full response to all connected clients |
| queue-event | QueueMessageEvent | The relevant data to construct a message to explain how the queue was modified |
| reload-song-list | N/A | A song was updated, client should reload the songlist |
| update-song | songId | Only sent if the song that was removed was a live-learn (nonlistSong) |
Set Song in Queue as played
Websocket Events
| Event | Payload | Description |
|---|---|---|
| queue-update | QueueResponse | Sends the full response to all connected clients |
| queue-event | QueueMessageEvent | The relevant data to construct a message to explain how the queue was modified |
| reload-song-list | N/A | A song was updated, client should reload the songlist |
| update-song | songId | Only sent if the song that was removed was a live-learn (nonlistSong) |
| new-playhistory | PlayHistoryResponse | New "played" song event |
Move Song to Saved Queue
Websocket Events
| Event | Payload | Description |
|---|---|---|
| queue-update | QueueResponse | Sends the full response to all connected clients |
| queue-event | QueueMessageEvent | The relevant data to construct a message to explain how the queue was modified |
| reload-song-list | N/A | A song was updated, client should reload the songlist |
| update-song | songId | Only sent if the song that was removed was a live-learn (nonlistSong) |
| reload-saved-queue | N/A | A new song can be retrieved from the "Saved Queue" endpoint |