Version: v2.9.2

Interface: QueueChangeEvent

The event emitted when the queue of the player is modified. This includes adding, removing, shuffling, or clearing tracks.

Property Type Description Optional
type string = "queue" The event type identifier. Always "queue" for this event.
action string = "add" | "remove" | "clear" | "shuffle" | "roundRobin" | "userBlock" | "autoPlayAdd" Describes the specific queue-related action that triggered the event.
previousQueueLength number | null The length of the queue before the event occurred.
currentQueueLength number | null The current length of the queue after the event.
tracks Track[] Array of affected tracks in this event. Only provided for specific actions like "add".

Property	Type	Description
`type`	string = "queue"	The event type identifier. Always `"queue"` for this event.
`action`	string = "add" \| "remove" \| "clear" \| "shuffle" \| "roundRobin" \| "userBlock" \| "autoPlayAdd"	Describes the specific queue-related action that triggered the event.
`previousQueueLength`	number \| null	The length of the queue before the event occurred.
`currentQueueLength`	number \| null	The current length of the queue after the event.
`tracks`	`Track[]`	Array of affected tracks in this event. Only provided for specific actions like `"add"`.