mirror of
https://github.com/LukeHagar/plex-api-spec.git
synced 2025-12-07 20:47:47 +00:00
Added Timeline endpoint
This commit is contained in:
95
pms/paths/timeline.yaml
Normal file
95
pms/paths/timeline.yaml
Normal file
@@ -0,0 +1,95 @@
|
||||
get:
|
||||
tags:
|
||||
- Video
|
||||
summary: Get the timeline for a media item
|
||||
description: Get the timeline for a media item
|
||||
operationId: getTimeline
|
||||
parameters:
|
||||
|
||||
- name: ratingKey
|
||||
description: The rating key of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 23409
|
||||
|
||||
- name: key
|
||||
description: The key of the media item to get the timeline for
|
||||
required: true
|
||||
in: query
|
||||
schema: string
|
||||
example: "/library/metadata/23409"
|
||||
|
||||
- name: state
|
||||
description: The state of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
enum: ["playing", "paused", "stopped"]
|
||||
example: "playing"
|
||||
|
||||
- name: hasMDE
|
||||
description: Whether the media item has MDE
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 1
|
||||
|
||||
- name: time
|
||||
description: The time of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 2000
|
||||
|
||||
- name: duration
|
||||
description: The duration of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 10000
|
||||
|
||||
- name: context
|
||||
description: The context of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: string
|
||||
example: "home:hub.continueWatching"
|
||||
|
||||
- name: playQueueItemID
|
||||
description: The play queue item ID of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 1
|
||||
|
||||
- name: playBackTime
|
||||
description: The playback time of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 2000
|
||||
|
||||
- name: row
|
||||
description: The row of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 1
|
||||
|
||||
- name: ratingKey
|
||||
description: The rating key of the media item
|
||||
required: true
|
||||
in: query
|
||||
schema: number
|
||||
example: 23409
|
||||
|
||||
responses:
|
||||
"200":
|
||||
description: The timeline for the media item
|
||||
|
||||
"400":
|
||||
$ref: "../../responses/400.yaml"
|
||||
"401":
|
||||
$ref: "../../responses/401.yaml"
|
||||
@@ -199,6 +199,12 @@ paths:
|
||||
/updater/apply:
|
||||
$ref: "./paths/updater-apply.yaml"
|
||||
|
||||
/video/:/transcode/universal/start.mpd:
|
||||
$ref: "./paths/video-transcode-universal-start.yaml"
|
||||
|
||||
/:/timeline:
|
||||
$ref: "./paths/timeline.yaml"
|
||||
|
||||
tags:
|
||||
- name: Activities
|
||||
description: |
|
||||
|
||||
Reference in New Issue
Block a user