Class Album

Represents a single Album.

Hierarchy (View Summary)

Audio
- Album

Index

Constructors

constructor

Accessors

hasSonicAnalysis isFullObject listType

Constructors

constructor

new Album(
    server: PlexServer,
    data: any,
    initpath: string,
    parent: PlexObject,
): Album
Parameters
- server: PlexServer
- data: any
- initpath: string
- parent: PlexObject
Returns Album
Overrides Audio.constructor
- Defined in src/audio.ts:722

Properties

_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;
} = ...

`Optional`addedAt

addedAt?: Date

`Optional`art

art?: string

`Optional`artBlurHash

artBlurHash?: string

`Optional`audienceRating

audienceRating?: number

`Optional`collections

collections?: Collection[]

`Optional`distance

distance?: number

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

`Optional`fields

fields?: Field[]

List of field objects.

`Optional`formats

formats?: Format[]

`Optional`genres

genres?: Genre[]

`Optional`guid

guid?: string

`Optional`guids

guids?: Guid[]

`Optional`images

images?: Image[]

List of image objects.

`Optional`index

index?: number

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

key

key: string

plex relative url

`Optional`labels

labels?: Label[]

`Optional`lastRatedAt

lastRatedAt?: Date

`Optional`lastViewedAt

lastViewedAt?: Date

`Optional`leafCount

leafCount?: number

`Optional`librarySectionID

librarySectionID?: number

`Optional`librarySectionKey

librarySectionKey?: string

Key of the library section this item belongs to.

`Optional`librarySectionTitle

librarySectionTitle?: string

Title of the library section this item belongs to.

`Optional`loudnessAnalysisVersion

loudnessAnalysisVersion?: number

`Optional`moods

moods?: Mood[]

List of mood objects.

`Optional`musicAnalysisVersion

musicAnalysisVersion?: number

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

`Optional`originallyAvailableAt

originallyAvailableAt?: Date

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

`Optional`parentGuid

parentGuid?: string

Artist GUID

`Optional`parentKey

parentKey?: string

Artist Key

`Optional`parentRatingKey

parentRatingKey?: number

Artist Rating Key

`Optional`parentTheme

parentTheme?: string

Artist Theme

`Optional`parentThumb

parentThumb?: string

Artist Thumb

`Optional`parentTitle

parentTitle?: string

Artist Title

`Optional`rating

rating?: number

`Optional`ratingKey

ratingKey?: string

`Readonly`server

server: PlexServer

`Optional`studio

studio?: string

`Optional`styles

styles?: Style[]

`Optional`subformats

subformats?: Subformat[]

`Optional`summary

summary?: string

`Optional`thumb

thumb?: string

`Optional`thumbBlurHash

thumbBlurHash?: string

`Optional`title

title?: string

`Optional`titleSort

titleSort?: string

Title used for sorting (defaults to title).

`Optional`type

type?: string

`Optional`updatedAt

updatedAt?: Date

`Optional`userRating

userRating?: number

User rating (0.0-10.0).

`Optional`viewCount

viewCount?: number

Count of times the item was played.

`Optional`viewedLeafCount

viewedLeafCount?: number

`Optional`year

year?: number

`Static`METADATA_TYPE

METADATA_TYPE: string = 'track'

Default metadata type for audio sync items.

`Static`TAG

TAG: string = 'Directory'

xml element tag

`Static`TYPE

TYPE: string = 'album'

xml element type

Accessors

hasSonicAnalysis

get hasSonicAnalysis(): boolean
Indicates if the audio item has undergone sonic analysis.

Returns boolean
Inherited from Audio.hasSonicAnalysis
- Defined in src/audio.ts:109

isFullObject

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
Inherited from Audio.isFullObject
- Defined in src/base/partialPlexObject.ts:86

listType

get listType(): "audio"
Hardcoded list type for filtering.

Returns "audio"
Inherited from Audio.listType
- Defined in src/audio.ts:34

Methods

_defaultSyncTitle

_defaultSyncTitle(): string
Returns the default title for a sync item.

Returns string
Overrides Audio._defaultSyncTitle
- Defined in src/audio.ts:780

addCollection

addCollection(collections: string[]): Promise<void>
Add a collection(s).
Parameters
- collections: string[]
Returns Promise<void>
Inherited from Audio.addCollection
- Defined in src/base/partialPlexObject.ts:216

addGenre

addGenre(genres: string[]): Promise<void>
Add a genre(s).
Parameters
- genres: string[]
Returns Promise<void>
Inherited from Audio.addGenre
- Defined in src/base/partialPlexObject.ts:236

addLabel

addLabel(labels: string[]): Promise<void>
Add a label(s).
Parameters
- labels: string[]
Returns Promise<void>
Inherited from Audio.addLabel
- Defined in src/base/partialPlexObject.ts:226

analyze

analyze(): Promise<void>
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>
Inherited from Audio.analyze
- Defined in src/base/partialPlexObject.ts:59

artist

artist(): Promise<Artist>
Return the album's Artist.

Returns Promise<Artist>
- Defined in src/audio.ts:769

delete

delete(): Promise<any>
Delete a media element. This has to be enabled under settings > server > library in plex webui.

Returns Promise<any>
Inherited from Audio.delete
- Defined in src/base/partialPlexObject.ts:211

edit

edit(changeObj: Record<string, string | number>): Promise<void>
Edit an object.
Parameters
- changeObj: Record<string, string | number>
  Obj of settings to edit. Example: {'type': 1, 'id': movie.ratingKey, 'title.value': 'New Title', 'collection[0].tag.tag': 'Super', 'collection.locked': 0}
Returns Promise<void>
Inherited from Audio.edit
- Defined in src/base/partialPlexObject.ts:259

fixMatch

fixMatch(
    searchResult?: SearchResult,
    auto?: boolean,
    agent?: string,
): Promise<void>
Use match result to update show metadata.
Parameters
- OptionalsearchResult: SearchResult
  Search result
- auto: boolean = false
  True uses first match from matches, False allows user to provide the match
- agent: string = ''
  (str): Agent name to be used (imdb, thetvdb, themoviedb, etc.)
Returns Promise<void>
See
PartialPlexObject.matches
Inherited from Audio.fixMatch
- Defined in src/base/partialPlexObject.ts:96

getWebURL

getWebURL(base?: string): string
Parameters
- Optionalbase: string
Returns string
Inherited from Audio.getWebURL
- Defined in src/base/partialPlexObject.ts:245

history

history(maxresults?: number, mindate?: Date): Promise<HistoryMetadatum[]>
Get Play History for a media item.
Parameters
- maxresults: number = 9999999
  Only return the specified number of results (optional).
- Optionalmindate: Date
  Min datetime to return results from.
Returns Promise<HistoryMetadatum[]>
Inherited from Audio.history
- Defined in src/base/partialPlexObject.ts:200

isChildOf

isChildOf(cls: any): boolean
Returns True if this object is a child of the given class.
Parameters
- cls: any
Returns boolean
Inherited from Audio.isChildOf
- Defined in src/base/plexObject.ts:63

matches

matches(
    agent?: string,
    title?: string,
    year?: string,
    language?: string,
): Promise<SearchResult[]>
Parameters
- Optionalagent: string
  Agent name to be used (imdb, thetvdb, themoviedb, etc.)
- Optionaltitle: string
  Title of item to search for
- Optionalyear: string
  Year of item to search in
- Optionallanguage: string
  Language of item to search in
  
  Examples:
  
  video.matches()
  
  video.matches(title="something", year=2020)
  
  video.matches(title="something")
  
  video.matches(year=2020)
  
  video.matches(title="something", year="")
  
  video.matches(title="", year=2020)
  
  video.matches(title="", year="")
  
  The default behaviour in Plex Web = no params in plexapi
  
  Both title and year specified by user
  
  Year automatically filled in
  
  Title automatically filled in
  
  Explicitly searches for title with blank year
  
  Explicitly searches for blank title with year
  
  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[]>
Inherited from Audio.matches
- Defined in src/base/partialPlexObject.ts:140

refresh

refresh(): 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>
Inherited from Audio.refresh
- Defined in src/base/plexObject.ts:55

reload

reload(ekey?: string, args?: any): Promise<void>
load full data / reload the data for this object from this.key.
Parameters
- Optionalekey: string
- Optionalargs: any
Returns Promise<void>
Inherited from Audio.reload
- Defined in src/base/partialPlexObject.ts:67

removeCollection

removeCollection(collections: string[]): Promise<void>
Remove a collection(s).
Parameters
- collections: string[]
Returns Promise<void>
Inherited from Audio.removeCollection
- Defined in src/base/partialPlexObject.ts:221

removeGenre

removeGenre(genres: string[]): Promise<void>
Remove a genre(s).
Parameters
- genres: string[]
Returns Promise<void>
Inherited from Audio.removeGenre
- Defined in src/base/partialPlexObject.ts:241

removeLabel

removeLabel(labels: string[]): Promise<void>
Remove a label(s).
Parameters
- labels: string[]
Returns Promise<void>
Inherited from Audio.removeLabel
- Defined in src/base/partialPlexObject.ts:231

section

section(): Promise<Section>
Returns Promise<Section>
Inherited from Audio.section
- Defined in src/base/partialPlexObject.ts:204

sonicallySimilar

sonicallySimilar(
    limit?: number,
    maxDistance?: number,
    options?: Record<string, string | number>,
): Promise<Audio[]>
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.
Inherited from Audio.sonicallySimilar
- Defined in src/audio.ts:123

tracks

tracks(options?: Record<string, string | number>): Promise<Track[]>
Returns a list of Track objects in the album.
Parameters
- options: Record<string, string | number> = {}
  Additional fetch options.
Returns Promise<Track[]>
- Defined in src/audio.ts:761

unmatch

unmatch(): Promise<any>
Unmatches metadata match from object.

Returns Promise<any>
Inherited from Audio.unmatch
- Defined in src/base/partialPlexObject.ts:190

url

url(part: string): string
Returns the full URL for a given part (like a media stream) relative to the item's key. Includes the authentication token.
Parameters
- part: string
  The relative path or resource identifier.
Returns string
The full URL string including the server address and token, or undefined if part is empty.
Inherited from Audio.url
- Defined in src/audio.ts:98

Class Album

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Album

Properties

_INCLUDES

OptionaladdedAt

Optionalart

OptionalartBlurHash

OptionalaudienceRating

Optionalcollections

Optionaldistance

Optionalfields

Optionalformats

Optionalgenres

Optionalguid

Optionalguids

Optionalimages

Optionalindex

key

Optionallabels

OptionallastRatedAt

OptionallastViewedAt

OptionalleafCount

OptionallibrarySectionID

OptionallibrarySectionKey

OptionallibrarySectionTitle

OptionalloudnessAnalysisVersion

Optionalmoods

OptionalmusicAnalysisVersion

OptionaloriginallyAvailableAt

Optional Readonlyparent

OptionalparentGuid

OptionalparentKey

OptionalparentRatingKey

OptionalparentTheme

OptionalparentThumb

OptionalparentTitle

Optionalrating

OptionalratingKey

Readonlyserver

Optionalstudio

Optionalstyles

Optionalsubformats

Optionalsummary

Optionalthumb

OptionalthumbBlurHash

Optionaltitle

OptionaltitleSort

Optionaltype

OptionalupdatedAt

OptionaluserRating

OptionalviewCount

OptionalviewedLeafCount

Optionalyear

StaticMETADATA_TYPE

StaticTAG

StaticTYPE

Accessors

hasSonicAnalysis

Returns boolean

isFullObject

Returns boolean

listType

Returns "audio"

Methods

_defaultSyncTitle

Returns string

addCollection

Parameters

Returns Promise<void>

addGenre

Parameters

`Optional`addedAt

`Optional`art

`Optional`artBlurHash

`Optional`audienceRating

`Optional`collections

`Optional`distance

`Optional`fields

`Optional`formats

`Optional`genres

`Optional`guid

`Optional`guids

`Optional`images

`Optional`index

`Optional`labels

`Optional`lastRatedAt

`Optional`lastViewedAt

`Optional`leafCount

`Optional`librarySectionID

`Optional`librarySectionKey

`Optional`librarySectionTitle

`Optional`loudnessAnalysisVersion

`Optional`moods

`Optional`musicAnalysisVersion

`Optional`originallyAvailableAt

`Optional` `Readonly`parent

`Optional`parentGuid

`Optional`parentKey

`Optional`parentRatingKey

`Optional`parentTheme

`Optional`parentThumb

`Optional`parentTitle

`Optional`rating

`Optional`ratingKey

`Readonly`server

`Optional`studio

`Optional`styles

`Optional`subformats

`Optional`summary

`Optional`thumb

`Optional`thumbBlurHash

`Optional`title

`Optional`titleSort

`Optional`type

`Optional`updatedAt

`Optional`userRating

`Optional`viewCount

`Optional`viewedLeafCount

`Optional`year

`Static`METADATA_TYPE

`Static`TAG

`Static`TYPE