foo-webview-sdk
    Preparing search index...

    Interface PlaylistSortParams

    Parameters for playlist.sort. Sort a playlist by a Title Formatting pattern, saving an undo point first. A locked playlist fails with LOCKED.

    interface PlaylistSortParams {
        descending?: boolean;
        pattern?: string;
        playlist?: number;
        playlistGuid?: string;
        selectedOnly?: boolean;
    }
    Index
    descending? pattern? playlist? playlistGuid? selectedOnly?
    descending?: boolean

    Reverse the whole playlist after sorting. The reversal covers all tracks, even when selectedOnly is set.

    false
    pattern?: string

    Title Formatting pattern to sort by.

    "%title%"
    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.

    selectedOnly?: boolean

    Sort only the selected tracks among themselves, keeping the others in place.

    false

    Settings
    Member Visibility

    On This Page
    Properties