LukeParke/plex-sdk-docs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-sdk-docs.git synced 2025-12-10 12:37:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial Commit

Browse Source
This commit is contained in:
Luke Hagar
2024-01-01 15:47:37 -06:00
parent 203c48ae7c
commit f91c1e6f54
4519 changed files with 88021 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
content/pages/01-reference/python/resources/media/mark_played/_header.mdx Normal file
View File

@@ -0,0 +1,3 @@
## Mark Played
This will mark the provided media key as Played.

7
content/pages/01-reference/python/resources/media/mark_played/_parameters.mdx Normal file
View File

@@ -0,0 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `key` *{`float`}*
The media key to mark as played
<br/>
**Example:** `59398`

11
content/pages/01-reference/python/resources/media/mark_played/_response.mdx Normal file
View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
import MarkPlayedResponse from "/content/types/models/operations/mark_played_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.MarkPlayedResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<MarkPlayedResponse/>
</Collapsible>

31
content/pages/01-reference/python/resources/media/mark_played/_usage.mdx Normal file
View File

@@ -0,0 +1,31 @@
<CH.Code>
```python MarkPlayed.py
import sdk
from sdk.models import operations
s = sdk.SDK(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.media.mark_played(key=59398)
if res.status_code == 200:
# handle response
pass
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
]
}
```
</CH.Code>

12
content/pages/01-reference/python/resources/media/mark_played/mark_played.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Media*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

3
content/pages/01-reference/python/resources/media/mark_unplayed/_header.mdx Normal file
View File

@@ -0,0 +1,3 @@
## Mark Unplayed
This will mark the provided media key as Unplayed.

7
content/pages/01-reference/python/resources/media/mark_unplayed/_parameters.mdx Normal file
View File

@@ -0,0 +1,7 @@
{/* Autogenerated DO NOT EDIT */}
##### `key` *{`float`}*
The media key to mark as Unplayed
<br/>
**Example:** `59398`

11
content/pages/01-reference/python/resources/media/mark_unplayed/_response.mdx Normal file
View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
import MarkUnplayedResponse from "/content/types/models/operations/mark_unplayed_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.MarkUnplayedResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<MarkUnplayedResponse/>
</Collapsible>

31
content/pages/01-reference/python/resources/media/mark_unplayed/_usage.mdx Normal file
View File

@@ -0,0 +1,31 @@
<CH.Code>
```python MarkUnplayed.py
import sdk
from sdk.models import operations
s = sdk.SDK(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.media.mark_unplayed(key=59398)
if res.status_code == 200:
# handle response
pass
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
]
}
```
</CH.Code>

12
content/pages/01-reference/python/resources/media/mark_unplayed/mark_unplayed.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Media*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}

22
content/pages/01-reference/python/resources/media/media.mdx Normal file
View File

@@ -0,0 +1,22 @@
import MarkPlayed from "./mark_played/mark_played.mdx";
import MarkUnplayed from "./mark_unplayed/mark_unplayed.mdx";
import UpdatePlayProgress from "./update_play_progress/update_play_progress.mdx";
## Media
API Calls interacting with Plex Media Server Media
### Available Operations
* [Mark Played](/python/media/mark_played) - Mark Media Played
* [Mark Unplayed](/python/media/mark_unplayed) - Mark Media Unplayed
* [Update Play Progress](/python/media/update_play_progress) - Update Media Play Progress
---
<MarkPlayed />
---
<MarkUnplayed />
---
<UpdatePlayProgress />

3
content/pages/01-reference/python/resources/media/update_play_progress/_header.mdx Normal file
View File

@@ -0,0 +1,3 @@
## Update Play Progress
This API command can be used to update the play progress of a media item.

13
content/pages/01-reference/python/resources/media/update_play_progress/_parameters.mdx Normal file
View File

@@ -0,0 +1,13 @@
{/* Autogenerated DO NOT EDIT */}
##### `key` *{`str`}*
the media key
---
##### `time` *{`float`}*
The time, in milliseconds, used to set the media playback progress.
---
##### `state` *{`str`}*
The playback state of the media item.

11
content/pages/01-reference/python/resources/media/update_play_progress/_response.mdx Normal file
View File

@@ -0,0 +1,11 @@
{/* Autogenerated DO NOT EDIT */}
import UpdatePlayProgressResponse from "/content/types/models/operations/update_play_progress_response/python.mdx"
import Collapsible from "/src/components/Collapsible";
import Labels from "/src/lib/labels";
##### *{`operations.UpdatePlayProgressResponse`}*
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
<UpdatePlayProgressResponse/>
</Collapsible>

31
content/pages/01-reference/python/resources/media/update_play_progress/_usage.mdx Normal file
View File

@@ -0,0 +1,31 @@
<CH.Code>
```python UpdatePlayProgress.py
import sdk
from sdk.models import operations
s = sdk.SDK(
access_token="<YOUR_API_KEY_HERE>",
)
res = s.media.update_play_progress(key='string', time=6027.63, state='string')
if res.status_code == 200:
# handle response
pass
```
---
```json Example Response
{
"errors": [
{
"code": 1001,
"message": "User could not be authenticated",
"status": 401
}
]
}
```
</CH.Code>

12
content/pages/01-reference/python/resources/media/update_play_progress/update_play_progress.mdx Normal file
View File

@@ -0,0 +1,12 @@
import CurlHeader from './_header.mdx';
import SDKHeader from './_header.mdx';
import OperationHeader from '/src/components/OperationHeader';
###### *Media*
<OperationHeader
sdkHeader={<SDKHeader />}
curlHeader={<CurlHeader />}
/>
{/* render operation */}