@ctrl/plex
    Preparing search index...

    Class Album

    Represents a single Album.

    Hierarchy (View Summary)

    Index
    constructor
    _INCLUDES addedAt? art? artBlurHash? audienceRating? collections? distance? fields formats? genres? guid? guids? images index? key labels? lastRatedAt? lastViewedAt? leafCount? librarySectionID? librarySectionKey? librarySectionTitle? live? loudnessAnalysisVersion? moods musicAnalysisVersion? originallyAvailableAt? parent? parentGuid? parentKey? parentRatingKey? parentTheme? parentThumb? parentTitle? player? players playlistItemID? playQueueItemID? rating? ratingKey? server session? sessionKey? sessions studio? styles? subformats? summary? thumb? thumbBlurHash? title? titleSort? transcodeSession? transcodeSessions type? ultraBlurColors? updatedAt? user? usernames userRating? viewCount viewedAt? viewedLeafCount? year? METADATA_TYPE TAG TYPE
    artUrl artwork hasPreviewThumbnails hasSonicAnalysis hasVoiceActivity isFullObject isPlayed listType metadataDirectory thumbUrl
    _defaultSyncTitle addCollection addGenre addLabel analyze artist audioStreams createPlayQueue defaultAdvanced delete download edit editAdvanced editContentRating editFields editOriginallyAvailableAt editSortTitle editStudio editSummary editTags editTitle extras fixMatch getStreamURL getWebURL history hubs isChildOf isLocked iterParts lyricStreams markPlayed markUnplayed matches merge play preference preferences rate refresh reload removeCollection removeGenre removeLabel section sonicallySimilar split subtitleStreams track tracks unmatch updateProgress updateTimeline url videoStreams

    _INCLUDES

    _INCLUDES: {
        checkFiles: number;
        includeAllConcerts: number;
        includeBandwidths: number;
        includeChapters: number;
        includeChildren: number;
        includeConcerts: number;
        includeExternalMedia: number;
        includeExtras: number;
        includeFields: string;
        includeGeolocation: number;
        includeLoudnessRamps: number;
        includeMarkers: number;
        includeOnDeck: number;
        includePopularLeaves: number;
        includePreferences: number;
        includeRelated: number;
        includeRelatedCount: number;
        includeReviews: number;
        includeStations: number;
    } = ...
    addedAt?: Date
    art?: string
    artBlurHash?: string
    audienceRating?: number
    collections?: Collection[]
    distance?: number

    Sonic distance from a seed item, used in sonically similar results.

    fields: Field[]

    List of field objects.

    formats?: Format[]
    genres?: Genre[]
    guid?: string
    guids?: Guid[]
    images: Image[]

    List of image objects.

    index?: number

    Plex index number (often the track number for tracks).

    key: string

    Plex relative url of this metadata item.

    labels?: Label[]
    lastRatedAt?: Date
    lastViewedAt?: Date
    leafCount?: number
    librarySectionID?: number
    librarySectionKey?: string

    Key of the library section this item belongs to.

    librarySectionTitle?: string

    Title of the library section this item belongs to.

    live?: boolean

    Whether the active session is live TV.

    loudnessAnalysisVersion?: string | number
    moods: Mood[]

    List of mood objects.

    musicAnalysisVersion?: number

    Plex music analysis version (1 indicates sonic analysis complete).

    originallyAvailableAt?: Date
    parent?: WeakRef<PlexObject>

    WeakRef to the parent object that this object is built from.

    parentGuid?: string

    Artist GUID

    parentKey?: string

    Artist Key

    parentRatingKey?: string | number

    Artist Rating Key

    parentTheme?: string

    Artist Theme

    parentThumb?: string

    Artist Thumb

    parentTitle?: string

    Artist Title

    player?: PlexSessionPlayer

    Client currently playing this item.

    players: PlexSessionPlayer[] = []

    Clients associated with this active playback.

    playlistItemID?: number

    Playlist item ID, only populated for items loaded from a Playlist.

    playQueueItemID?: number

    Queue-local item ID (only populated for PlayQueue items).

    rating?: number
    ratingKey?: string
    server: PlexServer
    session?: PlexPlaybackSession

    Bandwidth allocation for the active playback, when one exists.

    sessionKey?: number

    Server-local key for an active playback session.

    sessions: PlexPlaybackSession[] = []

    Bandwidth allocations associated with this active playback.

    studio?: string
    styles?: Style[]
    subformats?: Subformat[]
    summary?: string
    thumb?: string
    thumbBlurHash?: string
    title?: string
    titleSort?: string

    Title used for sorting (defaults to title).

    transcodeSession?: PlexTranscodeSession

    Active transcode associated with this playback, when Plex includes it.

    transcodeSessions: PlexTranscodeSession[] = []

    Transcodes associated with this active playback.

    type?: string
    ultraBlurColors?: UltraBlurColorsData
    updatedAt?: Date
    user?: PlexSessionUser

    Account currently playing this item.

    usernames: string[] = []

    Usernames associated with this active playback.

    userRating?: number

    User rating (0.0-10.0).

    viewCount: number

    Count of times the item was played.

    viewedAt?: Date

    Datetime item was last viewed (history).

    viewedLeafCount?: number
    year?: number
    METADATA_TYPE: string = 'track'

    Default metadata type for audio sync items.

    TAG: string = 'Directory'

    xml element tag

    TYPE: string = 'album'

    xml element type

    • get artUrl(): URL | undefined

      Background art URL with the token, falling back to the artist's art.

      Returns URL | undefined

    • get hasPreviewThumbnails(): boolean

      Returns boolean

    • get hasSonicAnalysis(): boolean

      Indicates if the audio item has undergone sonic analysis.

      Returns boolean

    • get hasVoiceActivity(): boolean

      Returns boolean

    • get isFullObject(): boolean

      Retruns True if this is already a full object. A full object means all attributes were populated from the api path representing only this item. For example, the search result for a movie often only contain a portion of the attributes a full object (main url) for that movie would contain.

      Returns boolean

    • get listType(): "audio"

      Hardcoded list type for filtering.

      Returns "audio"

    • get metadataDirectory(): string | undefined

      Path relative to the Plex server data directory, using server-independent separators.

      Returns string | undefined

    • get thumbUrl(): URL | undefined

      Thumbnail URL with the token, falling back to the album or artist thumbnail.

      Returns URL | undefined

    _defaultSyncTitle

    • _defaultSyncTitle(): string

      Returns the default title for a sync item.

      Returns string

    • Tell Plex Media Server to performs analysis on it this item to gather information. Analysis includes:

      • Gather Media Properties: All of the media you add to a Library has properties that are useful to know–whether it's a video file, a music track, or one of your photos (container, codec, resolution, etc).
      • Generate Default Artwork: Artwork will automatically be grabbed from a video file. A background image will be pulled out as well as a smaller image to be used for poster/thumbnail type purposes.
      • Generate Video Preview Thumbnails: Video preview thumbnails are created, if you have that feature enabled. Video preview thumbnails allow graphical seeking in some Apps. It's also used in the Plex Web App Now Playing screen to show a graphical representation of where playback is. Video preview thumbnails creation is a CPU-intensive process akin to transcoding the file.
      • Generate intro video markers: Detects show intros, exposing the 'Skip Intro' button in clients.

      Returns Promise<void>

    • Edit an object.

      Parameters

      • changes: Readonly<Record<string, string | number>>

      Returns Promise<void>

    • Use match result to update show metadata.

      Parameters

      • options: { agent?: string; auto?: boolean; searchResult?: SearchResult } = {}

        Match options.

      Returns Promise<void>

    • Returns true if this object was built from a parent of the given class.

      Parameters

      • cls: new (...args: any[]) => PlexObject

      Returns boolean

    • Parameters

      • options: { agent?: string; language?: string; title?: string; year?: string } = {}

        Match options.

        Examples:

        1. video.matches()

        2. video.matches({ title: "something", year: "2020" })

        3. video.matches({ title: "something" })

        4. video.matches({ year: "2020" })

        5. video.matches({ title: "something", year: "" })

        6. video.matches({ title: "", year: "2020" })

        7. video.matches({ title: "", year: "" })

        8. The default behaviour in Plex Web = no params in plexapi

        9. Both title and year specified by user

        10. Year automatically filled in

        11. Title automatically filled in

        12. Explicitly searches for title with blank year

        13. Explicitly searches for blank title with year

        14. I don't know what the user is thinking... return the same result as 1

        For 2 to 7, the agent and language is automatically filled in

      Returns Promise<SearchResult[]>

    • Set a personal rating from 0 to 10, or clear it with null.

      Parameters

      • rating: number | null

      Returns Promise<void>

    • Refreshing a Library or individual item causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as "update metadata for the requested item even if it already has some". You should refresh a Library or individual item if:

      Returns Promise<void>

    • load full data / reload the data for this object from this.key.

      Parameters

      • Optionalekey: string
      • Optionalargs: Record<string, number | boolean>

      Returns Promise<void>

    • Fetches a list of sonically similar audio items from the Plex server. The returned items will be instances of the same class as the current item (e.g., calling sonicallySimilar on a Track instance returns Track[]).

      Parameters

      • Optionallimit: number

        Maximum number of similar items to return. Server default is 50.

      • OptionalmaxDistance: number

        Maximum sonic distance (0.0 - 1.0) between items. Server default is 0.25.

      • Optionaloptions: Record<string, string | number>

        Optional additional filters to apply to the results.

      Returns Promise<Audio[]>

      A promise resolving to an array of sonically similar Audio items.

    • Find a track by title or its track and optional disc number.

      Parameters

      • options: { title: string } | { disc?: number; track: number }

      Returns Promise<Track>

    • Parameters

      • options: Record<string, string | number> = {}

      Returns Promise<Track[]>

    • Build an authenticated server URL for a path such as a media part key.

      Parameters

      • part: string

      Returns string | undefined

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods