foo-webview-sdk
    Preparing search index...

    Interface PlaylistInsertTracksParams

    Parameters for playlist.insertTracks. Insert tracks at a position of a playlist, saving an undo point first. Each entry of handles is a path with an optional |subsong:N suffix, or { path, subsong }; entries that are neither, or that name nothing, are counted in invalidCount. When none is usable the call fails with NOT_FOUND. A locked playlist fails with LOCKED.

    interface PlaylistInsertTracksParams {
        expectedVersion?: string;
        handles: JsonValue[];
        playlist?: number;
        playlistGuid?: string;
        position?: number;
    }
    Index
    expectedVersion? handles playlist? playlistGuid? position?
    expectedVersion?: string

    Expected content version for optimistic concurrency control. When mismatched, mutations are aborted with STALE_TARGET (details.current carries current version). Omitted, no check is made.

    handles: JsonValue[]

    Tracks to insert: each a path with an optional |subsong:N suffix, or { path, subsong }.

    playlist?: number

    Index of the playlist; omitted, the active playlist. 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.

    position?: number

    Row before which the tracks go; past the last row, they are appended.

    0

    Settings
    Member Visibility

    On This Page
    Properties