8.4 KiB
Plex-API
SDK Installation
Nuget
dotnet add package Plex-API
SDK Example Usage
Example
using PlexAPI;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
security: new Models.Components.Security() {
AccessToken = "<YOUR_API_KEY_HERE>",
});
var res = await sdk.Server.GetServerCapabilitiesAsync();
// handle response
Available Resources and Operations
Server
- GetServerCapabilities - Server Capabilities
- GetServerPreferences - Get Server Preferences
- GetAvailableClients - Get Available Clients
- GetDevices - Get Devices
- GetServerIdentity - Get Server Identity
- GetMyPlexAccount - Get MyPlex Account
- GetResizedPhoto - Get a Resized Photo
- GetServerList - Get Server List
Media
- MarkPlayed - Mark Media Played
- MarkUnplayed - Mark Media Unplayed
- UpdatePlayProgress - Update Media Play Progress
Activities
- GetServerActivities - Get Server Activities
- CancelServerActivities - Cancel Server Activities
Butler
- GetButlerTasks - Get Butler tasks
- StartAllTasks - Start all Butler tasks
- StopAllTasks - Stop all Butler tasks
- StartTask - Start a single Butler task
- StopTask - Stop a single Butler task
Hubs
- GetGlobalHubs - Get Global Hubs
- GetLibraryHubs - Get library specific hubs
Search
- PerformSearch - Perform a search
- PerformVoiceSearch - Perform a voice search
- GetSearchResults - Get Search Results
Library
- GetFileHash - Get Hash Value
- GetRecentlyAdded - Get Recently Added
- GetLibraries - Get All Libraries
- GetLibrary - Get Library Details
- DeleteLibrary - Delete Library Section
- GetLibraryItems - Get Library Items
- RefreshLibrary - Refresh Library
- GetLatestLibraryItems - Get Latest Library Items
- GetCommonLibraryItems - Get Common Library Items
- GetMetadata - Get Items Metadata
- GetMetadataChildren - Get Items Children
- GetOnDeck - Get On Deck
Log
- LogLine - Logging a single line message.
- LogMultiLine - Logging a multi-line message
- EnablePaperTrail - Enabling Papertrail
Playlists
- CreatePlaylist - Create a Playlist
- GetPlaylists - Get All Playlists
- GetPlaylist - Retrieve Playlist
- DeletePlaylist - Deletes a Playlist
- UpdatePlaylist - Update a Playlist
- GetPlaylistContents - Retrieve Playlist Contents
- ClearPlaylistContents - Delete Playlist Contents
- AddPlaylistContents - Adding to a Playlist
- UploadPlaylist - Upload Playlist
Security
- GetTransientToken - Get a Transient Token.
- GetSourceConnectionInformation - Get Source Connection Information
Sessions
- GetSessions - Get Active Sessions
- GetSessionHistory - Get Session History
- GetTranscodeSessions - Get Transcode Sessions
- StopTranscodeSession - Stop a Transcode Session
Updater
- GetUpdateStatus - Querying status of updates
- CheckForUpdates - Checking for updates
- ApplyUpdates - Apply Updates
Video
- StartUniversalTranscode - Start Universal Transcode
- GetTimeline - Get the timeline for a media item
Server Selection
Server Selection
Select Server by Index
You can override the default server globally by passing a server index to the serverIndex: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | {protocol}://{ip}:{port} |
protocol (default is http), ip (default is 10.10.10.47), port (default is 32400) |
Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following options are provided for doing so:
protocol: ServerProtocolip: stringport: string
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverUrl: str optional parameter when initializing the SDK client instance. For example:
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!