@dvxch/yandex-music
    Preparing search index...

    Class Cover

    Cover art descriptor.

    A cover can either reference a single uri template or a list of itemsUri tiles (mosaic covers, typically for playlists). Replace the %% placeholder in a URI with a size such as 400x400 to obtain a concrete image URL.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client? color? copyrightCline? copyrightName? custom? derivedColors? dir? error? isCustom? itemsUri? prefix? type? uri? version? videoUrl?

    Methods

    deJson requireClient

    Constructors

    Properties

    client?: Client

    The client that created this model, used by convenience methods.

    color?: string

    Dominant color.

    copyrightCline?: string

    Copyright C-line.

    copyrightName?: string

    Copyright holder name.

    custom?: boolean

    Whether the cover is custom (legacy flag).

    derivedColors?: CoverDerivedColors

    Colors derived from the cover image.

    dir?: string

    Storage directory of the cover.

    error?: string

    Error code when the cover could not be resolved.

    isCustom?: boolean

    Whether the cover is custom.

    itemsUri?: string[]

    URI templates of the tiles composing a mosaic cover.

    prefix?: string

    URI prefix.

    type?: string

    Cover kind, for example mosaic or pic.

    uri?: string

    URI template of a single image.

    version?: string

    Version tag of the cover.

    videoUrl?: string

    URL of an animated/video cover.

    Methods

    • Assert that this model carries a client, returning it narrowed to non-null.

      Convenience methods that need to call the API use this to fail fast with a clear message instead of a generic "cannot read property of undefined".

      Returns Client

      The owning Client.

      When the model was created without a client.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods