plexphp/docs/sdks/playlists/README.md

Playlists

Overview

Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017"). They can be organized in (optionally nesting) folders. Retrieving a playlist, or its items, will trigger a refresh of its metadata. This may cause the duration and number of items to change.

Available Operations

• 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

createPlaylist

Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass:

• uri - The content URI for what we're playing (e.g. server://1234/com.plexapp.plugins.library/library/metadata/1).
• playQueueID - To create a playlist from an existing play queue.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
use LukeHagar\Plex_API\Models\Operations;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {
    $request = new Operations\CreatePlaylistRequest(
        title: '<value>',
        type: Operations\CreatePlaylistQueryParamType::Photo,
        smart: Operations\Smart::One,
        uri: 'https://inborn-brochure.biz',
    );
    $response = $sdk->playlists->createPlaylist($request);

    if ($response->object !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
$request	Operations\CreatePlaylistRequest	✔️	The request object to use for the request.

Response

?Operations\CreatePlaylistResponse

Errors

Error Object	Status Code	Content Type
Errors\CreatePlaylistBadRequest	400	application/json
Errors\CreatePlaylistUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getPlaylists

Get All Playlists given the specified filters.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
use LukeHagar\Plex_API\Models\Operations;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->getPlaylists(Operations\PlaylistType::Audio, Operations\QueryParamSmart::Zero);

    if ($response->object !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
playlistType	Operations\PlaylistType	➖	limit to a type of playlist.
smart	Operations\QueryParamSmart	➖	type of playlists to return (default is all).

Response

?Operations\GetPlaylistsResponse

Errors

Error Object	Status Code	Content Type
Errors\GetPlaylistsBadRequest	400	application/json
Errors\GetPlaylistsUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getPlaylist

Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item: Smart playlist details contain the content attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->getPlaylist(4109.48);

    if ($response->object !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
playlistID	float	✔️	the ID of the playlist

Response

?Operations\GetPlaylistResponse

Errors

Error Object	Status Code	Content Type
Errors\GetPlaylistBadRequest	400	application/json
Errors\GetPlaylistUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

deletePlaylist

This endpoint will delete a playlist

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->deletePlaylist(216.22);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
playlistID	float	✔️	the ID of the playlist

Response

?Operations\DeletePlaylistResponse

Errors

Error Object	Status Code	Content Type
Errors\DeletePlaylistBadRequest	400	application/json
Errors\DeletePlaylistUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

updatePlaylist

From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via PUT /library/metadata/{playlistID}

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->updatePlaylist(3915, '<value>', '<value>');

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
playlistID	float	✔️	the ID of the playlist
title	string	➖	name of the playlist
summary	string	➖	summary description of the playlist

Response

?Operations\UpdatePlaylistResponse

Errors

Error Object	Status Code	Content Type
Errors\UpdatePlaylistBadRequest	400	application/json
Errors\UpdatePlaylistUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

getPlaylistContents

Gets the contents of a playlist. Should be paged by clients via standard mechanisms. By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the type parameter. For example, you could use this to display a list of recently added albums vis a smart playlist. Note that for dumb playlists, items have a playlistItemID attribute which is used for deleting or moving items.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
use LukeHagar\Plex_API\Models\Operations;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->getPlaylistContents(5004.46, Operations\GetPlaylistContentsQueryParamType::Two);

    if ($response->object !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description	Example
playlistID	float	✔️	the ID of the playlist
type	Operations\GetPlaylistContentsQueryParamType	✔️	The type of media to retrieve. 1 = movie 2 = show 3 = season 4 = episode E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries	2

Response

?Operations\GetPlaylistContentsResponse

Errors

Error Object	Status Code	Content Type
Errors\GetPlaylistContentsBadRequest	400	application/json
Errors\GetPlaylistContentsUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

clearPlaylistContents

Clears a playlist, only works with dumb playlists. Returns the playlist.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->clearPlaylistContents(1893.18);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
playlistID	float	✔️	the ID of the playlist

Response

?Operations\ClearPlaylistContentsResponse

Errors

Error Object	Status Code	Content Type
Errors\ClearPlaylistContentsBadRequest	400	application/json
Errors\ClearPlaylistContentsUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

addPlaylistContents

Adds a generator to a playlist, same parameters as the POST to create. With a dumb playlist, this adds the specified items to the playlist. With a smart playlist, passing a new uri parameter replaces the rules for the playlist. Returns the playlist.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->addPlaylistContents(8502.01, 'server://12345/com.plexapp.plugins.library/library/metadata/1', 123);

    if ($response->object !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description	Example
playlistID	float	✔️	the ID of the playlist
uri	string	✔️	the content URI for the playlist	server://12345/com.plexapp.plugins.library/library/metadata/1
playQueueID	float	➖	the play queue to add to a playlist	123

Response

?Operations\AddPlaylistContentsResponse

Errors

Error Object	Status Code	Content Type
Errors\AddPlaylistContentsBadRequest	400	application/json
Errors\AddPlaylistContentsUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/

uploadPlaylist

Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Components;
use LukeHagar\Plex_API\Models\Operations;

$security = new Components\Security(
    accessToken: "<YOUR_API_KEY_HERE>",
);

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('gcgzw5rz2xovp84b4vha3a40')
    ->setSecurity($security)->build();

try {

    $response = $sdk->playlists->uploadPlaylist('/home/barkley/playlist.m3u', Operations\QueryParamForce::Zero);

    if ($response->statusCode === 200) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description	Example
path	string	✔️	absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. If the path argument is a directory, that path will be scanned for playlist files to be processed. Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. The GUID of each playlist is based on the filename. If the path argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. The GUID of each playlist is based on the filename.	/home/barkley/playlist.m3u
force	Operations\QueryParamForce	✔️	Force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. The force argument is used to disable overwriting. If the force argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.

Response

?Operations\UploadPlaylistResponse

Errors

Error Object	Status Code	Content Type
Errors\UploadPlaylistBadRequest	400	application/json
Errors\UploadPlaylistUnauthorized	401	application/json
LukeHagar\Plex_API\Models\Errors.SDKException	4xx-5xx	/