LukeParke/plex-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-docs.git synced 2025-12-06 04:20:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating PMS Spec

Browse Source
This commit is contained in:
lukehagar
2023-07-03 20:49:19 +00:00
parent b873d8de33
commit 6bc9f6bc1f
1 changed files with 54 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
static/plex-media-server-spec-dereferenced.yaml
View File

@@ -12,7 +12,7 @@ info:
name: MIT name: MIT
identifier: MIT identifier: MIT
servers: servers:
- url: '{protocol}://{localIP}:{port}' - url: '{protocol}://{ip}:{port}'
description: The full address of your Plex Server description: The full address of your Plex Server
variables: variables:
protocol: protocol:
@@ -21,7 +21,7 @@ servers:
enum: enum:
- http - http
- https - https
localIP: ip:
default: 10.10.10.47 default: 10.10.10.47
description: The Local IP Address of your plex server. description: The Local IP Address of your plex server.
port: port:
@@ -3778,97 +3778,113 @@ paths:
description: Whether the media item has MDE description: Whether the media item has MDE
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 1 example: 1
- name: path - name: path
description: The path to the media item to transcode description: The path to the media item to transcode
required: true required: true
in: query in: query
schema: string schema:
type: string
example: /library/metadata/23409 example: /library/metadata/23409
- name: mediaIndex - name: mediaIndex
description: The index of the media item to transcode description: The index of the media item to transcode
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 0 example: 0
- name: partIndex - name: partIndex
description: The index of the part to transcode description: The index of the part to transcode
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 0 example: 0
- name: protocol - name: protocol
description: The protocol to use for the transcode session description: The protocol to use for the transcode session
required: true required: true
in: query in: query
schema: string schema:
type: string
example: hls example: hls
- name: fastSeek - name: fastSeek
description: Whether to use fast seek or not description: Whether to use fast seek or not
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 0 example: 0
- name: directPlay - name: directPlay
description: Whether to use direct play or not description: Whether to use direct play or not
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 0 example: 0
- name: directStream - name: directStream
description: Whether to use direct stream or not description: Whether to use direct stream or not
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 0 example: 0
- name: subtitleSize - name: subtitleSize
description: The size of the subtitles description: The size of the subtitles
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 100 example: 100
- name: subtites - name: subtites
description: The subtitles description: The subtitles
required: false required: false
in: query in: query
schema: string schema:
type: string
example: burn example: burn
- name: audioBoost - name: audioBoost
description: The audio boost description: The audio boost
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 100 example: 100
- name: location - name: location
description: The location of the transcode session description: The location of the transcode session
required: false required: false
in: query in: query
schema: string schema:
type: string
example: lan example: lan
- name: mediaBufferSize - name: mediaBufferSize
description: The size of the media buffer description: The size of the media buffer
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 102400 example: 102400
- name: session - name: session
description: The session ID description: The session ID
required: false required: false
in: query in: query
schema: string schema:
type: string
example: zvcage8b7rkioqcm8f4uns4c example: zvcage8b7rkioqcm8f4uns4c
- name: addDebugOverlay - name: addDebugOverlay
description: Whether to add a debug overlay or not description: Whether to add a debug overlay or not
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 0 example: 0
- name: autoAdjustQuality - name: autoAdjustQuality
description: Whether to auto adjust quality or not description: Whether to auto adjust quality or not
required: false required: false
in: query in: query
schema: number schema:
type: number
example: 0 example: 0
responses: responses:
'200': '200':
@@ -3908,13 +3924,15 @@ paths:
description: The rating key of the media item description: The rating key of the media item
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 23409 example: 23409
- name: key - name: key
description: The key of the media item to get the timeline for description: The key of the media item to get the timeline for
required: true required: true
in: query in: query
schema: string schema:
type: string
example: /library/metadata/23409 example: /library/metadata/23409
- name: state - name: state
description: The state of the media item description: The state of the media item
@@ -3931,49 +3949,57 @@ paths:
description: Whether the media item has MDE description: Whether the media item has MDE
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 1 example: 1
- name: time - name: time
description: The time of the media item description: The time of the media item
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 2000 example: 2000
- name: duration - name: duration
description: The duration of the media item description: The duration of the media item
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 10000 example: 10000
- name: context - name: context
description: The context of the media item description: The context of the media item
required: true required: true
in: query in: query
schema: string schema:
type: string
example: 'home:hub.continueWatching' example: 'home:hub.continueWatching'
- name: playQueueItemID - name: playQueueItemID
description: The play queue item ID of the media item description: The play queue item ID of the media item
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 1 example: 1
- name: playBackTime - name: playBackTime
description: The playback time of the media item description: The playback time of the media item
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 2000 example: 2000
- name: row - name: row
description: The row of the media item description: The row of the media item
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 1 example: 1
- name: ratingKey - name: ratingKey
description: The rating key of the media item description: The rating key of the media item
required: true required: true
in: query in: query
schema: number schema:
type: number
example: 23409 example: 23409
responses: responses:
'200': '200':