foo-webview-sdk
    Preparing search index...

    Interface QueueAddParams

    Parameters for queue.add. Queue one or more tracks by their position in a playlist. Positions past the last row are skipped; when none is in range the call fails with INVALID_INDEX. A negative position fails with INVALID_PARAMS.

    interface QueueAddParams {
        expectedPlaylistVersion?: string;
        playlist?: number;
        playlistGuid?: string;
        track?: number;
        tracks?: number[];
    }
    Index
    expectedPlaylistVersion? playlist? playlistGuid? track? tracks?
    expectedPlaylistVersion?: string

    Act only while the playlist that the rows belong to still has this contentVersion, as its reads report it. A different version changes nothing and fails with STALE_TARGET, the current version carried as details.current. Omitted, no check is made.

    playlist?: number

    Playlist the positions refer to; the active playlist when omitted. An index past the last playlist fails with INVALID_INDEX; with this omitted and no active playlist the call fails with NO_ACTIVE_ITEM.

    playlistGuid?: string

    Persistent unique identifier of a playlist (bracketed GUID, case-insensitive), used in place of a mutable index. Mutually exclusive with playlist; passing both or an invalid format fails with INVALID_PARAMS. Fails with NOT_FOUND if the playlist does not exist, never falling back. Invalid-format and not-found failures return the given GUID in details.playlistGuid.

    track?: number

    A single row to queue; read only when tracks is absent.

    tracks?: number[]

    Rows to queue, in order. Takes precedence over track.

    Settings
    Member Visibility

    On This Page
    Properties