@ctrl/plex
    Preparing search index...

    Class PlexServer

    This is the main entry point to interacting with a Plex server. It allows you to list connected clients, browse your library sections and perform actions such as emptying trash. If you do not know the auth token required to access your Plex server, or simply want to access your server with your username and password, you can also create an PlexServer instance from MyPlexAccount.

    Index
    constructor
    _library? _settings? allowCameraUpload allowChannelAccess allowMediaDeletion allowSharing allowSync allowTuners apiVersion? backgroundProcessing baseurl certificate companionProxy countryCode diagnostics eventStream friendlyName hubSearch itemClusters key livetv machineIdentifier? mediaProviders multiuser myPlex myPlexMappingState myPlexSigninState myPlexSubscription myPlexUsername offlineTranscode? ownerFeatures photoAutoTag? platform platformVersion pluginHost pushNotifications readOnlyLibraries requestParametersInCookie? streamingBrainABRVersion streamingBrainVersion sync timeout token transcoderActiveVideoSessions transcoderAudio transcoderLyrics transcoderPhoto transcoderSubtitles transcoderVideo transcoderVideoBitrates transcoderVideoQualities transcoderVideoResolutions updatedAt updater version voiceSearch
    _buildWebURL _uriRoot account activities agents backgroundTranscodeJobs bandwidth browse butlerTasks canInstallUpdate checkForUpdate claim client clients connect continueWatching conversions createCollection createOptimizedVersion createPlaylist createPlayQueue createToken deleteHistory downloadDatabases downloadLogs getWebURL history identity installUpdate isBrowsable isLatest library myPlexAccount optimizedItems playlist playlists query removeOptimizedItems resources runButlerTask search sessions setConversionsPaused settings source startAlertListener stopSession stream switchUser systemAccount systemAccounts systemDevice systemDevices transcodeImage transcodeSessions unclaim url walk

    • Parameters

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

      Returns PlexServer

    Optional_library

    _library?: Library

    Optional_settings

    _settings?: Settings
    allowCameraUpload: boolean

    True if server allows camera upload

    allowChannelAccess: boolean

    True if server allows channel access (iTunes?)

    allowMediaDeletion: boolean

    True is server allows media to be deleted.

    allowSharing: boolean

    True is server allows sharing

    allowSync: boolean

    True is server allows sync

    allowTuners: boolean

    Unknown

    apiVersion?: string

    Plex server API version.

    backgroundProcessing: boolean

    Unknown

    baseurl: string
    certificate: boolean

    True if server has an HTTPS certificate

    companionProxy: boolean

    Unknown

    countryCode: string

    Plex server country code.

    diagnostics: string

    Unknown

    eventStream: boolean

    Unknown

    friendlyName: string

    Human friendly name for this server

    hubSearch: boolean

    True if Hub Search <https!://www.plex.tv/blog /seek-plex-shall-find-leveling-web-app/>_ is enabled. I believe this is enabled for everyone

    itemClusters: boolean

    True if item clusters are enabled.

    key: string = '/'
    livetv: number

    Unknown

    machineIdentifier?: string

    Unique ID for this server (looks like an md5)

    mediaProviders: boolean

    True if media providers are enabled.

    multiuser: boolean

    True if multiusers <https!://support.plex.tv/hc/en-us/articles/200250367-Multi-User-Support>_ are enabled.

    myPlex: boolean

    Unknown (True if logged into myPlex?)

    myPlexMappingState: string

    Unknown (ex!: mapped)

    myPlexSigninState: string

    Unknown (ex!: ok).

    myPlexSubscription: boolean

    True if you have a myPlex subscription

    myPlexUsername: string

    Email address if signed into myPlex (user@example.com)

    offlineTranscode?: number

    Server offline transcode capability flag.

    ownerFeatures: string[]

    List of features allowed by the server owner. This may be based on your PlexPass subscription. Features include!: camera_upload, cloudsync, content_filter, dvr, hardware_transcoding, home, lyrics, music_videos, pass, photo_autotags, premium_music_metadata, session_bandwidth_restrictions, sync, trailers, webhooks (and maybe more).

    photoAutoTag?: boolean

    True if photo auto-tagging <https!://support.plex.tv/hc/en-us/articles/234976627-Auto-Tagging-of-Photos>_ is enabled.

    platform: string

    Platform the server is hosted on (ex!: Linux)

    platformVersion: string

    Platform version (ex!: '6.1 (Build 7601)', '4.4.0-59-generic').

    pluginHost: boolean

    Unknown

    pushNotifications: boolean

    Unknown

    readOnlyLibraries: boolean

    Unknown

    requestParametersInCookie?: boolean

    Unknown

    streamingBrainABRVersion: number
    streamingBrainVersion: number

    Current Streaming Brain <https!://www.plex.tv/blog/mcstreamy-brain-take-world-two-easy-steps/>_ version.

    sync: boolean

    True if syncing to a device <https!://support.plex.tv/hc/en-us/articles/201053678-Sync-Media-to-a-Device>_ is enabled.

    timeout: number

    Default request timeout in milliseconds.

    30000
    token: string
    transcoderActiveVideoSessions: number

    Number of active video transcoding sessions.

    transcoderAudio: boolean

    True if audio transcoding audio is available.

    transcoderLyrics: boolean

    True if audio transcoding lyrics is available.

    transcoderPhoto: boolean

    True if audio transcoding photos is available.

    transcoderSubtitles: boolean

    True if audio transcoding subtitles is available.

    transcoderVideo: boolean

    True if audio transcoding video is available.

    transcoderVideoBitrates: string

    List of video bitrates.

    transcoderVideoQualities: string

    List of video qualities.

    transcoderVideoResolutions: string

    List of video resolutions.

    updatedAt: number

    Datetime the server was updated.

    updater: boolean

    Unknown

    version: string

    Current Plex version (ex!: 1.3.2.3112-1751929)

    voiceSearch: boolean

    True if voice search is enabled. (is this Google Voice search?)

    _buildWebURL

    • _buildWebURL(
          options?: { base?: string; endpoint?: string; params?: URLSearchParams },
      ): string

      Build the Plex Web URL for the object.

      Parameters

      • options: { base?: string; endpoint?: string; params?: URLSearchParams } = {}

        Options for the URL.

        • Optionalbase?: string

          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

          URL parameters to append.

      Returns string

    _uriRoot

    • Parameters

      • OptionalmediaType: string | number

      Returns Promise<Agent[]>

    • Returns Promise<boolean>

    • Parameters

      • __namedParameters: { download?: boolean; force?: boolean } = {}

      Returns Promise<ServerRelease | undefined>

    • Returns items from the Continue Watching hub.

      Returns Promise<ContinueWatchingItemData[]>

    • Create a temporary delegation token. Unclaimed servers have no token.

      Parameters

      • __namedParameters: { scope?: string; type?: string } = {}

      Returns Promise<string | undefined>

    • Delete a history entry without deleting its media.

      Parameters

      Returns Promise<void>

    • Download a ZIP archive as a Blob; callers choose where and whether to save it.

      Returns Promise<Blob>

    • 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

      Returns Promise<HistoryResult[]>

    • Download and apply an available update on platforms that support it.

      Returns Promise<void>

    • Returns true when Plex can browse the given server-visible path.

      Parameters

      Returns Promise<boolean>

    • Send a request to the server and parse the JSON response. Use PlexServer.stream for binary responses.

      Type Parameters

      • T = unknown

      Parameters

      • __namedParameters: {
            body?: Uint8Array<ArrayBufferLike>;
            headers?: Record<string, string>;
            method?: "post" | "get" | "put" | "patch" | "head" | "delete";
            password?: string;
            path: string;
            signal?: AbortSignal;
            username?: string;
        }

      Returns Promise<T>

    • Returns Promise<void>

    • Trigger a butler task to run immediately.

      Parameters

      • taskName: string

        Name of the task to run (e.g. 'BackupDatabase', 'OptimizeDatabase', etc).

      Returns Promise<void>

    • 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.

      • options: {
            limit?: number;
            mediatype?:
                | "playlist"
                | "movie"
                | "show"
                | "season"
                | "episode"
                | "trailer"
                | "comic"
                | "person"
                | "artist"
                | "album"
                | "track"
                | "picture"
                | "clip"
                | "photo"
                | "photoalbum"
                | "playlistFolder"
                | "collection"
                | "optimizedVersion"
                | "userPlaylistItem";
        } = {}

        Search options.

        • Optionallimit?: number

          Optionally limit to the specified number of results per Hub.

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

          Optionally limit your search to the specified media type.

      Returns Promise<Hub[]>

    • Parameters

      • paused: boolean

      Returns Promise<void>

    • Resolve a session or history entry back to its current library metadata.

      Parameters

      • item: { ratingKey?: string | number }

      Returns Promise<HydratedPlexItem | undefined>

    • Stop a playback session by its session ID.

      Parameters

      Returns Promise<void>

    • Open an authenticated response stream from this server.

      Parameters

      • path: string
      • __namedParameters: { signal?: AbortSignal } = {}

      Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

    • Build a URL for this server. Extra params and the token are added to any query string already in the key.

      Parameters

      • key: string
      • __namedParameters: { includeToken?: boolean; params?: URLSearchParams } = {}

      Returns URL

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods