plexphp/docs/sdks/video/README.md

Video

(video)

Overview

API Calls that perform operations with Plex Media Server Videos

Available Operations

• getTimeline - Get the timeline for a media item
• startUniversalTranscode - Start Universal Transcode

getTimeline

Get the timeline for a media item

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();

$request = new Operations\GetTimelineRequest(
    ratingKey: 23409,
    key: '/library/metadata/23409',
    state: Operations\State::Playing,
    hasMDE: 1,
    time: 2000,
    duration: 10000,
    context: 'home:hub.continueWatching',
    playQueueItemID: 1,
    playBackTime: 2000,
    row: 1,
);

$response = $sdk->video->getTimeline(
    request: $request
);

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

Parameters

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

Response

?Operations\GetTimelineResponse

Errors

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

startUniversalTranscode

Begin a Universal Transcode Session

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();

$request = new Operations\StartUniversalTranscodeRequest(
    hasMDE: 1,
    path: '/library/metadata/23409',
    mediaIndex: 0,
    partIndex: 0,
    protocol: 'hls',
    fastSeek: 0,
    directPlay: 0,
    directStream: 0,
    subtitleSize: 100,
    subtites: 'burn',
    audioBoost: 100,
    location: 'lan',
    mediaBufferSize: 102400,
    session: 'zvcage8b7rkioqcm8f4uns4c',
    addDebugOverlay: 0,
    autoAdjustQuality: 0,
);

$response = $sdk->video->startUniversalTranscode(
    request: $request
);

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

Parameters

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

Response

?Operations\StartUniversalTranscodeResponse

Errors

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