Plex Plugin Framework — Comprehensive API Reference
This is an API reference for the Plex Plugin Framework.
The official documentation is no longer available, but you can consult the archived version for additional context. That archived documentation lacks some details, so this repository aims to provide a more comprehensive reference for Plex Plugin development.
This documentation is generated using Claude Opus 4.6 from the source code under
Framework.bundle/Contents/Resources/Versions/2/ and the content is not guaranteed to be correct or
complete — if you find any, please report them on GitHub.
Getting Started
Metadata Agent Plugins
Channel Plugins
Common API
- Global Functions & Decorators
- Template Attribute Types
- Container & Object Types (Modern API)
- ObjectContainer
- DirectoryObject
- NextPageObject
- InputDirectoryObject
- SearchDirectoryObject
- PopupDirectoryObject
- PrefsObject
- PlaylistObject
- MovieObject
- VideoClipObject
- EpisodeObject
- SeasonObject
- TVShowObject
- TrackObject
- ArtistObject / AlbumObject / PhotoObject / PhotoAlbumObject
- MetadataItem
- SearchResult
- MediaObject
- PartObject
- AudioStreamObject
- VideoStreamObject
- WebVideoURL
- HTTPLiveStreamURL
- RTMPVideoURL
- WindowsMediaVideoURL
- EmbedURL
- IndirectResponse
- Container & Object Types (Legacy API)
- Proxy Objects
- Networking API
- Parsing API
- Data & Persistence API
- Utility API
- Logging API
- Locale & Localization API
- Resource API
- ExternalPath(itemname) → str
- Load(itemname, binary=True) → str
- GuessMimeType(path) → str
- AddMimeType(mimetype, extension)
- ContentsOfURLWithFallback(url, fallback=None, hosted_fallback=None) → str
- Hosted(type, group, identifier=None) → HostedResource
- SharedExternalPath(itemname) → str
- LoadShared(itemname, binary=True) → str
- Threading API
- Cryptography API
- Helper API
- Constants
- Runtime & Plugin API