Class LibrarySection<SectionVideoType>Abstract

constructor

• new LibrarySection<SectionVideoType>(server, data, initpath?, parent?): LibrarySection<SectionVideoType>

• Type Parameters

  • SectionVideoType = VideoType

  Parameters

  • server: PlexServer
  • data: any
  • Optionalinitpath: string
  • Optionalparent: PlexObject

  Returns LibrarySection<SectionVideoType>

CONTENT_TYPE

ReadonlyVIDEO_TYPE

Optional_fieldTypes

Optional_filterTypes

agent

allowSync

art

composite

createdAt

filters

language

locations

refreshing

scannedAt

scanner

thumb

title

type

updatedAt

uuid

StaticALLOWED_FILTERS

StaticALLOWED_SORT

StaticBOOLEAN_FILTERS

agents

• agents(): Promise<Agent[]>

• Returns Promise<Agent[]>

all

• all(sort?): Promise<SectionVideoType[]>

• Parameters

  • sort: string = ''

  Returns Promise<SectionVideoType[]>

analyze

• analyze(): Promise<void>

• Run an analysis on all of the items in this library section. See :func:~plexapi.base.PlexPartialObject.analyze for more details.

  Returns Promise<void>

cancelUpdate

• cancelUpdate(): Promise<void>

• Cancel update of this Library Section.

  Returns Promise<void>

collections

• collections(args?): Promise<Collections<SectionVideoType>[]>

• Parameters

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

  Returns Promise<Collections<SectionVideoType>[]>

delete

• delete(): Promise<void>

• Delete a library section.

  Returns Promise<void>

deleteMediaPreviews

• deleteMediaPreviews(): Promise<void>

• Delete the preview thumbnails for items in this library. This cannot be undone. Recreating media preview files can take hours or even days.

  Returns Promise<void>

edit

• edit(kwargs): Promise<Section>

• Edit a library

  Parameters

  • kwargs: Record<string, string>

    object of settings to edit

  Returns Promise<Section>

emptyTrash

• emptyTrash(): Promise<void>

• If a section has items in the Trash, use this option to empty the Trash

  Returns Promise<void>

fieldTypes

• fieldTypes(): Promise<FilteringFieldType[]>

• Returns Promise<FilteringFieldType[]>

filterTypes

• filterTypes(): Promise<FilteringType[]>

• Returns Promise<FilteringType[]>

folders

• folders(): Promise<Folder[]>

• Returns a list of available Folders for this library section.

  Returns Promise<Folder[]>

genres

• genres(): Promise<FilterChoice[]>

• Returns Promise<FilterChoice[]>

get

• get(title): Promise<SectionVideoType>

• Parameters

  • title: string

    Title of the item to return.

  Returns Promise<SectionVideoType>

  the media item with the specified title.

getFieldType

• getFieldType(fieldType): Promise<FilteringFieldType>

• Parameters

  • fieldType: string

    The data type for the field (tag, integer, string, boolean, date, subtitleLanguage, audioLanguage, resolution).

  Returns Promise<FilteringFieldType>

getFilterType

• getFilterType(libtype?): Promise<FilteringType>

• Parameters

  • libtype:
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "artist"
        | "album"
        | "track"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem" = ...

  Returns Promise<FilteringType>

getGuid

• getGuid(guid): Promise<SectionVideoType>

• Returns the media item with the specified external IMDB, TMDB, or TVDB ID. Note: This search uses a PlexAPI operator so performance may be slow. All items from the entire Plex library need to be retrieved for each guid search. It is recommended to create your own lookup dictionary if you are searching for a lot of external guids.

  Parameters

  • guid: string

    The external guid of the item to return. Examples: IMDB imdb://tt0944947, TMDB tmdb://1399, TVDB tvdb://121361.

    Example:

    	.. code-block:: python
    
    			# This will retrieve all items in the entire library 3 times
    			result1 = library.getGuid('imdb://tt0944947')
    			result2 = library.getGuid('tmdb://1399')
    			result3 = library.getGuid('tvdb://121361')
    
    			# This will only retrieve all items in the library once to create a lookup dictionary
    			guidLookup = {guid.id: item for item in library.all() for guid in item.guids}
    			result1 = guidLookup['imdb://tt0944947']
    			result2 = guidLookup['tmdb://1399']
    			result3 = guidLookup['tvdb://121361']
    

  Returns Promise<SectionVideoType>

getWebURL

• getWebURL(base?, tab?, key?): string

• Returns the Plex Web URL for the library.

  Parameters

  • Optionalbase: string

    The base URL before the fragment (#!). Default is https://app.plex.tv/desktop.
  • Optionaltab: string

    The library tab (recommended, library, collections, playlists, timeline).
  • Optionalkey: string

    A hub key.

  Returns string

hubs

• hubs(): Promise<Hub[]>

• Returns Promise<Hub[]>

listFields

• listFields(libtype?): Promise<FilteringField[]>

• Returns a list of available FilteringFields for a specified libtype. This is the list of options in the custom filter dropdown menu

  Parameters

  • libtype:
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "artist"
        | "album"
        | "track"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem" = ...

  Returns Promise<FilteringField[]>

listFilters

• listFilters(libtype?): Promise<FilteringFilter[]>

• Parameters

  • Optionallibtype:
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "artist"
        | "album"
        | "track"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem"

    The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection).

  Returns Promise<FilteringFilter[]>

  Example

  const availableFilters = (await library.listFilters()).map(f => f.filter)
  Copy

listOperators

• listOperators(fieldType): Promise<FilteringOperator[]>

• Parameters

  • fieldType: string

    The data type for the field (tag, integer, string, boolean, date, subtitleLanguage, audioLanguage, resolution).

  Returns Promise<FilteringOperator[]>

playlists

• playlists(): Promise<Playlist[]>

• Returns a list of playlists from this library section.

  Returns Promise<Playlist[]>

refresh

• refresh(): Promise<void>

• Forces a download of fresh media information from the internet. This can take a long time. Any locked fields are not modified.

  Returns Promise<void>

search

• search<T>(args?, Cls?): Promise<T[]>

• Search the library. The http requests will be batched in container_size. If you are only looking for the first results, it would be wise to set the maxresults option to that amount so the search doesn't iterate over all results on the server.

  Example: "studio=Comedy%20Central" or "year=1999" "title=Kung Fu" all work. Other items such as actor= seem to work, but require you already know the id of the actor. TLDR: This is untested but seems to work. Use library section search when you can.

  Type Parameters

  • T = SectionVideoType

  Parameters

  • args: Partial<SearchArgs> = {}

    Search using a number of different attributes
  • Cls: any = ...

  Returns Promise<T[]>

update

• update(): Promise<void>

• Scan this section for new media.

  Returns Promise<void>