chindit/plex-api

A simple API library to interact with a Plex server

2.0.1 2024-01-21 12:21 UTC

Requires

• php: ^8.2
• ext-simplexml: *
• chindit/collection: ^1.0
• symfony/http-client: ^7.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.5

GPL-3.0-or-later

• David Lumaye

README

Installation

composer require chindit/plex-api

Usage

Create a new instance of PlexServer

Minimal parameters to pass are server host and token.

$plex = new Chindit\PlexServer('http://path.to.my.plex', 'MyPlexToken');

You can also provide a specific port as third argument (default is 32400) and some options as fourth parameters. Options must be suppored by Symfony's HTTP client.

Most common parameters are max_redirects and timeout.

In this case, server initialization will look like this:

$plex = new Chindit\PlexServer('http://path.to.my.plex', 'MyPlexToken', 32400, ['timeout' => 10]);

To find you plex token, check this article

Methods available

Once your $plexserver instance created, following methods are available:

• checkConnection(): bool Checks if connection can be made to your Plex instance.

• servers(): array<Server> Returns the list of active servers for your Plex instance.

  Response is an array of Chindit\Model\Server objects

• sessionsCount(): int Returns the number of active sessions on the server. An active session is a device streaming a media.

• libraries(): array<Library> Returns all you libraries. A Plex library is a general section like your «Movies» or «Shows» categories. All your medias are contained in libraries.

• library(int $libraryId): array<Movie|Show> Return all the media contained in a specific library. Library id can be obtained by a getId() on a Library object.

  Example:

  $myLibraries = $plexServer->libraries();
  $theLibraryIWant = $myLibraries[0]; // Choose any libray you want;
  $myMedias = $plexServer->library($theLibraryIWant->getId());

  Response is an array of Chindit\Model\Movie and Chindit\Model\Show objects.

Need help ?

If you need a specific call, have a suggestion or found a bug, do not hesitate tot leave a comment on the Issue tab.