LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-07 20:47:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.129.1

Browse Source
This commit is contained in:
speakeasybot
2024-01-01 14:37:30 +00:00
parent 4d1564b0b7
commit d69f35d589
621 changed files with 22413 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
docs/sdks/video/README.md Normal file
View File

@@ -0,0 +1,99 @@
# Video
(*Video*)
## Overview
API Calls that perform operations with Plex Media Server Videos
### Available Operations
* [StartUniversalTranscode](#startuniversaltranscode) - Start Universal Transcode
* [GetTimeline](#gettimeline) - Get the timeline for a media item
## StartUniversalTranscode
Begin a Universal Transcode Session
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
var sdk = new PlexAPISDK(
security: new Models.Components.Security() {
AccessToken = "<YOUR_API_KEY_HERE>",
});
StartUniversalTranscodeRequest req = new StartUniversalTranscodeRequest() {
HasMDE = 8924.99D,
Path = "/etc/mail",
MediaIndex = 9962.95D,
PartIndex = 1232.82D,
Protocol = "string",
};
var res = await sdk.Video.StartUniversalTranscodeAsync(req);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `request` | [StartUniversalTranscodeRequest](../../Models/Requests/StartUniversalTranscodeRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[StartUniversalTranscodeResponse](../../Models/Requests/StartUniversalTranscodeResponse.md)**
## GetTimeline
Get the timeline for a media item
### Example Usage
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
var sdk = new PlexAPISDK(
security: new Models.Components.Security() {
AccessToken = "<YOUR_API_KEY_HERE>",
});
GetTimelineRequest req = new GetTimelineRequest() {
RatingKey = 716.56D,
Key = "<key>",
State = State.Paused,
HasMDE = 7574.33D,
Time = 3327.51D,
Duration = 7585.39D,
Context = "string",
PlayQueueItemID = 1406.21D,
PlayBackTime = 2699.34D,
Row = 3536.42D,
};
var res = await sdk.Video.GetTimelineAsync(req);
// handle response
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
| `request` | [GetTimelineRequest](../../Models/Requests/GetTimelineRequest.md) | :heavy_check_mark: | The request object to use for the request. |
### Response
**[GetTimelineResponse](../../Models/Requests/GetTimelineResponse.md)**