mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-07 12:37:45 +00:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
891a7d39a1 | ||
|
|
763aa8e800 | ||
|
|
7a950ea773 |
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,3 +1,7 @@
|
||||
.DS_Store
|
||||
**/.speakeasy/temp/
|
||||
**/.speakeasy/logs/
|
||||
.DS_Store
|
||||
/mcp-server
|
||||
/bin
|
||||
/.eslintcache
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -11,11 +11,12 @@ generation:
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
securityFeb2025: false
|
||||
sharedErrorComponentsApr2025: false
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: false
|
||||
typescript:
|
||||
version: 0.36.1
|
||||
version: 0.37.1
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.529.1
|
||||
speakeasyVersion: 1.541.2
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,20 +9,20 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
|
||||
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
|
||||
sourceRevisionDigest: sha256:31ab7b2e65ccf1e0349bcd8b35791d1ce80091313481874749163fc0c80fd8ed
|
||||
sourceBlobDigest: sha256:d971fff9723c626fe70403a2a83d813c396a20b06ccd6b899263762038cfdbb0
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1743898297
|
||||
- speakeasy-sdk-regen-1746058355
|
||||
- 0.0.3
|
||||
targets:
|
||||
plexjs:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:ea508e3da23b283f47aeb4384d6b3ab374a27bdffb8d8d8376cedbad3ad77a06
|
||||
sourceBlobDigest: sha256:c210adbd02b0213b9e6f95ffc27f60ec38f8f9040137d55ccf2b650d92ab0ff5
|
||||
sourceRevisionDigest: sha256:31ab7b2e65ccf1e0349bcd8b35791d1ce80091313481874749163fc0c80fd8ed
|
||||
sourceBlobDigest: sha256:d971fff9723c626fe70403a2a83d813c396a20b06ccd6b899263762038cfdbb0
|
||||
codeSamplesNamespace: code-samples-typescript-plexjs
|
||||
codeSamplesRevisionDigest: sha256:871b7aa4b65bfb8932c4593238410f8f50b425e8039c1edd716be8b5f253ef9a
|
||||
codeSamplesRevisionDigest: sha256:a91f578e701b7e8f5859b16094a73f590cbbec59c3b81c7f8baeafbef0f3a47e
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
@@ -629,6 +629,7 @@ Certain SDK methods accept files as part of a multi-part request. It is possible
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { openAsBlob } from "node:fs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
@@ -637,6 +638,7 @@ const plexAPI = new PlexAPI({
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaArts(
|
||||
2268,
|
||||
await openAsBlob("example.file"),
|
||||
"https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b",
|
||||
);
|
||||
|
||||
|
||||
32
RELEASES.md
32
RELEASES.md
@@ -1298,4 +1298,34 @@ Based on:
|
||||
### Generated
|
||||
- [typescript v0.36.1] .
|
||||
### Releases
|
||||
- [NPM v0.36.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.1 - .
|
||||
- [NPM v0.36.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.1 - .
|
||||
|
||||
## 2025-04-14 00:11:23
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.531.4 (2.570.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.36.2] .
|
||||
### Releases
|
||||
- [NPM v0.36.2] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.36.2 - .
|
||||
|
||||
## 2025-04-19 00:10:19
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.535.1 (2.585.2) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.37.0] .
|
||||
### Releases
|
||||
- [NPM v0.37.0] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.0 - .
|
||||
|
||||
## 2025-05-01 00:12:16
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.541.2 (2.595.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [typescript v0.37.1] .
|
||||
### Releases
|
||||
- [NPM v0.37.1] https://www.npmjs.com/package/@lukehagar/plexjs/v/0.37.1 - .
|
||||
@@ -621,13 +621,14 @@ actions:
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { openAsBlob } from "node:fs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaArts(2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
const result = await plexAPI.library.postMediaArts(2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -708,13 +709,14 @@ actions:
|
||||
label: PlexJS
|
||||
source: |-
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { openAsBlob } from "node:fs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaPoster(2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
const result = await plexAPI.library.postMediaPoster(2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
|
||||
21
docs/sdk/models/operations/attributes.md
Normal file
21
docs/sdk/models/operations/attributes.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Attributes
|
||||
|
||||
Attributes associated with the marker.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Attributes } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Attributes = {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||
| `version` | *number* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||
29
docs/sdk/models/operations/chapter.md
Normal file
29
docs/sdk/models/operations/chapter.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Chapter
|
||||
|
||||
The thumbnail for the chapter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Chapter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Chapter = {
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 4 |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | thumb=4 |
|
||||
| `index` | *number* | :heavy_check_mark: | N/A | 1 |
|
||||
| `startTimeOffset` | *number* | :heavy_check_mark: | N/A | 0 |
|
||||
| `endTimeOffset` | *number* | :heavy_check_mark: | N/A | 100100 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||
@@ -12,8 +12,11 @@ let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Photo;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,7 +13,10 @@ let value: EnableCreditsMarkerGeneration =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -12,8 +12,11 @@ let value: EpisodeSort = EpisodeSort.OldestFirst;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
| - | `Unrecognized<string>` |
|
||||
17
docs/sdk/models/operations/extras.md
Normal file
17
docs/sdk/models/operations/extras.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Extras
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Extras } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Extras = {
|
||||
size: 1,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||
| `size` | *number* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||
@@ -12,8 +12,11 @@ let value: Filter = Filter.Available;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `All` | all |
|
||||
| `Available` | available |
|
||||
| `Released` | released |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `All` | all |
|
||||
| `Available` | available |
|
||||
| `Released` | released |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -12,8 +12,11 @@ let value: FlattenSeasons = FlattenSeasons.Show;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -19,12 +19,15 @@ let value: GetActorsLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -36,26 +36,26 @@ let value: GetAllLibrariesDirectory = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | The number of seconds since the content was last changed relative to now. | 9173960 |
|
||||
| `hidden` | [operations.Hidden](../../../sdk/models/operations/hidden.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `composite` | *string* | :heavy_check_mark: | The relative path to the composite media item. | /library/sections/1/composite/1743824484 |
|
||||
| `filters` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `refreshing` | *boolean* | :heavy_check_mark: | Indicates whether the library is currently being refreshed or updated | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `key` | *string* | :heavy_check_mark: | The library key representing the unique identifier | 1 |
|
||||
| `type` | [operations.GetAllLibrariesType](../../../sdk/models/operations/getalllibrariestype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the library | Movies |
|
||||
| `agent` | *string* | :heavy_check_mark: | The Plex agent used to match and retrieve media metadata. | tv.plex.agents.movie |
|
||||
| `scanner` | *string* | :heavy_check_mark: | UNKNOWN | Plex Movie |
|
||||
| `language` | *string* | :heavy_check_mark: | The Plex library language that has been set | en-US |
|
||||
| `uuid` | *string* | :heavy_check_mark: | The universally unique identifier for the library. | e69655a2-ef48-4aba-bb19-01e7d3cc34d6 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `createdAt` | *number* | :heavy_minus_sign: | N/A | 1556281940 |
|
||||
| `scannedAt` | *number* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `content` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `directory` | *boolean* | :heavy_check_mark: | UNKNOWN | true |
|
||||
| `contentChangedAt` | *number* | :heavy_check_mark: | Timestamp (in seconds) representing the last time the content was modified.<br/>NOTE: Some Plex server have some absurd values for this field, like 8457612157633039800 so it should be int64<br/> | 9173960 |
|
||||
| `hidden` | [operations.Hidden](../../../sdk/models/operations/hidden.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `location` | [operations.GetAllLibrariesLocation](../../../sdk/models/operations/getalllibrarieslocation.md)[] | :heavy_check_mark: | N/A | |
|
||||
@@ -12,11 +12,14 @@ let value: GetAllLibrariesType = GetAllLibrariesType.Movie;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -11,9 +11,12 @@ let value: GetAllMediaLibraryLibraryResponseType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,11 +13,14 @@ let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.Movie;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllMediaLibraryMedia, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMedia = {
|
||||
id: 387322,
|
||||
@@ -41,7 +41,8 @@ let value: GetAllMediaLibraryMedia = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -69,6 +70,7 @@ let value: GetAllMediaLibraryMedia = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMediaContainer,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -188,7 +189,8 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -216,6 +218,7 @@ let value: GetAllMediaLibraryMediaContainer = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -10,6 +10,7 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMetadata,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -122,7 +123,8 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -150,6 +152,7 @@ let value: GetAllMediaLibraryMetadata = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllMediaLibraryPart, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryPart = {
|
||||
accessible: true,
|
||||
@@ -22,7 +22,8 @@ let value: GetAllMediaLibraryPart = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -50,6 +51,7 @@ let value: GetAllMediaLibraryPart = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -19,12 +19,15 @@ let value: GetAllMediaLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponse,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -195,7 +196,8 @@ let value: GetAllMediaLibraryResponse = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -223,6 +225,7 @@ let value: GetAllMediaLibraryResponse = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -9,6 +9,7 @@ import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponseBody,
|
||||
GetAllMediaLibraryStreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -191,7 +192,8 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -219,6 +221,7 @@ let value: GetAllMediaLibraryResponseBody = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,11 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetAllMediaLibraryStream, GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryStream = {
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetAllMediaLibraryStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -35,6 +36,7 @@ let value: GetAllMediaLibraryStream = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -60,54 +62,56 @@ let value: GetAllMediaLibraryStream = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | *number* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `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_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 |
|
||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `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 |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `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) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | [operations.GetAllMediaLibraryStreamType](../../../sdk/models/operations/getallmedialibrarystreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `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 |
|
||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `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 |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `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) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
26
docs/sdk/models/operations/getallmedialibrarystreamtype.md
Normal file
26
docs/sdk/models/operations/getallmedialibrarystreamtype.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetAllMediaLibraryStreamType
|
||||
|
||||
Stream type:
|
||||
- 1 = video
|
||||
- 2 = audio
|
||||
- 3 = subtitle
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryStreamType = GetAllMediaLibraryStreamType.Video;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Video` | 1 |
|
||||
| `Audio` | 2 |
|
||||
| `Subtitle` | 3 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -19,12 +19,15 @@ let value: GetCountriesLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -19,12 +19,15 @@ let value: GetGenresLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -12,7 +12,7 @@ let value: GetLibraryDetailsRequest = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `includeDetails` | [operations.IncludeDetails](../../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
|
||||
@@ -11,9 +11,12 @@ let value: GetLibraryItemsLibraryResponse200Type =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,11 +13,14 @@ let value: GetLibraryItemsLibraryType = GetLibraryItemsLibraryType.Movie;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -18,12 +18,15 @@ let value: GetLibraryItemsQueryParamType = GetLibraryItemsQueryParamType.TvShow;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -1,21 +1,23 @@
|
||||
# GetMediaMetaDataCountry
|
||||
|
||||
The filter query string for country media items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataCountry = {
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique country identifier. | 58591 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country name. | 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 |
|
||||
@@ -6,23 +6,21 @@
|
||||
import { GetMediaMetaDataDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataDirector = {
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this director. | director=235876 |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | A unique key associated with the director's tag, used for internal identification. | 5d776831151a60001f24d031 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
@@ -1,21 +1,23 @@
|
||||
# GetMediaMetaDataGenre
|
||||
|
||||
The filter query string for similar items.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataGenre = {
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | The unique genre identifier. | 1057 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the genre. | genre=1057 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name. | Crime |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre=19 |
|
||||
@@ -3,19 +3,19 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataImage } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataImage, GetMediaMetaDataLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataImage = {
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | Alternate text for the image. | Better Call Saul |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of image (e.g., coverPoster, background, clearLogo). | coverPoster |
|
||||
| `url` | *string* | :heavy_check_mark: | The URL of the image. | /library/metadata/44288/thumb/1736487993 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetMediaMetaDataLibraryType](../../../sdk/models/operations/getmediametadatalibrarytype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
21
docs/sdk/models/operations/getmediametadatalibrarytype.md
Normal file
21
docs/sdk/models/operations/getmediametadatalibrarytype.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetMediaMetaDataLibraryType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataLibraryType = GetMediaMetaDataLibraryType.Background;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataMedia, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataMedia = {
|
||||
id: 387322,
|
||||
@@ -41,7 +41,8 @@ let value: GetMediaMetaDataMedia = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -69,6 +70,7 @@ let value: GetMediaMetaDataMedia = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,7 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataMediaContainer } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataMediaContainer,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataMediaContainer = {
|
||||
@@ -17,55 +22,80 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
mediaTagVersion: 1734362201,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -103,7 +133,8 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -131,6 +162,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -157,31 +189,60 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -196,50 +257,6 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -252,6 +269,32 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
@@ -1,61 +1,94 @@
|
||||
# GetMediaMetaDataMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataMetadata,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataMetadata = {
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -93,7 +126,8 @@ let value: GetMediaMetaDataMetadata = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -121,6 +155,7 @@ let value: GetMediaMetaDataMetadata = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -147,31 +182,60 @@ let value: GetMediaMetaDataMetadata = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -186,50 +250,6 @@ let value: GetMediaMetaDataMetadata = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -242,71 +262,109 @@ let value: GetMediaMetaDataMetadata = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key of the metadata item. | 44288 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent of this metadata item. | 48047 |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent of this metadata item. | 45520 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | A GUID identifying the parent entity (e.g., season) for the item. | plex://season/618b89208dde18df707ad15c |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | A GUID identifying the grandparent entity (e.g., show). | plex://show/5e16253691c20300412003a8 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | A URL-friendly identifier (slug) for the grandparent entity. | alice-in-borderland-2020 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | A key identifying the grandparent metadata in the library. | /library/metadata/45520 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | A key identifying the parent metadata in the library. | /library/metadata/48047 |
|
||||
| `key` | *string* | :heavy_check_mark: | The API key to access metadata details. | /library/metadata/44288/children |
|
||||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the item. | plex://show/5d9c08254eefaa001f5d6dcb |
|
||||
| `slug` | *string* | :heavy_minus_sign: | A URL-friendly identifier for the item. | better-call-saul |
|
||||
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the content. | Sony Pictures Television |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of content (e.g., show, movie). | show |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the content. | Better Call Saul |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the content. | Wicked: Part I |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The ID of the library section. | 2 |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
|
||||
| `summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
|
||||
| `index` | *number* | :heavy_minus_sign: | The index or order of the item. | 1 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
|
||||
| `audienceRating` | *number* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
|
||||
| `viewCount` | *number* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
|
||||
| `year` | *number* | :heavy_check_mark: | The release year. | 2015 |
|
||||
| `rating` | *number* | :heavy_minus_sign: | The general rating | 6 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
|
||||
| `tagline` | *string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
|
||||
| `art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
|
||||
| `theme` | *string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
|
||||
| `duration` | *number* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
|
||||
| `childCount` | *number* | :heavy_minus_sign: | The number of child items. | 6 |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | The URL of the grandparent's art image. | /library/metadata/45520/art/1736488003 |
|
||||
| `media` | [operations.GetMediaMetaDataMedia](../../../sdk/models/operations/getmediametadatamedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `image` | [operations.GetMediaMetaDataImage](../../../sdk/models/operations/getmediametadataimage.md)[] | :heavy_check_mark: | An array of image objects. | |
|
||||
| `ultraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../../sdk/models/operations/getmediametadataultrablurcolors.md) | :heavy_check_mark: | N/A | |
|
||||
| `genre` | [operations.GetMediaMetaDataGenre](../../../sdk/models/operations/getmediametadatagenre.md)[] | :heavy_minus_sign: | An array of genre tags. | |
|
||||
| `country` | [operations.GetMediaMetaDataCountry](../../../sdk/models/operations/getmediametadatacountry.md)[] | :heavy_minus_sign: | An array of country tags. | |
|
||||
| `guids` | [operations.GetMediaMetaDataGuids](../../../sdk/models/operations/getmediametadataguids.md)[] | :heavy_minus_sign: | An array of GUID objects. | |
|
||||
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | An array of rating objects. | |
|
||||
| `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.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. | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
|
||||
| `key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `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 |
|
||||
| `type` | [operations.GetMediaMetaDataType](../../../sdk/models/operations/getmediametadatatype.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `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_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 |
|
||||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `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 |
|
||||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `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 |
|
||||
| `lastRatedAt` | *number* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `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 |
|
||||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | [operations.GetMediaMetaDataImage](../../../sdk/models/operations/getmediametadataimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [operations.GetMediaMetaDataUltraBlurColors](../../../sdk/models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `media` | [operations.GetMediaMetaDataMedia](../../../sdk/models/operations/getmediametadatamedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [operations.GetMediaMetaDataGenre](../../../sdk/models/operations/getmediametadatagenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetMediaMetaDataCountry](../../../sdk/models/operations/getmediametadatacountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetMediaMetaDataDirector](../../../sdk/models/operations/getmediametadatadirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetMediaMetaDataWriter](../../../sdk/models/operations/getmediametadatawriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | [operations.GetMediaMetaDataProducer](../../../sdk/models/operations/getmediametadataproducer.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetMediaMetaDataRole](../../../sdk/models/operations/getmediametadatarole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.GetMediaMetaDataGuids](../../../sdk/models/operations/getmediametadataguids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | [operations.Ratings](../../../sdk/models/operations/ratings.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | [operations.GetMediaMetaDataSimilar](../../../sdk/models/operations/getmediametadatasimilar.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | [operations.GetMediaMetaDataLocation](../../../sdk/models/operations/getmediametadatalocation.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | [operations.Chapter](../../../sdk/models/operations/chapter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | [operations.Marker](../../../sdk/models/operations/marker.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [operations.Extras](../../../sdk/models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataPart, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataPart = {
|
||||
accessible: true,
|
||||
@@ -22,7 +22,8 @@ let value: GetMediaMetaDataPart = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -50,6 +51,7 @@ let value: GetMediaMetaDataPart = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,7 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataResponse,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataResponse = {
|
||||
@@ -24,55 +29,80 @@ let value: GetMediaMetaDataResponse = {
|
||||
mediaTagVersion: 1734362201,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -110,7 +140,8 @@ let value: GetMediaMetaDataResponse = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -138,6 +169,7 @@ let value: GetMediaMetaDataResponse = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -164,31 +196,60 @@ let value: GetMediaMetaDataResponse = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -203,50 +264,6 @@ let value: GetMediaMetaDataResponse = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -259,6 +276,32 @@ let value: GetMediaMetaDataResponse = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -5,7 +5,12 @@ The metadata of the library item.
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataResponseBody } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import {
|
||||
GetMediaMetaDataLibraryType,
|
||||
GetMediaMetaDataResponseBody,
|
||||
GetMediaMetaDataStreamType,
|
||||
GetMediaMetaDataType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataResponseBody = {
|
||||
@@ -20,55 +25,80 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
mediaTagVersion: 1734362201,
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "44288",
|
||||
parentRatingKey: "48047",
|
||||
grandparentRatingKey: "45520",
|
||||
parentGuid: "plex://season/618b89208dde18df707ad15c",
|
||||
grandparentGuid: "plex://show/5e16253691c20300412003a8",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/45520",
|
||||
parentKey: "/library/metadata/48047",
|
||||
key: "/library/metadata/44288/children",
|
||||
guid: "plex://show/5d9c08254eefaa001f5d6dcb",
|
||||
slug: "better-call-saul",
|
||||
studio: "Sony Pictures Television",
|
||||
type: "show",
|
||||
title: "Better Call Saul",
|
||||
originalTitle: "Wicked: Part I",
|
||||
librarySectionTitle: "TV Series ",
|
||||
librarySectionID: 2,
|
||||
librarySectionKey: "/library/sections/2",
|
||||
contentRating: "TV-MA",
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetMediaMetaDataType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
rating: 7.6,
|
||||
audienceRating: 9.2,
|
||||
year: 2022,
|
||||
tagline: "Return to Pandora.",
|
||||
thumb: "/library/metadata/58683/thumb/1703239236",
|
||||
art: "/library/metadata/58683/art/1703239236",
|
||||
theme: "/library/metadata/1/theme/1705636920",
|
||||
index: 1,
|
||||
grandparentTitle: "Alice in Borderland",
|
||||
parentTitle: "Season 2",
|
||||
audienceRating: 8.7,
|
||||
viewCount: 4,
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
thumb: "/library/metadata/44288/thumb/1736487993",
|
||||
art: "/library/metadata/44288/art/1736487993",
|
||||
theme: "/library/metadata/44288/theme/1736487993",
|
||||
duration: 2700000,
|
||||
originallyAvailableAt: new RFCDate("2015-02-08"),
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
grandparentThumb: "/library/metadata/45520/thumb/1736488003",
|
||||
grandparentArt: "/library/metadata/45520/art/1736488003",
|
||||
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/58684",
|
||||
originalTitle: "映画 ブラッククローバー 魔法帝の剣",
|
||||
parentRatingKey: "66",
|
||||
grandparentRatingKey: "66",
|
||||
parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
|
||||
grandparentSlug: "alice-in-borderland-2020",
|
||||
grandparentKey: "/library/metadata/66",
|
||||
parentKey: "/library/metadata/66",
|
||||
grandparentTitle: "Caprica",
|
||||
grandparentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
grandparentTheme: "/library/metadata/66/theme/1705716261",
|
||||
grandparentArt: "/library/metadata/66/art/1705716261",
|
||||
parentTitle: "Caprica",
|
||||
parentIndex: 1,
|
||||
parentThumb: "/library/metadata/66/thumb/1705716261",
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
viewCount: 1,
|
||||
viewOffset: 5222500,
|
||||
skipCount: 1,
|
||||
subtype: "clip",
|
||||
lastRatedAt: 1721813113,
|
||||
createdAtAccuracy: "epoch,local",
|
||||
createdAtTZOffset: "0",
|
||||
lastViewedAt: 1682752242,
|
||||
userRating: 10,
|
||||
image: [
|
||||
{
|
||||
alt: "Episode 1",
|
||||
type: GetMediaMetaDataLibraryType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
librarySectionID: 1,
|
||||
librarySectionTitle: "Movies",
|
||||
librarySectionKey: "/library/sections/1",
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
@@ -106,7 +136,8 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -134,6 +165,7 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -160,31 +192,60 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
],
|
||||
},
|
||||
],
|
||||
image: [
|
||||
{
|
||||
alt: "Better Call Saul",
|
||||
type: "coverPoster",
|
||||
url: "/library/metadata/44288/thumb/1736487993",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
},
|
||||
genre: [
|
||||
{
|
||||
id: 1057,
|
||||
filter: "genre=1057",
|
||||
id: 259,
|
||||
tag: "Crime",
|
||||
filter: "genre=19",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
id: 58591,
|
||||
filter: "country=58591",
|
||||
id: 259,
|
||||
tag: "United States of America",
|
||||
filter: "country=19",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Danny Boyle",
|
||||
filter: "director=235876",
|
||||
tagKey: "5d776831151a60001f24d031",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
@@ -199,50 +260,6 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
type: "audience",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
producer: [
|
||||
{
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
},
|
||||
],
|
||||
similar: [
|
||||
{
|
||||
id: 26,
|
||||
@@ -255,6 +272,32 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
path: "/TV Shows/Better Call Saul",
|
||||
},
|
||||
],
|
||||
chapter: [
|
||||
{
|
||||
id: 4,
|
||||
filter: "thumb=4",
|
||||
index: 1,
|
||||
startTimeOffset: 0,
|
||||
endTimeOffset: 100100,
|
||||
thumb: "/library/media/46883/chapterImages/1",
|
||||
},
|
||||
],
|
||||
marker: [
|
||||
{
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
},
|
||||
],
|
||||
extras: {
|
||||
size: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@@ -6,23 +6,23 @@
|
||||
import { GetMediaMetaDataRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataRole = {
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
id: 126522,
|
||||
tag: "Teller",
|
||||
role: "Self - Judge",
|
||||
filter: "actor=126522",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
"https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique identifier for the actor or role. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `role` | *string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this actor. For example, it may indicate that this is an actor with a given key. | actor=126522 |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | A unique key associated with the actor's tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||
@@ -3,11 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { GetMediaMetaDataStream, GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataStream = {
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: GetMediaMetaDataStreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -35,6 +36,7 @@ let value: GetMediaMetaDataStream = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -60,54 +62,56 @@ let value: GetMediaMetaDataStream = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | *number* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `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_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 |
|
||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `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 |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `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) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | [operations.GetMediaMetaDataStreamType](../../../sdk/models/operations/getmediametadatastreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `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 |
|
||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `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 |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `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) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
26
docs/sdk/models/operations/getmediametadatastreamtype.md
Normal file
26
docs/sdk/models/operations/getmediametadatastreamtype.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetMediaMetaDataStreamType
|
||||
|
||||
Stream type:
|
||||
- 1 = video
|
||||
- 2 = audio
|
||||
- 3 = subtitle
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataStreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataStreamType = GetMediaMetaDataStreamType.Video;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Video` | 1 |
|
||||
| `Audio` | 2 |
|
||||
| `Subtitle` | 3 |
|
||||
| - | `Unrecognized<number>` |
|
||||
26
docs/sdk/models/operations/getmediametadatatype.md
Normal file
26
docs/sdk/models/operations/getmediametadatatype.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetMediaMetaDataType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataType = GetMediaMetaDataType.Movie;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -6,18 +6,18 @@
|
||||
import { GetMediaMetaDataUltraBlurColors } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataUltraBlurColors = {
|
||||
topLeft: "11333a",
|
||||
topRight: "1d2721",
|
||||
bottomRight: "5c451d",
|
||||
bottomLeft: "372c10",
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `topLeft` | *string* | :heavy_check_mark: | The top-left color value. | 11333a |
|
||||
| `topRight` | *string* | :heavy_check_mark: | The top-right color value. | 1d2721 |
|
||||
| `bottomRight` | *string* | :heavy_check_mark: | The bottom-right color value. | 5c451d |
|
||||
| `bottomLeft` | *string* | :heavy_check_mark: | The bottom-left color value. | 372c10 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `topLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
|
||||
| `topRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
|
||||
| `bottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
|
||||
| `bottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |
|
||||
@@ -6,23 +6,21 @@
|
||||
import { GetMediaMetaDataWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataWriter = {
|
||||
id: 109501,
|
||||
filter: "actor=109501",
|
||||
tag: "Bob Odenkirk",
|
||||
tagKey: "5d77683254f42c001f8c3f69",
|
||||
role: "Jimmy McGill",
|
||||
id: 126522,
|
||||
tag: "Jamie P. Hanson",
|
||||
filter: "writer=126522",
|
||||
thumb:
|
||||
"https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
|
||||
"https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
|
||||
tagKey: "5d77683d85719b001f3a535e",
|
||||
};
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string used to query this writer. | writer=126522 |
|
||||
| `thumb` | *string* | :heavy_minus_sign: | The URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
| `tagKey` | *string* | :heavy_minus_sign: | A unique key associated with the writers tag, used for internal identification. | 5d77683d85719b001f3a535e |
|
||||
@@ -19,12 +19,15 @@ let value: GetPlaylistContentsQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -11,9 +11,12 @@ let value: GetRecentlyAddedHubsResponseType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,11 +13,14 @@ let value: GetRecentlyAddedHubsType = GetRecentlyAddedHubsType.Movie;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedMediaContainer,
|
||||
StreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -183,7 +184,8 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: StreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -211,6 +213,7 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -10,6 +10,7 @@ import {
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedMetadata,
|
||||
StreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -129,7 +130,8 @@ let value: GetRecentlyAddedMetadata = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: StreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -157,6 +159,7 @@ let value: GetRecentlyAddedMetadata = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -7,6 +7,7 @@ import {
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedResponse,
|
||||
StreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -190,7 +191,8 @@ let value: GetRecentlyAddedResponse = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: StreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -218,6 +220,7 @@ let value: GetRecentlyAddedResponse = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -9,6 +9,7 @@ import {
|
||||
GetRecentlyAddedHubsResponseType,
|
||||
GetRecentlyAddedHubsType,
|
||||
GetRecentlyAddedResponseBody,
|
||||
StreamType,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
@@ -186,7 +187,8 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: StreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -214,6 +216,7 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -13,7 +13,10 @@ let value: GetSearchAllLibrariesEnableCreditsMarkerGeneration =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,8 +13,11 @@ let value: GetSearchAllLibrariesEpisodeSort =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,8 +13,11 @@ let value: GetSearchAllLibrariesFlattenSeasons =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Hide` | 0 |
|
||||
| `Show` | 1 |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -11,9 +11,12 @@ let value: GetSearchAllLibrariesLibraryType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -19,10 +19,13 @@ let value: GetSearchAllLibrariesShowOrdering =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `TvdbAired` | aired |
|
||||
| `TvdbDvd` | dvd |
|
||||
| `TvdbAbsolute` | absolute |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `TvdbAired` | aired |
|
||||
| `TvdbDvd` | dvd |
|
||||
| `TvdbAbsolute` | absolute |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,11 +13,14 @@ let value: GetSearchAllLibrariesType = GetSearchAllLibrariesType.Movie;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -19,12 +19,15 @@ let value: GetSearchLibraryQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -13,7 +13,10 @@ let value: GetTokenDetailsAuthenticationResponseStatus =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,7 +13,10 @@ let value: GetTokenDetailsAuthenticationStatus =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -10,7 +10,10 @@ let value: GetTokenDetailsStatus = GetTokenDetailsStatus.Online;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Online` | online |
|
||||
| `Offline` | offline |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Online` | online |
|
||||
| `Offline` | offline |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -19,12 +19,15 @@ let value: GetTopWatchedContentQueryParamType =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -1,6 +1,6 @@
|
||||
# IncludeDetails
|
||||
|
||||
Whether or not to include details for a section (types, filters, and sorts).
|
||||
Whether or not to include details for a section (types, filters, and sorts).
|
||||
Only exists for backwards compatibility, media providers other than the server libraries have it on always.
|
||||
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Level
|
||||
|
||||
An integer log level to write to the PMS log with.
|
||||
0: Error
|
||||
1: Warning
|
||||
2: Info
|
||||
3: Debug
|
||||
An integer log level to write to the PMS log with.
|
||||
0: Error
|
||||
1: Warning
|
||||
2: Info
|
||||
3: Debug
|
||||
4: Verbose
|
||||
|
||||
|
||||
@@ -18,10 +18,13 @@ let value: Level = Level.Two;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| `Two` | 2 |
|
||||
| `Three` | 3 |
|
||||
| `Four` | 4 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| `Two` | 2 |
|
||||
| `Three` | 3 |
|
||||
| `Four` | 4 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -13,7 +13,10 @@ let value: Libtype = Libtype.Show;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Movie` | movie |
|
||||
| `Show` | show |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | movie |
|
||||
| `Show` | show |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -14,8 +14,8 @@ let value: LogLineRequest = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `level` | [operations.Level](../../../sdk/models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with. <br/>0: Error <br/>1: Warning <br/>2: Info <br/>3: Debug <br/>4: Verbose<br/> | |
|
||||
| `message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
|
||||
| `source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `level` | [operations.Level](../../../sdk/models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.<br/>0: Error<br/>1: Warning<br/>2: Info<br/>3: Debug<br/>4: Verbose<br/> | |
|
||||
| `message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | Test log message |
|
||||
| `source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | Postman |
|
||||
@@ -12,7 +12,10 @@ let value: MailingListStatus = MailingListStatus.Active;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `Active` | active |
|
||||
| `Unsubscribed` | unsubscribed |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Active` | active |
|
||||
| `Unsubscribed` | unsubscribed |
|
||||
| - | `Unrecognized<string>` |
|
||||
32
docs/sdk/models/operations/marker.md
Normal file
32
docs/sdk/models/operations/marker.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Marker
|
||||
|
||||
The final status of the marker
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Marker } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Marker = {
|
||||
id: 306970,
|
||||
type: "credits",
|
||||
startTimeOffset: 4176050,
|
||||
endTimeOffset: 4393389,
|
||||
final: true,
|
||||
attributes: {
|
||||
id: 306970,
|
||||
version: 4,
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | N/A | 306970 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | credits |
|
||||
| `startTimeOffset` | *number* | :heavy_check_mark: | N/A | 4176050 |
|
||||
| `endTimeOffset` | *number* | :heavy_check_mark: | N/A | 4393389 |
|
||||
| `final` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `attributes` | [operations.Attributes](../../../sdk/models/operations/attributes.md) | :heavy_minus_sign: | Attributes associated with the marker. | |
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Media } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Media, StreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Media = {
|
||||
id: 387322,
|
||||
@@ -41,7 +41,8 @@ let value: Media = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: StreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -69,6 +70,7 @@ let value: Media = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Part } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Part, StreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Part = {
|
||||
accessible: true,
|
||||
@@ -22,7 +22,8 @@ let value: Part = {
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: StreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -50,6 +51,7 @@ let value: Part = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
|
||||
@@ -12,6 +12,8 @@ let value: PathParamTaskName = PathParamTaskName.RefreshPeriodicMetadata;
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------- | --------------------------- |
|
||||
| `BackupDatabase` | BackupDatabase |
|
||||
@@ -27,4 +29,5 @@ let value: PathParamTaskName = PathParamTaskName.RefreshPeriodicMetadata;
|
||||
| `RefreshLibraries` | RefreshLibraries |
|
||||
| `RefreshLocalMedia` | RefreshLocalMedia |
|
||||
| `RefreshPeriodicMetadata` | RefreshPeriodicMetadata |
|
||||
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
|
||||
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -12,8 +12,11 @@ let value: PlaylistType = PlaylistType.Video;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Audio` | audio |
|
||||
| `Video` | video |
|
||||
| `Photo` | photo |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,7 +13,10 @@ let value: PostUsersSignInDataAuthenticationResponseStatus =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,7 +13,10 @@ let value: PostUsersSignInDataAuthenticationStatus =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Inactive` | Inactive |
|
||||
| `Active` | Active |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -13,7 +13,10 @@ let value: PostUsersSignInDataMailingListStatus =
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `Active` | active |
|
||||
| `Unsubscribed` | unsubscribed |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Active` | active |
|
||||
| `Unsubscribed` | unsubscribed |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -10,6 +10,9 @@ let value: PostUsersSignInDataState = PostUsersSignInDataState.Ended;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `Ended` | ended |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Ended` | ended |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -10,7 +10,10 @@ let value: PostUsersSignInDataStatus = PostUsersSignInDataStatus.Online;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Online` | online |
|
||||
| `Offline` | offline |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Online` | online |
|
||||
| `Offline` | offline |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -1,8 +1,8 @@
|
||||
# QueryParamForce
|
||||
|
||||
Force overwriting of duplicate playlists.
|
||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
The `force` argument is used to disable overwriting.
|
||||
Force overwriting of duplicate playlists.
|
||||
By default, a playlist file uploaded with the same path will overwrite the existing playlist.
|
||||
The `force` argument is used to disable overwriting.
|
||||
If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.
|
||||
|
||||
|
||||
|
||||
@@ -12,7 +12,10 @@ let value: QueryParamSmart = QueryParamSmart.Zero;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -18,12 +18,15 @@ let value: QueryParamType = QueryParamType.TvShow;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -10,10 +10,13 @@ let value: SearchTypes = SearchTypes.Tv;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `Movies` | movies |
|
||||
| `Music` | music |
|
||||
| `OtherVideos` | otherVideos |
|
||||
| `People` | people |
|
||||
| `Tv` | tv |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movies` | movies |
|
||||
| `Music` | music |
|
||||
| `OtherVideos` | otherVideos |
|
||||
| `People` | people |
|
||||
| `Tv` | tv |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -18,10 +18,13 @@ let value: ShowOrdering = ShowOrdering.TvdbAbsolute;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `TvdbAired` | aired |
|
||||
| `TvdbDvd` | dvd |
|
||||
| `TvdbAbsolute` | absolute |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `None` | None |
|
||||
| `TmdbAiring` | tmdbAiring |
|
||||
| `TvdbAired` | aired |
|
||||
| `TvdbDvd` | dvd |
|
||||
| `TvdbAbsolute` | absolute |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -12,8 +12,11 @@ let value: State = State.Playing;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Playing` | playing |
|
||||
| `Paused` | paused |
|
||||
| `Stopped` | stopped |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Playing` | playing |
|
||||
| `Paused` | paused |
|
||||
| `Stopped` | stopped |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -12,6 +12,9 @@ let value: Status = Status.Accepted;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Accepted` | accepted |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Accepted` | accepted |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -3,11 +3,12 @@
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Stream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { Stream, StreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Stream = {
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
streamType: StreamType.Video,
|
||||
format: "srt",
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
@@ -35,6 +36,7 @@ let value: Stream = {
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
key: "/library/streams/216389",
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
@@ -60,54 +62,56 @@ let value: Stream = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | *number* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `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_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 |
|
||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `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 |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `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) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | [operations.StreamType](../../../sdk/models/operations/streamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format` | *string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *boolean* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *number* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `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 |
|
||||
| `dovielPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *number* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *number* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *boolean* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *number* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `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 |
|
||||
| `colorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *number* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *number* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *boolean* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `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) |
|
||||
| `extendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *boolean* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *number* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *number* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *boolean* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *boolean* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *boolean* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
26
docs/sdk/models/operations/streamtype.md
Normal file
26
docs/sdk/models/operations/streamtype.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# StreamType
|
||||
|
||||
Stream type:
|
||||
- 1 = video
|
||||
- 2 = audio
|
||||
- 3 = subtitle
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { StreamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: StreamType = StreamType.Video;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Video` | 1 |
|
||||
| `Audio` | 2 |
|
||||
| `Subtitle` | 3 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -12,21 +12,24 @@ let value: Tag = Tag.RecentlyViewed;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `Unwatched` | unwatched |
|
||||
| `Newest` | newest |
|
||||
| `RecentlyAdded` | recentlyAdded |
|
||||
| `RecentlyViewed` | recentlyViewed |
|
||||
| `OnDeck` | onDeck |
|
||||
| `Collection` | collection |
|
||||
| `Edition` | edition |
|
||||
| `Year` | year |
|
||||
| `Decade` | decade |
|
||||
| `Director` | director |
|
||||
| `ContentRating` | contentRating |
|
||||
| `Rating` | rating |
|
||||
| `Resolution` | resolution |
|
||||
| `FirstCharacter` | firstCharacter |
|
||||
| `Folder` | folder |
|
||||
| `Albums` | albums |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Unwatched` | unwatched |
|
||||
| `Newest` | newest |
|
||||
| `RecentlyAdded` | recentlyAdded |
|
||||
| `RecentlyViewed` | recentlyViewed |
|
||||
| `OnDeck` | onDeck |
|
||||
| `Collection` | collection |
|
||||
| `Edition` | edition |
|
||||
| `Year` | year |
|
||||
| `Decade` | decade |
|
||||
| `Director` | director |
|
||||
| `ContentRating` | contentRating |
|
||||
| `Rating` | rating |
|
||||
| `Resolution` | resolution |
|
||||
| `FirstCharacter` | firstCharacter |
|
||||
| `Folder` | folder |
|
||||
| `Albums` | albums |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -12,6 +12,8 @@ let value: TaskName = TaskName.RefreshLocalMedia;
|
||||
|
||||
## Values
|
||||
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<string>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| --------------------------- | --------------------------- |
|
||||
| `BackupDatabase` | BackupDatabase |
|
||||
@@ -27,4 +29,5 @@ let value: TaskName = TaskName.RefreshLocalMedia;
|
||||
| `RefreshLibraries` | RefreshLibraries |
|
||||
| `RefreshLocalMedia` | RefreshLocalMedia |
|
||||
| `RefreshPeriodicMetadata` | RefreshPeriodicMetadata |
|
||||
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
|
||||
| `UpgradeMediaAnalysis` | UpgradeMediaAnalysis |
|
||||
| - | `Unrecognized<string>` |
|
||||
@@ -18,12 +18,15 @@ let value: Type = Type.TvShow;
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
This is an open enum. Unrecognized values will be captured as the `Unrecognized<number>` branded type.
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
| - | `Unrecognized<number>` |
|
||||
@@ -14,8 +14,8 @@ let value: UploadPlaylistRequest = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. <br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed. <br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename. <br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. <br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
|
||||
| `force` | [operations.QueryParamForce](../../../sdk/models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists. <br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist. <br/>The `force` argument is used to disable overwriting. <br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
|
||||
| `sectionID` | *number* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `path` | *string* | :heavy_check_mark: | absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server.<br/>If the `path` argument is a directory, that path will be scanned for playlist files to be processed.<br/>Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it.<br/>The GUID of each playlist is based on the filename.<br/>If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it.<br/>The GUID of each playlist is based on the filename.<br/> | /home/barkley/playlist.m3u |
|
||||
| `force` | [operations.QueryParamForce](../../../sdk/models/operations/queryparamforce.md) | :heavy_check_mark: | Force overwriting of duplicate playlists.<br/>By default, a playlist file uploaded with the same path will overwrite the existing playlist.<br/>The `force` argument is used to disable overwriting.<br/>If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.<br/> | |
|
||||
| `sectionID` | *number* | :heavy_check_mark: | Possibly the section ID to upload the playlist to, we are not certain. | 1 |
|
||||
@@ -300,14 +300,14 @@ run();
|
||||
|
||||
## Library Details Endpoint
|
||||
|
||||
This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.
|
||||
This endpoint provides comprehensive details about the library, focusing on organizational aspects rather than the content itself.
|
||||
|
||||
The details include:
|
||||
|
||||
### Directories
|
||||
Organized into three categories:
|
||||
|
||||
- **Primary Directories**:
|
||||
- **Primary Directories**:
|
||||
- Used in some clients for quick access to media subsets (e.g., "All", "On Deck").
|
||||
- Most can be replicated via media queries.
|
||||
- Customizable by users.
|
||||
@@ -390,13 +390,13 @@ run();
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | [object Object] |
|
||||
| `includeDetails` | [operations.IncludeDetails](../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts). <br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `sectionKey` | *number* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | [object Object] |
|
||||
| `includeDetails` | [operations.IncludeDetails](../../sdk/models/operations/includedetails.md) | :heavy_minus_sign: | Whether or not to include details for a section (types, filters, and sorts).<br/>Only exists for backwards compatibility, media providers other than the server libraries have it on always.<br/> | |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
|
||||
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
|
||||
|
||||
### Response
|
||||
|
||||
@@ -1353,13 +1353,14 @@ Uploads an image to use as the background artwork for a library item, either fro
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { openAsBlob } from "node:fs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaArts(2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
const result = await plexAPI.library.postMediaArts(2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -1375,6 +1376,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { libraryPostMediaArts } from "@lukehagar/plexjs/funcs/libraryPostMediaArts.js";
|
||||
import { openAsBlob } from "node:fs";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -1383,7 +1385,7 @@ const plexAPI = new PlexAPICore({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await libraryPostMediaArts(plexAPI, 2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
const res = await libraryPostMediaArts(plexAPI, 2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
if (!res.ok) {
|
||||
throw res.error;
|
||||
@@ -1499,13 +1501,14 @@ Uploads a poster to a library item, either from a local file or a remote URL
|
||||
|
||||
```typescript
|
||||
import { PlexAPI } from "@lukehagar/plexjs";
|
||||
import { openAsBlob } from "node:fs";
|
||||
|
||||
const plexAPI = new PlexAPI({
|
||||
accessToken: "<YOUR_API_KEY_HERE>",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await plexAPI.library.postMediaPoster(2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
const result = await plexAPI.library.postMediaPoster(2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
@@ -1521,6 +1524,7 @@ The standalone function version of this method:
|
||||
```typescript
|
||||
import { PlexAPICore } from "@lukehagar/plexjs/core.js";
|
||||
import { libraryPostMediaPoster } from "@lukehagar/plexjs/funcs/libraryPostMediaPoster.js";
|
||||
import { openAsBlob } from "node:fs";
|
||||
|
||||
// Use `PlexAPICore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
@@ -1529,7 +1533,7 @@ const plexAPI = new PlexAPICore({
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await libraryPostMediaPoster(plexAPI, 2268, "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
const res = await libraryPostMediaPoster(plexAPI, 2268, await openAsBlob("example.file"), "https://api.mediux.pro/assets/fcfdc487-dd07-4993-a0c1-0a3015362e5b");
|
||||
|
||||
if (!res.ok) {
|
||||
throw res.error;
|
||||
|
||||
@@ -72,7 +72,7 @@ run();
|
||||
|
||||
| Parameter | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `level` | [operations.Level](../../sdk/models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with. <br/>0: Error <br/>1: Warning <br/>2: Info <br/>3: Debug <br/>4: Verbose<br/> | |
|
||||
| `level` | [operations.Level](../../sdk/models/operations/level.md) | :heavy_check_mark: | An integer log level to write to the PMS log with.<br/>0: Error<br/>1: Warning<br/>2: Info<br/>3: Debug<br/>4: Verbose<br/> | |
|
||||
| `message` | *string* | :heavy_check_mark: | The text of the message to write to the log. | [object Object] |
|
||||
| `source` | *string* | :heavy_check_mark: | a string indicating the source of the message. | [object Object] |
|
||||
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
||||
@@ -93,13 +93,13 @@ run();
|
||||
|
||||
## logMultiLine
|
||||
|
||||
This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||
It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||
Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||
This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
|
||||
It accepts a text/plain request body, where each line represents a distinct log entry.
|
||||
Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.
|
||||
|
||||
Log entries are separated by a newline character (`\n`).
|
||||
Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||
This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||
Log entries are separated by a newline character (`\n`).
|
||||
Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
|
||||
This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.
|
||||
|
||||
The 'level' parameter specifies the log entry's severity or importance, with the following integer values:
|
||||
- `0`: Error - Critical issues that require immediate attention.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user