Skip to content

Latest commit

 

History

History
267 lines (172 loc) · 11 KB

README.md

File metadata and controls

267 lines (172 loc) · 11 KB

Media

(media)

Overview

API Calls interacting with Plex Media Server Media

Available Operations

getBannerImage

Gets the banner image of the media item

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = '<YOUR_API_KEY_HERE>';

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

$request = new Operations\GetBannerImageRequest(
    ratingKey: 9518,
    width: 396,
    height: 396,
    minSize: 1,
    upscale: 1,
    xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
);

$response = $sdk->media->getBannerImage(
    request: $request
);

if ($response->bytes !== null) {
    // handle response
}

Parameters

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

Response

?Operations\GetBannerImageResponse

Errors

Error Type Status Code Content Type
Errors\GetBannerImageBadRequest 400 application/json
Errors\GetBannerImageUnauthorized 401 application/json
Errors\SDKException 4XX, 5XX */*

getThumbImage

Gets the thumbnail image of the media item

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = '<YOUR_API_KEY_HERE>';

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

$request = new Operations\GetThumbImageRequest(
    ratingKey: 9518,
    width: 396,
    height: 396,
    minSize: 1,
    upscale: 1,
    xPlexToken: 'CV5xoxjTpFKUzBTShsaf',
);

$response = $sdk->media->getThumbImage(
    request: $request
);

if ($response->bytes !== null) {
    // handle response
}

Parameters

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

Response

?Operations\GetThumbImageResponse

Errors

Error Type Status Code Content Type
Errors\GetThumbImageBadRequest 400 application/json
Errors\GetThumbImageUnauthorized 401 application/json
Errors\SDKException 4XX, 5XX */*

markPlayed

This will mark the provided media key as Played.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;

$security = '<YOUR_API_KEY_HERE>';

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



$response = $sdk->media->markPlayed(
    key: 59398
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description Example
key float ✔️ The media key to mark as played 59398

Response

?Operations\MarkPlayedResponse

Errors

Error Type Status Code Content Type
Errors\MarkPlayedBadRequest 400 application/json
Errors\MarkPlayedUnauthorized 401 application/json
Errors\SDKException 4XX, 5XX */*

markUnplayed

This will mark the provided media key as Unplayed.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;

$security = '<YOUR_API_KEY_HERE>';

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



$response = $sdk->media->markUnplayed(
    key: 59398
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description Example
key float ✔️ The media key to mark as Unplayed 59398

Response

?Operations\MarkUnplayedResponse

Errors

Error Type Status Code Content Type
Errors\MarkUnplayedBadRequest 400 application/json
Errors\MarkUnplayedUnauthorized 401 application/json
Errors\SDKException 4XX, 5XX */*

updatePlayProgress

This API command can be used to update the play progress of a media item.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;

$security = '<YOUR_API_KEY_HERE>';

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



$response = $sdk->media->updatePlayProgress(
    key: '<key>',
    time: 90000,
    state: 'played'

);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description Example
key string ✔️ the media key
time float ✔️ The time, in milliseconds, used to set the media playback progress. 90000
state string ✔️ The playback state of the media item. played

Response

?Operations\UpdatePlayProgressResponse

Errors

Error Type Status Code Content Type
Errors\UpdatePlayProgressBadRequest 400 application/json
Errors\UpdatePlayProgressUnauthorized 401 application/json
Errors\SDKException 4XX, 5XX */*