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

    Class Album

    A music album (also used to represent podcasts and audiobooks).

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    actionButton? albumType? artists? available? availableForMobile? availableForOptions? availableForPremiumUsers? availablePartially? availableRegions? backgroundImageUrl? bests? childContent? client? contentRestrictions? contentWarning? cover? coverUri? customWave? deprecation? derivedColors? description? disclaimers? duplicates? durationMs? error? explicit? genre? hasTrailer? id? isBanner? isPremiere? labels? likesCount? listeningFinished? lyricsAvailable? metaTagId? metaType? millisecondsUntilRelease? ogImage? pager? presaveDate? recent? regions? releaseDate? shortDescription? sortOrder? startDate? storageDir? textColor? title? trackCount? trackPosition? trailer? type? version? veryImportant? volumes? year?

    Methods

    deJson requireClient

    Constructors

    Properties

    actionButton?: AlbumActionButton

    Call-to-action button.

    albumType?: string

    Album type marker (newer key, for example single, podcast, audiobook).

    artists?: Artist[]

    Album artists.

    available?: boolean

    Whether the album is available.

    availableForMobile?: boolean

    Whether available on mobile.

    availableForOptions?: string[]

    Options the album is available for.

    availableForPremiumUsers?: boolean

    Whether the album is available to premium users.

    availablePartially?: boolean

    Whether only partially available.

    availableRegions?: string[]

    Regions where the album is available.

    backgroundImageUrl?: string

    Background image URI template.

    bests?: number[]

    Identifiers of the "best" tracks.

    childContent?: boolean

    Whether the album is child-friendly content.

    client?: Client

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

    contentRestrictions?: ContentRestrictions

    Content availability restrictions (age rating, etc.).

    contentWarning?: string

    Explicit/content warning marker.

    cover?: Cover

    Structured cover descriptor.

    coverUri?: string

    Cover URI template.

    customWave?: CustomWave

    Custom wave (radio) descriptor.

    deprecation?: Deprecation

    Deprecation/replacement info.

    derivedColors?: CoverDerivedColors

    Colors derived from the cover image.

    description?: string

    Full description.

    disclaimers?: string[]

    Disclaimers.

    duplicates?: Album[]

    Duplicate albums (other editions of the same release).

    durationMs?: number

    Total duration in milliseconds.

    error?: string

    Error code, present when the album could not be resolved.

    explicit?: boolean

    Explicit marker.

    genre?: string

    Genre.

    hasTrailer?: boolean

    Whether the album has a trailer.

    id?: number

    Unique album identifier.

    isBanner?: boolean

    Whether the album is a banner feature.

    isPremiere?: boolean

    Whether the album is a premiere.

    labels?: (string | Label)[]

    Record labels (objects or bare names depending on endpoint).

    likesCount?: number

    Number of likes.

    listeningFinished?: boolean

    Whether the user finished listening (audiobooks/podcasts).

    lyricsAvailable?: boolean

    Whether lyrics are available.

    metaTagId?: string

    Metatag id the album is grouped under.

    metaType?: string

    Meta type, for example music or podcast.

    millisecondsUntilRelease?: number

    Milliseconds until an unreleased album becomes available (pre-saves).

    ogImage?: string

    Open Graph image URI template.

    pager?: Pager

    Pagination metadata for the track list (with-tracks endpoint).

    presaveDate?: string

    Pre-save availability date (ISO 8601), for upcoming albums.

    recent?: boolean

    Whether the album is recent.

    regions?: string[]

    Regions where available.

    releaseDate?: string

    Release date (ISO 8601).

    shortDescription?: string

    Short description.

    sortOrder?: string

    Sort order applied to the track list (with-tracks endpoint).

    startDate?: string

    Start date of availability.

    storageDir?: string

    Storage directory.

    textColor?: string

    Text color suited for the cover.

    title?: string

    Album title.

    trackCount?: number

    Number of tracks.

    trackPosition?: TrackPosition

    Position of a single track within the album (contextual).

    trailer?: JSONValue

    Album trailer (free-form raw JSON, pending a typed model).

    type?: string

    Album kind, for example single or compilation.

    version?: string

    Version (for example "Deluxe Edition").

    veryImportant?: boolean

    Whether the album is flagged very important.

    volumes?: Track[][]

    Tracks grouped by volume (disc). Present on the with-tracks endpoint.

    year?: number

    Release year.

    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