Class Playlist

Hierarchy

Playable
- Playlist

Constructors

constructor

new Playlist(
    server: PlexServer,
    data: any,
    initpath?: string,
    parent?: PlexObject,
): Playlist
Parameters
- server: PlexServer
- data: any
- Optionalinitpath: string
- Optionalparent: PlexObject
Returns Playlist
Inherited from Playable.constructor
- Defined in src/base/plexObject.ts:23

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

addedAt

addedAt: Date

`Optional`allowSync

allowSync?: boolean

composite

composite: string

`Optional`duration

duration?: number

`Optional`durationInSeconds

durationInSeconds?: number

guid

guid: string

key

key: string

plex relative url

leafCount

leafCount: number

`Optional`librarySectionID

librarySectionID?: number

`Optional` `Readonly`parent

parent?: WeakRef<any>

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

players

players: any

(:class:~plexapi.client.PlexClient): Client objects playing this item (for active sessions).

`Optional`playlistItemID

playlistItemID?: number

(int): Playlist item ID (only populated for :class:~plexapi.playlist.Playlist items).

playlistType

playlistType: string

`Optional`ratingKey

ratingKey?: string

`Readonly`server

server: PlexServer

session

session: any

(:class:~plexapi.media.Session): Session object, for a playing media file.

sessionKey

sessionKey: any

(int): Active session key.

smart

smart: boolean

summary

summary: string

`Optional`title

title?: string

transcodeSessions

transcodeSessions: any

(:class:~plexapi.media.TranscodeSession): Transcode Session object if item is being transcoded (None otherwise).

`Optional`type

type?: string

TYPE

TYPE: string = 'playlist'

updatedAt

updatedAt: Date

usernames

usernames: any

(str): Username of the person playing this item (for active sessions).

viewedAt

viewedAt: any

(datetime): Datetime item was last viewed (history).

`Optional`year

year?: number

`Static`TAG

TAG: string = 'Playlist'

xml element tag

`Static`TYPE

TYPE: string = null

xml element type

Accessors

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

Methods

_edit

_edit(args: { summary?: string; title?: string }): Promise<void>
Parameters
- args: { summary?: string; title?: string }
Returns Promise<void>
- Defined in src/playlist.ts:156

addCollection

addCollection(collections: string[]): Promise<void>
Add a collection(s).
Parameters
- collections: string[]
Returns Promise<void>
Inherited from Playable.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 Playable.addGenre
- Defined in src/base/partialPlexObject.ts:236

addItems

addItems(items: PlaylistContent[]): Promise<void>
Add items to a playlist.
Parameters
- items: PlaylistContent[]
Returns Promise<void>
- Defined in src/playlist.ts:189

addLabel

addLabel(labels: string[]): Promise<void>
Add a label(s).
Parameters
- labels: string[]
Returns Promise<void>
Inherited from Playable.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 Playable.analyze
- Defined in src/base/partialPlexObject.ts:59

createPlayQueue

createPlayQueue(options?: CreatePlayQueueOptions): Promise<PlayQueue>
Returns a new PlayQueue from this media item.
Parameters
- options: CreatePlayQueueOptions = {}
  Options for creating the PlayQueue
Returns Promise<PlayQueue>
New PlayQueue instance
Inherited from Playable.createPlayQueue
- Defined in src/base/playable.ts:34

delete

delete(): Promise<void>
Delete the playlist.

Returns Promise<void>
Overrides Playable.delete
- Defined in src/playlist.ts:223

edit

edit(changeObj: { summary?: string; title?: string }): Promise<void>
Edit an object.
Parameters
- changeObj: { summary?: string; title?: string }
  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>
Overrides Playable.edit
- Defined in src/playlist.ts:162

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 Playable.fixMatch
- Defined in src/base/partialPlexObject.ts:96

getWebURL

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

history

history(maxresults?: number, mindate?: Date): Promise<HistoryResult[]>
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<HistoryResult[]>
Inherited from Playable.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 Playable.isChildOf
- Defined in src/base/plexObject.ts:63

item

item(title: string): Promise<PlaylistContent>
Parameters
- title: string
Returns Promise<PlaylistContent>
the item in the playlist that matches the specified title.
- Defined in src/playlist.ts:169

items

items<T extends PlaylistContent>(): Promise<T[]>
Type Parameters
- T extends PlaylistContent
Returns Promise<T[]>
- Defined in src/playlist.ts:175

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 Playable.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 Playable.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 Playable.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 Playable.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 Playable.removeGenre
- Defined in src/base/partialPlexObject.ts:241

removeItems

removeItems(items: PlaylistContent[]): Promise<void>
Remove an item from a playlist.
Parameters
- items: PlaylistContent[]
Returns Promise<void>
- Defined in src/playlist.ts:209

removeLabel

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

section

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

unmatch

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

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

`Static`create

create(
    server: PlexServer,
    title: string,
    options: CreatePlaylistOptions,
): Promise<Playlist>
Parameters
- server: PlexServer
- title: string
- options: CreatePlaylistOptions
Returns Promise<Playlist>
- Defined in src/playlist.ts:73

`Static`update

update(
    server: PlexServer,
    ratingKey: string,
    options: UpdatePlaylistOptions,
): Promise<void>
Update a playlist's metadata by ratingKey without fetching the full playlist first.
Parameters
- server: PlexServer
  The Plex server instance
- ratingKey: string
  The playlist's ratingKey
- options: UpdatePlaylistOptions
  Fields to update (title and/or summary)
Returns Promise<void>
Example
```
await Playlist.update(server, '12345', {
  title: 'My Updated Playlist',
  summary: 'A new description'
});
```
- Defined in src/playlist.ts:97

Class Playlist

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Playlist

Properties

_INCLUDES

addedAt

OptionalallowSync

composite

Optionalduration

OptionaldurationInSeconds

guid

key

leafCount

OptionallibrarySectionID

Optional Readonlyparent

players

OptionalplaylistItemID

playlistType

OptionalratingKey

Readonlyserver

session

sessionKey

smart

summary

Optionaltitle

transcodeSessions

Optionaltype

TYPE

updatedAt

usernames

viewedAt

Optionalyear

StaticTAG

StaticTYPE

Accessors

isFullObject

Returns boolean

Methods

_edit

Parameters

Returns Promise<void>

addCollection

Parameters

Returns Promise<void>

addGenre

Parameters

Returns Promise<void>

addItems

Parameters

Returns Promise<void>

addLabel

Parameters

Returns Promise<void>

analyze

Returns Promise<void>

createPlayQueue

Parameters

Returns Promise<PlayQueue>

delete

Returns Promise<void>

edit

Parameters

Returns Promise<void>

fixMatch

Parameters

Returns Promise<void>

See

getWebURL

Parameters

Returns string

history

Parameters

`Optional`allowSync

`Optional`duration

`Optional`durationInSeconds

`Optional`librarySectionID

`Optional` `Readonly`parent

`Optional`playlistItemID

`Optional`ratingKey

`Readonly`server

`Optional`title

`Optional`type

`Optional`year

`Static`TAG

`Static`TYPE

`Static`create

`Static`update