foo-webview-sdk
    Preparing search index...

    Interface PlaylistGetAutoplaylistQueryParams

    Parameters for playlist.getAutoplaylistQuery. Describe a playlist's autoplaylist status without editor capability fields, and read the query and sort of a list driven by foobar2000's built-in query/sort client. The read does not open UI or change the list; it reflects the client's current state on every call. Lists of any other provider (third-party, managed by this component, lock-only) and lists whose configuration cannot be decoded return null for both, with note saying which; getAutoplaylistConfig reads the managed ones.

    interface PlaylistGetAutoplaylistQueryParams {
        playlist?: number;
        playlistGuid?: string;
    }
    Index
    playlist? playlistGuid?
    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