foo-webview-sdk
    Preparing search index...

    Interface PlaylistSetFocusedTrackParams

    Parameters for playlist.setFocusedTrack. Move the focus of a playlist to a row, or remove it. A row past the last one fails with INVALID_INDEX.

    interface PlaylistSetFocusedTrackParams {
        expectedVersion?: string;
        index?: number;
        playlist?: number;
        playlistGuid?: string;
    }
    Index
    expectedVersion? index? playlist? playlistGuid?
    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.

    index?: number

    Row to focus; omitted or negative, the playlist loses its focus.

    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.

    Settings
    Member Visibility

    On This Page
    Properties