mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-10 12:37:45 +00:00
Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ed63eb13b9 | ||
|
|
442b11c11a | ||
|
|
c56a0f5d3c | ||
|
|
fe48f93ccb | ||
|
|
a7ec77cd04 |
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
|||||||
|
/examples/node_modules
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
.DS_Store
|
.DS_Store
|
||||||
**/.speakeasy/temp/
|
**/.speakeasy/temp/
|
||||||
**/.speakeasy/logs/
|
**/.speakeasy/logs/
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -16,15 +16,22 @@ generation:
|
|||||||
auth:
|
auth:
|
||||||
oAuth2ClientCredentialsEnabled: true
|
oAuth2ClientCredentialsEnabled: true
|
||||||
oAuth2PasswordEnabled: false
|
oAuth2PasswordEnabled: false
|
||||||
|
hoistGlobalSecurity: true
|
||||||
|
tests:
|
||||||
|
generateTests: true
|
||||||
|
generateNewTests: false
|
||||||
|
skipResponseBodyAssertions: false
|
||||||
typescript:
|
typescript:
|
||||||
version: 0.38.0
|
version: 0.40.3
|
||||||
additionalDependencies:
|
additionalDependencies:
|
||||||
dependencies: {}
|
dependencies: {}
|
||||||
devDependencies: {}
|
devDependencies: {}
|
||||||
peerDependencies: {}
|
peerDependencies: {}
|
||||||
additionalPackageJSON: {}
|
additionalPackageJSON: {}
|
||||||
author: LukeHagar
|
author: LukeHagar
|
||||||
|
baseErrorName: PlexAPIError
|
||||||
clientServerStatusCodesAsErrors: true
|
clientServerStatusCodesAsErrors: true
|
||||||
|
constFieldsAlwaysOptional: true
|
||||||
defaultErrorName: SDKError
|
defaultErrorName: SDKError
|
||||||
enableCustomCodeRegions: false
|
enableCustomCodeRegions: false
|
||||||
enableMCPServer: true
|
enableMCPServer: true
|
||||||
@@ -32,6 +39,7 @@ typescript:
|
|||||||
enumFormat: enum
|
enumFormat: enum
|
||||||
flattenGlobalSecurity: true
|
flattenGlobalSecurity: true
|
||||||
flatteningOrder: body-first
|
flatteningOrder: body-first
|
||||||
|
generateExamples: true
|
||||||
imports:
|
imports:
|
||||||
option: openapi
|
option: openapi
|
||||||
paths:
|
paths:
|
||||||
@@ -48,5 +56,7 @@ typescript:
|
|||||||
outputModelSuffix: output
|
outputModelSuffix: output
|
||||||
packageName: '@lukehagar/plexjs'
|
packageName: '@lukehagar/plexjs'
|
||||||
responseFormat: envelope
|
responseFormat: envelope
|
||||||
|
sseFlatResponse: false
|
||||||
templateVersion: v2
|
templateVersion: v2
|
||||||
|
usageSDKInitImports: []
|
||||||
useIndexModules: true
|
useIndexModules: true
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
speakeasyVersion: 1.555.2
|
speakeasyVersion: 1.615.2
|
||||||
sources:
|
sources:
|
||||||
my-source:
|
my-source:
|
||||||
sourceNamespace: my-source
|
sourceNamespace: my-source
|
||||||
@@ -9,20 +9,20 @@ sources:
|
|||||||
- main
|
- main
|
||||||
plexapi:
|
plexapi:
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
sourceRevisionDigest: sha256:5125adfea1b0daea399c6ecf755e32795de6b4131465ae6a1f32ad73b3bc7787
|
||||||
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
sourceBlobDigest: sha256:95cea18b6e5f7d76d35db0aba5bcb59e72cf204451a2b09a99be0e3e9ec1f4c0
|
||||||
tags:
|
tags:
|
||||||
- latest
|
- latest
|
||||||
- speakeasy-sdk-regen-1748995899
|
- speakeasy-sdk-regen-1757895128
|
||||||
- 0.0.3
|
- 0.0.3
|
||||||
targets:
|
targets:
|
||||||
plexjs:
|
plexjs:
|
||||||
source: plexapi
|
source: plexapi
|
||||||
sourceNamespace: plexapi
|
sourceNamespace: plexapi
|
||||||
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
sourceRevisionDigest: sha256:5125adfea1b0daea399c6ecf755e32795de6b4131465ae6a1f32ad73b3bc7787
|
||||||
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
sourceBlobDigest: sha256:95cea18b6e5f7d76d35db0aba5bcb59e72cf204451a2b09a99be0e3e9ec1f4c0
|
||||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||||
codeSamplesRevisionDigest: sha256:132446d6299798fab8378bc875b16290ef126cdb50befe85a0a88bee8bf35799
|
codeSamplesRevisionDigest: sha256:1e2d6fa14f87b947de490bc7f88a36b2e43145643385bd8f728c7cdc69b56086
|
||||||
workflow:
|
workflow:
|
||||||
workflowVersion: 1.0.0
|
workflowVersion: 1.0.0
|
||||||
speakeasyVersion: latest
|
speakeasyVersion: latest
|
||||||
|
|||||||
366
README.md
366
README.md
@@ -267,16 +267,15 @@ run();
|
|||||||
<!-- Start Error Handling [errors] -->
|
<!-- Start Error Handling [errors] -->
|
||||||
## Error Handling
|
## Error Handling
|
||||||
|
|
||||||
This table shows properties which are common on error classes. For full details see [error classes](#error-classes).
|
[`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts) is the base class for all HTTP error responses. It has the following properties:
|
||||||
|
|
||||||
| Property | Type | Description |
|
| Property | Type | Description |
|
||||||
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
|
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
|
||||||
| `error.name` | `string` | Error class name eg `SDKError` |
|
|
||||||
| `error.message` | `string` | Error message |
|
| `error.message` | `string` | Error message |
|
||||||
| `error.statusCode` | `number` | HTTP status code eg `404` |
|
| `error.statusCode` | `number` | HTTP response status code eg `404` |
|
||||||
| `error.contentType` | `string` | HTTP content type eg `application/json` |
|
| `error.headers` | `Headers` | HTTP response headers |
|
||||||
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
|
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
|
||||||
| `error.rawResponse` | `Response` | Raw HTTP response. Access to headers and more. |
|
| `error.rawResponse` | `Response` | Raw HTTP response |
|
||||||
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
|
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
@@ -294,19 +293,18 @@ async function run() {
|
|||||||
|
|
||||||
console.log(result);
|
console.log(result);
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
// Depending on the method different errors may be thrown
|
// The base class for HTTP error responses
|
||||||
if (error instanceof errors.GetServerCapabilitiesBadRequest) {
|
if (error instanceof errors.PlexAPIError) {
|
||||||
console.log(error.message);
|
|
||||||
console.log(error.data$.errors); // Errors[]
|
|
||||||
console.log(error.data$.rawResponse); // Response
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fallback error class, if no other more specific error class is matched
|
|
||||||
if (error instanceof errors.SDKError) {
|
|
||||||
console.log(error.message);
|
console.log(error.message);
|
||||||
console.log(error.statusCode);
|
console.log(error.statusCode);
|
||||||
console.log(error.body);
|
console.log(error.body);
|
||||||
console.log(error.rawResponse.headers);
|
console.log(error.headers);
|
||||||
|
|
||||||
|
// Depending on the method different errors may be thrown
|
||||||
|
if (error instanceof errors.GetServerCapabilitiesBadRequest) {
|
||||||
|
console.log(error.data$.errors); // Errors[]
|
||||||
|
console.log(error.data$.rawResponse); // Response
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -316,176 +314,182 @@ run();
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Error Classes
|
### Error Classes
|
||||||
* `SDKError`: The fallback error class, if no other more specific error class is matched.
|
**Primary error:**
|
||||||
* `SDKValidationError`: Type mismatch between the data returned from the server and the structure expected by the SDK. This can also be thrown for invalid method arguments. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
* [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts): The base class for HTTP error responses.
|
||||||
* Network errors:
|
|
||||||
* `ConnectionError`: HTTP client was unable to make a request to a server.
|
|
||||||
* `RequestTimeoutError`: HTTP request timed out due to an AbortSignal signal.
|
|
||||||
* `RequestAbortedError`: HTTP request was aborted by the client.
|
|
||||||
* `InvalidRequestError`: Any input used to create a request is invalid.
|
|
||||||
* `UnexpectedClientError`: Unrecognised or unexpected error.
|
|
||||||
|
|
||||||
<details><summary>Less common errors, applicable to a subset of methods (156)</summary>
|
<details><summary>Less common errors (162)</summary>
|
||||||
|
|
||||||
|
<br />
|
||||||
|
|
||||||
|
**Network errors:**
|
||||||
|
* [`ConnectionError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
|
||||||
|
* [`RequestTimeoutError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
|
||||||
|
* [`RequestAbortedError`](./src/sdk/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
|
||||||
|
* [`InvalidRequestError`](./src/sdk/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
|
||||||
|
* [`UnexpectedClientError`](./src/sdk/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
|
||||||
|
|
||||||
|
|
||||||
|
**Inherit from [`PlexAPIError`](./src/sdk/models/errors/plexapierror.ts)**:
|
||||||
|
* [`GetServerCapabilitiesBadRequest`](./src/sdk/models/errors/getservercapabilitiesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerPreferencesBadRequest`](./src/sdk/models/errors/getserverpreferencesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetAvailableClientsBadRequest`](./src/sdk/models/errors/getavailableclientsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetDevicesBadRequest`](./src/sdk/models/errors/getdevicesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMyPlexAccountBadRequest`](./src/sdk/models/errors/getmyplexaccountbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetResizedPhotoBadRequest`](./src/sdk/models/errors/getresizedphotobadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMediaProvidersBadRequest`](./src/sdk/models/errors/getmediaprovidersbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerListBadRequest`](./src/sdk/models/errors/getserverlistbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`MarkPlayedBadRequest`](./src/sdk/models/errors/markplayedbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`MarkUnplayedBadRequest`](./src/sdk/models/errors/markunplayedbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`UpdatePlayProgressBadRequest`](./src/sdk/models/errors/updateplayprogressbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetBannerImageBadRequest`](./src/sdk/models/errors/getbannerimagebadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetThumbImageBadRequest`](./src/sdk/models/errors/getthumbimagebadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTimelineBadRequest`](./src/sdk/models/errors/gettimelinebadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StartUniversalTranscodeBadRequest`](./src/sdk/models/errors/startuniversaltranscodebadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerActivitiesBadRequest`](./src/sdk/models/errors/getserveractivitiesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`CancelServerActivitiesBadRequest`](./src/sdk/models/errors/cancelserveractivitiesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetButlerTasksBadRequest`](./src/sdk/models/errors/getbutlertasksbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StartAllTasksBadRequest`](./src/sdk/models/errors/startalltasksbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StopAllTasksBadRequest`](./src/sdk/models/errors/stopalltasksbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StartTaskBadRequest`](./src/sdk/models/errors/starttaskbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StopTaskBadRequest`](./src/sdk/models/errors/stoptaskbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetCompanionsDataBadRequest`](./src/sdk/models/errors/getcompanionsdatabadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetUserFriendsBadRequest`](./src/sdk/models/errors/getuserfriendsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetGeoDataBadRequest`](./src/sdk/models/errors/getgeodatabadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetHomeDataBadRequest`](./src/sdk/models/errors/gethomedatabadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerResourcesBadRequest`](./src/sdk/models/errors/getserverresourcesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetPinBadRequest`](./src/sdk/models/errors/getpinbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTokenByPinIdBadRequest`](./src/sdk/models/errors/gettokenbypinidbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetGlobalHubsBadRequest`](./src/sdk/models/errors/getglobalhubsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibraryHubsBadRequest`](./src/sdk/models/errors/getlibraryhubsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`PerformSearchBadRequest`](./src/sdk/models/errors/performsearchbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`PerformVoiceSearchBadRequest`](./src/sdk/models/errors/performvoicesearchbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSearchResultsBadRequest`](./src/sdk/models/errors/getsearchresultsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetFileHashBadRequest`](./src/sdk/models/errors/getfilehashbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetRecentlyAddedLibraryBadRequest`](./src/sdk/models/errors/getrecentlyaddedlibrarybadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetAllLibrariesBadRequest`](./src/sdk/models/errors/getalllibrariesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibraryDetailsBadRequest`](./src/sdk/models/errors/getlibrarydetailsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`DeleteLibraryBadRequest`](./src/sdk/models/errors/deletelibrarybadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibraryItemsBadRequest`](./src/sdk/models/errors/getlibraryitemsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibrarySectionsAllBadRequest`](./src/sdk/models/errors/getlibrarysectionsallbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetRefreshLibraryMetadataBadRequest`](./src/sdk/models/errors/getrefreshlibrarymetadatabadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSearchLibraryBadRequest`](./src/sdk/models/errors/getsearchlibrarybadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetGenresLibraryBadRequest`](./src/sdk/models/errors/getgenreslibrarybadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetCountriesLibraryBadRequest`](./src/sdk/models/errors/getcountrieslibrarybadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetActorsLibraryBadRequest`](./src/sdk/models/errors/getactorslibrarybadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSearchAllLibrariesBadRequest`](./src/sdk/models/errors/getsearchalllibrariesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMediaMetaDataBadRequest`](./src/sdk/models/errors/getmediametadatabadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMetadataChildrenBadRequest`](./src/sdk/models/errors/getmetadatachildrenbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTopWatchedContentBadRequest`](./src/sdk/models/errors/gettopwatchedcontentbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetWatchListBadRequest`](./src/sdk/models/errors/getwatchlistbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`LogLineBadRequest`](./src/sdk/models/errors/loglinebadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`LogMultiLineBadRequest`](./src/sdk/models/errors/logmultilinebadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`EnablePaperTrailBadRequest`](./src/sdk/models/errors/enablepapertrailbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`CreatePlaylistBadRequest`](./src/sdk/models/errors/createplaylistbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetPlaylistsBadRequest`](./src/sdk/models/errors/getplaylistsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetPlaylistBadRequest`](./src/sdk/models/errors/getplaylistbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`DeletePlaylistBadRequest`](./src/sdk/models/errors/deleteplaylistbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`UpdatePlaylistBadRequest`](./src/sdk/models/errors/updateplaylistbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetPlaylistContentsBadRequest`](./src/sdk/models/errors/getplaylistcontentsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`ClearPlaylistContentsBadRequest`](./src/sdk/models/errors/clearplaylistcontentsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`AddPlaylistContentsBadRequest`](./src/sdk/models/errors/addplaylistcontentsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`UploadPlaylistBadRequest`](./src/sdk/models/errors/uploadplaylistbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTransientTokenBadRequest`](./src/sdk/models/errors/gettransienttokenbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSourceConnectionInformationBadRequest`](./src/sdk/models/errors/getsourceconnectioninformationbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTokenDetailsBadRequest`](./src/sdk/models/errors/gettokendetailsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`PostUsersSignInDataBadRequest`](./src/sdk/models/errors/postuserssignindatabadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetStatisticsBadRequest`](./src/sdk/models/errors/getstatisticsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetResourcesStatisticsBadRequest`](./src/sdk/models/errors/getresourcesstatisticsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetBandwidthStatisticsBadRequest`](./src/sdk/models/errors/getbandwidthstatisticsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSessionsBadRequest`](./src/sdk/models/errors/getsessionsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSessionHistoryBadRequest`](./src/sdk/models/errors/getsessionhistorybadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTranscodeSessionsBadRequest`](./src/sdk/models/errors/gettranscodesessionsbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StopTranscodeSessionBadRequest`](./src/sdk/models/errors/stoptranscodesessionbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetUpdateStatusBadRequest`](./src/sdk/models/errors/getupdatestatusbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`CheckForUpdatesBadRequest`](./src/sdk/models/errors/checkforupdatesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`ApplyUpdatesBadRequest`](./src/sdk/models/errors/applyupdatesbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetUsersBadRequest`](./src/sdk/models/errors/getusersbadrequest.ts): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerCapabilitiesUnauthorized`](./src/sdk/models/errors/getservercapabilitiesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerPreferencesUnauthorized`](./src/sdk/models/errors/getserverpreferencesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetAvailableClientsUnauthorized`](./src/sdk/models/errors/getavailableclientsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetDevicesUnauthorized`](./src/sdk/models/errors/getdevicesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMyPlexAccountUnauthorized`](./src/sdk/models/errors/getmyplexaccountunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetResizedPhotoUnauthorized`](./src/sdk/models/errors/getresizedphotounauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMediaProvidersUnauthorized`](./src/sdk/models/errors/getmediaprovidersunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerListUnauthorized`](./src/sdk/models/errors/getserverlistunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`MarkPlayedUnauthorized`](./src/sdk/models/errors/markplayedunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`MarkUnplayedUnauthorized`](./src/sdk/models/errors/markunplayedunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`UpdatePlayProgressUnauthorized`](./src/sdk/models/errors/updateplayprogressunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetBannerImageUnauthorized`](./src/sdk/models/errors/getbannerimageunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetThumbImageUnauthorized`](./src/sdk/models/errors/getthumbimageunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTimelineUnauthorized`](./src/sdk/models/errors/gettimelineunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StartUniversalTranscodeUnauthorized`](./src/sdk/models/errors/startuniversaltranscodeunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerActivitiesUnauthorized`](./src/sdk/models/errors/getserveractivitiesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`CancelServerActivitiesUnauthorized`](./src/sdk/models/errors/cancelserveractivitiesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetButlerTasksUnauthorized`](./src/sdk/models/errors/getbutlertasksunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StartAllTasksUnauthorized`](./src/sdk/models/errors/startalltasksunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StopAllTasksUnauthorized`](./src/sdk/models/errors/stopalltasksunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StartTaskUnauthorized`](./src/sdk/models/errors/starttaskunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StopTaskUnauthorized`](./src/sdk/models/errors/stoptaskunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetCompanionsDataUnauthorized`](./src/sdk/models/errors/getcompanionsdataunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetUserFriendsUnauthorized`](./src/sdk/models/errors/getuserfriendsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetGeoDataUnauthorized`](./src/sdk/models/errors/getgeodataunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetHomeDataUnauthorized`](./src/sdk/models/errors/gethomedataunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerResourcesUnauthorized`](./src/sdk/models/errors/getserverresourcesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetGlobalHubsUnauthorized`](./src/sdk/models/errors/getglobalhubsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibraryHubsUnauthorized`](./src/sdk/models/errors/getlibraryhubsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`PerformSearchUnauthorized`](./src/sdk/models/errors/performsearchunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`PerformVoiceSearchUnauthorized`](./src/sdk/models/errors/performvoicesearchunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSearchResultsUnauthorized`](./src/sdk/models/errors/getsearchresultsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetFileHashUnauthorized`](./src/sdk/models/errors/getfilehashunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetRecentlyAddedLibraryUnauthorized`](./src/sdk/models/errors/getrecentlyaddedlibraryunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetAllLibrariesUnauthorized`](./src/sdk/models/errors/getalllibrariesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibraryDetailsUnauthorized`](./src/sdk/models/errors/getlibrarydetailsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`DeleteLibraryUnauthorized`](./src/sdk/models/errors/deletelibraryunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibraryItemsUnauthorized`](./src/sdk/models/errors/getlibraryitemsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetLibrarySectionsAllUnauthorized`](./src/sdk/models/errors/getlibrarysectionsallunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetRefreshLibraryMetadataUnauthorized`](./src/sdk/models/errors/getrefreshlibrarymetadataunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSearchLibraryUnauthorized`](./src/sdk/models/errors/getsearchlibraryunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetGenresLibraryUnauthorized`](./src/sdk/models/errors/getgenreslibraryunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetCountriesLibraryUnauthorized`](./src/sdk/models/errors/getcountrieslibraryunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetActorsLibraryUnauthorized`](./src/sdk/models/errors/getactorslibraryunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSearchAllLibrariesUnauthorized`](./src/sdk/models/errors/getsearchalllibrariesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMediaMetaDataUnauthorized`](./src/sdk/models/errors/getmediametadataunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetMetadataChildrenUnauthorized`](./src/sdk/models/errors/getmetadatachildrenunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTopWatchedContentUnauthorized`](./src/sdk/models/errors/gettopwatchedcontentunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetWatchListUnauthorized`](./src/sdk/models/errors/getwatchlistunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`LogLineUnauthorized`](./src/sdk/models/errors/loglineunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`LogMultiLineUnauthorized`](./src/sdk/models/errors/logmultilineunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`EnablePaperTrailUnauthorized`](./src/sdk/models/errors/enablepapertrailunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`CreatePlaylistUnauthorized`](./src/sdk/models/errors/createplaylistunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetPlaylistsUnauthorized`](./src/sdk/models/errors/getplaylistsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetPlaylistUnauthorized`](./src/sdk/models/errors/getplaylistunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`DeletePlaylistUnauthorized`](./src/sdk/models/errors/deleteplaylistunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`UpdatePlaylistUnauthorized`](./src/sdk/models/errors/updateplaylistunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetPlaylistContentsUnauthorized`](./src/sdk/models/errors/getplaylistcontentsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`ClearPlaylistContentsUnauthorized`](./src/sdk/models/errors/clearplaylistcontentsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`AddPlaylistContentsUnauthorized`](./src/sdk/models/errors/addplaylistcontentsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`UploadPlaylistUnauthorized`](./src/sdk/models/errors/uploadplaylistunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTransientTokenUnauthorized`](./src/sdk/models/errors/gettransienttokenunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSourceConnectionInformationUnauthorized`](./src/sdk/models/errors/getsourceconnectioninformationunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTokenDetailsUnauthorized`](./src/sdk/models/errors/gettokendetailsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`PostUsersSignInDataUnauthorized`](./src/sdk/models/errors/postuserssignindataunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetStatisticsUnauthorized`](./src/sdk/models/errors/getstatisticsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetResourcesStatisticsUnauthorized`](./src/sdk/models/errors/getresourcesstatisticsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetBandwidthStatisticsUnauthorized`](./src/sdk/models/errors/getbandwidthstatisticsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSessionsUnauthorized`](./src/sdk/models/errors/getsessionsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetSessionHistoryUnauthorized`](./src/sdk/models/errors/getsessionhistoryunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTranscodeSessionsUnauthorized`](./src/sdk/models/errors/gettranscodesessionsunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`StopTranscodeSessionUnauthorized`](./src/sdk/models/errors/stoptranscodesessionunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetUpdateStatusUnauthorized`](./src/sdk/models/errors/getupdatestatusunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`CheckForUpdatesUnauthorized`](./src/sdk/models/errors/checkforupdatesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`ApplyUpdatesUnauthorized`](./src/sdk/models/errors/applyupdatesunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetUsersUnauthorized`](./src/sdk/models/errors/getusersunauthorized.ts): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetTokenByPinIdResponseBody`](./src/sdk/models/errors/gettokenbypinidresponsebody.ts): Not Found or Expired. Status code `404`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`GetServerIdentityRequestTimeout`](./src/sdk/models/errors/getserveridentityrequesttimeout.ts): Request Timeout. Status code `408`. Applicable to 1 of 84 methods.*
|
||||||
|
* [`ResponseValidationError`](./src/sdk/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
||||||
|
|
||||||
* [`GetServerCapabilitiesBadRequest`](docs/sdk/models/errors/getservercapabilitiesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerPreferencesBadRequest`](docs/sdk/models/errors/getserverpreferencesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetAvailableClientsBadRequest`](docs/sdk/models/errors/getavailableclientsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetDevicesBadRequest`](docs/sdk/models/errors/getdevicesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMyPlexAccountBadRequest`](docs/sdk/models/errors/getmyplexaccountbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetResizedPhotoBadRequest`](docs/sdk/models/errors/getresizedphotobadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMediaProvidersBadRequest`](docs/sdk/models/errors/getmediaprovidersbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerListBadRequest`](docs/sdk/models/errors/getserverlistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`MarkPlayedBadRequest`](docs/sdk/models/errors/markplayedbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`MarkUnplayedBadRequest`](docs/sdk/models/errors/markunplayedbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`UpdatePlayProgressBadRequest`](docs/sdk/models/errors/updateplayprogressbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetBannerImageBadRequest`](docs/sdk/models/errors/getbannerimagebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetThumbImageBadRequest`](docs/sdk/models/errors/getthumbimagebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTimelineBadRequest`](docs/sdk/models/errors/gettimelinebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StartUniversalTranscodeBadRequest`](docs/sdk/models/errors/startuniversaltranscodebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerActivitiesBadRequest`](docs/sdk/models/errors/getserveractivitiesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`CancelServerActivitiesBadRequest`](docs/sdk/models/errors/cancelserveractivitiesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetButlerTasksBadRequest`](docs/sdk/models/errors/getbutlertasksbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StartAllTasksBadRequest`](docs/sdk/models/errors/startalltasksbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StopAllTasksBadRequest`](docs/sdk/models/errors/stopalltasksbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StartTaskBadRequest`](docs/sdk/models/errors/starttaskbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StopTaskBadRequest`](docs/sdk/models/errors/stoptaskbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetCompanionsDataBadRequest`](docs/sdk/models/errors/getcompanionsdatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetUserFriendsBadRequest`](docs/sdk/models/errors/getuserfriendsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetGeoDataBadRequest`](docs/sdk/models/errors/getgeodatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetHomeDataBadRequest`](docs/sdk/models/errors/gethomedatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerResourcesBadRequest`](docs/sdk/models/errors/getserverresourcesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetPinBadRequest`](docs/sdk/models/errors/getpinbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTokenByPinIdBadRequest`](docs/sdk/models/errors/gettokenbypinidbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetGlobalHubsBadRequest`](docs/sdk/models/errors/getglobalhubsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibraryHubsBadRequest`](docs/sdk/models/errors/getlibraryhubsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`PerformSearchBadRequest`](docs/sdk/models/errors/performsearchbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`PerformVoiceSearchBadRequest`](docs/sdk/models/errors/performvoicesearchbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSearchResultsBadRequest`](docs/sdk/models/errors/getsearchresultsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetFileHashBadRequest`](docs/sdk/models/errors/getfilehashbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetRecentlyAddedLibraryBadRequest`](docs/sdk/models/errors/getrecentlyaddedlibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetAllLibrariesBadRequest`](docs/sdk/models/errors/getalllibrariesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibraryDetailsBadRequest`](docs/sdk/models/errors/getlibrarydetailsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`DeleteLibraryBadRequest`](docs/sdk/models/errors/deletelibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibraryItemsBadRequest`](docs/sdk/models/errors/getlibraryitemsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibrarySectionsAllBadRequest`](docs/sdk/models/errors/getlibrarysectionsallbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetRefreshLibraryMetadataBadRequest`](docs/sdk/models/errors/getrefreshlibrarymetadatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSearchLibraryBadRequest`](docs/sdk/models/errors/getsearchlibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetGenresLibraryBadRequest`](docs/sdk/models/errors/getgenreslibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetCountriesLibraryBadRequest`](docs/sdk/models/errors/getcountrieslibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetActorsLibraryBadRequest`](docs/sdk/models/errors/getactorslibrarybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSearchAllLibrariesBadRequest`](docs/sdk/models/errors/getsearchalllibrariesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMediaMetaDataBadRequest`](docs/sdk/models/errors/getmediametadatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMetadataChildrenBadRequest`](docs/sdk/models/errors/getmetadatachildrenbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTopWatchedContentBadRequest`](docs/sdk/models/errors/gettopwatchedcontentbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetWatchListBadRequest`](docs/sdk/models/errors/getwatchlistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`LogLineBadRequest`](docs/sdk/models/errors/loglinebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`LogMultiLineBadRequest`](docs/sdk/models/errors/logmultilinebadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`EnablePaperTrailBadRequest`](docs/sdk/models/errors/enablepapertrailbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`CreatePlaylistBadRequest`](docs/sdk/models/errors/createplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetPlaylistsBadRequest`](docs/sdk/models/errors/getplaylistsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetPlaylistBadRequest`](docs/sdk/models/errors/getplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`DeletePlaylistBadRequest`](docs/sdk/models/errors/deleteplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`UpdatePlaylistBadRequest`](docs/sdk/models/errors/updateplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetPlaylistContentsBadRequest`](docs/sdk/models/errors/getplaylistcontentsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`ClearPlaylistContentsBadRequest`](docs/sdk/models/errors/clearplaylistcontentsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`AddPlaylistContentsBadRequest`](docs/sdk/models/errors/addplaylistcontentsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`UploadPlaylistBadRequest`](docs/sdk/models/errors/uploadplaylistbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTransientTokenBadRequest`](docs/sdk/models/errors/gettransienttokenbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSourceConnectionInformationBadRequest`](docs/sdk/models/errors/getsourceconnectioninformationbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTokenDetailsBadRequest`](docs/sdk/models/errors/gettokendetailsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`PostUsersSignInDataBadRequest`](docs/sdk/models/errors/postuserssignindatabadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetStatisticsBadRequest`](docs/sdk/models/errors/getstatisticsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetResourcesStatisticsBadRequest`](docs/sdk/models/errors/getresourcesstatisticsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetBandwidthStatisticsBadRequest`](docs/sdk/models/errors/getbandwidthstatisticsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSessionsBadRequest`](docs/sdk/models/errors/getsessionsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSessionHistoryBadRequest`](docs/sdk/models/errors/getsessionhistorybadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTranscodeSessionsBadRequest`](docs/sdk/models/errors/gettranscodesessionsbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StopTranscodeSessionBadRequest`](docs/sdk/models/errors/stoptranscodesessionbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetUpdateStatusBadRequest`](docs/sdk/models/errors/getupdatestatusbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`CheckForUpdatesBadRequest`](docs/sdk/models/errors/checkforupdatesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`ApplyUpdatesBadRequest`](docs/sdk/models/errors/applyupdatesbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetUsersBadRequest`](docs/sdk/models/errors/getusersbadrequest.md): Bad Request - A parameter was not specified, or was specified incorrectly. Status code `400`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerCapabilitiesUnauthorized`](docs/sdk/models/errors/getservercapabilitiesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerPreferencesUnauthorized`](docs/sdk/models/errors/getserverpreferencesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetAvailableClientsUnauthorized`](docs/sdk/models/errors/getavailableclientsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetDevicesUnauthorized`](docs/sdk/models/errors/getdevicesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMyPlexAccountUnauthorized`](docs/sdk/models/errors/getmyplexaccountunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetResizedPhotoUnauthorized`](docs/sdk/models/errors/getresizedphotounauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMediaProvidersUnauthorized`](docs/sdk/models/errors/getmediaprovidersunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerListUnauthorized`](docs/sdk/models/errors/getserverlistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`MarkPlayedUnauthorized`](docs/sdk/models/errors/markplayedunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`MarkUnplayedUnauthorized`](docs/sdk/models/errors/markunplayedunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`UpdatePlayProgressUnauthorized`](docs/sdk/models/errors/updateplayprogressunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetBannerImageUnauthorized`](docs/sdk/models/errors/getbannerimageunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetThumbImageUnauthorized`](docs/sdk/models/errors/getthumbimageunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTimelineUnauthorized`](docs/sdk/models/errors/gettimelineunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StartUniversalTranscodeUnauthorized`](docs/sdk/models/errors/startuniversaltranscodeunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerActivitiesUnauthorized`](docs/sdk/models/errors/getserveractivitiesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`CancelServerActivitiesUnauthorized`](docs/sdk/models/errors/cancelserveractivitiesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetButlerTasksUnauthorized`](docs/sdk/models/errors/getbutlertasksunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StartAllTasksUnauthorized`](docs/sdk/models/errors/startalltasksunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StopAllTasksUnauthorized`](docs/sdk/models/errors/stopalltasksunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StartTaskUnauthorized`](docs/sdk/models/errors/starttaskunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StopTaskUnauthorized`](docs/sdk/models/errors/stoptaskunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetCompanionsDataUnauthorized`](docs/sdk/models/errors/getcompanionsdataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetUserFriendsUnauthorized`](docs/sdk/models/errors/getuserfriendsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetGeoDataUnauthorized`](docs/sdk/models/errors/getgeodataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetHomeDataUnauthorized`](docs/sdk/models/errors/gethomedataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerResourcesUnauthorized`](docs/sdk/models/errors/getserverresourcesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetGlobalHubsUnauthorized`](docs/sdk/models/errors/getglobalhubsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibraryHubsUnauthorized`](docs/sdk/models/errors/getlibraryhubsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`PerformSearchUnauthorized`](docs/sdk/models/errors/performsearchunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`PerformVoiceSearchUnauthorized`](docs/sdk/models/errors/performvoicesearchunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSearchResultsUnauthorized`](docs/sdk/models/errors/getsearchresultsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetFileHashUnauthorized`](docs/sdk/models/errors/getfilehashunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetRecentlyAddedLibraryUnauthorized`](docs/sdk/models/errors/getrecentlyaddedlibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetAllLibrariesUnauthorized`](docs/sdk/models/errors/getalllibrariesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibraryDetailsUnauthorized`](docs/sdk/models/errors/getlibrarydetailsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`DeleteLibraryUnauthorized`](docs/sdk/models/errors/deletelibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibraryItemsUnauthorized`](docs/sdk/models/errors/getlibraryitemsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetLibrarySectionsAllUnauthorized`](docs/sdk/models/errors/getlibrarysectionsallunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetRefreshLibraryMetadataUnauthorized`](docs/sdk/models/errors/getrefreshlibrarymetadataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSearchLibraryUnauthorized`](docs/sdk/models/errors/getsearchlibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetGenresLibraryUnauthorized`](docs/sdk/models/errors/getgenreslibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetCountriesLibraryUnauthorized`](docs/sdk/models/errors/getcountrieslibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetActorsLibraryUnauthorized`](docs/sdk/models/errors/getactorslibraryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSearchAllLibrariesUnauthorized`](docs/sdk/models/errors/getsearchalllibrariesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMediaMetaDataUnauthorized`](docs/sdk/models/errors/getmediametadataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetMetadataChildrenUnauthorized`](docs/sdk/models/errors/getmetadatachildrenunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTopWatchedContentUnauthorized`](docs/sdk/models/errors/gettopwatchedcontentunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetWatchListUnauthorized`](docs/sdk/models/errors/getwatchlistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`LogLineUnauthorized`](docs/sdk/models/errors/loglineunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`LogMultiLineUnauthorized`](docs/sdk/models/errors/logmultilineunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`EnablePaperTrailUnauthorized`](docs/sdk/models/errors/enablepapertrailunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`CreatePlaylistUnauthorized`](docs/sdk/models/errors/createplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetPlaylistsUnauthorized`](docs/sdk/models/errors/getplaylistsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetPlaylistUnauthorized`](docs/sdk/models/errors/getplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`DeletePlaylistUnauthorized`](docs/sdk/models/errors/deleteplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`UpdatePlaylistUnauthorized`](docs/sdk/models/errors/updateplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetPlaylistContentsUnauthorized`](docs/sdk/models/errors/getplaylistcontentsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`ClearPlaylistContentsUnauthorized`](docs/sdk/models/errors/clearplaylistcontentsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`AddPlaylistContentsUnauthorized`](docs/sdk/models/errors/addplaylistcontentsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`UploadPlaylistUnauthorized`](docs/sdk/models/errors/uploadplaylistunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTransientTokenUnauthorized`](docs/sdk/models/errors/gettransienttokenunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSourceConnectionInformationUnauthorized`](docs/sdk/models/errors/getsourceconnectioninformationunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTokenDetailsUnauthorized`](docs/sdk/models/errors/gettokendetailsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`PostUsersSignInDataUnauthorized`](docs/sdk/models/errors/postuserssignindataunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetStatisticsUnauthorized`](docs/sdk/models/errors/getstatisticsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetResourcesStatisticsUnauthorized`](docs/sdk/models/errors/getresourcesstatisticsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetBandwidthStatisticsUnauthorized`](docs/sdk/models/errors/getbandwidthstatisticsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSessionsUnauthorized`](docs/sdk/models/errors/getsessionsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetSessionHistoryUnauthorized`](docs/sdk/models/errors/getsessionhistoryunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTranscodeSessionsUnauthorized`](docs/sdk/models/errors/gettranscodesessionsunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`StopTranscodeSessionUnauthorized`](docs/sdk/models/errors/stoptranscodesessionunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetUpdateStatusUnauthorized`](docs/sdk/models/errors/getupdatestatusunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`CheckForUpdatesUnauthorized`](docs/sdk/models/errors/checkforupdatesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`ApplyUpdatesUnauthorized`](docs/sdk/models/errors/applyupdatesunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetUsersUnauthorized`](docs/sdk/models/errors/getusersunauthorized.md): Unauthorized - Returned if the X-Plex-Token is missing from the header or query. Status code `401`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetTokenByPinIdResponseBody`](docs/sdk/models/errors/gettokenbypinidresponsebody.md): Not Found or Expired. Status code `404`. Applicable to 1 of 84 methods.*
|
|
||||||
* [`GetServerIdentityRequestTimeout`](docs/sdk/models/errors/getserveridentityrequesttimeout.md): Request Timeout. Status code `408`. Applicable to 1 of 84 methods.*
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|
||||||
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
|
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
|
||||||
<!-- End Error Handling [errors] -->
|
<!-- End Error Handling [errors] -->
|
||||||
|
|
||||||
|
|||||||
52
RELEASES.md
52
RELEASES.md
@@ -1348,4 +1348,54 @@ Based on:
|
|||||||
### Generated
|
### Generated
|
||||||
- [typescript v0.38.0] .
|
- [typescript v0.38.0] .
|
||||||
### Releases
|
### Releases
|
||||||
- [NPM v0.38.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.38.0 - .
|
- [NPM v0.38.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.38.0 - .
|
||||||
|
|
||||||
|
## 2025-06-09 00:12:06
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.557.0 (2.623.0) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.39.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.39.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.39.0 - .
|
||||||
|
|
||||||
|
## 2025-07-10 00:11:39
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.580.1 (2.656.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.0] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.0 - .
|
||||||
|
|
||||||
|
## 2025-08-06 00:12:14
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.598.0 (2.674.1) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.1] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.1 - .
|
||||||
|
|
||||||
|
## 2025-08-07 00:12:28
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.598.3 (2.674.3) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.2] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.2 - .
|
||||||
|
|
||||||
|
## 2025-09-15 00:11:38
|
||||||
|
### Changes
|
||||||
|
Based on:
|
||||||
|
- OpenAPI Doc
|
||||||
|
- Speakeasy CLI 1.615.2 (2.698.4) https://github.com/speakeasy-api/speakeasy
|
||||||
|
### Generated
|
||||||
|
- [typescript v0.40.3] .
|
||||||
|
### Releases
|
||||||
|
- [NPM v0.40.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.40.3 - .
|
||||||
@@ -527,7 +527,7 @@ actions:
|
|||||||
});
|
});
|
||||||
|
|
||||||
async function run() {
|
async function run() {
|
||||||
const result = await plexAPI.library.getFileHash("file://C:\Image.png&type=13");
|
const result = await plexAPI.library.getFileHash("file://C:\\Image.png&type=13");
|
||||||
|
|
||||||
console.log(result);
|
console.log(result);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: AddPlaylistContentsResponse = {};
|
let value: AddPlaylistContentsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 736053,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: ApplyUpdatesResponse = {};
|
let value: ApplyUpdatesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 99456,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { CancelServerActivitiesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: CancelServerActivitiesResponse = {};
|
let value: CancelServerActivitiesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 192797,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: CheckForUpdatesResponse = {};
|
let value: CheckForUpdatesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 395012,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: ClearPlaylistContentsResponse = {};
|
let value: ClearPlaylistContentsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 406986,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: CreatePlaylistResponse = {};
|
let value: CreatePlaylistResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 842539,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DeleteLibraryResponse = {};
|
let value: DeleteLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 536997,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: DeletePlaylistResponse = {};
|
let value: DeletePlaylistResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 447001,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
# EnableCreditsMarkerGeneration
|
|
||||||
|
|
||||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { EnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: EnableCreditsMarkerGeneration =
|
|
||||||
EnableCreditsMarkerGeneration.LibraryDefault;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------------- | ---------------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `Disabled` | 0 |
|
|
||||||
| - | `Unrecognized<string>` |
|
|
||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: EnablePaperTrailResponse = {};
|
let value: EnablePaperTrailResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 561624,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -1,22 +0,0 @@
|
|||||||
# EpisodeSort
|
|
||||||
|
|
||||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { EpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: EpisodeSort = EpisodeSort.OldestFirst;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------------- | ---------------------- |
|
|
||||||
| `LibraryDefault` | -1 |
|
|
||||||
| `OldestFirst` | 0 |
|
|
||||||
| `NewestFirst` | 1 |
|
|
||||||
| - | `Unrecognized<string>` |
|
|
||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
|
|||||||
@@ -45,5 +45,5 @@ let value: GetActorsLibraryMediaContainer = {
|
|||||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
| `viewMode` | *string* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||||
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |
|
| `directory` | [operations.GetActorsLibraryDirectory](../../../sdk/models/operations/getactorslibrarydirectory.md)[] | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetActorsLibraryResponse = {};
|
let value: GetActorsLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 309641,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetAllLibrariesResponse = {};
|
let value: GetAllLibrariesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 429079,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetAvailableClientsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetAvailableClientsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetAvailableClientsResponse = {};
|
let value: GetAvailableClientsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 927142,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetBandwidthStatisticsResponse = {};
|
let value: GetBandwidthStatisticsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 430843,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetButlerTasksResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetButlerTasksResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetButlerTasksResponse = {};
|
let value: GetButlerTasksResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 73689,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetCompanionsDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetCompanionsDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetCompanionsDataResponse = {};
|
let value: GetCompanionsDataResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 133605,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetCountriesLibraryResponse = {};
|
let value: GetCountriesLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 138249,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetDevicesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetDevicesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetDevicesResponse = {};
|
let value: GetDevicesResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 113704,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
import { GetFileHashRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetFileHashRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetFileHashRequest = {
|
let value: GetFileHashRequest = {
|
||||||
url: "file://C:\Image.png&type=13",
|
url: "file://C:\\Image.png&type=13",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetFileHashResponse = {};
|
let value: GetFileHashResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 537323,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetGenresLibraryResponse = {};
|
let value: GetGenresLibraryResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 150762,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetGeoDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetGeoDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetGeoDataResponse = {};
|
let value: GetGeoDataResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 752880,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetGlobalHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetGlobalHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetGlobalHubsResponse = {};
|
let value: GetGlobalHubsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 711048,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetHomeDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetHomeDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetHomeDataResponse = {};
|
let value: GetHomeDataResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 145217,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryDetailsResponse = {};
|
let value: GetLibraryDetailsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 683537,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryHubsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryHubsResponse = {};
|
let value: GetLibraryHubsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 455564,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -6,12 +6,12 @@
|
|||||||
import { GetLibraryItemsCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsCollection = {
|
let value: GetLibraryItemsCollection = {
|
||||||
tag: "Working NL Subs",
|
tag: "My Awesome Collection",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||||
@@ -6,12 +6,14 @@
|
|||||||
import { GetLibraryItemsCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsCountry = {
|
let value: GetLibraryItemsCountry = {
|
||||||
|
id: 259,
|
||||||
tag: "United States of America",
|
tag: "United States of America",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
| `id` | *number* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||||
@@ -6,12 +6,17 @@
|
|||||||
import { GetLibraryItemsDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsDirector = {
|
let value: GetLibraryItemsDirector = {
|
||||||
tag: "James Cameron",
|
id: 126522,
|
||||||
|
tag: "Danny Boyle",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
| `id` | *number* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -11,7 +11,6 @@ let value: GetLibraryItemsFilter = {
|
|||||||
key: "/library/sections/2/genre?type=2",
|
key: "/library/sections/2/genre?type=2",
|
||||||
title: "Genre",
|
title: "Genre",
|
||||||
type: "filter",
|
type: "filter",
|
||||||
advanced: true,
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -23,5 +22,4 @@ let value: GetLibraryItemsFilter = {
|
|||||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||||
| `advanced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
|
||||||
@@ -6,12 +6,14 @@
|
|||||||
import { GetLibraryItemsGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsGenre = {
|
let value: GetLibraryItemsGenre = {
|
||||||
tag: "Adventure",
|
id: 259,
|
||||||
|
tag: "Crime",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
| `id` | *number* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||||
18
docs/sdk/models/operations/getlibraryitemsguids.md
Normal file
18
docs/sdk/models/operations/getlibraryitemsguids.md
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# GetLibraryItemsGuids
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsGuids } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsGuids = {
|
||||||
|
id:
|
||||||
|
"{\"imdbExample\":{\"summary\":\"IMDB example\",\"value\":\"imdb://tt13015952\"},\"tmdbExample\":{\"summary\":\"TMDB example\",\"value\":\"tmdb://2434012\"},\"tvdbExample\":{\"summary\":\"TVDB example\",\"value\":\"tvdb://7945991\"}}",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *string* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||||
@@ -1,5 +1,8 @@
|
|||||||
# GetLibraryItemsHasThumbnail
|
# GetLibraryItemsHasThumbnail
|
||||||
|
|
||||||
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
|
|||||||
@@ -3,19 +3,19 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsImage, GetLibraryItemsLibraryResponse200Type } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsImage, GetLibraryItemsLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsImage = {
|
let value: GetLibraryItemsImage = {
|
||||||
alt: "Episode 1",
|
alt: "Episode 1",
|
||||||
type: GetLibraryItemsLibraryResponse200Type.Background,
|
type: GetLibraryItemsLibraryResponseType.Background,
|
||||||
url: "/library/metadata/45521/thumb/1644710589",
|
url: "/library/metadata/45521/thumb/1644710589",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||||
| `type` | [operations.GetLibraryItemsLibraryResponse200Type](../../../sdk/models/operations/getlibraryitemslibraryresponse200type.md) | :heavy_check_mark: | N/A | background |
|
| `type` | [operations.GetLibraryItemsLibraryResponseType](../../../sdk/models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryActiveDirection
|
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibraryActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryActiveDirection =
|
|
||||||
GetLibraryItemsLibraryActiveDirection.Ascending;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `Ascending` | asc |
|
|
||||||
| `Descending` | desc |
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryDefaultDirection
|
|
||||||
|
|
||||||
The direction of the sort. Can be either `asc` or `desc`.
|
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibraryDefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryDefaultDirection =
|
|
||||||
GetLibraryItemsLibraryDefaultDirection.Ascending;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ------------ | ------------ |
|
|
||||||
| `Ascending` | asc |
|
|
||||||
| `Descending` | desc |
|
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryField
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibraryField } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryField = {
|
|
||||||
key: "show.title",
|
|
||||||
title: "Show Title",
|
|
||||||
type: "string",
|
|
||||||
subType: "rating",
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
|
||||||
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
|
||||||
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryFieldType
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibraryFieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryFieldType = {
|
|
||||||
type: "tag",
|
|
||||||
operator: [],
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
|
||||||
| `operator` | [operations.GetLibraryItemsLibraryOperator](../../../sdk/models/operations/getlibraryitemslibraryoperator.md)[] | :heavy_check_mark: | N/A | |
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryFilter
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibraryFilter } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryFilter = {
|
|
||||||
filter: "genre",
|
|
||||||
filterType: "string",
|
|
||||||
key: "/library/sections/2/genre?type=2",
|
|
||||||
title: "Genre",
|
|
||||||
type: "filter",
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
|
||||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
|
|
||||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
|
||||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryOperator
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibraryOperator } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryOperator = {
|
|
||||||
key: "=",
|
|
||||||
title: "is",
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | = |
|
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | is |
|
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryItemsLibraryOptimizedForStreaming
|
||||||
|
|
||||||
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `operations.GetLibraryItemsOptimizedForStreaming1`
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const value: operations.GetLibraryItemsOptimizedForStreaming1 =
|
||||||
|
GetLibraryItemsOptimizedForStreaming1.One;
|
||||||
|
```
|
||||||
|
|
||||||
|
### `boolean`
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const value: boolean = true;
|
||||||
|
```
|
||||||
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
# GetLibraryItemsLibraryResponse200Type
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibraryResponse200Type } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryResponse200Type =
|
|
||||||
GetLibraryItemsLibraryResponse200Type.Background;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------------- | ---------------------- |
|
|
||||||
| `CoverPoster` | coverPoster |
|
|
||||||
| `Background` | background |
|
|
||||||
| `Snapshot` | snapshot |
|
|
||||||
| `ClearLogo` | clearLogo |
|
|
||||||
| - | `Unrecognized<string>` |
|
|
||||||
@@ -5,49 +5,18 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryResponseType = {
|
let value: GetLibraryItemsLibraryResponseType =
|
||||||
key: "/library/sections/2/all?type=2",
|
GetLibraryItemsLibraryResponseType.Background;
|
||||||
type: "show",
|
|
||||||
title: "TV Shows",
|
|
||||||
active: false,
|
|
||||||
filter: [
|
|
||||||
{
|
|
||||||
filter: "genre",
|
|
||||||
filterType: "string",
|
|
||||||
key: "/library/sections/2/genre?type=2",
|
|
||||||
title: "Genre",
|
|
||||||
type: "filter",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
sort: [
|
|
||||||
{
|
|
||||||
default: "asc",
|
|
||||||
active: false,
|
|
||||||
descKey: "titleSort:desc",
|
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
|
||||||
key: "titleSort",
|
|
||||||
title: "Title",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
field: [
|
|
||||||
{
|
|
||||||
key: "show.title",
|
|
||||||
title: "Show Title",
|
|
||||||
type: "string",
|
|
||||||
subType: "rating",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Values
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| Name | Value |
|
||||||
| `type` | *string* | :heavy_check_mark: | N/A | show |
|
| ---------------------- | ---------------------- |
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
| `CoverPoster` | coverPoster |
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `Background` | background |
|
||||||
| `filter` | [operations.GetLibraryItemsLibraryFilter](../../../sdk/models/operations/getlibraryitemslibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
| `Snapshot` | snapshot |
|
||||||
| `sort` | [operations.GetLibraryItemsLibrarySort](../../../sdk/models/operations/getlibraryitemslibrarysort.md)[] | :heavy_minus_sign: | N/A | |
|
| `ClearLogo` | clearLogo |
|
||||||
| `field` | [operations.GetLibraryItemsLibraryField](../../../sdk/models/operations/getlibraryitemslibraryfield.md)[] | :heavy_minus_sign: | N/A | |
|
| - | `Unrecognized<string>` |
|
||||||
@@ -1,29 +0,0 @@
|
|||||||
# GetLibraryItemsLibrarySort
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsLibrarySort = {
|
|
||||||
default: "asc",
|
|
||||||
active: false,
|
|
||||||
descKey: "titleSort:desc",
|
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
|
||||||
key: "titleSort",
|
|
||||||
title: "Title",
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| `default` | *string* | :heavy_minus_sign: | N/A | asc |
|
|
||||||
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `activeDirection` | [operations.GetLibraryItemsLibraryActiveDirection](../../../sdk/models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `defaultDirection` | [operations.GetLibraryItemsLibraryDefaultDirection](../../../sdk/models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
|
||||||
| `descKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
|
||||||
| `firstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | Title |
|
|
||||||
@@ -1,30 +1,53 @@
|
|||||||
# GetLibraryItemsLibraryType
|
# GetLibraryItemsLibraryType
|
||||||
|
|
||||||
The type of media content in the Plex library. This can represent videos, music, or photos.
|
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsLibraryType = GetLibraryItemsLibraryType.Movie;
|
let value: GetLibraryItemsLibraryType = {
|
||||||
|
key: "/library/sections/2/all?type=2",
|
||||||
|
type: "show",
|
||||||
|
title: "TV Shows",
|
||||||
|
active: false,
|
||||||
|
filter: [
|
||||||
|
{
|
||||||
|
filter: "genre",
|
||||||
|
filterType: "string",
|
||||||
|
key: "/library/sections/2/genre?type=2",
|
||||||
|
title: "Genre",
|
||||||
|
type: "filter",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
sort: [
|
||||||
|
{
|
||||||
|
default: "asc",
|
||||||
|
active: false,
|
||||||
|
descKey: "titleSort:desc",
|
||||||
|
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||||
|
key: "titleSort",
|
||||||
|
title: "Title",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
field: [
|
||||||
|
{
|
||||||
|
key: "show.title",
|
||||||
|
title: "Show Title",
|
||||||
|
type: "string",
|
||||||
|
subType: "rating",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
## Fields
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
| Field | Type | Required | Description | Example |
|
||||||
|
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||||
| Name | Value |
|
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||||
| ---------------------- | ---------------------- |
|
| `type` | *string* | :heavy_check_mark: | N/A | show |
|
||||||
| `Movie` | movie |
|
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||||
| `TvShow` | show |
|
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||||
| `Season` | season |
|
| `filter` | [operations.GetLibraryItemsFilter](../../../sdk/models/operations/getlibraryitemsfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `Episode` | episode |
|
| `sort` | [operations.GetLibraryItemsSort](../../../sdk/models/operations/getlibraryitemssort.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `Artist` | artist |
|
| `field` | [operations.GetLibraryItemsField](../../../sdk/models/operations/getlibraryitemsfield.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `Album` | album |
|
|
||||||
| `Track` | track |
|
|
||||||
| `PhotoAlbum` | photoalbum |
|
|
||||||
| `Photo` | photo |
|
|
||||||
| `Collection` | collection |
|
|
||||||
| - | `Unrecognized<string>` |
|
|
||||||
@@ -1,17 +1,19 @@
|
|||||||
# GetLibraryItemsLocation
|
# GetLibraryItemsLocation
|
||||||
|
|
||||||
|
The folder path for the media item.
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsLocation } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsLocation } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsLocation = {
|
let value: GetLibraryItemsLocation = {
|
||||||
path: "/TV Shows/House",
|
path: "/TV Shows/Clarkson's Farm",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||||
| `path` | *string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
| `path` | *string* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||||
@@ -3,49 +3,67 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsMedia, GetLibraryItemsOptimizedForStreaming } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsHasThumbnail, GetLibraryItemsMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsMedia = {
|
let value: GetLibraryItemsMedia = {
|
||||||
id: 119534,
|
id: 387322,
|
||||||
duration: 11558112,
|
duration: 9610350,
|
||||||
bitrate: 25025,
|
bitrate: 25512,
|
||||||
width: 3840,
|
width: 3840,
|
||||||
height: 2072,
|
height: 1602,
|
||||||
aspectRatio: 1.85,
|
aspectRatio: 2.35,
|
||||||
audioProfile: "dts",
|
|
||||||
audioChannels: 6,
|
audioChannels: 6,
|
||||||
audioCodec: "eac3",
|
displayOffset: 50,
|
||||||
|
audioCodec: "aac",
|
||||||
videoCodec: "hevc",
|
videoCodec: "hevc",
|
||||||
videoResolution: "4k",
|
videoResolution: "4k",
|
||||||
container: "mkv",
|
container: "mp4",
|
||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
audioProfile: "dts",
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
part: [],
|
part: [
|
||||||
|
{
|
||||||
|
accessible: true,
|
||||||
|
exists: true,
|
||||||
|
id: 418385,
|
||||||
|
key: "/library/parts/418385/1735864239/file.mkv",
|
||||||
|
indexes: "sd",
|
||||||
|
duration: 9610350,
|
||||||
|
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||||
|
size: 30649952104,
|
||||||
|
packetLength: 188,
|
||||||
|
container: "mkv",
|
||||||
|
videoProfile: "main 10",
|
||||||
|
audioProfile: "dts",
|
||||||
|
has64bitOffsets: false,
|
||||||
|
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||||
|
},
|
||||||
|
],
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_check_mark: | N/A | 119534 |
|
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
| `duration` | *number* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 25025 |
|
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
| `width` | *number* | :heavy_minus_sign: | N/A | 3840 |
|
| `width` | *number* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
| `height` | *number* | :heavy_minus_sign: | N/A | 2072 |
|
| `height` | *number* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.85 |
|
| `aspectRatio` | *number* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
| `audioChannels` | *number* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 6 |
|
| `displayOffset` | *number* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | eac3 |
|
| `audioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
| `videoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 4k |
|
| `videoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
|
| `container` | *string* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | 24p |
|
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `optimizedForStreaming` | [operations.GetLibraryItemsOptimizedForStreaming](../../../sdk/models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `optimizedForStreaming` | *operations.GetLibraryItemsOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `part` | [operations.GetLibraryItemsPart](../../../sdk/models/operations/getlibraryitemspart.md)[] | :heavy_check_mark: | N/A | |
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
|
||||||
|
| `part` | [operations.GetLibraryItemsPart](../../../sdk/models/operations/getlibraryitemspart.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,244 +1,31 @@
|
|||||||
# GetLibraryItemsMediaContainer
|
# GetLibraryItemsMediaContainer
|
||||||
|
|
||||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
EnableCreditsMarkerGeneration,
|
|
||||||
EpisodeSort,
|
|
||||||
FlattenSeasons,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
|
||||||
GetLibraryItemsLibraryType,
|
|
||||||
GetLibraryItemsMediaContainer,
|
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
ShowOrdering,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsMediaContainer = {
|
let value: GetLibraryItemsMediaContainer = {
|
||||||
type: [
|
size: 50,
|
||||||
{
|
totalSize: 50,
|
||||||
key: "/library/sections/2/all?type=2",
|
|
||||||
type: "filter",
|
|
||||||
subtype: "clip",
|
|
||||||
title: "TV Shows",
|
|
||||||
active: false,
|
|
||||||
filter: [
|
|
||||||
{
|
|
||||||
filter: "genre",
|
|
||||||
filterType: "string",
|
|
||||||
key: "/library/sections/2/genre?type=2",
|
|
||||||
title: "Genre",
|
|
||||||
type: "filter",
|
|
||||||
advanced: true,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
sort: [
|
|
||||||
{
|
|
||||||
default: "asc",
|
|
||||||
active: false,
|
|
||||||
descKey: "titleSort:desc",
|
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
|
||||||
key: "titleSort",
|
|
||||||
title: "Title",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
field: [
|
|
||||||
{
|
|
||||||
key: "show.title",
|
|
||||||
title: "Show Title",
|
|
||||||
type: "string",
|
|
||||||
subType: "rating",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
fieldType: [
|
|
||||||
{
|
|
||||||
type: "tag",
|
|
||||||
operator: [],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
size: 70,
|
|
||||||
totalSize: 170,
|
|
||||||
offset: 0,
|
offset: 0,
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
allowSync: true,
|
allowSync: false,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
art: "/:/resources/movie-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
identifier: "com.plexapp.plugins.library",
|
identifier: "com.plexapp.plugins.library",
|
||||||
librarySectionID: 1,
|
librarySectionID: 2,
|
||||||
librarySectionTitle: "Movies",
|
librarySectionTitle: "TV Series",
|
||||||
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1701731894,
|
mediaTagVersion: 1734362201,
|
||||||
thumb: "/:/resources/movie.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "Movies",
|
title1: "TV Series",
|
||||||
title2: "Recently Released",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "movie",
|
viewGroup: "secondary",
|
||||||
viewMode: 65592,
|
viewMode: "131131",
|
||||||
mixedParents: true,
|
mixedParents: true,
|
||||||
metadata: [
|
metadata: [],
|
||||||
{
|
|
||||||
ratingKey: "58683",
|
|
||||||
key: "/library/metadata/58683",
|
|
||||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
|
||||||
studio: "20th Century Studios",
|
|
||||||
skipChildren: false,
|
|
||||||
librarySectionID: 1,
|
|
||||||
librarySectionTitle: "Movies",
|
|
||||||
librarySectionKey: "/library/sections/1",
|
|
||||||
type: GetLibraryItemsLibraryType.Movie,
|
|
||||||
title: "Avatar: The Way of Water",
|
|
||||||
slug: "4-for-texas",
|
|
||||||
contentRating: "PG-13",
|
|
||||||
summary:
|
|
||||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
|
||||||
rating: 7.6,
|
|
||||||
audienceRating: 9.2,
|
|
||||||
year: 2022,
|
|
||||||
seasonCount: 2022,
|
|
||||||
tagline: "Return to Pandora.",
|
|
||||||
flattenSeasons: FlattenSeasons.Show,
|
|
||||||
episodeSort: EpisodeSort.OldestFirst,
|
|
||||||
enableCreditsMarkerGeneration:
|
|
||||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
|
||||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
|
||||||
duration: 11558112,
|
|
||||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
|
||||||
addedAt: 1556281940,
|
|
||||||
updatedAt: 1556281940,
|
|
||||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
|
||||||
chapterSource: "media",
|
|
||||||
primaryExtraKey: "/library/metadata/58684",
|
|
||||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
|
||||||
grandparentRatingKey: "66",
|
|
||||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
|
||||||
grandparentKey: "/library/metadata/66",
|
|
||||||
grandparentTitle: "Caprica",
|
|
||||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
|
||||||
parentSlug: "alice-in-borderland-2020",
|
|
||||||
grandparentSlug: "alice-in-borderland-2020",
|
|
||||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
|
||||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
|
||||||
media: [
|
|
||||||
{
|
|
||||||
id: 119534,
|
|
||||||
duration: 11558112,
|
|
||||||
bitrate: 25025,
|
|
||||||
width: 3840,
|
|
||||||
height: 2072,
|
|
||||||
aspectRatio: 1.85,
|
|
||||||
audioProfile: "dts",
|
|
||||||
audioChannels: 6,
|
|
||||||
audioCodec: "eac3",
|
|
||||||
videoCodec: "hevc",
|
|
||||||
videoResolution: "4k",
|
|
||||||
container: "mkv",
|
|
||||||
videoFrameRate: "24p",
|
|
||||||
videoProfile: "main 10",
|
|
||||||
hasVoiceActivity: false,
|
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
|
||||||
part: [],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
genre: [
|
|
||||||
{
|
|
||||||
tag: "Adventure",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
country: [
|
|
||||||
{
|
|
||||||
tag: "United States of America",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
director: [
|
|
||||||
{
|
|
||||||
tag: "James Cameron",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
writer: [
|
|
||||||
{
|
|
||||||
tag: "James Cameron",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
collection: [
|
|
||||||
{
|
|
||||||
tag: "Working NL Subs",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
role: [
|
|
||||||
{
|
|
||||||
id: 294129,
|
|
||||||
filter: "actor=294129",
|
|
||||||
thumb:
|
|
||||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
|
||||||
tag: "Mike Smith",
|
|
||||||
tagKey: "668e7e7b22bcad9064350c91",
|
|
||||||
role: "Self",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
location: [
|
|
||||||
{
|
|
||||||
path: "/TV Shows/House",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
mediaGuid: [
|
|
||||||
{
|
|
||||||
id: "imdb://tt13015952",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
ultraBlurColors: {
|
|
||||||
topLeft: "11333b",
|
|
||||||
topRight: "0a232d",
|
|
||||||
bottomRight: "73958",
|
|
||||||
bottomLeft: "1f5066",
|
|
||||||
},
|
|
||||||
metaDataRating: [
|
|
||||||
{
|
|
||||||
image: "themoviedb://image.rating",
|
|
||||||
value: 3,
|
|
||||||
type: "audience",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
image: [
|
|
||||||
{
|
|
||||||
alt: "Episode 1",
|
|
||||||
type: GetLibraryItemsLibraryResponse200Type.Background,
|
|
||||||
url: "/library/metadata/45521/thumb/1644710589",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
titleSort: "Whale",
|
|
||||||
viewCount: 1,
|
|
||||||
lastViewedAt: 1682752242,
|
|
||||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
|
||||||
viewOffset: 5222500,
|
|
||||||
skipCount: 1,
|
|
||||||
index: 1,
|
|
||||||
theme: "/library/metadata/1/theme/1705636920",
|
|
||||||
leafCount: 14,
|
|
||||||
viewedLeafCount: 0,
|
|
||||||
childCount: 1,
|
|
||||||
hasPremiumExtras: "1",
|
|
||||||
hasPremiumPrimaryExtra: "1",
|
|
||||||
parentRatingKey: "66",
|
|
||||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
|
||||||
parentStudio: "UCP",
|
|
||||||
parentKey: "/library/metadata/66",
|
|
||||||
parentTitle: "Caprica",
|
|
||||||
parentIndex: 1,
|
|
||||||
parentYear: 2010,
|
|
||||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
|
||||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
meta: {
|
meta: {
|
||||||
type: [
|
type: [
|
||||||
{
|
{
|
||||||
@@ -287,28 +74,26 @@ let value: GetLibraryItemsMediaContainer = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||||
| `type` | [operations.GetLibraryItemsType](../../../sdk/models/operations/getlibraryitemstype.md)[] | :heavy_minus_sign: | N/A | |
|
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `fieldType` | [operations.GetLibraryItemsFieldType](../../../sdk/models/operations/getlibraryitemsfieldtype.md)[] | :heavy_minus_sign: | N/A | |
|
| `totalSize` | *number* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||||
| `size` | *number* | :heavy_check_mark: | N/A | 70 |
|
| `offset` | *number* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||||
| `totalSize` | *number* | :heavy_check_mark: | N/A | 170 |
|
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `offset` | *number* | :heavy_check_mark: | N/A | 0 |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | true |
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `nocache` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
| `librarySectionID` | *number* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
| `librarySectionID` | *number* | :heavy_check_mark: | N/A | 1 |
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | N/A | Movies |
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `librarySectionUUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1701731894 |
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||||
| `title1` | *string* | :heavy_check_mark: | N/A | Movies |
|
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||||
| `title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
|
| `viewMode` | *string* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
| `mixedParents` | *boolean* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
|
||||||
| `viewMode` | *number* | :heavy_minus_sign: | N/A | 65592 |
|
| `metadata` | [operations.GetLibraryItemsMetadata](../../../sdk/models/operations/getlibraryitemsmetadata.md)[] | :heavy_check_mark: | An array of metadata items. | |
|
||||||
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `meta` | [operations.GetLibraryItemsMeta](../../../sdk/models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||||
| `metadata` | [operations.GetLibraryItemsMetadata](../../../sdk/models/operations/getlibraryitemsmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
|
||||||
| `meta` | [operations.GetLibraryItemsMeta](../../../sdk/models/operations/getlibraryitemsmeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
|
||||||
@@ -55,7 +55,7 @@ let value: GetLibraryItemsMeta = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description |
|
| Field | Type | Required | Description |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
| `type` | [operations.GetLibraryItemsLibraryResponseType](../../../sdk/models/operations/getlibraryitemslibraryresponsetype.md)[] | :heavy_minus_sign: | N/A |
|
| `type` | [operations.GetLibraryItemsLibraryType](../../../sdk/models/operations/getlibraryitemslibrarytype.md)[] | :heavy_minus_sign: | N/A |
|
||||||
| `fieldType` | [operations.GetLibraryItemsLibraryFieldType](../../../sdk/models/operations/getlibraryitemslibraryfieldtype.md)[] | :heavy_minus_sign: | N/A |
|
| `fieldType` | [operations.GetLibraryItemsFieldType](../../../sdk/models/operations/getlibraryitemsfieldtype.md)[] | :heavy_minus_sign: | N/A |
|
||||||
@@ -1,16 +1,17 @@
|
|||||||
# GetLibraryItemsMetadata
|
# GetLibraryItemsMetadata
|
||||||
|
|
||||||
|
Unknown
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import {
|
||||||
EnableCreditsMarkerGeneration,
|
|
||||||
EpisodeSort,
|
|
||||||
FlattenSeasons,
|
FlattenSeasons,
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
GetLibraryItemsHasThumbnail,
|
||||||
GetLibraryItemsLibraryType,
|
GetLibraryItemsLibraryResponseType,
|
||||||
GetLibraryItemsMetadata,
|
GetLibraryItemsMetadata,
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
GetLibraryItemsType,
|
||||||
ShowOrdering,
|
ShowOrdering,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
@@ -19,112 +20,67 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
ratingKey: "58683",
|
ratingKey: "58683",
|
||||||
key: "/library/metadata/58683",
|
key: "/library/metadata/58683",
|
||||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||||
studio: "20th Century Studios",
|
|
||||||
skipChildren: false,
|
|
||||||
librarySectionID: 1,
|
|
||||||
librarySectionTitle: "Movies",
|
|
||||||
librarySectionKey: "/library/sections/1",
|
|
||||||
type: GetLibraryItemsLibraryType.Movie,
|
|
||||||
title: "Avatar: The Way of Water",
|
|
||||||
slug: "4-for-texas",
|
slug: "4-for-texas",
|
||||||
|
studio: "20th Century Studios",
|
||||||
|
type: GetLibraryItemsType.Movie,
|
||||||
|
title: "Avatar: The Way of Water",
|
||||||
|
banner: "/library/metadata/58683/banner/1703239236",
|
||||||
|
titleSort: "Whale",
|
||||||
contentRating: "PG-13",
|
contentRating: "PG-13",
|
||||||
summary:
|
summary:
|
||||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||||
|
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||||
|
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||||
|
+ "",
|
||||||
rating: 7.6,
|
rating: 7.6,
|
||||||
audienceRating: 9.2,
|
audienceRating: 9.2,
|
||||||
year: 2022,
|
year: 2022,
|
||||||
seasonCount: 2022,
|
|
||||||
tagline: "Return to Pandora.",
|
tagline: "Return to Pandora.",
|
||||||
flattenSeasons: FlattenSeasons.Show,
|
|
||||||
episodeSort: EpisodeSort.OldestFirst,
|
|
||||||
enableCreditsMarkerGeneration: EnableCreditsMarkerGeneration.LibraryDefault,
|
|
||||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
art: "/library/metadata/58683/art/1703239236",
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
theme: "/library/metadata/1/theme/1705636920",
|
||||||
|
index: 1,
|
||||||
|
leafCount: 14,
|
||||||
|
viewedLeafCount: 0,
|
||||||
|
childCount: 1,
|
||||||
|
seasonCount: 2022,
|
||||||
duration: 11558112,
|
duration: 11558112,
|
||||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||||
addedAt: 1556281940,
|
addedAt: 1556281940,
|
||||||
updatedAt: 1556281940,
|
updatedAt: 1556281940,
|
||||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||||
chapterSource: "media",
|
chapterSource: "media",
|
||||||
primaryExtraKey: "/library/metadata/58684",
|
primaryExtraKey: "/library/metadata/58684",
|
||||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||||
|
parentRatingKey: "66",
|
||||||
grandparentRatingKey: "66",
|
grandparentRatingKey: "66",
|
||||||
|
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||||
|
grandparentSlug: "alice-in-borderland-2020",
|
||||||
grandparentKey: "/library/metadata/66",
|
grandparentKey: "/library/metadata/66",
|
||||||
|
parentKey: "/library/metadata/66",
|
||||||
grandparentTitle: "Caprica",
|
grandparentTitle: "Caprica",
|
||||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||||
parentSlug: "alice-in-borderland-2020",
|
|
||||||
grandparentSlug: "alice-in-borderland-2020",
|
|
||||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
|
||||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||||
media: [
|
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||||
|
parentTitle: "Caprica",
|
||||||
|
parentIndex: 1,
|
||||||
|
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||||
|
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||||
|
viewCount: 1,
|
||||||
|
viewOffset: 5222500,
|
||||||
|
skipCount: 1,
|
||||||
|
subtype: "clip",
|
||||||
|
lastRatedAt: 1721813113,
|
||||||
|
createdAtAccuracy: "epoch,local",
|
||||||
|
createdAtTZOffset: "0",
|
||||||
|
lastViewedAt: 1682752242,
|
||||||
|
userRating: 10,
|
||||||
|
image: [
|
||||||
{
|
{
|
||||||
id: 119534,
|
alt: "Episode 1",
|
||||||
duration: 11558112,
|
type: GetLibraryItemsLibraryResponseType.Background,
|
||||||
bitrate: 25025,
|
url: "/library/metadata/45521/thumb/1644710589",
|
||||||
width: 3840,
|
|
||||||
height: 2072,
|
|
||||||
aspectRatio: 1.85,
|
|
||||||
audioProfile: "dts",
|
|
||||||
audioChannels: 6,
|
|
||||||
audioCodec: "eac3",
|
|
||||||
videoCodec: "hevc",
|
|
||||||
videoResolution: "4k",
|
|
||||||
container: "mkv",
|
|
||||||
videoFrameRate: "24p",
|
|
||||||
videoProfile: "main 10",
|
|
||||||
hasVoiceActivity: false,
|
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
|
||||||
part: [],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
genre: [
|
|
||||||
{
|
|
||||||
tag: "Adventure",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
country: [
|
|
||||||
{
|
|
||||||
tag: "United States of America",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
director: [
|
|
||||||
{
|
|
||||||
tag: "James Cameron",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
writer: [
|
|
||||||
{
|
|
||||||
tag: "James Cameron",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
collection: [
|
|
||||||
{
|
|
||||||
tag: "Working NL Subs",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
role: [
|
|
||||||
{
|
|
||||||
id: 294129,
|
|
||||||
filter: "actor=294129",
|
|
||||||
thumb:
|
|
||||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
|
||||||
tag: "Mike Smith",
|
|
||||||
tagKey: "668e7e7b22bcad9064350c91",
|
|
||||||
role: "Self",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
location: [
|
|
||||||
{
|
|
||||||
path: "/TV Shows/House",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
mediaGuid: [
|
|
||||||
{
|
|
||||||
id: "imdb://tt13015952",
|
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
ultraBlurColors: {
|
ultraBlurColors: {
|
||||||
@@ -133,122 +89,237 @@ let value: GetLibraryItemsMetadata = {
|
|||||||
bottomRight: "73958",
|
bottomRight: "73958",
|
||||||
bottomLeft: "1f5066",
|
bottomLeft: "1f5066",
|
||||||
},
|
},
|
||||||
metaDataRating: [
|
guids: [
|
||||||
{
|
{
|
||||||
image: "themoviedb://image.rating",
|
id:
|
||||||
value: 3,
|
"{\"imdbExample\":{\"summary\":\"IMDB example\",\"value\":\"imdb://tt13015952\"},\"tmdbExample\":{\"summary\":\"TMDB example\",\"value\":\"tmdb://2434012\"},\"tvdbExample\":{\"summary\":\"TVDB example\",\"value\":\"tvdb://7945991\"}}",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
librarySectionID: 1,
|
||||||
|
librarySectionTitle: "Movies",
|
||||||
|
librarySectionKey: "/library/sections/1",
|
||||||
|
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||||
|
flattenSeasons: FlattenSeasons.Show,
|
||||||
|
skipChildren: false,
|
||||||
|
media: [
|
||||||
|
{
|
||||||
|
id: 387322,
|
||||||
|
duration: 9610350,
|
||||||
|
bitrate: 25512,
|
||||||
|
width: 3840,
|
||||||
|
height: 1602,
|
||||||
|
aspectRatio: 2.35,
|
||||||
|
audioChannels: 6,
|
||||||
|
displayOffset: 50,
|
||||||
|
audioCodec: "aac",
|
||||||
|
videoCodec: "hevc",
|
||||||
|
videoResolution: "4k",
|
||||||
|
container: "mp4",
|
||||||
|
videoFrameRate: "24p",
|
||||||
|
videoProfile: "main 10",
|
||||||
|
hasVoiceActivity: false,
|
||||||
|
audioProfile: "dts",
|
||||||
|
has64bitOffsets: false,
|
||||||
|
part: [
|
||||||
|
{
|
||||||
|
accessible: true,
|
||||||
|
exists: true,
|
||||||
|
id: 418385,
|
||||||
|
key: "/library/parts/418385/1735864239/file.mkv",
|
||||||
|
indexes: "sd",
|
||||||
|
duration: 9610350,
|
||||||
|
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||||
|
size: 30649952104,
|
||||||
|
packetLength: 188,
|
||||||
|
container: "mkv",
|
||||||
|
videoProfile: "main 10",
|
||||||
|
audioProfile: "dts",
|
||||||
|
has64bitOffsets: false,
|
||||||
|
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
genre: [
|
||||||
|
{
|
||||||
|
id: 259,
|
||||||
|
tag: "Crime",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
country: [
|
||||||
|
{
|
||||||
|
id: 259,
|
||||||
|
tag: "United States of America",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
director: [
|
||||||
|
{
|
||||||
|
id: 126522,
|
||||||
|
tag: "Danny Boyle",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
writer: [
|
||||||
|
{
|
||||||
|
id: 126522,
|
||||||
|
tag: "Jamie P. Hanson",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
producer: [
|
||||||
|
{
|
||||||
|
id: 109501,
|
||||||
|
filter: "actor=109501",
|
||||||
|
tag: "Bob Odenkirk",
|
||||||
|
tagKey: "5d77683254f42c001f8c3f69",
|
||||||
|
role: "Jimmy McGill",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
collection: [
|
||||||
|
{
|
||||||
|
tag: "My Awesome Collection",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
role: [
|
||||||
|
{
|
||||||
|
id: 126522,
|
||||||
|
tag: "Teller",
|
||||||
|
role: "Self - Judge",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
ratings: [
|
||||||
|
{
|
||||||
|
image: "imdb://image.rating",
|
||||||
|
value: 9,
|
||||||
type: "audience",
|
type: "audience",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
image: [
|
similar: [
|
||||||
{
|
{
|
||||||
alt: "Episode 1",
|
id: 26,
|
||||||
type: GetLibraryItemsLibraryResponse200Type.Background,
|
filter: "similar=26",
|
||||||
url: "/library/metadata/45521/thumb/1644710589",
|
tag: "Breaking Bad",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
titleSort: "Whale",
|
location: [
|
||||||
viewCount: 1,
|
{
|
||||||
lastViewedAt: 1682752242,
|
path: "/TV Shows/Clarkson's Farm",
|
||||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
},
|
||||||
viewOffset: 5222500,
|
],
|
||||||
skipCount: 1,
|
chapter: [
|
||||||
index: 1,
|
{
|
||||||
theme: "/library/metadata/1/theme/1705636920",
|
id: 4,
|
||||||
leafCount: 14,
|
filter: "thumb=4",
|
||||||
viewedLeafCount: 0,
|
index: 1,
|
||||||
childCount: 1,
|
startTimeOffset: 0,
|
||||||
hasPremiumExtras: "1",
|
endTimeOffset: 100100,
|
||||||
hasPremiumPrimaryExtra: "1",
|
thumb: "/library/media/46883/chapterImages/1",
|
||||||
parentRatingKey: "66",
|
},
|
||||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
],
|
||||||
parentStudio: "UCP",
|
marker: [
|
||||||
parentKey: "/library/metadata/66",
|
{
|
||||||
parentTitle: "Caprica",
|
id: 306970,
|
||||||
parentIndex: 1,
|
type: "credits",
|
||||||
parentYear: 2010,
|
startTimeOffset: 4176050,
|
||||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
endTimeOffset: 4393389,
|
||||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
final: true,
|
||||||
|
attributes: {
|
||||||
|
id: 306970,
|
||||||
|
version: 4,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
extras: {
|
||||||
|
size: 1,
|
||||||
|
},
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||||
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||||
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||||
| `skipChildren` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `type` | [operations.GetLibraryItemsType](../../../sdk/models/operations/getlibraryitemstype.md) | :heavy_check_mark: | N/A | movie |
|
||||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
| `banner` | *string* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
|
||||||
| `type` | [operations.GetLibraryItemsLibraryType](../../../sdk/models/operations/getlibraryitemslibrarytype.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
| `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||||
| `slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||||
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 |
|
| `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 |
|
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||||
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||||
| `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
| `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||||
| `episodeSort` | [operations.EpisodeSort](../../../sdk/models/operations/episodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
| `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||||
| `enableCreditsMarkerGeneration` | [operations.EnableCreditsMarkerGeneration](../../../sdk/models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||||
| `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `addedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
| `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||||
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
| `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||||
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
| `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||||
| `parentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
| `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
| `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||||
| `media` | [operations.GetLibraryItemsMedia](../../../sdk/models/operations/getlibraryitemsmedia.md)[] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||||
| `genre` | [operations.GetLibraryItemsGenre](../../../sdk/models/operations/getlibraryitemsgenre.md)[] | :heavy_minus_sign: | N/A | |
|
| `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||||
| `country` | [operations.GetLibraryItemsCountry](../../../sdk/models/operations/getlibraryitemscountry.md)[] | :heavy_minus_sign: | N/A | |
|
| `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||||
| `director` | [operations.GetLibraryItemsDirector](../../../sdk/models/operations/getlibraryitemsdirector.md)[] | :heavy_minus_sign: | N/A | |
|
| `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||||
| `writer` | [operations.GetLibraryItemsWriter](../../../sdk/models/operations/getlibraryitemswriter.md)[] | :heavy_minus_sign: | N/A | |
|
| `viewCount` | *number* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||||
| `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | |
|
| `viewOffset` | *number* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||||
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
|
| `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||||
| `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | |
|
| `subtype` | *string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
|
||||||
| `mediaGuid` | [operations.MediaGuid](../../../sdk/models/operations/mediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
| `lastRatedAt` | *number* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||||
| `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
| `createdAtAccuracy` | *string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
|
||||||
| `metaDataRating` | [operations.MetaDataRating](../../../sdk/models/operations/metadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
| `createdAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||||
| `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | |
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 |
|
| `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `originalTitle` | *string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
| `guids` | [operations.GetLibraryItemsGuids](../../../sdk/models/operations/getlibraryitemsguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `viewOffset` | *number* | :heavy_minus_sign: | N/A | 5222500 |
|
| `librarySectionID` | *number* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||||
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||||
| `index` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `librarySectionKey` | *string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
| `theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
| `showOrdering` | [operations.ShowOrdering](../../../sdk/models/operations/showordering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
|
||||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 14 |
|
| `flattenSeasons` | [operations.FlattenSeasons](../../../sdk/models/operations/flattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).<br/> | 1 |
|
||||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 0 |
|
| `skipChildren` | *boolean* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||||
| `childCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `media` | [operations.GetLibraryItemsMedia](../../../sdk/models/operations/getlibraryitemsmedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
| `genre` | [operations.GetLibraryItemsGenre](../../../sdk/models/operations/getlibraryitemsgenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
| `country` | [operations.GetLibraryItemsCountry](../../../sdk/models/operations/getlibraryitemscountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
| `director` | [operations.GetLibraryItemsDirector](../../../sdk/models/operations/getlibraryitemsdirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
| `writer` | [operations.GetLibraryItemsWriter](../../../sdk/models/operations/getlibraryitemswriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
| `producer` | [operations.GetLibraryItemsProducer](../../../sdk/models/operations/getlibraryitemsproducer.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
| `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2010 |
|
| `similar` | [operations.GetLibraryItemsSimilar](../../../sdk/models/operations/getlibraryitemssimilar.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
| `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `parentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
| `chapter` | [operations.Chapter](../../../sdk/models/operations/chapter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `marker` | [operations.Marker](../../../sdk/models/operations/marker.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
|
| `extras` | [operations.Extras](../../../sdk/models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,17 +1,19 @@
|
|||||||
# GetLibraryItemsOptimizedForStreaming
|
# GetLibraryItemsOptimizedForStreaming
|
||||||
|
|
||||||
## Example Usage
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
## Supported Types
|
||||||
|
|
||||||
|
### `operations.OptimizedForStreaming1`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsOptimizedForStreaming } from "@lukehagar/plexjs/sdk/models/operations";
|
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.One;
|
||||||
|
|
||||||
let value: GetLibraryItemsOptimizedForStreaming =
|
|
||||||
GetLibraryItemsOptimizedForStreaming.Enable;
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Values
|
### `boolean`
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const value: boolean = true;
|
||||||
|
```
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| --------- | --------- |
|
|
||||||
| `Disable` | 0 |
|
|
||||||
| `Enable` | 1 |
|
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# GetLibraryItemsOptimizedForStreaming1
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsOptimizedForStreaming1 =
|
||||||
|
GetLibraryItemsOptimizedForStreaming1.One;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `Zero` | 0 |
|
||||||
|
| `One` | 1 |
|
||||||
@@ -6,78 +6,39 @@
|
|||||||
import { GetLibraryItemsHasThumbnail, GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsHasThumbnail, GetLibraryItemsPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsPart = {
|
let value: GetLibraryItemsPart = {
|
||||||
id: 119542,
|
accessible: true,
|
||||||
key: "/library/parts/119542/1680457526/file.mkv",
|
exists: true,
|
||||||
duration: 11558112,
|
id: 418385,
|
||||||
file:
|
key: "/library/parts/418385/1735864239/file.mkv",
|
||||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
indexes: "sd",
|
||||||
size: 36158371307,
|
duration: 9610350,
|
||||||
|
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||||
|
size: 30649952104,
|
||||||
|
packetLength: 188,
|
||||||
container: "mkv",
|
container: "mkv",
|
||||||
|
videoProfile: "main 10",
|
||||||
audioProfile: "dts",
|
audioProfile: "dts",
|
||||||
has64bitOffsets: false,
|
has64bitOffsets: false,
|
||||||
optimizedForStreaming: false,
|
|
||||||
videoProfile: "main 10",
|
|
||||||
indexes: "sd",
|
|
||||||
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
hasThumbnail: GetLibraryItemsHasThumbnail.True,
|
||||||
stream: [
|
|
||||||
{
|
|
||||||
id: 272796,
|
|
||||||
streamType: 1,
|
|
||||||
default: true,
|
|
||||||
selected: true,
|
|
||||||
codec: "h264",
|
|
||||||
index: 0,
|
|
||||||
bitrate: 6273,
|
|
||||||
colorPrimaries: "bt709",
|
|
||||||
colorRange: "tv",
|
|
||||||
colorSpace: "bt709",
|
|
||||||
colorTrc: "bt709",
|
|
||||||
bitDepth: 8,
|
|
||||||
chromaLocation: "left",
|
|
||||||
streamIdentifier: "2",
|
|
||||||
chromaSubsampling: "4:2:0",
|
|
||||||
codedHeight: 1088,
|
|
||||||
codedWidth: 1920,
|
|
||||||
frameRate: 29.97,
|
|
||||||
hasScalingMatrix: false,
|
|
||||||
hearingImpaired: false,
|
|
||||||
closedCaptions: false,
|
|
||||||
embeddedInVideo: "1",
|
|
||||||
height: 1080,
|
|
||||||
level: 40,
|
|
||||||
profile: "main",
|
|
||||||
refFrames: 4,
|
|
||||||
scanType: "progressive",
|
|
||||||
width: 1920,
|
|
||||||
displayTitle: "1080p (H.264)",
|
|
||||||
extendedDisplayTitle: "1080p (H.264)",
|
|
||||||
channels: 2,
|
|
||||||
language: "English",
|
|
||||||
languageTag: "en",
|
|
||||||
languageCode: "eng",
|
|
||||||
audioChannelLayout: "stereo",
|
|
||||||
samplingRate: 48000,
|
|
||||||
title: "English",
|
|
||||||
canAutoSync: false,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_check_mark: | N/A | 119542 |
|
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
| `key` | *string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `size` | *number* | :heavy_check_mark: | N/A | 36158371307 |
|
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||||
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
| `duration` | *number* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | dts |
|
| `file` | *string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `size` | *number* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||||
| `optimizedForStreaming` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `packetLength` | *number* | :heavy_minus_sign: | N/A | 188 |
|
||||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main 10 |
|
| `container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
| `hasThumbnail` | [operations.GetLibraryItemsHasThumbnail](../../../sdk/models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `stream` | [operations.GetLibraryItemsStream](../../../sdk/models/operations/getlibraryitemsstream.md)[] | :heavy_minus_sign: | N/A | |
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
|
| `optimizedForStreaming` | *operations.GetLibraryItemsLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||||
|
| `hasThumbnail` | [operations.GetLibraryItemsHasThumbnail](../../../sdk/models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
28
docs/sdk/models/operations/getlibraryitemsproducer.md
Normal file
28
docs/sdk/models/operations/getlibraryitemsproducer.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# GetLibraryItemsProducer
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsProducer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsProducer = {
|
||||||
|
id: 109501,
|
||||||
|
filter: "actor=109501",
|
||||||
|
tag: "Bob Odenkirk",
|
||||||
|
tagKey: "5d77683254f42c001f8c3f69",
|
||||||
|
role: "Jimmy McGill",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||||
|
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||||
|
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||||
|
| `role` | *string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsResponse = {};
|
let value: GetLibraryItemsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 603151,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,240 +5,30 @@ The contents of the library by section and tag
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibraryItemsResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
EnableCreditsMarkerGeneration,
|
|
||||||
EpisodeSort,
|
|
||||||
FlattenSeasons,
|
|
||||||
GetLibraryItemsLibraryResponse200Type,
|
|
||||||
GetLibraryItemsLibraryType,
|
|
||||||
GetLibraryItemsOptimizedForStreaming,
|
|
||||||
GetLibraryItemsResponseBody,
|
|
||||||
ShowOrdering,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsResponseBody = {
|
let value: GetLibraryItemsResponseBody = {
|
||||||
mediaContainer: {
|
mediaContainer: {
|
||||||
type: [
|
size: 50,
|
||||||
{
|
totalSize: 50,
|
||||||
key: "/library/sections/2/all?type=2",
|
|
||||||
type: "filter",
|
|
||||||
subtype: "clip",
|
|
||||||
title: "TV Shows",
|
|
||||||
active: false,
|
|
||||||
filter: [
|
|
||||||
{
|
|
||||||
filter: "genre",
|
|
||||||
filterType: "string",
|
|
||||||
key: "/library/sections/2/genre?type=2",
|
|
||||||
title: "Genre",
|
|
||||||
type: "filter",
|
|
||||||
advanced: true,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
sort: [
|
|
||||||
{
|
|
||||||
default: "asc",
|
|
||||||
active: false,
|
|
||||||
descKey: "titleSort:desc",
|
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
|
||||||
key: "titleSort",
|
|
||||||
title: "Title",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
field: [
|
|
||||||
{
|
|
||||||
key: "show.title",
|
|
||||||
title: "Show Title",
|
|
||||||
type: "string",
|
|
||||||
subType: "rating",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
fieldType: [
|
|
||||||
{
|
|
||||||
type: "tag",
|
|
||||||
operator: [],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
size: 70,
|
|
||||||
totalSize: 170,
|
|
||||||
offset: 0,
|
offset: 0,
|
||||||
content: "secondary",
|
content: "secondary",
|
||||||
allowSync: true,
|
allowSync: false,
|
||||||
nocache: true,
|
nocache: true,
|
||||||
art: "/:/resources/movie-fanart.jpg",
|
art: "/:/resources/show-fanart.jpg",
|
||||||
identifier: "com.plexapp.plugins.library",
|
identifier: "com.plexapp.plugins.library",
|
||||||
librarySectionID: 1,
|
librarySectionID: 2,
|
||||||
librarySectionTitle: "Movies",
|
librarySectionTitle: "TV Series",
|
||||||
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
|
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||||
mediaTagVersion: 1701731894,
|
mediaTagVersion: 1734362201,
|
||||||
thumb: "/:/resources/movie.png",
|
thumb: "/:/resources/show.png",
|
||||||
title1: "Movies",
|
title1: "TV Series",
|
||||||
title2: "Recently Released",
|
title2: "By Starring Actor",
|
||||||
viewGroup: "movie",
|
viewGroup: "secondary",
|
||||||
viewMode: 65592,
|
viewMode: "131131",
|
||||||
mixedParents: true,
|
mixedParents: true,
|
||||||
metadata: [
|
metadata: [],
|
||||||
{
|
|
||||||
ratingKey: "58683",
|
|
||||||
key: "/library/metadata/58683",
|
|
||||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
|
||||||
studio: "20th Century Studios",
|
|
||||||
skipChildren: false,
|
|
||||||
librarySectionID: 1,
|
|
||||||
librarySectionTitle: "Movies",
|
|
||||||
librarySectionKey: "/library/sections/1",
|
|
||||||
type: GetLibraryItemsLibraryType.Movie,
|
|
||||||
title: "Avatar: The Way of Water",
|
|
||||||
slug: "4-for-texas",
|
|
||||||
contentRating: "PG-13",
|
|
||||||
summary:
|
|
||||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
|
||||||
rating: 7.6,
|
|
||||||
audienceRating: 9.2,
|
|
||||||
year: 2022,
|
|
||||||
seasonCount: 2022,
|
|
||||||
tagline: "Return to Pandora.",
|
|
||||||
flattenSeasons: FlattenSeasons.Show,
|
|
||||||
episodeSort: EpisodeSort.OldestFirst,
|
|
||||||
enableCreditsMarkerGeneration:
|
|
||||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
|
||||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
|
||||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
|
||||||
art: "/library/metadata/58683/art/1703239236",
|
|
||||||
banner: "/library/metadata/58683/banner/1703239236",
|
|
||||||
duration: 11558112,
|
|
||||||
originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
|
|
||||||
addedAt: 1556281940,
|
|
||||||
updatedAt: 1556281940,
|
|
||||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
|
||||||
chapterSource: "media",
|
|
||||||
primaryExtraKey: "/library/metadata/58684",
|
|
||||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
|
||||||
grandparentRatingKey: "66",
|
|
||||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
|
||||||
grandparentKey: "/library/metadata/66",
|
|
||||||
grandparentTitle: "Caprica",
|
|
||||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
|
||||||
parentSlug: "alice-in-borderland-2020",
|
|
||||||
grandparentSlug: "alice-in-borderland-2020",
|
|
||||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
|
||||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
|
||||||
media: [
|
|
||||||
{
|
|
||||||
id: 119534,
|
|
||||||
duration: 11558112,
|
|
||||||
bitrate: 25025,
|
|
||||||
width: 3840,
|
|
||||||
height: 2072,
|
|
||||||
aspectRatio: 1.85,
|
|
||||||
audioProfile: "dts",
|
|
||||||
audioChannels: 6,
|
|
||||||
audioCodec: "eac3",
|
|
||||||
videoCodec: "hevc",
|
|
||||||
videoResolution: "4k",
|
|
||||||
container: "mkv",
|
|
||||||
videoFrameRate: "24p",
|
|
||||||
videoProfile: "main 10",
|
|
||||||
hasVoiceActivity: false,
|
|
||||||
optimizedForStreaming: GetLibraryItemsOptimizedForStreaming.Enable,
|
|
||||||
has64bitOffsets: false,
|
|
||||||
part: [],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
genre: [
|
|
||||||
{
|
|
||||||
tag: "Adventure",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
country: [
|
|
||||||
{
|
|
||||||
tag: "United States of America",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
director: [
|
|
||||||
{
|
|
||||||
tag: "James Cameron",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
writer: [
|
|
||||||
{
|
|
||||||
tag: "James Cameron",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
collection: [
|
|
||||||
{
|
|
||||||
tag: "Working NL Subs",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
role: [
|
|
||||||
{
|
|
||||||
id: 294129,
|
|
||||||
filter: "actor=294129",
|
|
||||||
thumb:
|
|
||||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
|
||||||
tag: "Mike Smith",
|
|
||||||
tagKey: "668e7e7b22bcad9064350c91",
|
|
||||||
role: "Self",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
location: [
|
|
||||||
{
|
|
||||||
path: "/TV Shows/House",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
mediaGuid: [
|
|
||||||
{
|
|
||||||
id: "imdb://tt13015952",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
ultraBlurColors: {
|
|
||||||
topLeft: "11333b",
|
|
||||||
topRight: "0a232d",
|
|
||||||
bottomRight: "73958",
|
|
||||||
bottomLeft: "1f5066",
|
|
||||||
},
|
|
||||||
metaDataRating: [
|
|
||||||
{
|
|
||||||
image: "themoviedb://image.rating",
|
|
||||||
value: 3,
|
|
||||||
type: "audience",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
image: [
|
|
||||||
{
|
|
||||||
alt: "Episode 1",
|
|
||||||
type: GetLibraryItemsLibraryResponse200Type.Background,
|
|
||||||
url: "/library/metadata/45521/thumb/1644710589",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
titleSort: "Whale",
|
|
||||||
viewCount: 1,
|
|
||||||
lastViewedAt: 1682752242,
|
|
||||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
|
||||||
viewOffset: 5222500,
|
|
||||||
skipCount: 1,
|
|
||||||
index: 1,
|
|
||||||
theme: "/library/metadata/1/theme/1705636920",
|
|
||||||
leafCount: 14,
|
|
||||||
viewedLeafCount: 0,
|
|
||||||
childCount: 1,
|
|
||||||
hasPremiumExtras: "1",
|
|
||||||
hasPremiumPrimaryExtra: "1",
|
|
||||||
parentRatingKey: "66",
|
|
||||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
|
||||||
parentStudio: "UCP",
|
|
||||||
parentKey: "/library/metadata/66",
|
|
||||||
parentTitle: "Caprica",
|
|
||||||
parentIndex: 1,
|
|
||||||
parentYear: 2010,
|
|
||||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
|
||||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
meta: {
|
meta: {
|
||||||
type: [
|
type: [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -6,23 +6,19 @@
|
|||||||
import { GetLibraryItemsRole } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsRole = {
|
let value: GetLibraryItemsRole = {
|
||||||
id: 294129,
|
id: 126522,
|
||||||
filter: "actor=294129",
|
tag: "Teller",
|
||||||
|
role: "Self - Judge",
|
||||||
thumb:
|
thumb:
|
||||||
"https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg",
|
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||||
tag: "Mike Smith",
|
|
||||||
tagKey: "668e7e7b22bcad9064350c91",
|
|
||||||
role: "Self",
|
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
| `id` | *number* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
|
||||||
| `filter` | *string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||||
| `thumb` | *string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
| `role` | *string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
| `thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||||
| `tagKey` | *string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
|
||||||
| `role` | *string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
|
||||||
21
docs/sdk/models/operations/getlibraryitemssimilar.md
Normal file
21
docs/sdk/models/operations/getlibraryitemssimilar.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetLibraryItemsSimilar
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibraryItemsSimilar } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibraryItemsSimilar = {
|
||||||
|
id: 26,
|
||||||
|
filter: "similar=26",
|
||||||
|
tag: "Breaking Bad",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||||
|
| `filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
# GetLibraryItemsStream
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibraryItemsStream } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibraryItemsStream = {
|
|
||||||
id: 272796,
|
|
||||||
streamType: 1,
|
|
||||||
default: true,
|
|
||||||
selected: true,
|
|
||||||
codec: "h264",
|
|
||||||
index: 0,
|
|
||||||
bitrate: 6273,
|
|
||||||
colorPrimaries: "bt709",
|
|
||||||
colorRange: "tv",
|
|
||||||
colorSpace: "bt709",
|
|
||||||
colorTrc: "bt709",
|
|
||||||
bitDepth: 8,
|
|
||||||
chromaLocation: "left",
|
|
||||||
streamIdentifier: "2",
|
|
||||||
chromaSubsampling: "4:2:0",
|
|
||||||
codedHeight: 1088,
|
|
||||||
codedWidth: 1920,
|
|
||||||
frameRate: 29.97,
|
|
||||||
hasScalingMatrix: false,
|
|
||||||
hearingImpaired: false,
|
|
||||||
closedCaptions: false,
|
|
||||||
embeddedInVideo: "1",
|
|
||||||
height: 1080,
|
|
||||||
level: 40,
|
|
||||||
profile: "main",
|
|
||||||
refFrames: 4,
|
|
||||||
scanType: "progressive",
|
|
||||||
width: 1920,
|
|
||||||
displayTitle: "1080p (H.264)",
|
|
||||||
extendedDisplayTitle: "1080p (H.264)",
|
|
||||||
channels: 2,
|
|
||||||
language: "English",
|
|
||||||
languageTag: "en",
|
|
||||||
languageCode: "eng",
|
|
||||||
audioChannelLayout: "stereo",
|
|
||||||
samplingRate: 48000,
|
|
||||||
title: "English",
|
|
||||||
canAutoSync: false,
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
|
||||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
|
||||||
| `id` | *number* | :heavy_check_mark: | N/A | 272796 |
|
|
||||||
| `streamType` | *number* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
|
||||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
|
||||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
|
||||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
|
||||||
| `index` | *number* | :heavy_check_mark: | The index of the stream | 0 |
|
|
||||||
| `bitrate` | *number* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
|
||||||
| `colorPrimaries` | *string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
|
||||||
| `colorRange` | *string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
|
||||||
| `colorSpace` | *string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
|
||||||
| `colorTrc` | *string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
|
||||||
| `bitDepth` | *number* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
|
||||||
| `chromaLocation` | *string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
|
||||||
| `streamIdentifier` | *string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
|
||||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
|
||||||
| `codedHeight` | *number* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
|
||||||
| `codedWidth` | *number* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
|
||||||
| `frameRate` | *number* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
|
||||||
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
|
||||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | false |
|
|
||||||
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | 1 |
|
|
||||||
| `height` | *number* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
|
||||||
| `level` | *number* | :heavy_minus_sign: | The level of the video codec | 40 |
|
|
||||||
| `profile` | *string* | :heavy_minus_sign: | The profile of the video codec | main |
|
|
||||||
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames | 4 |
|
|
||||||
| `scanType` | *string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
|
||||||
| `width` | *number* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
|
||||||
| `displayTitle` | *string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
|
||||||
| `extendedDisplayTitle` | *string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
|
||||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
|
||||||
| `language` | *string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
|
||||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag of the stream | en |
|
|
||||||
| `languageCode` | *string* | :heavy_minus_sign: | Language code of the stream | eng |
|
|
||||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
|
||||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
|
||||||
| `title` | *string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
|
||||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
|
||||||
@@ -1,56 +1,30 @@
|
|||||||
# GetLibraryItemsType
|
# GetLibraryItemsType
|
||||||
|
|
||||||
|
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibraryItemsType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsType = {
|
let value: GetLibraryItemsType = GetLibraryItemsType.Movie;
|
||||||
key: "/library/sections/2/all?type=2",
|
|
||||||
type: "filter",
|
|
||||||
subtype: "clip",
|
|
||||||
title: "TV Shows",
|
|
||||||
active: false,
|
|
||||||
filter: [
|
|
||||||
{
|
|
||||||
filter: "genre",
|
|
||||||
filterType: "string",
|
|
||||||
key: "/library/sections/2/genre?type=2",
|
|
||||||
title: "Genre",
|
|
||||||
type: "filter",
|
|
||||||
advanced: true,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
sort: [
|
|
||||||
{
|
|
||||||
default: "asc",
|
|
||||||
active: false,
|
|
||||||
descKey: "titleSort:desc",
|
|
||||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
|
||||||
key: "titleSort",
|
|
||||||
title: "Title",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
field: [
|
|
||||||
{
|
|
||||||
key: "show.title",
|
|
||||||
title: "Show Title",
|
|
||||||
type: "string",
|
|
||||||
subType: "rating",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
};
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Values
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
|
||||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
| Name | Value |
|
||||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
| ---------------------- | ---------------------- |
|
||||||
| `subtype` | *string* | :heavy_minus_sign: | N/A | clip |
|
| `Movie` | movie |
|
||||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
| `TvShow` | show |
|
||||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
| `Season` | season |
|
||||||
| `filter` | [operations.GetLibraryItemsFilter](../../../sdk/models/operations/getlibraryitemsfilter.md)[] | :heavy_minus_sign: | N/A | |
|
| `Episode` | episode |
|
||||||
| `sort` | [operations.GetLibraryItemsSort](../../../sdk/models/operations/getlibraryitemssort.md)[] | :heavy_minus_sign: | N/A | |
|
| `Artist` | artist |
|
||||||
| `field` | [operations.GetLibraryItemsField](../../../sdk/models/operations/getlibraryitemsfield.md)[] | :heavy_minus_sign: | N/A | |
|
| `Album` | album |
|
||||||
|
| `Track` | track |
|
||||||
|
| `PhotoAlbum` | photoalbum |
|
||||||
|
| `Photo` | photo |
|
||||||
|
| `Collection` | collection |
|
||||||
|
| - | `Unrecognized<string>` |
|
||||||
@@ -6,12 +6,17 @@
|
|||||||
import { GetLibraryItemsWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibraryItemsWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibraryItemsWriter = {
|
let value: GetLibraryItemsWriter = {
|
||||||
tag: "James Cameron",
|
id: 126522,
|
||||||
|
tag: "Jamie P. Hanson",
|
||||||
|
thumb:
|
||||||
|
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
| `id` | *number* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||||
|
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||||
|
| `thumb` | *string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||||
@@ -5,11 +5,11 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
|||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
|
|
||||||
### `operations.GetLibrarySectionsAllOptimizedForStreaming1`
|
### `operations.GetLibrarySectionsAllOptimizedForStreamingLibrary1`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const value: operations.GetLibrarySectionsAllOptimizedForStreaming1 =
|
const value: operations.GetLibrarySectionsAllOptimizedForStreamingLibrary1 =
|
||||||
GetLibrarySectionsAllOptimizedForStreaming1.Zero;
|
GetLibrarySectionsAllOptimizedForStreamingLibrary1.One;
|
||||||
```
|
```
|
||||||
|
|
||||||
### `boolean`
|
### `boolean`
|
||||||
|
|||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibrarySectionsAllHasThumbnail, GetLibrarySectionsAllMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibrarySectionsAllHasThumbnail,
|
|
||||||
GetLibrarySectionsAllMedia,
|
|
||||||
GetLibrarySectionsAllStreamType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibrarySectionsAllMedia = {
|
let value: GetLibrarySectionsAllMedia = {
|
||||||
id: 387322,
|
id: 387322,
|
||||||
@@ -46,7 +42,6 @@ let value: GetLibrarySectionsAllMedia = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetLibrarySectionsAllStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ import {
|
|||||||
GetLibrarySectionsAllLibraryResponseType,
|
GetLibrarySectionsAllLibraryResponseType,
|
||||||
GetLibrarySectionsAllLibraryType,
|
GetLibrarySectionsAllLibraryType,
|
||||||
GetLibrarySectionsAllMediaContainer,
|
GetLibrarySectionsAllMediaContainer,
|
||||||
GetLibrarySectionsAllStreamType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
@@ -197,7 +196,6 @@ let value: GetLibrarySectionsAllMediaContainer = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetLibrarySectionsAllStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
@@ -299,8 +297,8 @@ let value: GetLibrarySectionsAllMediaContainer = {
|
|||||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
| `librarySectionID` | *number* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ import {
|
|||||||
GetLibrarySectionsAllLibraryResponseType,
|
GetLibrarySectionsAllLibraryResponseType,
|
||||||
GetLibrarySectionsAllLibraryType,
|
GetLibrarySectionsAllLibraryType,
|
||||||
GetLibrarySectionsAllMetadata,
|
GetLibrarySectionsAllMetadata,
|
||||||
GetLibrarySectionsAllStreamType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
@@ -131,7 +130,6 @@ let value: GetLibrarySectionsAllMetadata = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetLibrarySectionsAllStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
@@ -247,7 +245,7 @@ let value: GetLibrarySectionsAllMetadata = {
|
|||||||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
|
|||||||
@@ -5,10 +5,11 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
|||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
|
|
||||||
### `operations.OptimizedForStreaming1`
|
### `operations.GetLibrarySectionsAllOptimizedForStreaming1`
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.One;
|
const value: operations.GetLibrarySectionsAllOptimizedForStreaming1 =
|
||||||
|
GetLibrarySectionsAllOptimizedForStreaming1.Zero;
|
||||||
```
|
```
|
||||||
|
|
||||||
### `boolean`
|
### `boolean`
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# GetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetLibrarySectionsAllOptimizedForStreamingLibrary1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetLibrarySectionsAllOptimizedForStreamingLibrary1 =
|
||||||
|
GetLibrarySectionsAllOptimizedForStreamingLibrary1.One;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Values
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------ | ------ |
|
||||||
|
| `Zero` | 0 |
|
||||||
|
| `One` | 1 |
|
||||||
@@ -3,11 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import {
|
import { GetLibrarySectionsAllHasThumbnail, GetLibrarySectionsAllPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
GetLibrarySectionsAllHasThumbnail,
|
|
||||||
GetLibrarySectionsAllPart,
|
|
||||||
GetLibrarySectionsAllStreamType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibrarySectionsAllPart = {
|
let value: GetLibrarySectionsAllPart = {
|
||||||
accessible: true,
|
accessible: true,
|
||||||
@@ -27,7 +23,6 @@ let value: GetLibrarySectionsAllPart = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetLibrarySectionsAllStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetLibrarySectionsAllResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibrarySectionsAllResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibrarySectionsAllResponse = {};
|
let value: GetLibrarySectionsAllResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 118591,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import {
|
|||||||
GetLibrarySectionsAllLibraryResponseType,
|
GetLibrarySectionsAllLibraryResponseType,
|
||||||
GetLibrarySectionsAllLibraryType,
|
GetLibrarySectionsAllLibraryType,
|
||||||
GetLibrarySectionsAllResponseBody,
|
GetLibrarySectionsAllResponseBody,
|
||||||
GetLibrarySectionsAllStreamType,
|
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
|
|
||||||
@@ -200,7 +199,6 @@ let value: GetLibrarySectionsAllResponseBody = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetLibrarySectionsAllStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
|
|||||||
@@ -3,11 +3,10 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetLibrarySectionsAllStream, GetLibrarySectionsAllStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetLibrarySectionsAllStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetLibrarySectionsAllStream = {
|
let value: GetLibrarySectionsAllStream = {
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetLibrarySectionsAllStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
@@ -62,56 +61,56 @@ let value: GetLibrarySectionsAllStream = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `streamType` | [operations.GetLibrarySectionsAllStreamType](../../../sdk/models/operations/getlibrarysectionsallstreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
| `streamType` | *number* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||||
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||||
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
|
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
|
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
# GetLibrarySectionsAllStreamType
|
|
||||||
|
|
||||||
Stream type:
|
|
||||||
- 1 = video
|
|
||||||
- 2 = audio
|
|
||||||
- 3 = subtitle
|
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetLibrarySectionsAllStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetLibrarySectionsAllStreamType =
|
|
||||||
GetLibrarySectionsAllStreamType.Video;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------------- | ---------------------- |
|
|
||||||
| `Video` | 1 |
|
|
||||||
| `Audio` | 2 |
|
|
||||||
| `Subtitle` | 3 |
|
|
||||||
| - | `Unrecognized<number>` |
|
|
||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetMediaArtsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaArtsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMediaArtsResponse = {};
|
let value: GetMediaArtsResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 153816,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
21
docs/sdk/models/operations/getmediametadataattributes.md
Normal file
21
docs/sdk/models/operations/getmediametadataattributes.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# GetMediaMetaDataAttributes
|
||||||
|
|
||||||
|
Attributes associated with the marker.
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataAttributes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataAttributes = {
|
||||||
|
id: 306970,
|
||||||
|
version: 4,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||||
|
| `version` | *number* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||||
29
docs/sdk/models/operations/getmediametadatachapter.md
Normal file
29
docs/sdk/models/operations/getmediametadatachapter.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# GetMediaMetaDataChapter
|
||||||
|
|
||||||
|
The thumbnail for the chapter
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataChapter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataChapter = {
|
||||||
|
id: 4,
|
||||||
|
filter: "thumb=4",
|
||||||
|
index: 1,
|
||||||
|
startTimeOffset: 0,
|
||||||
|
endTimeOffset: 100100,
|
||||||
|
thumb: "/library/media/46883/chapterImages/1",
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A | 4 |
|
||||||
|
| `filter` | *string* | :heavy_check_mark: | N/A | thumb=4 |
|
||||||
|
| `index` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||||
|
| `startTimeOffset` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||||
|
| `endTimeOffset` | *number* | :heavy_check_mark: | N/A | 100100 |
|
||||||
|
| `thumb` | *string* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||||
17
docs/sdk/models/operations/getmediametadataextras.md
Normal file
17
docs/sdk/models/operations/getmediametadataextras.md
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# GetMediaMetaDataExtras
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataExtras } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataExtras = {
|
||||||
|
size: 1,
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||||
|
| `size` | *number* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
Indicates if the part has a thumbnail.
|
Indicates if the part has a thumbnail.
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Supported Types
|
## Supported Types
|
||||||
|
|
||||||
### `operations.GetMediaMetaDataOptimizedForStreamingLibrary1`
|
### `operations.GetMediaMetaDataOptimizedForStreamingLibrary1`
|
||||||
|
|||||||
32
docs/sdk/models/operations/getmediametadatamarker.md
Normal file
32
docs/sdk/models/operations/getmediametadatamarker.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# GetMediaMetaDataMarker
|
||||||
|
|
||||||
|
The final status of the marker
|
||||||
|
|
||||||
|
## Example Usage
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { GetMediaMetaDataMarker } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
|
let value: GetMediaMetaDataMarker = {
|
||||||
|
id: 306970,
|
||||||
|
type: "credits",
|
||||||
|
startTimeOffset: 4176050,
|
||||||
|
endTimeOffset: 4393389,
|
||||||
|
final: true,
|
||||||
|
attributes: {
|
||||||
|
id: 306970,
|
||||||
|
version: 4,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
| Field | Type | Required | Description | Example |
|
||||||
|
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||||
|
| `id` | *number* | :heavy_check_mark: | N/A | 306970 |
|
||||||
|
| `type` | *string* | :heavy_check_mark: | N/A | credits |
|
||||||
|
| `startTimeOffset` | *number* | :heavy_check_mark: | N/A | 4176050 |
|
||||||
|
| `endTimeOffset` | *number* | :heavy_check_mark: | N/A | 4393389 |
|
||||||
|
| `final` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
|
| `attributes` | [operations.GetMediaMetaDataAttributes](../../../sdk/models/operations/getmediametadataattributes.md) | :heavy_minus_sign: | Attributes associated with the marker. | |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMediaMetaDataHasThumbnail, GetMediaMetaDataMedia, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaMetaDataHasThumbnail, GetMediaMetaDataMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMediaMetaDataMedia = {
|
let value: GetMediaMetaDataMedia = {
|
||||||
id: 387322,
|
id: 387322,
|
||||||
@@ -14,10 +14,10 @@ let value: GetMediaMetaDataMedia = {
|
|||||||
aspectRatio: 2.35,
|
aspectRatio: 2.35,
|
||||||
audioChannels: 6,
|
audioChannels: 6,
|
||||||
displayOffset: 50,
|
displayOffset: 50,
|
||||||
audioCodec: "eac3",
|
audioCodec: "aac",
|
||||||
videoCodec: "hevc",
|
videoCodec: "hevc",
|
||||||
videoResolution: "4k",
|
videoResolution: "4k",
|
||||||
container: "mkv",
|
container: "mp4",
|
||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
@@ -42,7 +42,6 @@ let value: GetMediaMetaDataMedia = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetMediaMetaDataStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
@@ -101,24 +100,24 @@ let value: GetMediaMetaDataMedia = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
| `duration` | *number* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||||
| `width` | *number* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
| `width` | *number* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||||
| `height` | *number* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
| `height` | *number* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||||
| `aspectRatio` | *number* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
| `aspectRatio` | *number* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||||
| `audioChannels` | *number* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
| `audioChannels` | *number* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||||
| `displayOffset` | *number* | :heavy_minus_sign: | N/A | 50 |
|
| `displayOffset` | *number* | :heavy_minus_sign: | N/A | 50 |
|
||||||
| `audioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
| `audioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||||
| `videoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
|
| `videoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||||
| `videoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
| `videoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||||
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
|
| `container` | *string* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||||
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
| `hasVoiceActivity` | *boolean* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `optimizedForStreaming` | *operations.GetMediaMetaDataOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
| `optimizedForStreaming` | *operations.GetMediaMetaDataOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
|
||||||
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |
|
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -25,8 +25,8 @@ let value: GetMediaMetaDataMediaContainer = {
|
|||||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||||
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
| `librarySectionID` | *number* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ import {
|
|||||||
GetMediaMetaDataHasThumbnail,
|
GetMediaMetaDataHasThumbnail,
|
||||||
GetMediaMetaDataLibraryType,
|
GetMediaMetaDataLibraryType,
|
||||||
GetMediaMetaDataMetadata,
|
GetMediaMetaDataMetadata,
|
||||||
GetMediaMetaDataStreamType,
|
|
||||||
GetMediaMetaDataType,
|
GetMediaMetaDataType,
|
||||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||||
@@ -106,10 +105,10 @@ let value: GetMediaMetaDataMetadata = {
|
|||||||
aspectRatio: 2.35,
|
aspectRatio: 2.35,
|
||||||
audioChannels: 6,
|
audioChannels: 6,
|
||||||
displayOffset: 50,
|
displayOffset: 50,
|
||||||
audioCodec: "eac3",
|
audioCodec: "aac",
|
||||||
videoCodec: "hevc",
|
videoCodec: "hevc",
|
||||||
videoResolution: "4k",
|
videoResolution: "4k",
|
||||||
container: "mkv",
|
container: "mp4",
|
||||||
videoFrameRate: "24p",
|
videoFrameRate: "24p",
|
||||||
videoProfile: "main 10",
|
videoProfile: "main 10",
|
||||||
hasVoiceActivity: false,
|
hasVoiceActivity: false,
|
||||||
@@ -134,7 +133,6 @@ let value: GetMediaMetaDataMetadata = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetMediaMetaDataStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
@@ -321,7 +319,7 @@ let value: GetMediaMetaDataMetadata = {
|
|||||||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||||
@@ -354,9 +352,9 @@ let value: GetMediaMetaDataMetadata = {
|
|||||||
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||||
| `image` | [operations.GetMediaMetaDataImage](../../../sdk/models/operations/getmediametadataimage.md)[] | :heavy_minus_sign: | N/A | |
|
| `image` | [operations.GetMediaMetaDataImage](../../../sdk/models/operations/getmediametadataimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `ultraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../../sdk/models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
| `ultraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../../sdk/models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||||
| `librarySectionID` | *number* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
| `librarySectionID` | *number* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
| `librarySectionKey` | *string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||||
| `guids` | [operations.GetMediaMetaDataGuids](../../../sdk/models/operations/getmediametadataguids.md)[] | :heavy_minus_sign: | N/A | |
|
| `guids` | [operations.GetMediaMetaDataGuids](../../../sdk/models/operations/getmediametadataguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `media` | [operations.GetMediaMetaDataMedia](../../../sdk/models/operations/getmediametadatamedia.md)[] | :heavy_minus_sign: | N/A | |
|
| `media` | [operations.GetMediaMetaDataMedia](../../../sdk/models/operations/getmediametadatamedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `genre` | [operations.GetMediaMetaDataGenre](../../../sdk/models/operations/getmediametadatagenre.md)[] | :heavy_minus_sign: | N/A | |
|
| `genre` | [operations.GetMediaMetaDataGenre](../../../sdk/models/operations/getmediametadatagenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -365,9 +363,9 @@ let value: GetMediaMetaDataMetadata = {
|
|||||||
| `writer` | [operations.GetMediaMetaDataWriter](../../../sdk/models/operations/getmediametadatawriter.md)[] | :heavy_minus_sign: | N/A | |
|
| `writer` | [operations.GetMediaMetaDataWriter](../../../sdk/models/operations/getmediametadatawriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `producer` | [operations.GetMediaMetaDataProducer](../../../sdk/models/operations/getmediametadataproducer.md)[] | :heavy_minus_sign: | N/A | |
|
| `producer` | [operations.GetMediaMetaDataProducer](../../../sdk/models/operations/getmediametadataproducer.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | N/A | |
|
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
| `ratings` | [operations.GetMediaMetaDataRatings](../../../sdk/models/operations/getmediametadataratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `similar` | [operations.GetMediaMetaDataSimilar](../../../sdk/models/operations/getmediametadatasimilar.md)[] | :heavy_minus_sign: | N/A | |
|
| `similar` | [operations.GetMediaMetaDataSimilar](../../../sdk/models/operations/getmediametadatasimilar.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | N/A | |
|
| `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `chapter` | [operations.Chapter](../../../sdk/models/operations/chapter.md)[] | :heavy_minus_sign: | N/A | |
|
| `chapter` | [operations.GetMediaMetaDataChapter](../../../sdk/models/operations/getmediametadatachapter.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `marker` | [operations.Marker](../../../sdk/models/operations/marker.md)[] | :heavy_minus_sign: | N/A | |
|
| `marker` | [operations.GetMediaMetaDataMarker](../../../sdk/models/operations/getmediametadatamarker.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
| `extras` | [operations.Extras](../../../sdk/models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
| `extras` | [operations.GetMediaMetaDataExtras](../../../sdk/models/operations/getmediametadataextras.md) | :heavy_minus_sign: | N/A | |
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMediaMetaDataHasThumbnail, GetMediaMetaDataPart, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaMetaDataHasThumbnail, GetMediaMetaDataPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMediaMetaDataPart = {
|
let value: GetMediaMetaDataPart = {
|
||||||
accessible: true,
|
accessible: true,
|
||||||
@@ -23,7 +23,6 @@ let value: GetMediaMetaDataPart = {
|
|||||||
stream: [
|
stream: [
|
||||||
{
|
{
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetMediaMetaDataStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
@@ -85,16 +84,16 @@ let value: GetMediaMetaDataPart = {
|
|||||||
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||||
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||||
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||||
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
| `key` | *string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
| `duration` | *number* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||||
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
| `file` | *string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||||
| `size` | *number* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
| `size` | *number* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||||
| `packetLength` | *number* | :heavy_minus_sign: | N/A | 188 |
|
| `packetLength` | *number* | :heavy_minus_sign: | N/A | 188 |
|
||||||
| `container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
| `container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
| `optimizedForStreaming` | *operations.GetMediaMetaDataLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
| `optimizedForStreaming` | *operations.GetMediaMetaDataLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||||
| `hasThumbnail` | [operations.GetMediaMetaDataHasThumbnail](../../../sdk/models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
| `hasThumbnail` | [operations.GetMediaMetaDataHasThumbnail](../../../sdk/models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||||
| `stream` | [operations.GetMediaMetaDataStream](../../../sdk/models/operations/getmediametadatastream.md)[] | :heavy_minus_sign: | An array of streams for this part. | |
|
| `stream` | [operations.GetMediaMetaDataStream](../../../sdk/models/operations/getmediametadatastream.md)[] | :heavy_minus_sign: | N/A | |
|
||||||
@@ -1,13 +1,13 @@
|
|||||||
# MetaDataRating
|
# GetMediaMetaDataRatings
|
||||||
|
|
||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { MetaDataRating } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaMetaDataRatings } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: MetaDataRating = {
|
let value: GetMediaMetaDataRatings = {
|
||||||
image: "themoviedb://image.rating",
|
image: "imdb://image.rating",
|
||||||
value: 3,
|
value: 9,
|
||||||
type: "audience",
|
type: "audience",
|
||||||
};
|
};
|
||||||
```
|
```
|
||||||
@@ -16,6 +16,6 @@ let value: MetaDataRating = {
|
|||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||||
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
| `image` | *string* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
|
||||||
| `value` | *number* | :heavy_check_mark: | The value of the rating. | 3 |
|
| `value` | *number* | :heavy_check_mark: | The rating value. | 9 |
|
||||||
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetMediaMetaDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaMetaDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMediaMetaDataResponse = {};
|
let value: GetMediaMetaDataResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 114115,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -3,11 +3,10 @@
|
|||||||
## Example Usage
|
## Example Usage
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { GetMediaMetaDataStream, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaMetaDataStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMediaMetaDataStream = {
|
let value: GetMediaMetaDataStream = {
|
||||||
id: 1002625,
|
id: 1002625,
|
||||||
streamType: GetMediaMetaDataStreamType.Video,
|
|
||||||
format: "srt",
|
format: "srt",
|
||||||
default: true,
|
default: true,
|
||||||
codec: "hevc",
|
codec: "hevc",
|
||||||
@@ -62,56 +61,56 @@ let value: GetMediaMetaDataStream = {
|
|||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|
||||||
| Field | Type | Required | Description | Example |
|
| Field | Type | Required | Description | Example |
|
||||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||||
| `streamType` | [operations.GetMediaMetaDataStreamType](../../../sdk/models/operations/getmediametadatastreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
| `streamType` | *number* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||||
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
| `codec` | *string* | :heavy_minus_sign: | Codec used by the stream. | hevc |
|
||||||
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||||
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||||
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||||
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||||
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||||
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||||
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||||
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||||
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||||
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||||
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||||
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||||
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||||
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||||
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
|
| `scanType` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
|
| `embeddedInVideo` | *string* | :heavy_minus_sign: | N/A | progressive |
|
||||||
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
| `refFrames` | *number* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||||
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
| `width` | *number* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||||
| `displayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `displayTitle` | *string* | :heavy_minus_sign: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
| `extendedDisplayTitle` | *string* | :heavy_minus_sign: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
# GetMediaMetaDataStreamType
|
|
||||||
|
|
||||||
Stream type:
|
|
||||||
- 1 = video
|
|
||||||
- 2 = audio
|
|
||||||
- 3 = subtitle
|
|
||||||
|
|
||||||
|
|
||||||
## Example Usage
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
|
||||||
|
|
||||||
let value: GetMediaMetaDataStreamType = GetMediaMetaDataStreamType.Video;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Values
|
|
||||||
|
|
||||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
|
||||||
|
|
||||||
| Name | Value |
|
|
||||||
| ---------------------- | ---------------------- |
|
|
||||||
| `Video` | 1 |
|
|
||||||
| `Audio` | 2 |
|
|
||||||
| `Subtitle` | 3 |
|
|
||||||
| - | `Unrecognized<number>` |
|
|
||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetMediaPostersResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaPostersResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMediaPostersResponse = {};
|
let value: GetMediaPostersResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 802181,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetMediaProvidersResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMediaProvidersResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMediaProvidersResponse = {};
|
let value: GetMediaProvidersResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 674530,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
@@ -5,7 +5,10 @@
|
|||||||
```typescript
|
```typescript
|
||||||
import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||||
|
|
||||||
let value: GetMetadataChildrenResponse = {};
|
let value: GetMetadataChildrenResponse = {
|
||||||
|
contentType: "<value>",
|
||||||
|
statusCode: 590251,
|
||||||
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
## Fields
|
## Fields
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user