Library | perplexed - v5.19.0

Interact with a plex server

class: Library
param: config to pass to plex-api package

Hierarchy

Library

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new Library(serverConnection: ServerConnection): Library

- Defined in library.ts:72
Parameters
- serverConnection: ServerConnection
Returns Library

Properties

api

api: ServerConnection

Methods

addToPlaylist

addToPlaylist(playlistId: number, uri: string): Promise<any>

- Defined in library.ts:443
Parameters
- playlistId: number
- uri: string
Returns Promise<any>

album

album(albumId: number): Promise<AlbumContainer>

- Defined in library.ts:293
Get information about a single album

Parameters
- albumId: number
Returns Promise<AlbumContainer>

albumTracks

albumTracks(albumId: number, searchParams?: Params): Promise<TrackContainer>

- Defined in library.ts:307
Get the tracks related to an album

Parameters
- albumId: number
- Default value searchParams: Params = {}
Returns Promise<TrackContainer>

albums

albums(sectionId: number, searchParams?: Params): Promise<AlbumContainer>

- Defined in library.ts:274
Query all albums in the library

Parameters
- sectionId: number
  
  id of the section to fetch
- Default value searchParams: Params = {}
Returns Promise<AlbumContainer>

artist

artist(artistId: number, options?: object): Promise<ArtistContainer>

- Defined in library.ts:351
Get information about a single artist

Parameters
- artistId: number
- Default value options: object = {}
  - Optional includePopular?: boolean
Returns Promise<ArtistContainer>

artistAlbums

artistAlbums(artistId: number, searchParams?: Params): Promise<AlbumContainer>

- Defined in library.ts:368
Get the albums related to an artist

Parameters
- artistId: number
- Default value searchParams: Params = {}
Returns Promise<AlbumContainer>

artists

artists(sectionId: number, searchParams?: Params): Promise<ArtistContainer>

- Defined in library.ts:330
Query all artists in the library

Parameters
- sectionId: number
  
  id of the library section
- Default value searchParams: Params = {}
Returns Promise<ArtistContainer>

buildLibraryURI

buildLibraryURI(uuid: string, path: string, searchParams?: Params): string

- Defined in library.ts:163
Build library URI for use in creating queues and playlists

Parameters
- uuid: string
  
  library UUID
- path: string
  
  library path
- Default value searchParams: Params = {}
Returns string

countries

countries(sectionId: number): Promise<CountryRecord>

- Defined in library.ts:211
Parameters
- sectionId: number
Returns Promise<CountryRecord>

createQueue

createQueue(options?: object): Promise<object>

- Defined in library.ts:596
Create a play queue from a uri

Parameters
- Default value options: object = {}
  - Optional includeChapters?: number
  - Optional includeRelated?: number
  - Optional key?: number
  - Optional playlistId?: number
  - Optional repeat?: boolean
  - Optional shuffle?: boolean
  - Optional uri?: string
Returns Promise<object>

createSmartPlaylist

createSmartPlaylist(title: string, uri: string): Promise<PlaylistContainer>

- Defined in library.ts:381
Parameters
- title: string
- uri: string
Returns Promise<PlaylistContainer>

deletePlaylist

deletePlaylist(playlistId: number): Promise<any>

- Defined in library.ts:466
Parameters
- playlistId: number
Returns Promise<any>

editPlaylistDetails

editPlaylistDetails(playlistId: number, searchParams?: Params): Promise<any>

- Defined in library.ts:425
Parameters
- playlistId: number
- Default value searchParams: Params = {}
Returns Promise<any>

editPlaylistSummary

editPlaylistSummary(playlistId: number, summary: string): Promise<any>

- Defined in library.ts:438
Parameters
- playlistId: number
- summary: string
Returns Promise<any>

editPlaylistTitle

editPlaylistTitle(playlistId: number, title: string): Promise<any>

- Defined in library.ts:433
Parameters
- playlistId: number
- title: string
Returns Promise<any>

fetch

fetch(url: string, options?: RequestOptions): Promise<any>

- Defined in library.ts:87
Query the API for a limited set of results. By default Plex will return everything that matches, which in most cases can be far too much data.

Parameters
- url: string
- Default value options: RequestOptions = {}
Returns Promise<any>

genres

genres(sectionId: number): Promise<GenreRecord>

- Defined in library.ts:221
Parameters
- sectionId: number
Returns Promise<GenreRecord>

metadata

metadata<T>(id: number, type: T, searchParams?: Params): Promise<ReturnType<T>>

- Defined in library.ts:178
Fetch a metadata item

Type parameters
- T: MediaType
Parameters
- id: number
- type: T
- Default value searchParams: Params = {}
Returns Promise<ReturnType<T>>

metadataChildren

metadataChildren<T>(id: number, type: T, searchParams?: Params): Promise<ReturnType<T>>

- Defined in library.ts:197
Fetch children of a metadata item

Type parameters
- T: MediaType
Parameters
- id: number
- type: T
- Default value searchParams: Params = {}
Returns Promise<ReturnType<T>>

modifyAlbumCollection

modifyAlbumCollection(sessionId: number, albumId: number, add: string[], remove?: string[]): Promise<any>

- Defined in library.ts:842
Parameters
- sessionId: number
- albumId: number
- add: string[]
- Optional remove: string[]
Returns Promise<any>

modifyAlbumGenre

modifyAlbumGenre(sectionId: number, albumId: number, add: string[], remove?: string[]): Promise<any>

- Defined in library.ts:796
Modify the genre tags for an album

Parameters
- sectionId: number
- albumId: number
- add: string[]
- Optional remove: string[]
Returns Promise<any>

modifyArtistGenre

modifyArtistGenre(sectionId: number, artistId: number, add: string[], remove?: string[]): Promise<any>

- Defined in library.ts:816
Modify the genre tags for an artist

Parameters
- sectionId: number
- artistId: number
- add: string[]
- Optional remove: string[]
Returns Promise<any>

modifyCollection

modifyCollection(sectionId: number, type: MediaType, id: number, add: string[], remove?: string[]): Promise<any>

- Defined in library.ts:832
Parameters
- sectionId: number
- type: MediaType
- id: number
- add: string[]
- Optional remove: string[]
Returns Promise<any>

modifyGenre

modifyGenre(sectionId: number, type: MediaType, id: number, add: string[], remove?: string[]): Promise<any>

- Defined in library.ts:782
Modify the genre tags for an item

Parameters
- sectionId: number
  
  library section id
- type: MediaType
  
  type of item to modify
- id: number
  
  id of the item to modify
- add: string[]
- Optional remove: string[]
Returns Promise<any>

modifyListField

modifyListField(prop: string, sectionId: number, type: MediaType, id: number, addTags?: string[], removeTags?: string[]): Promise<any>

- Defined in library.ts:740
Parameters
- prop: string
- sectionId: number
- type: MediaType
- id: number
- Default value addTags: string[] = []
- Default value removeTags: string[] = []
Returns Promise<any>

movePlayQueueItem

movePlayQueueItem(playQueueId: number, itemId: number, afterId: number): Promise<object>

- Defined in library.ts:644
Move an item in the play queue to a new position

Parameters
- playQueueId: number
- itemId: number
- afterId: number
Returns Promise<object>

Promise

movePlaylistItem

movePlaylistItem(playlistId: number, itemId: number, afterId: number): Promise<any>

- Defined in library.ts:453
Parameters
- playlistId: number
- itemId: number
- afterId: number
Returns Promise<any>

playQueue

playQueue(playQueueId: number): Promise<object>

- Defined in library.ts:630
Fetch information about an existing play queue

Parameters
- playQueueId: number
Returns Promise<object>

Promise

playlist

playlist(id: number): Promise<PlaylistContainer>

- Defined in library.ts:414
Parameters
- id: number
Returns Promise<PlaylistContainer>

playlistTracks

playlistTracks(id: number, searchParams?: Params): Promise<Playlist>

- Defined in library.ts:419
Parameters
- id: number
- Default value searchParams: Params = {}
Returns Promise<Playlist>

playlists

playlists(searchParams?: Params): Promise<PlaylistContainer>

- Defined in library.ts:403
Fetch all playlists on the server

params

{Obect} params

params

{string} [params.playlistType] - filter playlists by the type of playlist they are

Parameters
- Default value searchParams: Params = {}
Returns Promise<PlaylistContainer>

rate

rate(trackId: number, rating: number): Promise<any>

- Defined in library.ts:564
Set the user rating for a track

params

{number} trackId

params

{number} rating

Parameters
- trackId: number
- rating: number
Returns Promise<any>

removeFromPlaylist

removeFromPlaylist(playlistId: number, itemId: number): Promise<any>

- Defined in library.ts:481
Remove an item from a playlist

params

{number} playlistId - ID of the playlist

params

{number} itemId - ID of the item to remove

Parameters
- playlistId: number
- itemId: number
Returns Promise<any>

resizePhoto

resizePhoto(searchParams?: Params): string

- Defined in library.ts:532
Resize a photo to a specific size

params

{Object} params

params

{string} params.uri

params

{number} params.width

params

{number} params.height

Parameters
- Default value searchParams: Params = {}
Returns string

searchAll

searchAll(query: string, limit?: number): Promise<object>

- Defined in library.ts:492
Parameters
- query: string
- Default value limit: number = 3
Returns Promise<object>

searchTracks

searchTracks(sectionId: number, query: string): Promise<any>

- Defined in library.ts:508
Search the library for tracks matching a query

Parameters
- sectionId: number
- query: string
Returns Promise<any>

section

section(sectionId: number): Promise<any>

- Defined in library.ts:125
Get a specific section in the library

Parameters
- sectionId: number
  
  the id of the section to get
Returns Promise<any>

sectionItems

sectionItems<T>(sectionId: number, type: T, searchParams?: Params): Promise<ReturnType<T>>

- Defined in library.ts:139
Get all items in a section

Type parameters
- T: MediaType
Parameters
- sectionId: number
- type: T
- Default value searchParams: Params = {}
Returns Promise<ReturnType<T>>

sections

sections(): Promise<object>

- Defined in library.ts:113
Get all available sections in the library

Returns Promise<object>

sessions

sessions(): Promise<any>

- Defined in library.ts:103
Get the status of all connected clients

Returns Promise<any>

shufflePlayQueue

shufflePlayQueue(playQueueId: number): Promise<object>

- Defined in library.ts:668
Shuffle a play queue

Parameters
- playQueueId: number
Returns Promise<object>

Promise

timeline

timeline(options: object): Promise<any>

- Defined in library.ts:706
Update plex about the current timeline status.

Parameters
- options: object
  - currentTime: number
    
    current time in ms
  - duration: number
    
    track duration in ms
  - key: number
    
    id of track
  - playerState: string
    
    playing, paused, stopped
  - queueItemId: number
    
    id of playlist queue item
  - ratingKey: string
    
    uri of track metadata
Returns Promise<any>

track

track(trackId: number): Promise<TrackContainer>

- Defined in library.ts:257
Get information about a single track

Parameters
- trackId: number
Returns Promise<TrackContainer>

trackLyrics

trackLyrics(track: Track): string

- Defined in library.ts:544
Parameters
- track: Track
Returns string

trackSrc

trackSrc(track: Track): string

- Defined in library.ts:540
Parameters
- track: Track
Returns string

tracks

tracks(sectionId: number, searchParams?: Params): Promise<TrackContainer>

- Defined in library.ts:238
Query all the tracks in the library

Parameters
- sectionId: number
  
  id of the library section
- Default value searchParams: Params = {}
Returns Promise<TrackContainer>

unshufflePlayQueue

unshufflePlayQueue(playQueueId: number): Promise<object>

- Defined in library.ts:682
Unshuffle a play queue

Parameters
- playQueueId: number
Returns Promise<object>

Promise

Generated using TypeDoc