create_timeline
Report media playback state and position to Plex to keep timelines accurate and enable resume.
Instructions
Report media timeline.
POST /:/timeline
Args:
key: The details key for the item.
rating_key: The rating key attribute for the item.
state: The current state of the media.
play_queue_item_id: If playing media from a play queue, the play queue's ID.
time: The current time offset of playback in ms.
duration: The total duration of the item in ms.
continuing: When state is stopped, a flag indicating whether or not the client is going to continue playing anothe item.
updated: Used when a sync client comes online and is syncing media timelines, holds the time at which the playback state was last updated.
offline: Also used by sync clients, used to indicate that a timeline is being synced from being offline, as opposed to being "live".
time_to_first_frame: Time in seconds till first frame is displayed. Sent only on the first playing timeline request.
time_stalled: Time in seconds spent buffering since last request.
bandwidth: Bandwidth in kbps as estimated by the client.
buffered_time: Amount of time in seconds buffered by client. Omit if computed by bufferedSize below.
buffered_size: Size in kilobytes of data buffered by client. Omit if computed by bufferedTime above
container_key: Groups timeline reports (e.g. /playQueues/123).
guid: Global unique identifier for the item.
play_queue_id: Identifies the play queue itself (distinct from playQueueItemID).
url: Alternative to key/ratingKey (legacy).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | ||
| url | No | ||
| guid | No | ||
| time | No | ||
| state | No | ||
| offline | No | ||
| updated | No | ||
| duration | No | ||
| bandwidth | No | ||
| continuing | No | ||
| rating_key | No | ||
| time_stalled | No | ||
| buffered_size | No | ||
| buffered_time | No | ||
| container_key | No | ||
| play_queue_id | No | ||
| play_queue_item_id | No | ||
| time_to_first_frame | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |