Centrifugo Channels

Queue events are published to the following channels:

Channel Pattern	Description
streamer:{streamerId}-queue	Queue-specific events
streamer:{streamerId}	All events for the streamer (includes queue)

All events follow this JSON structure:

{
  "type": "event_type",
  "data": <payload or null>
}

Add Song to Queue

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

Events

Event	Channel	Payload	Description
queue_add	queue	QueueDetails	The full queue entry that was added

Update Song in Queue

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

Events

Event	Channel	Payload	Description
queue_update	queue	null	Signals that the queue has been modified

Remove Song from Queue

Events

Event	Channel	Payload	Description
queue_remove	queue	{"id": <id>}	The ID of the queue entry that was removed

Set Song in Queue as Played

Events

Event	Channel	Payload	Description
queue_remove	queue	{"id": <id>}	The queue entry is removed from the active queue
play_history_add	play_history	null	Signals that a new play history entry was created

Reorder Queue

Events

Event	Channel	Payload	Description
queue_update	queue	null	Signals that the queue order has been modified

Move Song to Saved Queue

Events

Event	Channel	Payload	Description
queue_remove	queue	{"id": <id>}	The queue entry is removed from the active queue
saved_queue_update	saved-queue	null	Signals that the saved queue has been modified