Class PlexServer

constructor

• new PlexServer(baseurl, token, timeout?): PlexServer

• Parameters

  • baseurl: string
  • token: string
  • timeout: number = TIMEOUT

    Default request timeout in milliseconds.

    Default

    30000
    Copy

  Returns PlexServer

Optional_library

Optional_settings

allowCameraUpload

allowChannelAccess

allowMediaDeletion

allowSharing

allowSync

allowTuners

backgroundProcessing

baseurl

certificate

companionProxy

diagnostics

eventStream

friendlyName

hubSearch

key

livetv

OptionalmachineIdentifier

multiuser

myPlex

myPlexMappingState

myPlexSigninState

myPlexSubscription

myPlexUsername

ownerFeatures

photoAutoTag

platform

platformVersion

pluginHost

pushNotifications

readOnlyLibraries

requestParametersInCookie

streamingBrainABRVersion

streamingBrainVersion

sync

timeout

30000
Copy

token

transcoderActiveVideoSessions

transcoderAudio

transcoderLyrics

transcoderPhoto

transcoderSubtitles

transcoderVideo

transcoderVideoBitrates

transcoderVideoQualities

transcoderVideoResolutions

updatedAt

updater

version

voiceSearch

_buildWebURL

• _buildWebURL(base?, endpoint?, params?): string

• Build the Plex Web URL for the object.

  Parameters

  • base: string = 'https://app.plex.tv/desktop/'

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

    The Plex Web URL endpoint. None for server, 'playlist' for playlists, 'details' for all other media types.
  • Optionalparams: URLSearchParams

  Returns string

_uriRoot

• _uriRoot(): string

• Returns string

agents

• agents(mediaType?): Promise<Agent[]>

• Parameters

  • OptionalmediaType: string | number

  Returns Promise<Agent[]>

clients

• clients(): Promise<PlexClient[]>

• Returns Promise<PlexClient[]>

connect

• connect(): Promise<void>

• Returns Promise<void>

history

• history(maxresults?, mindate?, ratingKey?, accountId?, librarySectionId?): Promise<HistoryMetadatum[]>

• Returns a list of media items from watched history. If there are many results, they will be fetched from the server in batches of X_PLEX_CONTAINER_SIZE amounts. If you're only looking for the first results, it would be wise to set the maxresults option to that amount so this functions doesn't iterate over all results on the server.

  Parameters

  • maxresults: number = 9999999

    Only return the specified number of results (optional).
  • Optionalmindate: Date

    Min datetime to return results from. This really helps speed up the result listing. For example: datetime.now() - timedelta(days=7)
  • OptionalratingKey: string | number

    request history for a specific ratingKey item.
  • OptionalaccountId: string | number

    request history for a specific account ID.
  • OptionallibrarySectionId: string | number

    request history for a specific library section ID.

  Returns Promise<HistoryMetadatum[]>

library

• library(): Promise<Library>

• Library to browse or search your media.

  Returns Promise<Library>

myPlexAccount

• myPlexAccount(): MyPlexAccount

• Returns a :class:~plexapi.myplex.MyPlexAccount object using the same token to access this server. If you are not the owner of this PlexServer you're likley to recieve an authentication error calling this.

  Returns MyPlexAccount

optimizedItems

• optimizedItems(): Promise<Optimized[]>

• Returns list of all :class:~plexapi.media.Optimized objects connected to server.

  Returns Promise<Optimized[]>

query

• query<T>(path, method?, options?, username?, password?): Promise<T>

• Main method used to handle HTTPS requests to the Plex server. This method helps by encoding the response to utf-8 and parsing the returned XML into and ElementTree object. Returns None if no data exists in the response. TODO: use headers

  Type Parameters

  • T = any

  Parameters

  • path: string
  • method:
        | "get"
        | "post"
        | "put"
        | "patch"
        | "head"
        | "delete" = 'get'
  • options: {
        body?: Uint8Array;
        headers?: Record<string, string>;
    } = {}

    • Optionalbody?: Uint8Array

    • Optionalheaders?: Record<string, string>

  • Optionalusername: string
  • Optionalpassword: string

  Returns Promise<T>

search

• search(query, mediatype?, limit?): Promise<Hub[]>

• Returns a list of media items or filter categories from the resulting Hub Search <https://www.plex.tv/blog/seek-plex-shall-find-leveling-web-app/>_ against all items in your Plex library. This searches genres, actors, directors, playlists, as well as all the obvious media titles. It performs spell-checking against your search terms (because KUROSAWA is hard to spell). It also provides contextual search results. So for example, if you search for 'Pernice', it’ll return 'Pernice Brothers' as the artist result, but we’ll also go ahead and return your most-listened to albums and tracks from the artist. If you type 'Arnold' you’ll get a result for the actor, but also the most recently added movies he’s in.

  Parameters

  • query: string

    Query to use when searching your library.
  • Optionalmediatype:
        | "movie"
        | "show"
        | "season"
        | "episode"
        | "trailer"
        | "comic"
        | "person"
        | "artist"
        | "album"
        | "track"
        | "picture"
        | "clip"
        | "photo"
        | "photoalbum"
        | "playlist"
        | "playlistFolder"
        | "collection"
        | "optimizedVersion"
        | "userPlaylistItem"

    Optionally limit your search to the specified media type.
  • Optionallimit: number

    Optionally limit to the specified number of results per Hub.

  Returns Promise<Hub[]>

settings

• settings(): Promise<Settings>

• Returns Promise<Settings>

url

• url(key, includeToken?, params?): URL

• Build a URL string with proper token argument. Token will be appended to the URL if either includeToken is True or TODO: CONFIG.log.show_secrets is 'true'.

  Parameters

  • key: string
  • includeToken: boolean = false
  • Optionalparams: URLSearchParams

  Returns URL