mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
3c13bba9de | ||
|
|
650c5043ef | ||
|
|
0234804578 | ||
|
|
60d913c8f9 | ||
|
|
8d9f4bbaf1 | ||
|
|
5d57cd7c34 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
||||
/mcp-server
|
||||
/bin
|
||||
/.eslintcache
|
||||
/.speakeasy/reports
|
||||
/react-query
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
!/REACT_QUERY.md
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.mjs
|
||||
!/**/*.json
|
||||
!/**/*.map
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -7,13 +7,15 @@ generation:
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
nameResolutionFeb2025: false
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.34.0
|
||||
version: 0.35.3
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
@@ -23,6 +25,7 @@ typescript:
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: SDKError
|
||||
enableCustomCodeRegions: false
|
||||
enableMCPServer: true
|
||||
enableReactQuery: false
|
||||
enumFormat: enum
|
||||
flattenGlobalSecurity: true
|
||||
@@ -36,6 +39,7 @@ typescript:
|
||||
shared: sdk/models/shared
|
||||
webhooks: sdk/models/webhooks
|
||||
inputModelSuffix: input
|
||||
jsonpath: legacy
|
||||
maxMethodParams: 4
|
||||
methodArguments: require-security-and-request
|
||||
moduleFormat: commonjs
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.487.1
|
||||
speakeasyVersion: 1.526.6
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,20 +9,20 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
||||
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
||||
sourceRevisionDigest: sha256:277010613dd132c4b785bacddcba720038318ae87b0ce5e1eea3887cf8f22df4
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1739146221
|
||||
- speakeasy-sdk-regen-1743449645
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:0efb9039972533bf1190dfc1ffb377429a8e486b6299442e732f662c1ffbeca6
|
||||
sourceBlobDigest: sha256:038d73166cc9db17f514d511cfe4365ea032f4ebcb247fa86b7aa1bba0e1ab46
|
||||
sourceRevisionDigest: sha256:277010613dd132c4b785bacddcba720038318ae87b0ce5e1eea3887cf8f22df4
|
||||
sourceBlobDigest: sha256:1737023e29cd9cf36c07ccd8c8c48c47e14f47ce22b4d6ba9ee241afbbd8f351
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:18095ae1c50f9a506f370f124c16b4b0d5ebe8ec15c006e533371285a7201fb3
|
||||
codeSamplesRevisionDigest: sha256:f99618862675a8c5993740b2acb9b573110d9b506d2bc70e3180f0f7f393798f
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
@@ -43,3 +43,6 @@ workflow:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
langOverride: TypeScript
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
@@ -17,3 +17,6 @@ targets:
|
||||
output: codeSamples.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/plexapi/plexapi/code-samples-typescript-plexjs
|
||||
langOverride: TypeScript
|
||||
labelOverride:
|
||||
fixedValue: PlexJS
|
||||
|
||||
36
README.md
36
README.md
@@ -169,7 +169,6 @@ run();
|
||||
* [getMediaMetaData](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
* [getMetadataChildren](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
* [getTopWatchedContent](docs/sdks/library/README.md#gettopwatchedcontent) - Get Top Watched Content
|
||||
* [getOnDeck](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
|
||||
### [log](docs/sdks/log/README.md)
|
||||
|
||||
@@ -344,13 +343,39 @@ In some rare cases, the SDK can fail to get a response from the server or even m
|
||||
### Server Variables
|
||||
|
||||
The default server `{protocol}://{ip}:{port}` contains variables and is set to `https://10.10.10.47:32400` by default. To override default values, the following parameters are available when initializing the SDK client instance:
|
||||
* `protocol: models.ServerProtocol`
|
||||
* `ip: string`
|
||||
* `port: string`
|
||||
|
||||
| Variable | Parameter | Supported Values | Default | Description |
|
||||
| ---------- | --------------------------------- | -------------------------- | --------------- | ---------------------------------------------- |
|
||||
| `protocol` | `protocol: models.ServerProtocol` | - `"http"`<br/>- `"https"` | `"https"` | The protocol to use for the server connection |
|
||||
| `ip` | `ip: string` | string | `"10.10.10.47"` | The IP address or hostname of your Plex Server |
|
||||
| `port` | `port: string` | string | `"32400"` | The port of your Plex Server |
|
||||
|
||||
#### Example
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
protocol: "https",
|
||||
ip: "e0c3:bcc0:6bac:dccc:c4ec:34b1:ca98:4cb9",
|
||||
port: "40311",
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.server.getServerCapabilities();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||
The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -520,7 +545,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
- [`libraryGetLibraryItems`](docs/sdks/library/README.md#getlibraryitems) - Get Library Items
|
||||
- [`libraryGetMediaMetaData`](docs/sdks/library/README.md#getmediametadata) - Get Media Metadata
|
||||
- [`libraryGetMetadataChildren`](docs/sdks/library/README.md#getmetadatachildren) - Get Items Children
|
||||
- [`libraryGetOnDeck`](docs/sdks/library/README.md#getondeck) - Get On Deck
|
||||
- [`libraryGetRecentlyAddedLibrary`](docs/sdks/library/README.md#getrecentlyaddedlibrary) - Get Recently Added
|
||||
- [`libraryGetRefreshLibraryMetadata`](docs/sdks/library/README.md#getrefreshlibrarymetadata) - Refresh Metadata Of The Library
|
||||
- [`libraryGetSearchAllLibraries`](docs/sdks/library/README.md#getsearchalllibraries) - Search All Libraries
|
||||
|
||||
42
RELEASES.md
42
RELEASES.md
@@ -1228,4 +1228,44 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.34.0] .
|
||||
### Releases
|
||||
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
|
||||
- [NPM v0.34.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.34.0 - .
|
||||
|
||||
## 2025-03-07 00:09:55
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.2 (2.545.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.0] .
|
||||
### Releases
|
||||
- [NPM v0.35.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.0 - .
|
||||
|
||||
## 2025-03-09 00:09:12
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.513.4 (2.545.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.1] .
|
||||
### Releases
|
||||
- [NPM v0.35.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.1 - .
|
||||
|
||||
## 2025-03-31 16:31:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.2] .
|
||||
### Releases
|
||||
- [NPM v0.35.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.2 - .
|
||||
|
||||
## 2025-03-31 19:33:46
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.526.6 (2.563.1) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.35.3] .
|
||||
### Releases
|
||||
- [NPM v0.35.3] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.35.3 - .
|
||||
340
codeSamples.yaml
340
codeSamples.yaml
@@ -6,8 +6,8 @@ actions:
|
||||
- target: $["paths"]["/"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerCapabilities
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -26,8 +26,8 @@ actions:
|
||||
- target: $["paths"]["/:/prefs"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerPreferences
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -46,8 +46,8 @@ actions:
|
||||
- target: $["paths"]["/:/progress"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: updatePlayProgress
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -66,8 +66,8 @@ actions:
|
||||
- target: $["paths"]["/:/scrobble"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: markPlayed
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -86,8 +86,8 @@ actions:
|
||||
- target: $["paths"]["/:/timeline"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTimeline
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { State } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -118,8 +118,8 @@ actions:
|
||||
- target: $["paths"]["/:/unscrobble"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: markUnplayed
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -138,8 +138,8 @@ actions:
|
||||
- target: $["paths"]["/activities"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerActivities
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -158,8 +158,8 @@ actions:
|
||||
- target: $["paths"]["/activities/{activityUUID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: cancelServerActivities
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -178,8 +178,8 @@ actions:
|
||||
- target: $["paths"]["/butler"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopAllTasks
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -198,8 +198,8 @@ actions:
|
||||
- target: $["paths"]["/butler"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getButlerTasks
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -218,8 +218,8 @@ actions:
|
||||
- target: $["paths"]["/butler"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startAllTasks
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -238,8 +238,8 @@ actions:
|
||||
- target: $["paths"]["/butler/{taskName}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopTask
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { PathParamTaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -259,8 +259,8 @@ actions:
|
||||
- target: $["paths"]["/butler/{taskName}"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startTask
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { TaskName } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -280,8 +280,8 @@ actions:
|
||||
- target: $["paths"]["/clients"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getAvailableClients
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -300,8 +300,8 @@ actions:
|
||||
- target: $["paths"]["/companions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getCompanionsData
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -320,8 +320,8 @@ actions:
|
||||
- target: $["paths"]["/devices"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getDevices
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -340,8 +340,8 @@ actions:
|
||||
- target: $["paths"]["/friends"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getUserFriends
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -360,8 +360,8 @@ actions:
|
||||
- target: $["paths"]["/geoip"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getGeoData
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -378,8 +378,8 @@ actions:
|
||||
- target: $["paths"]["/home"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getHomeData
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -398,8 +398,8 @@ actions:
|
||||
- target: $["paths"]["/hubs"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getGlobalHubs
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -418,8 +418,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/home/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: added
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Type } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -443,8 +443,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: performSearch
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -463,8 +463,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/search/voice"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: performVoiceSearch
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -483,8 +483,8 @@ actions:
|
||||
- target: $["paths"]["/hubs/sections/{sectionId}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getLibraryHubs
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -503,8 +503,8 @@ actions:
|
||||
- target: $["paths"]["/identity"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: identity
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -521,8 +521,8 @@ actions:
|
||||
- target: $["paths"]["/library/all/top"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTopWatchedContent
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetTopWatchedContentQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -542,8 +542,8 @@ actions:
|
||||
- target: $["paths"]["/library/hashes"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getFileHash
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -562,8 +562,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: data
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -597,8 +597,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/banner"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: image
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -624,8 +624,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/children"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getMetadataChildren
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -644,8 +644,8 @@ actions:
|
||||
- target: $["paths"]["/library/metadata/{ratingKey}/thumb"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: image
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -667,32 +667,12 @@ actions:
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/onDeck"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getOnDeck
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.getOnDeck();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
- target: $["paths"]["/library/recentlyAdded"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -730,8 +710,8 @@ actions:
|
||||
- target: $["paths"]["/library/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: libraries
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { SearchTypes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -757,8 +737,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: libraries
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -777,8 +757,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/watchlist/{filter}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: list
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -801,8 +781,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: deleteLibrary
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -821,8 +801,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: details
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -841,8 +821,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/actor"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetActorsLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -862,8 +842,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/all"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -886,8 +866,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/country"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetCountriesLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -907,8 +887,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/genre"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetGenresLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -928,8 +908,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/refresh"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: metadata
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -949,8 +929,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: library
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetSearchLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -970,8 +950,8 @@ actions:
|
||||
- target: $["paths"]["/library/sections/{sectionKey}/{tag}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: items
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetLibraryItemsQueryParamType, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -995,8 +975,8 @@ actions:
|
||||
- target: $["paths"]["/log"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: logLine
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Level } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1016,8 +996,8 @@ actions:
|
||||
- target: $["paths"]["/log"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: logMultiLine
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1038,8 +1018,8 @@ actions:
|
||||
- target: $["paths"]["/log/networked"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: enablePaperTrail
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1058,8 +1038,8 @@ actions:
|
||||
- target: $["paths"]["/media/providers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: providers
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1078,8 +1058,8 @@ actions:
|
||||
- target: $["paths"]["/myplex/account"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getMyPlexAccount
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1098,8 +1078,8 @@ actions:
|
||||
- target: $["paths"]["/photo/:/transcode"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getResizedPhoto
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { MinSize, Upscale } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1127,8 +1107,8 @@ actions:
|
||||
- target: $["paths"]["/pins"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPin
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1151,8 +1131,8 @@ actions:
|
||||
- target: $["paths"]["/pins/{pinID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTokenByPinId
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1176,8 +1156,8 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylists
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1196,8 +1176,8 @@ actions:
|
||||
- target: $["paths"]["/playlists"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: createPlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { CreatePlaylistQueryParamType, Smart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1222,8 +1202,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/upload"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: uploadPlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { QueryParamForce } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1243,8 +1223,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: deletePlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1263,8 +1243,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1283,8 +1263,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: updatePlaylist
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1303,8 +1283,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: clearPlaylistContents
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1323,8 +1303,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getPlaylistContents
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetPlaylistContentsQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1344,8 +1324,8 @@ actions:
|
||||
- target: $["paths"]["/playlists/{playlistID}/items"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: addPlaylistContents
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1364,8 +1344,8 @@ actions:
|
||||
- target: $["paths"]["/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: resources
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1384,8 +1364,8 @@ actions:
|
||||
- target: $["paths"]["/search"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSearchResults
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1404,8 +1384,8 @@ actions:
|
||||
- target: $["paths"]["/security/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSourceConnectionInformation
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1424,8 +1404,8 @@ actions:
|
||||
- target: $["paths"]["/security/token"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTransientToken
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { GetTransientTokenQueryParamType, Scope } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1445,8 +1425,8 @@ actions:
|
||||
- target: $["paths"]["/servers"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getServerList
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1465,8 +1445,8 @@ actions:
|
||||
- target: $["paths"]["/statistics/bandwidth"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getBandwidthStatistics
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1485,8 +1465,8 @@ actions:
|
||||
- target: $["paths"]["/statistics/media"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getStatistics
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1505,8 +1485,8 @@ actions:
|
||||
- target: $["paths"]["/statistics/resources"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getResourcesStatistics
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1525,8 +1505,8 @@ actions:
|
||||
- target: $["paths"]["/status/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSessions
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1545,8 +1525,8 @@ actions:
|
||||
- target: $["paths"]["/status/sessions/history/all"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getSessionHistory
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1565,8 +1545,8 @@ actions:
|
||||
- target: $["paths"]["/transcode/sessions"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTranscodeSessions
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1585,8 +1565,8 @@ actions:
|
||||
- target: $["paths"]["/transcode/sessions/{sessionKey}"]["delete"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: stopTranscodeSession
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1605,8 +1585,8 @@ actions:
|
||||
- target: $["paths"]["/updater/apply"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: applyUpdates
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Skip, Tonight } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1626,8 +1606,8 @@ actions:
|
||||
- target: $["paths"]["/updater/check"]["put"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: checkForUpdates
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { Download } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
@@ -1647,8 +1627,8 @@ actions:
|
||||
- target: $["paths"]["/updater/status"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getUpdateStatus
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1667,8 +1647,8 @@ actions:
|
||||
- target: $["paths"]["/user"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: getTokenDetails
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1687,8 +1667,8 @@ actions:
|
||||
- target: $["paths"]["/users"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: users
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1719,8 +1699,8 @@ actions:
|
||||
- target: $["paths"]["/users/signin"]["post"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: data
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
@@ -1748,8 +1728,8 @@ actions:
|
||||
- target: $["paths"]["/video/:/transcode/universal/start.mpd"]["get"]
|
||||
update:
|
||||
x-codeSamples:
|
||||
- lang: typescript
|
||||
label: startUniversalTranscode
|
||||
- lang: TypeScript
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetOnDeckBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckErrors](../../../sdk/models/errors/getondeckerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -1,21 +0,0 @@
|
||||
# GetOnDeckErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
@@ -1,21 +0,0 @@
|
||||
# GetOnDeckLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetOnDeckLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
@@ -1,18 +0,0 @@
|
||||
# GetOnDeckUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetOnDeckLibraryErrors](../../../sdk/models/errors/getondecklibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 3741.7,
|
||||
playlistID: 2776.28,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 302,
|
||||
statusCode: 307,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 428,
|
||||
statusCode: 208,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 765326,
|
||||
paymentMethodId: 903720,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 508,
|
||||
statusCode: 428,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 256.62,
|
||||
playlistID: 4246.85,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { Collection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Collection = {
|
||||
tag: "Working NL Subs",
|
||||
tag: "My Awesome Collection",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
@@ -1,17 +1,23 @@
|
||||
# Country
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Country } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Country = {
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| `filter` | *string* | :heavy_minus_sign: | N/A | country=19 |
|
||||
@@ -7,7 +7,7 @@ type of playlist to create
|
||||
```typescript
|
||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video;
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Photo,
|
||||
type: CreatePlaylistQueryParamType.Audio,
|
||||
smart: Smart.One,
|
||||
uri: "https://radiant-dividend.com/",
|
||||
uri: "https://ajar-reward.biz/",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 409,
|
||||
statusCode: 205,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeleteLibraryResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeleteLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 507,
|
||||
statusCode: 451,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 1856.36,
|
||||
playlistID: 6874.88,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 507,
|
||||
statusCode: 226,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { Director } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Director = {
|
||||
tag: "James Cameron",
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 304,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ Filter
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Filter = Filter.All;
|
||||
let value: Filter = Filter.Released;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -1,17 +1,23 @@
|
||||
# Genre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Genre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Genre = {
|
||||
tag: "Adventure",
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
@@ -7,7 +7,7 @@ import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetActorsLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 300,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetAllLibrariesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: GetAllLibrariesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 508,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryGenre = {
|
||||
tag: "United States of America",
|
||||
tag: "Crime",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
17
docs/sdk/models/operations/getallmedialibraryguids.md
Normal file
17
docs/sdk/models/operations/getallmedialibraryguids.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryGuids
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryGuids } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryGuids = {
|
||||
id: "tvdb://2337",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |
|
||||
@@ -63,6 +63,7 @@ let value: GetAllMediaLibraryMedia = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -74,6 +75,7 @@ let value: GetAllMediaLibraryMedia = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -112,8 +114,8 @@ let value: GetAllMediaLibraryMedia = {
|
||||
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `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 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | 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 |
|
||||
| `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :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 |
|
||||
| `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
| `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
@@ -210,6 +210,7 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -221,6 +222,7 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -242,7 +244,7 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
@@ -257,12 +259,12 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
|
||||
@@ -144,6 +144,7 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -155,6 +156,7 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -176,7 +178,7 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
@@ -191,12 +193,12 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -228,7 +230,7 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
| `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/> |
|
||||
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `year` | *number* | :heavy_check_mark: | The release year of the media item. | 2022 |
|
||||
| `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
@@ -278,5 +280,5 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
| `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.GetAllMediaLibraryGuids](../../../sdk/models/operations/getallmedialibraryguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.One`
|
||||
### `operations.OptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.One = One.One;
|
||||
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryOptimizedForStreaming1 =
|
||||
GetAllMediaLibraryOptimizedForStreaming1.Zero;
|
||||
GetAllMediaLibraryOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -44,6 +44,7 @@ let value: GetAllMediaLibraryPart = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -55,6 +56,7 @@ let value: GetAllMediaLibraryPart = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
|
||||
@@ -12,7 +12,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 300,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -217,6 +217,7 @@ let value: GetAllMediaLibraryResponse = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -228,6 +229,7 @@ let value: GetAllMediaLibraryResponse = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -249,7 +251,7 @@ let value: GetAllMediaLibraryResponse = {
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
@@ -264,12 +266,12 @@ let value: GetAllMediaLibraryResponse = {
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
|
||||
@@ -213,6 +213,7 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -224,6 +225,7 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -245,7 +247,7 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
@@ -260,12 +262,12 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Jamie P. Hanson",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
tag: "Teller",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
|
||||
@@ -6,12 +6,12 @@
|
||||
import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryRole = {
|
||||
tag: "Danny Boyle",
|
||||
tag: "Teller",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
@@ -29,6 +29,7 @@ let value: GetAllMediaLibraryStream = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -40,6 +41,7 @@ let value: GetAllMediaLibraryStream = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -66,9 +68,9 @@ let value: GetAllMediaLibraryStream = {
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
@@ -83,6 +85,7 @@ let value: GetAllMediaLibraryStream = {
|
||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
@@ -94,6 +97,7 @@ let value: GetAllMediaLibraryStream = {
|
||||
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scanType` | *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 |
|
||||
| `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) |
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryWriter = {
|
||||
tag: "Danny Boyle",
|
||||
tag: "Jamie P. Hanson",
|
||||
};
|
||||
```
|
||||
|
||||
@@ -14,4 +14,4 @@ let value: GetAllMediaLibraryWriter = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 424,
|
||||
statusCode: 205,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetCountriesLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 510,
|
||||
statusCode: 404,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetFileHashResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetFileHashResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 305,
|
||||
statusCode: 308,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetGenresLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 428,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetLibraryDetailsResponse } from "@lukehagar/plexjs/sdk/models/operatio
|
||||
|
||||
let value: GetLibraryDetailsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 308,
|
||||
statusCode: 103,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetLibraryHubsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryHubsRequest = {
|
||||
sectionId: 6063.93,
|
||||
sectionId: 2900.77,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetLibraryHubsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 412,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
# GetLibraryItemsEnableCreditsMarkerGeneration
|
||||
|
||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsEnableCreditsMarkerGeneration } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsEnableCreditsMarkerGeneration =
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
@@ -1,19 +0,0 @@
|
||||
# GetLibraryItemsEpisodeSort
|
||||
|
||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsEpisodeSort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsEpisodeSort = GetLibraryItemsEpisodeSort.OldestFirst;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
@@ -1,19 +0,0 @@
|
||||
# GetLibraryItemsFlattenSeasons
|
||||
|
||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsFlattenSeasons } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsFlattenSeasons = GetLibraryItemsFlattenSeasons.Show;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
@@ -7,13 +7,13 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsMediaContainer,
|
||||
GetLibraryItemsShowOrdering,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -106,11 +106,11 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
flattenSeasons: FlattenSeasons.Show,
|
||||
episodeSort: EpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# GetLibraryItemsMediaGuid
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsMediaGuid } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsMediaGuid = {
|
||||
id: "imdb://tt13015952",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||
@@ -4,13 +4,13 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsMetadata,
|
||||
GetLibraryItemsShowOrdering,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -34,11 +34,10 @@ let value: GetLibraryItemsMetadata = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
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",
|
||||
@@ -250,10 +249,10 @@ let value: GetLibraryItemsMetadata = {
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flattenSeasons` | [operations.GetLibraryItemsFlattenSeasons](../../../sdk/models/operations/getlibraryitemsflattenseasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||
| `episodeSort` | [operations.GetLibraryItemsEpisodeSort](../../../sdk/models/operations/getlibraryitemsepisodesort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||
| `enableCreditsMarkerGeneration` | [operations.GetLibraryItemsEnableCreditsMarkerGeneration](../../../sdk/models/operations/getlibraryitemsenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `showOrdering` | [operations.GetLibraryItemsShowOrdering](../../../sdk/models/operations/getlibraryitemsshowordering.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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
@@ -282,9 +281,9 @@ let value: GetLibraryItemsMetadata = {
|
||||
| `collection` | [operations.GetLibraryItemsCollection](../../../sdk/models/operations/getlibraryitemscollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetLibraryItemsRole](../../../sdk/models/operations/getlibraryitemsrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.GetLibraryItemsLocation](../../../sdk/models/operations/getlibraryitemslocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | [operations.GetLibraryItemsMediaGuid](../../../sdk/models/operations/getlibraryitemsmediaguid.md)[] | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `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/> | |
|
||||
| `ultraBlurColors` | [operations.GetLibraryItemsUltraBlurColors](../../../sdk/models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | [operations.GetLibraryItemsMetaDataRating](../../../sdk/models/operations/getlibraryitemsmetadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | [operations.MetaDataRating](../../../sdk/models/operations/metadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `image` | [operations.GetLibraryItemsImage](../../../sdk/models/operations/getlibraryitemsimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
# GetLibraryItemsMetaDataRating
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsMetaDataRating } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsMetaDataRating = {
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
type: "audience",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||
| `value` | *number* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetLibraryItemsQueryParamType, GetLibraryItemsRequest, Tag } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsRequest = {
|
||||
tag: Tag.Folder,
|
||||
tag: Tag.FirstCharacter,
|
||||
type: GetLibraryItemsQueryParamType.TvShow,
|
||||
sectionKey: 9518,
|
||||
};
|
||||
|
||||
@@ -4,19 +4,19 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsResponse,
|
||||
GetLibraryItemsShowOrdering,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetLibraryItemsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 451,
|
||||
statusCode: 102,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -110,11 +110,11 @@ let value: GetLibraryItemsResponse = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
flattenSeasons: FlattenSeasons.Show,
|
||||
episodeSort: EpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
|
||||
@@ -6,13 +6,13 @@ The contents of the library by section and tag
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration,
|
||||
GetLibraryItemsEpisodeSort,
|
||||
GetLibraryItemsFlattenSeasons,
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetLibraryItemsLibraryResponse200Type,
|
||||
GetLibraryItemsLibraryType,
|
||||
GetLibraryItemsResponseBody,
|
||||
GetLibraryItemsShowOrdering,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -106,11 +106,11 @@ let value: GetLibraryItemsResponseBody = {
|
||||
year: 2022,
|
||||
seasonCount: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
flattenSeasons: GetLibraryItemsFlattenSeasons.Show,
|
||||
episodeSort: GetLibraryItemsEpisodeSort.OldestFirst,
|
||||
flattenSeasons: FlattenSeasons.Show,
|
||||
episodeSort: EpisodeSort.OldestFirst,
|
||||
enableCreditsMarkerGeneration:
|
||||
GetLibraryItemsEnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: GetLibraryItemsShowOrdering.TvdbAbsolute,
|
||||
EnableCreditsMarkerGeneration.LibraryDefault,
|
||||
showOrdering: ShowOrdering.TvdbAbsolute,
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
banner: "/library/metadata/58683/banner/1703239236",
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
# GetLibraryItemsShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show.
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetLibraryItemsShowOrdering } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsShowOrdering =
|
||||
GetLibraryItemsShowOrdering.TvdbAbsolute;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `TvdbAired` | aired |
|
||||
| `TvdbDvd` | dvd |
|
||||
| `TvdbAbsolute` | absolute |
|
||||
@@ -5,11 +5,11 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetMediaMetaDataOptimizedForStreaming1`
|
||||
### `operations.GetMediaMetaDataOptimizedForStreamingLibrary1`
|
||||
|
||||
```typescript
|
||||
const value: operations.GetMediaMetaDataOptimizedForStreaming1 =
|
||||
GetMediaMetaDataOptimizedForStreaming1.One;
|
||||
const value: operations.GetMediaMetaDataOptimizedForStreamingLibrary1 =
|
||||
GetMediaMetaDataOptimizedForStreamingLibrary1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
@@ -63,6 +63,7 @@ let value: GetMediaMetaDataMedia = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -74,6 +75,7 @@ let value: GetMediaMetaDataMedia = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -112,8 +114,8 @@ let value: GetMediaMetaDataMedia = {
|
||||
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `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 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | 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 |
|
||||
| `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 |
|
||||
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
@@ -125,6 +125,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -136,6 +137,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
|
||||
@@ -115,6 +115,7 @@ let value: GetMediaMetaDataMetadata = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -126,6 +127,7 @@ let value: GetMediaMetaDataMetadata = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -305,6 +307,6 @@ let value: GetMediaMetaDataMetadata = {
|
||||
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | An array of Actor roles. | |
|
||||
| `director` | [operations.GetMediaMetaDataDirector](../../../sdk/models/operations/getmediametadatadirector.md)[] | :heavy_minus_sign: | An array of Director roles. | |
|
||||
| `writer` | [operations.GetMediaMetaDataWriter](../../../sdk/models/operations/getmediametadatawriter.md)[] | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `producer` | [operations.Producer](../../../sdk/models/operations/producer.md)[] | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `similar` | [operations.Similar](../../../sdk/models/operations/similar.md)[] | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `producer` | [operations.GetMediaMetaDataProducer](../../../sdk/models/operations/getmediametadataproducer.md)[] | :heavy_minus_sign: | An array of Writer roles. | |
|
||||
| `similar` | [operations.GetMediaMetaDataSimilar](../../../sdk/models/operations/getmediametadatasimilar.md)[] | :heavy_minus_sign: | An array of similar content objects. | |
|
||||
| `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | An array of location objects. | |
|
||||
@@ -5,10 +5,11 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.OptimizedForStreaming1`
|
||||
### `operations.GetMediaMetaDataOptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.Zero;
|
||||
const value: operations.GetMediaMetaDataOptimizedForStreaming1 =
|
||||
GetMediaMetaDataOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMediaMetaDataOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataOptimizedForStreaming1 =
|
||||
GetMediaMetaDataOptimizedForStreaming1.One;
|
||||
GetMediaMetaDataOptimizedForStreaming1.Zero;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetMediaMetaDataOptimizedForStreamingLibrary1
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataOptimizedForStreamingLibrary1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataOptimizedForStreamingLibrary1 =
|
||||
GetMediaMetaDataOptimizedForStreamingLibrary1.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -44,6 +44,7 @@ let value: GetMediaMetaDataPart = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -55,6 +56,7 @@ let value: GetMediaMetaDataPart = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
|
||||
28
docs/sdk/models/operations/getmediametadataproducer.md
Normal file
28
docs/sdk/models/operations/getmediametadataproducer.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# GetMediaMetaDataProducer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataProducer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataProducer = {
|
||||
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 |
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 226,
|
||||
statusCode: 306,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -132,6 +132,7 @@ let value: GetMediaMetaDataResponse = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -143,6 +144,7 @@ let value: GetMediaMetaDataResponse = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
|
||||
@@ -128,6 +128,7 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -139,6 +140,7 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
|
||||
21
docs/sdk/models/operations/getmediametadatasimilar.md
Normal file
21
docs/sdk/models/operations/getmediametadatasimilar.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataSimilar
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataSimilar } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataSimilar = {
|
||||
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 |
|
||||
@@ -29,6 +29,7 @@ let value: GetMediaMetaDataStream = {
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
@@ -40,6 +41,7 @@ let value: GetMediaMetaDataStream = {
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
@@ -66,9 +68,9 @@ let value: GetMediaMetaDataStream = {
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_check_mark: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `language` | *string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `headerCompression` | *boolean* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `doviblCompatID` | *number* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `doviblPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
@@ -83,6 +85,7 @@ let value: GetMediaMetaDataStream = {
|
||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `codedHeight` | *number* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `codedWidth` | *number* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closedCaptions` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `colorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `colorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
@@ -94,6 +97,7 @@ let value: GetMediaMetaDataStream = {
|
||||
| `hasScalingMatrix` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scanType` | *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 |
|
||||
| `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) |
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMetadataChildrenRequest = {
|
||||
ratingKey: 6139.66,
|
||||
ratingKey: 3119.45,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetMetadataChildrenResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 305,
|
||||
statusCode: 202,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# GetOnDeckGuids
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckGuids } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckGuids = {
|
||||
id: "imdb://tt13303712",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *string* | :heavy_minus_sign: | N/A | imdb://tt13303712 |
|
||||
@@ -1,82 +0,0 @@
|
||||
# GetOnDeckMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckMedia = {
|
||||
id: 80994,
|
||||
duration: 420080,
|
||||
bitrate: 1046,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "1080",
|
||||
container: "mkv",
|
||||
videoFrameRate: "PAL",
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main",
|
||||
part: [
|
||||
{
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 1046 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | N/A | 1.78 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | N/A | aac |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | N/A | PAL |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main |
|
||||
| `part` | [operations.GetOnDeckPart](../../../sdk/models/operations/getondeckpart.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,125 +0,0 @@
|
||||
# GetOnDeckMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckMediaContainer = {
|
||||
size: 16,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1680021154,
|
||||
metadata: [
|
||||
{
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Shows",
|
||||
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
|
||||
ratingKey: 49564,
|
||||
key: "/library/metadata/49564",
|
||||
parentRatingKey: 49557,
|
||||
grandparentRatingKey: 49556,
|
||||
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
|
||||
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
|
||||
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
|
||||
type: "episode",
|
||||
title: "Circus",
|
||||
grandparentKey: "/library/metadata/49556",
|
||||
parentKey: "/library/metadata/49557",
|
||||
librarySectionKey: "/library/sections/2",
|
||||
grandparentTitle: "Bluey (2018)",
|
||||
parentTitle: "Season 2",
|
||||
contentRating: "TV-Y",
|
||||
summary:
|
||||
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
|
||||
index: 33,
|
||||
parentIndex: 2,
|
||||
lastViewedAt: 1681908352,
|
||||
year: 2018,
|
||||
thumb: "/library/metadata/49564/thumb/1654258204",
|
||||
art: "/library/metadata/49556/art/1680939546",
|
||||
parentThumb: "/library/metadata/49557/thumb/1654258204",
|
||||
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
|
||||
grandparentArt: "/library/metadata/49556/art/1680939546",
|
||||
grandparentTheme: "/library/metadata/49556/theme/1680939546",
|
||||
duration: 420080,
|
||||
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
|
||||
addedAt: 1654258196,
|
||||
updatedAt: 1654258204,
|
||||
media: [
|
||||
{
|
||||
id: 80994,
|
||||
duration: 420080,
|
||||
bitrate: 1046,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "1080",
|
||||
container: "mkv",
|
||||
videoFrameRate: "PAL",
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main",
|
||||
part: [
|
||||
{
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "imdb://tt13303712",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 16 |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `mediaTagPrefix` | *string* | :heavy_minus_sign: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_minus_sign: | N/A | 1680021154 |
|
||||
| `mixedParents` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `metadata` | [operations.GetOnDeckMetadata](../../../sdk/models/operations/getondeckmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,146 +0,0 @@
|
||||
# GetOnDeckMetadata
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckMetadata = {
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Shows",
|
||||
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
|
||||
ratingKey: 49564,
|
||||
key: "/library/metadata/49564",
|
||||
parentRatingKey: 49557,
|
||||
grandparentRatingKey: 49556,
|
||||
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
|
||||
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
|
||||
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
|
||||
type: "episode",
|
||||
title: "Circus",
|
||||
grandparentKey: "/library/metadata/49556",
|
||||
parentKey: "/library/metadata/49557",
|
||||
librarySectionKey: "/library/sections/2",
|
||||
grandparentTitle: "Bluey (2018)",
|
||||
parentTitle: "Season 2",
|
||||
contentRating: "TV-Y",
|
||||
summary:
|
||||
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
|
||||
index: 33,
|
||||
parentIndex: 2,
|
||||
lastViewedAt: 1681908352,
|
||||
year: 2018,
|
||||
thumb: "/library/metadata/49564/thumb/1654258204",
|
||||
art: "/library/metadata/49556/art/1680939546",
|
||||
parentThumb: "/library/metadata/49557/thumb/1654258204",
|
||||
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
|
||||
grandparentArt: "/library/metadata/49556/art/1680939546",
|
||||
grandparentTheme: "/library/metadata/49556/theme/1680939546",
|
||||
duration: 420080,
|
||||
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
|
||||
addedAt: 1654258196,
|
||||
updatedAt: 1654258204,
|
||||
media: [
|
||||
{
|
||||
id: 80994,
|
||||
duration: 420080,
|
||||
bitrate: 1046,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "1080",
|
||||
container: "mkv",
|
||||
videoFrameRate: "PAL",
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main",
|
||||
part: [
|
||||
{
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "imdb://tt13303712",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | TV Shows |
|
||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 4bb2521c-8ba9-459b-aaee-8ab8bc35eabd |
|
||||
| `ratingKey` | *number* | :heavy_minus_sign: | N/A | 49564 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49564 |
|
||||
| `parentRatingKey` | *number* | :heavy_minus_sign: | N/A | 49557 |
|
||||
| `grandparentRatingKey` | *number* | :heavy_minus_sign: | N/A | 49556 |
|
||||
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://episode/5ea7d7402e7ab10042e74d4f |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://season/602e754d67f4c8002ce54b3d |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c090e705e7a001e6e94d8 |
|
||||
| `type` | *string* | :heavy_minus_sign: | N/A | episode |
|
||||
| `title` | *string* | :heavy_minus_sign: | N/A | Circus |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49557 |
|
||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Bluey (2018) |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Season 2 |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | TV-Y |
|
||||
| `summary` | *string* | :heavy_minus_sign: | N/A | Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy. |
|
||||
| `index` | *number* | :heavy_minus_sign: | N/A | 33 |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 2 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1681908352 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2018 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49564/thumb/1654258204 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49557/thumb/1654258204 |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/thumb/1680939546 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/art/1680939546 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/49556/theme/1680939546 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `originallyAvailableAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2020-10-31 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1654258196 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1654258204 |
|
||||
| `media` | [operations.GetOnDeckMedia](../../../sdk/models/operations/getondeckmedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.GetOnDeckGuids](../../../sdk/models/operations/getondeckguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,58 +0,0 @@
|
||||
# GetOnDeckPart
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckPart = {
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file: "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 80994 |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A | /library/parts/80994/1655007810/file.mkv |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 420080 |
|
||||
| `file` | *string* | :heavy_minus_sign: | N/A | /tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv |
|
||||
| `size` | *number* | :heavy_minus_sign: | N/A | 55148931 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | N/A | lc |
|
||||
| `container` | *string* | :heavy_minus_sign: | N/A | mkv |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | N/A | main |
|
||||
| `stream` | [operations.GetOnDeckStream](../../../sdk/models/operations/getondeckstream.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,132 +0,0 @@
|
||||
# GetOnDeckResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 202,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 16,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1680021154,
|
||||
metadata: [
|
||||
{
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Shows",
|
||||
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
|
||||
ratingKey: 49564,
|
||||
key: "/library/metadata/49564",
|
||||
parentRatingKey: 49557,
|
||||
grandparentRatingKey: 49556,
|
||||
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
|
||||
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
|
||||
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
|
||||
type: "episode",
|
||||
title: "Circus",
|
||||
grandparentKey: "/library/metadata/49556",
|
||||
parentKey: "/library/metadata/49557",
|
||||
librarySectionKey: "/library/sections/2",
|
||||
grandparentTitle: "Bluey (2018)",
|
||||
parentTitle: "Season 2",
|
||||
contentRating: "TV-Y",
|
||||
summary:
|
||||
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
|
||||
index: 33,
|
||||
parentIndex: 2,
|
||||
lastViewedAt: 1681908352,
|
||||
year: 2018,
|
||||
thumb: "/library/metadata/49564/thumb/1654258204",
|
||||
art: "/library/metadata/49556/art/1680939546",
|
||||
parentThumb: "/library/metadata/49557/thumb/1654258204",
|
||||
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
|
||||
grandparentArt: "/library/metadata/49556/art/1680939546",
|
||||
grandparentTheme: "/library/metadata/49556/theme/1680939546",
|
||||
duration: 420080,
|
||||
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
|
||||
addedAt: 1654258196,
|
||||
updatedAt: 1654258204,
|
||||
media: [
|
||||
{
|
||||
id: 80994,
|
||||
duration: 420080,
|
||||
bitrate: 1046,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "1080",
|
||||
container: "mkv",
|
||||
videoFrameRate: "PAL",
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main",
|
||||
part: [
|
||||
{
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file:
|
||||
"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "imdb://tt13303712",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetOnDeckResponseBody](../../../sdk/models/operations/getondeckresponsebody.md) | :heavy_minus_sign: | The on Deck content |
|
||||
@@ -1,124 +0,0 @@
|
||||
# GetOnDeckResponseBody
|
||||
|
||||
The on Deck content
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 16,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1680021154,
|
||||
metadata: [
|
||||
{
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Shows",
|
||||
librarySectionUUID: "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd",
|
||||
ratingKey: 49564,
|
||||
key: "/library/metadata/49564",
|
||||
parentRatingKey: 49557,
|
||||
grandparentRatingKey: 49556,
|
||||
guid: "plex://episode/5ea7d7402e7ab10042e74d4f",
|
||||
parentGuid: "plex://season/602e754d67f4c8002ce54b3d",
|
||||
grandparentGuid: "plex://show/5d9c090e705e7a001e6e94d8",
|
||||
type: "episode",
|
||||
title: "Circus",
|
||||
grandparentKey: "/library/metadata/49556",
|
||||
parentKey: "/library/metadata/49557",
|
||||
librarySectionKey: "/library/sections/2",
|
||||
grandparentTitle: "Bluey (2018)",
|
||||
parentTitle: "Season 2",
|
||||
contentRating: "TV-Y",
|
||||
summary:
|
||||
"Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.",
|
||||
index: 33,
|
||||
parentIndex: 2,
|
||||
lastViewedAt: 1681908352,
|
||||
year: 2018,
|
||||
thumb: "/library/metadata/49564/thumb/1654258204",
|
||||
art: "/library/metadata/49556/art/1680939546",
|
||||
parentThumb: "/library/metadata/49557/thumb/1654258204",
|
||||
grandparentThumb: "/library/metadata/49556/thumb/1680939546",
|
||||
grandparentArt: "/library/metadata/49556/art/1680939546",
|
||||
grandparentTheme: "/library/metadata/49556/theme/1680939546",
|
||||
duration: 420080,
|
||||
originallyAvailableAt: new Date("2020-10-31T00:00:00Z"),
|
||||
addedAt: 1654258196,
|
||||
updatedAt: 1654258204,
|
||||
media: [
|
||||
{
|
||||
id: 80994,
|
||||
duration: 420080,
|
||||
bitrate: 1046,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
aspectRatio: 1.78,
|
||||
audioChannels: 2,
|
||||
audioCodec: "aac",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "1080",
|
||||
container: "mkv",
|
||||
videoFrameRate: "PAL",
|
||||
audioProfile: "lc",
|
||||
videoProfile: "main",
|
||||
part: [
|
||||
{
|
||||
id: 80994,
|
||||
key: "/library/parts/80994/1655007810/file.mkv",
|
||||
duration: 420080,
|
||||
file:
|
||||
"/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv",
|
||||
size: 55148931,
|
||||
audioProfile: "lc",
|
||||
container: "mkv",
|
||||
videoProfile: "main",
|
||||
stream: [
|
||||
{
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "imdb://tt13303712",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetOnDeckMediaContainer](../../../sdk/models/operations/getondeckmediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -1,60 +0,0 @@
|
||||
# GetOnDeckStream
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetOnDeckStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckStream = {
|
||||
id: 211234,
|
||||
streamType: 1,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 918,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
bitDepth: 8,
|
||||
chromaLocation: "left",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1080,
|
||||
codedWidth: 1920,
|
||||
colorRange: "tv",
|
||||
frameRate: 25,
|
||||
height: 1080,
|
||||
level: 120,
|
||||
profile: "main",
|
||||
refFrames: 1,
|
||||
width: 1920,
|
||||
displayTitle: "1080p (HEVC Main)",
|
||||
extendedDisplayTitle: "1080p (HEVC Main)",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A | 211234 |
|
||||
| `streamType` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | N/A | |
|
||||
| `codec` | *string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `index` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | N/A | 918 |
|
||||
| `language` | *string* | :heavy_minus_sign: | N/A | English |
|
||||
| `languageTag` | *string* | :heavy_minus_sign: | N/A | en |
|
||||
| `languageCode` | *string* | :heavy_minus_sign: | N/A | eng |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | N/A | 8 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | N/A | left |
|
||||
| `chromaSubsampling` | *string* | :heavy_minus_sign: | N/A | 4:2:0 |
|
||||
| `codedHeight` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `codedWidth` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `colorRange` | *string* | :heavy_minus_sign: | N/A | tv |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | N/A | 25 |
|
||||
| `height` | *number* | :heavy_minus_sign: | N/A | 1080 |
|
||||
| `level` | *number* | :heavy_minus_sign: | N/A | 120 |
|
||||
| `profile` | *string* | :heavy_minus_sign: | N/A | main |
|
||||
| `refFrames` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `width` | *number* | :heavy_minus_sign: | N/A | 1920 |
|
||||
| `displayTitle` | *string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_minus_sign: | N/A | 1080p (HEVC Main) |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistContentsRequest = {
|
||||
playlistID: 2539.41,
|
||||
playlistID: 5182.01,
|
||||
type: GetPlaylistContentsQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 205,
|
||||
statusCode: 100,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistRequest = {
|
||||
playlistID: 8726.51,
|
||||
playlistID: 7980.47,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 207,
|
||||
statusCode: 103,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 506,
|
||||
statusCode: 503,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetRecentlyAddedLibraryResponse } from "@lukehagar/plexjs/sdk/models/op
|
||||
|
||||
let value: GetRecentlyAddedLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 418,
|
||||
statusCode: 204,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -4,20 +4,18 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedMediaContainer,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetRecentlyAddedMediaContainer = {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
@@ -70,172 +68,76 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
},
|
||||
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: GetRecentlyAddedHubsType.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,
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
audienceRating: 9.2,
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
childCount: 1,
|
||||
contentRating: "PG-13",
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
duration: 11558112,
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTitle: "Caprica",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
index: 1,
|
||||
key: "/library/metadata/58683",
|
||||
lastRatedAt: 1721813113,
|
||||
lastViewedAt: 1682752242,
|
||||
leafCount: 14,
|
||||
librarySectionID: 1,
|
||||
librarySectionKey: "/library/sections/1",
|
||||
librarySectionTitle: "Movies",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentIndex: 1,
|
||||
parentKey: "/library/metadata/66",
|
||||
parentRatingKey: "66",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
parentStudio: "UCP",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentYear: 2010,
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
ratingKey: "58683",
|
||||
rating: 7.6,
|
||||
seasonCount: 2022,
|
||||
skipCount: 1,
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
subtype: "clip",
|
||||
summary:
|
||||
"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"
|
||||
+ "",
|
||||
tagline: "Return to Pandora.",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
titleSort: "Whale",
|
||||
title: "Avatar: The Way of Water",
|
||||
type: GetRecentlyAddedHubsType.Movie,
|
||||
updatedAt: 1556281940,
|
||||
userRating: 10,
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
viewedLeafCount: 0,
|
||||
year: 2022,
|
||||
image: [
|
||||
{
|
||||
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,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
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,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
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",
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
@@ -244,42 +146,174 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
media: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
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,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "writer=126522",
|
||||
tag: "Jamie P. Hanson",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "actor=126522",
|
||||
tag: "Teller",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
role: "Self - Judge",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "producer=126522",
|
||||
tag: "Amelia Knapp",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
rating1: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 5.1,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
similar: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
id: 259,
|
||||
filter: "similar=259",
|
||||
tag: "Criss Angel Mindfreak",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/Clarkson's Farm",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
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",
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -289,10 +323,10 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |
|
||||
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `totalSize` | *number* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `offset` | *number* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `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 |
|
||||
| `meta` | [operations.Meta](../../../sdk/models/operations/meta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
| `metadata` | [operations.GetRecentlyAddedMetadata](../../../sdk/models/operations/getrecentlyaddedmetadata.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `metadata` | [operations.GetRecentlyAddedMetadata](../../../sdk/models/operations/getrecentlyaddedmetadata.md)[] | :heavy_minus_sign: | An array of metadata items. | |
|
||||
@@ -1,185 +1,89 @@
|
||||
# GetRecentlyAddedMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedMetadata,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetRecentlyAddedMetadata = {
|
||||
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: GetRecentlyAddedHubsType.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,
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
audienceRating: 9.2,
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
childCount: 1,
|
||||
contentRating: "PG-13",
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
duration: 11558112,
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTitle: "Caprica",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
index: 1,
|
||||
key: "/library/metadata/58683",
|
||||
lastRatedAt: 1721813113,
|
||||
lastViewedAt: 1682752242,
|
||||
leafCount: 14,
|
||||
librarySectionID: 1,
|
||||
librarySectionKey: "/library/sections/1",
|
||||
librarySectionTitle: "Movies",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentIndex: 1,
|
||||
parentKey: "/library/metadata/66",
|
||||
parentRatingKey: "66",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
parentStudio: "UCP",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentYear: 2010,
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
ratingKey: "58683",
|
||||
rating: 7.6,
|
||||
seasonCount: 2022,
|
||||
skipCount: 1,
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
subtype: "clip",
|
||||
summary:
|
||||
"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"
|
||||
+ "",
|
||||
tagline: "Return to Pandora.",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
titleSort: "Whale",
|
||||
title: "Avatar: The Way of Water",
|
||||
type: GetRecentlyAddedHubsType.Movie,
|
||||
updatedAt: 1556281940,
|
||||
userRating: 10,
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
viewedLeafCount: 0,
|
||||
year: 2022,
|
||||
image: [
|
||||
{
|
||||
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,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
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,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
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",
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
@@ -188,122 +92,253 @@ let value: GetRecentlyAddedMetadata = {
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
media: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
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,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "writer=126522",
|
||||
tag: "Jamie P. Hanson",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "actor=126522",
|
||||
tag: "Teller",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
role: "Self - Judge",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "producer=126522",
|
||||
tag: "Amelia Knapp",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
rating1: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 5.1,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
similar: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
id: 259,
|
||||
filter: "similar=259",
|
||||
tag: "Criss Angel Mindfreak",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/Clarkson's Farm",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
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",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skipChildren` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `type` | [operations.GetRecentlyAddedHubsType](../../../sdk/models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | The type of media content<br/> | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `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. |
|
||||
| `rating` | *number* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `seasonCount` | *number* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | [operations.Media](../../../sdk/models/operations/media.md)[] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | [operations.Genre](../../../sdk/models/operations/genre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.Country](../../../sdk/models/operations/country.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.Director](../../../sdk/models/operations/director.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.Writer](../../../sdk/models/operations/writer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.Collection](../../../sdk/models/operations/collection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.Role](../../../sdk/models/operations/role.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `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/> | |
|
||||
| `ultraBlurColors` | [operations.UltraBlurColors](../../../sdk/models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | [operations.MetaDataRating](../../../sdk/models/operations/metadatarating.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `image` | [operations.GetRecentlyAddedImage](../../../sdk/models/operations/getrecentlyaddedimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `childCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentStudio` | *string* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentYear` | *number* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTheme` | *string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `lastRatedAt` | *number* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `parentSlug` | *string* | :heavy_minus_sign: | The slug for the parent media item. | alice-in-borderland-2020 |
|
||||
| `parentStudio` | *string* | :heavy_check_mark: | The studio of the parent media item. | UCP |
|
||||
| `parentTheme` | *string* | :heavy_check_mark: | The theme URL for the parent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parentYear` | *number* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `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 |
|
||||
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||||
| `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 |
|
||||
| `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/> |
|
||||
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `type` | [operations.GetRecentlyAddedHubsType](../../../sdk/models/operations/getrecentlyaddedhubstype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `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: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *number* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `image` | [operations.GetRecentlyAddedImage](../../../sdk/models/operations/getrecentlyaddedimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [operations.UltraBlurColors](../../../sdk/models/operations/ultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `media` | [operations.Media](../../../sdk/models/operations/media.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [operations.Genre](../../../sdk/models/operations/genre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.Country](../../../sdk/models/operations/country.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.Director](../../../sdk/models/operations/director.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.Writer](../../../sdk/models/operations/writer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.Role](../../../sdk/models/operations/role.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | [operations.Producer](../../../sdk/models/operations/producer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `rating1` | [operations.Rating](../../../sdk/models/operations/rating.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | [operations.Similar](../../../sdk/models/operations/similar.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.Location](../../../sdk/models/operations/location.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.Collection](../../../sdk/models/operations/collection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetRecentlyAddedOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetRecentlyAddedOptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.GetRecentlyAddedOptimizedForStreaming1 =
|
||||
GetRecentlyAddedOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetRecentlyAddedOptimizedForStreaming1
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetRecentlyAddedOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedOptimizedForStreaming1 =
|
||||
GetRecentlyAddedOptimizedForStreaming1.Zero;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -4,27 +4,25 @@
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedResponse,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetRecentlyAddedResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 507,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
@@ -77,172 +75,76 @@ let value: GetRecentlyAddedResponse = {
|
||||
},
|
||||
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: GetRecentlyAddedHubsType.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,
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
audienceRating: 9.2,
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
childCount: 1,
|
||||
contentRating: "PG-13",
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
duration: 11558112,
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTitle: "Caprica",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
index: 1,
|
||||
key: "/library/metadata/58683",
|
||||
lastRatedAt: 1721813113,
|
||||
lastViewedAt: 1682752242,
|
||||
leafCount: 14,
|
||||
librarySectionID: 1,
|
||||
librarySectionKey: "/library/sections/1",
|
||||
librarySectionTitle: "Movies",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentIndex: 1,
|
||||
parentKey: "/library/metadata/66",
|
||||
parentRatingKey: "66",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
parentStudio: "UCP",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentYear: 2010,
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
ratingKey: "58683",
|
||||
rating: 7.6,
|
||||
seasonCount: 2022,
|
||||
skipCount: 1,
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
subtype: "clip",
|
||||
summary:
|
||||
"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"
|
||||
+ "",
|
||||
tagline: "Return to Pandora.",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
titleSort: "Whale",
|
||||
title: "Avatar: The Way of Water",
|
||||
type: GetRecentlyAddedHubsType.Movie,
|
||||
updatedAt: 1556281940,
|
||||
userRating: 10,
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
viewedLeafCount: 0,
|
||||
year: 2022,
|
||||
image: [
|
||||
{
|
||||
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,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
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,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
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",
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
@@ -251,42 +153,174 @@ let value: GetRecentlyAddedResponse = {
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
media: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
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,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "writer=126522",
|
||||
tag: "Jamie P. Hanson",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "actor=126522",
|
||||
tag: "Teller",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
role: "Self - Judge",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "producer=126522",
|
||||
tag: "Amelia Knapp",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
rating1: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 5.1,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
similar: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
id: 259,
|
||||
filter: "similar=259",
|
||||
tag: "Criss Angel Mindfreak",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/Clarkson's Farm",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
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",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -6,21 +6,19 @@ A successful response with recently added content.
|
||||
|
||||
```typescript
|
||||
import {
|
||||
EnableCreditsMarkerGeneration,
|
||||
EpisodeSort,
|
||||
FlattenSeasons,
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedResponseBody,
|
||||
ShowOrdering,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetRecentlyAddedResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
@@ -73,172 +71,76 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
},
|
||||
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: GetRecentlyAddedHubsType.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,
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
audienceRating: 9.2,
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
grandparentRatingKey: "66",
|
||||
childCount: 1,
|
||||
contentRating: "PG-13",
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
duration: 11558112,
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
grandparentRatingKey: "66",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
media: [
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTitle: "Caprica",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
index: 1,
|
||||
key: "/library/metadata/58683",
|
||||
lastRatedAt: 1721813113,
|
||||
lastViewedAt: 1682752242,
|
||||
leafCount: 14,
|
||||
librarySectionID: 1,
|
||||
librarySectionKey: "/library/sections/1",
|
||||
librarySectionTitle: "Movies",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
parentIndex: 1,
|
||||
parentKey: "/library/metadata/66",
|
||||
parentRatingKey: "66",
|
||||
parentSlug: "alice-in-borderland-2020",
|
||||
parentStudio: "UCP",
|
||||
parentTheme: "/library/metadata/66/theme/1705716261",
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentYear: 2010,
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
ratingKey: "58683",
|
||||
rating: 7.6,
|
||||
seasonCount: 2022,
|
||||
skipCount: 1,
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
subtype: "clip",
|
||||
summary:
|
||||
"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"
|
||||
+ "",
|
||||
tagline: "Return to Pandora.",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
titleSort: "Whale",
|
||||
title: "Avatar: The Way of Water",
|
||||
type: GetRecentlyAddedHubsType.Movie,
|
||||
updatedAt: 1556281940,
|
||||
userRating: 10,
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
viewedLeafCount: 0,
|
||||
year: 2022,
|
||||
image: [
|
||||
{
|
||||
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,
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
id: 119542,
|
||||
key: "/library/parts/119542/1680457526/file.mkv",
|
||||
duration: 11558112,
|
||||
file:
|
||||
"/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
size: 36158371307,
|
||||
container: "mkv",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
optimizedForStreaming: false,
|
||||
videoProfile: "main 10",
|
||||
indexes: "sd",
|
||||
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,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
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",
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
@@ -247,42 +149,174 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
metaDataRating: [
|
||||
media: [
|
||||
{
|
||||
image: "themoviedb://image.rating",
|
||||
value: 3,
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
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,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
closedCaptions: true,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
embeddedInVideo: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
id: 259,
|
||||
filter: "genre=19",
|
||||
tag: "Crime",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "writer=126522",
|
||||
tag: "Jamie P. Hanson",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "actor=126522",
|
||||
tag: "Teller",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
role: "Self - Judge",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 126522,
|
||||
filter: "producer=126522",
|
||||
tag: "Amelia Knapp",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
rating1: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 5.1,
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
image: [
|
||||
similar: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetRecentlyAddedHubsResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
id: 259,
|
||||
filter: "similar=259",
|
||||
tag: "Criss Angel Mindfreak",
|
||||
},
|
||||
],
|
||||
location: [
|
||||
{
|
||||
path: "/TV Shows/Clarkson's Farm",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
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",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { Force, GetRefreshLibraryMetadataRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRefreshLibraryMetadataRequest = {
|
||||
force: Force.One,
|
||||
force: Force.Zero,
|
||||
sectionKey: 9518,
|
||||
};
|
||||
```
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user