foo-webview-sdk
    Preparing search index...

    Interface LibraryGetAlbumsParams

    Parameters for library.getAlbums. Albums of the whole library, grouped by album name plus album artist; tracks without an album tag are skipped. A complete list (offset 0, no includeTracks, every album within limit) is kept until the library changes, and a later call with the same query, sort and includeCover from offset 0 without includeTracks is answered from it. The grouping behind the list is kept the same way and shared with library.getAlbumTracks, so other calls do not read the library again either until it changes. With the library disabled it succeeds with no albums.

    interface LibraryGetAlbumsParams {
        coverMaxSize?: number;
        includeCover?: boolean;
        includeTracks?: boolean;
        limit?: number;
        offset?: number;
        query?: string;
        sort?: string;
        useCache?: boolean;
    }
    Index
    coverMaxSize? includeCover? includeTracks? limit? offset? query? sort? useCache?
    coverMaxSize?: number

    Largest cover to inline, in KiB; a larger cover is left out. 0 or less inlines any size.

    500
    includeCover?: boolean

    Add each album's front cover as coverDataUrl, read from its first track.

    false
    includeTracks?: boolean

    Add each album's tracks as tracks.

    false
    limit?: number

    Most albums to return.

    100
    offset?: number

    Albums to skip.

    0
    query?: string

    Keep only albums whose name or artist contains this text, compared case-insensitively for ASCII letters; empty keeps every album.

    ""
    sort?: string

    name, artist (the album artist), year or trackCount; any other value sorts by name.

    "name"
    useCache?: boolean

    Answer from the kept list when there is one; false always scans the library, and the result is still kept.

    true

    Settings
    Member Visibility

    On This Page
    Properties