Skip to content

QueueItem

One occurrence of a Song in a queue, frozen when created.

Metadata is the client’s caller-metadata type. Core stores the caller’s reference and never reads it.

Type Parameter Default type
Metadata unknown
Property Type Description
addedAt number Creation time in epoch milliseconds.
autoplay boolean Whether autoplay added this occurrence rather than a caller. Repeat and previous replays keep it.
id string -
metadata Metadata For an autoplay item, the metadata of the item it was related from.
playlist? Playlist<unknown, unknown> The Playlist this occurrence was inserted from, as the queue committed it after maxPlaylistSongs and age filtering. Absent for a Song insertion and for autoplay items. Repeat and previous replays keep it.
song Song -