plexpy/docs/sdks/video/README.md

Video

(video)

Overview

API Calls that perform operations with Plex Media Server Videos

Available Operations

• get_timeline - Get the timeline for a media item
• start_universal_transcode - Start Universal Transcode

get_timeline

Get the timeline for a media item

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import operations


with PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.video.get_timeline(request={
        "rating_key": 23409,
        "key": "/library/metadata/23409",
        "state": operations.State.PLAYING,
        "has_mde": 1,
        "time": 2000,
        "duration": 10000,
        "context": "home:hub.continueWatching",
        "play_queue_item_id": 1,
        "play_back_time": 2000,
        "row": 1,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.GetTimelineRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetTimelineResponse

Errors

Error Type	Status Code	Content Type
errors.GetTimelineBadRequest	400	application/json
errors.GetTimelineUnauthorized	401	application/json
errors.SDKError	4XX, 5XX	*/*

start_universal_transcode

Begin a Universal Transcode Session

Example Usage

from plex_api_client import PlexAPI


with PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.video.start_universal_transcode(request={
        "has_mde": 1,
        "path": "/library/metadata/23409",
        "media_index": 0,
        "part_index": 0,
        "protocol": "hls",
        "fast_seek": 0,
        "direct_play": 0,
        "direct_stream": 0,
        "subtitle_size": 100,
        "subtites": "burn",
        "audio_boost": 100,
        "location": "lan",
        "media_buffer_size": 102400,
        "session": "zvcage8b7rkioqcm8f4uns4c",
        "add_debug_overlay": 0,
        "auto_adjust_quality": 0,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.StartUniversalTranscodeRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.StartUniversalTranscodeResponse

Errors

Error Type	Status Code	Content Type
errors.StartUniversalTranscodeBadRequest	400	application/json
errors.StartUniversalTranscodeUnauthorized	401	application/json
errors.SDKError	4XX, 5XX	*/*