mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.1
This commit is contained in:
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
18
docs/sdk/models/errors/getallmedialibrarybadrequest.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryBadRequest
|
||||
|
||||
Bad Request - A parameter was not specified, or was specified incorrectly.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryBadRequest } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAllMediaLibraryErrors](../../../sdk/models/errors/getallmedialibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
21
docs/sdk/models/errors/getallmedialibraryerrors.md
Normal file
21
docs/sdk/models/errors/getallmedialibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllMediaLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAllMediaLibraryErrors = {
|
||||
code: 1000,
|
||||
message: "X-Plex-Client-Identifier is missing",
|
||||
status: 400,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1000 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | X-Plex-Client-Identifier is missing |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 400 |
|
||||
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
21
docs/sdk/models/errors/getallmedialibrarylibraryerrors.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllMediaLibraryLibraryErrors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryErrors } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryErrors = {
|
||||
code: 1001,
|
||||
message: "User could not be authenticated",
|
||||
status: 401,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `code` | *number* | :heavy_minus_sign: | N/A | 1001 |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | User could not be authenticated |
|
||||
| `status` | *number* | :heavy_minus_sign: | N/A | 401 |
|
||||
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
18
docs/sdk/models/errors/getallmedialibraryunauthorized.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryUnauthorized
|
||||
|
||||
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryUnauthorized } from "@lukehagar/plexjs/sdk/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `errors` | [errors.GetAllMediaLibraryLibraryErrors](../../../sdk/models/errors/getallmedialibrarylibraryerrors.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
|
||||
@@ -6,7 +6,7 @@
|
||||
import { AddPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: AddPlaylistContentsRequest = {
|
||||
playlistID: 6874.88,
|
||||
playlistID: 3741.7,
|
||||
uri: "server://12345/com.plexapp.plugins.library/library/metadata/1",
|
||||
playQueueID: 123,
|
||||
};
|
||||
|
||||
@@ -7,7 +7,7 @@ import { AddPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: AddPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 226,
|
||||
statusCode: 302,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ApplyUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ApplyUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 101,
|
||||
statusCode: 428,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { Billing } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Billing = {
|
||||
internalPaymentMethod: {},
|
||||
paymentMethodId: 517379,
|
||||
paymentMethodId: 765326,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CheckForUpdatesResponse } from "@lukehagar/plexjs/sdk/models/operations
|
||||
|
||||
let value: CheckForUpdatesResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 205,
|
||||
statusCode: 508,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { ClearPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: ClearPlaylistContentsRequest = {
|
||||
playlistID: 7980.47,
|
||||
playlistID: 256.62,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { ClearPlaylistContentsResponse } from "@lukehagar/plexjs/sdk/models/oper
|
||||
|
||||
let value: ClearPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 204,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ type of playlist to create
|
||||
```typescript
|
||||
import { CreatePlaylistQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Audio;
|
||||
let value: CreatePlaylistQueryParamType = CreatePlaylistQueryParamType.Video;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -7,9 +7,9 @@ import { CreatePlaylistQueryParamType, CreatePlaylistRequest, Smart } from "@luk
|
||||
|
||||
let value: CreatePlaylistRequest = {
|
||||
title: "<value>",
|
||||
type: CreatePlaylistQueryParamType.Video,
|
||||
smart: Smart.Zero,
|
||||
uri: "https://humble-confusion.com",
|
||||
type: CreatePlaylistQueryParamType.Photo,
|
||||
smart: Smart.One,
|
||||
uri: "https://radiant-dividend.com/",
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { CreatePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: CreatePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 409,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { DeletePlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: DeletePlaylistRequest = {
|
||||
playlistID: 206.51,
|
||||
playlistID: 1856.36,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { DeletePlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations"
|
||||
|
||||
let value: DeletePlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 409,
|
||||
statusCode: 507,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { EnablePaperTrailResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: EnablePaperTrailResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 302,
|
||||
statusCode: 102,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ Filter
|
||||
```typescript
|
||||
import { Filter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Filter = Filter.Available;
|
||||
let value: Filter = Filter.All;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -7,7 +7,7 @@ Force the refresh even if the library is already being refreshed.
|
||||
```typescript
|
||||
import { Force } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: Force = Force.Zero;
|
||||
let value: Force = Force.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
@@ -34,7 +34,7 @@ let value: GetActorsLibraryMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetActorsLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetActorsLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 413,
|
||||
statusCode: 101,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryActiveDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryActiveDirection =
|
||||
GetAllMediaLibraryActiveDirection.Ascending;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarycollection.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryCollection
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryCollection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryCollection = {
|
||||
tag: "My Awesome Collection",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
17
docs/sdk/models/operations/getallmedialibrarycountry.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarycountry.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryCountry
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryCountry } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryCountry = {
|
||||
tag: "United States of America",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryDefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryDefaultDirection } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryDefaultDirection =
|
||||
GetAllMediaLibraryDefaultDirection.Ascending;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
17
docs/sdk/models/operations/getallmedialibrarydirector.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarydirector.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryDirector
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryDirector } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryDirector = {
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
23
docs/sdk/models/operations/getallmedialibraryfield.md
Normal file
23
docs/sdk/models/operations/getallmedialibraryfield.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryField
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryField } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryField = {
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `subType` | *string* | :heavy_minus_sign: | N/A | rating |
|
||||
24
docs/sdk/models/operations/getallmedialibraryfieldtype.md
Normal file
24
docs/sdk/models/operations/getallmedialibraryfieldtype.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# GetAllMediaLibraryFieldType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryFieldType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryFieldType = {
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||
| `operator` | [operations.GetAllMediaLibraryOperator](../../../sdk/models/operations/getallmedialibraryoperator.md)[] | :heavy_check_mark: | N/A | |
|
||||
27
docs/sdk/models/operations/getallmedialibraryfilter.md
Normal file
27
docs/sdk/models/operations/getallmedialibraryfilter.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# GetAllMediaLibraryFilter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryFilter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryFilter = {
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `advanced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
17
docs/sdk/models/operations/getallmedialibrarygenre.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarygenre.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryGenre
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryGenre } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryGenre = {
|
||||
tag: "United States of America",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
18
docs/sdk/models/operations/getallmedialibraryhasthumbnail.md
Normal file
18
docs/sdk/models/operations/getallmedialibraryhasthumbnail.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetAllMediaLibraryHasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryHasThumbnail } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryHasThumbnail = GetAllMediaLibraryHasThumbnail.True;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
21
docs/sdk/models/operations/getallmedialibraryimage.md
Normal file
21
docs/sdk/models/operations/getallmedialibraryimage.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# GetAllMediaLibraryImage
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryImage, GetAllMediaLibraryLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryImage = {
|
||||
alt: "Episode 1",
|
||||
type: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetAllMediaLibraryLibraryResponseType](../../../sdk/models/operations/getallmedialibrarylibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetAllMediaLibraryOptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.GetAllMediaLibraryOptimizedForStreaming1 =
|
||||
GetAllMediaLibraryOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetAllMediaLibraryLibraryResponseType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryResponseType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryResponseType =
|
||||
GetAllMediaLibraryLibraryResponseType.Background;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
23
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
23
docs/sdk/models/operations/getallmedialibrarylibrarytype.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryLibraryType
|
||||
|
||||
The type of media content
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryLibraryType = GetAllMediaLibraryLibraryType.Movie;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
119
docs/sdk/models/operations/getallmedialibrarymedia.md
Normal file
119
docs/sdk/models/operations/getallmedialibrarymedia.md
Normal file
@@ -0,0 +1,119 @@
|
||||
# GetAllMediaLibraryMedia
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMedia } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMedia = {
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *number* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *number* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | *operations.GetAllMediaLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | [operations.GetAllMediaLibraryPart](../../../sdk/models/operations/getallmedialibrarypart.md)[] | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
305
docs/sdk/models/operations/getallmedialibrarymediacontainer.md
Normal file
305
docs/sdk/models/operations/getallmedialibrarymediacontainer.md
Normal file
@@ -0,0 +1,305 @@
|
||||
# GetAllMediaLibraryMediaContainer
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMediaContainer,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryMediaContainer = {
|
||||
size: 50,
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Series",
|
||||
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
thumb: "/:/resources/show.png",
|
||||
nocache: true,
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
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,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
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: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `totalSize` | *number* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `offset` | *number* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `librarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `meta` | [operations.GetAllMediaLibraryMeta](../../../sdk/models/operations/getallmedialibrarymeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
| `metadata` | [operations.GetAllMediaLibraryMetadata](../../../sdk/models/operations/getallmedialibrarymetadata.md)[] | :heavy_minus_sign: | An array of metadata items. | |
|
||||
68
docs/sdk/models/operations/getallmedialibrarymeta.md
Normal file
68
docs/sdk/models/operations/getallmedialibrarymeta.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# GetAllMediaLibraryMeta
|
||||
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryMeta = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | [operations.GetAllMediaLibraryType](../../../sdk/models/operations/getallmedialibrarytype.md)[] | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | [operations.GetAllMediaLibraryFieldType](../../../sdk/models/operations/getallmedialibraryfieldtype.md)[] | :heavy_minus_sign: | N/A |
|
||||
282
docs/sdk/models/operations/getallmedialibrarymetadata.md
Normal file
282
docs/sdk/models/operations/getallmedialibrarymetadata.md
Normal file
@@ -0,0 +1,282 @@
|
||||
# GetAllMediaLibraryMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryMetadata,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryMetadata = {
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
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,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
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: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| 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.GetAllMediaLibraryLibraryType](../../../sdk/models/operations/getallmedialibrarylibrarytype.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_check_mark: | 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.GetAllMediaLibraryImage](../../../sdk/models/operations/getallmedialibraryimage.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [operations.GetAllMediaLibraryUltraBlurColors](../../../sdk/models/operations/getallmedialibraryultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `media` | [operations.GetAllMediaLibraryMedia](../../../sdk/models/operations/getallmedialibrarymedia.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | [operations.GetAllMediaLibraryGenre](../../../sdk/models/operations/getallmedialibrarygenre.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | [operations.GetAllMediaLibraryCountry](../../../sdk/models/operations/getallmedialibrarycountry.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | [operations.GetAllMediaLibraryDirector](../../../sdk/models/operations/getallmedialibrarydirector.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | [operations.GetAllMediaLibraryWriter](../../../sdk/models/operations/getallmedialibrarywriter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | [operations.GetAllMediaLibraryRole](../../../sdk/models/operations/getallmedialibraryrole.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | [operations.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | [operations.GetAllMediaLibraryCollection](../../../sdk/models/operations/getallmedialibrarycollection.md)[] | :heavy_minus_sign: | N/A | |
|
||||
19
docs/sdk/models/operations/getallmedialibraryoperator.md
Normal file
19
docs/sdk/models/operations/getallmedialibraryoperator.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetAllMediaLibraryOperator
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryOperator } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryOperator = {
|
||||
key: "=",
|
||||
title: "is",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | = |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | is |
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetAllMediaLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.One`
|
||||
|
||||
```typescript
|
||||
const value: operations.One = One.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryOptimizedForStreaming1
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryOptimizedForStreaming1 =
|
||||
GetAllMediaLibraryOptimizedForStreaming1.Zero;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
95
docs/sdk/models/operations/getallmedialibrarypart.md
Normal file
95
docs/sdk/models/operations/getallmedialibrarypart.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# GetAllMediaLibraryPart
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryPart } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryPart = {
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *number* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *number* | :heavy_minus_sign: | N/A | 188 |
|
||||
| `container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *operations.GetAllMediaLibraryLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `hasThumbnail` | [operations.GetAllMediaLibraryHasThumbnail](../../../sdk/models/operations/getallmedialibraryhasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | [operations.GetAllMediaLibraryStream](../../../sdk/models/operations/getallmedialibrarystream.md)[] | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetAllMediaLibraryQueryParamIncludeMeta
|
||||
|
||||
Adds the Meta object to the response
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryQueryParamIncludeMeta } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryQueryParamIncludeMeta =
|
||||
GetAllMediaLibraryQueryParamIncludeMeta.Enable;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
@@ -0,0 +1,30 @@
|
||||
# GetAllMediaLibraryQueryParamType
|
||||
|
||||
The type of media to retrieve or filter by.
|
||||
1 = movie
|
||||
2 = show
|
||||
3 = season
|
||||
4 = episode
|
||||
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
|
||||
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryQueryParamType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryQueryParamType =
|
||||
GetAllMediaLibraryQueryParamType.TvShow;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Movie` | 1 |
|
||||
| `TvShow` | 2 |
|
||||
| `Season` | 3 |
|
||||
| `Episode` | 4 |
|
||||
| `Audio` | 8 |
|
||||
| `Album` | 9 |
|
||||
| `Track` | 10 |
|
||||
26
docs/sdk/models/operations/getallmedialibraryrequest.md
Normal file
26
docs/sdk/models/operations/getallmedialibraryrequest.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# GetAllMediaLibraryRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryQueryParamType, GetAllMediaLibraryRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryRequest = {
|
||||
sectionKey: 9518,
|
||||
type: GetAllMediaLibraryQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | 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/> | 9518 |
|
||||
| `type` | [operations.GetAllMediaLibraryQueryParamType](../../../sdk/models/operations/getallmedialibraryqueryparamtype.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
|
||||
| `includeMeta` | [operations.GetAllMediaLibraryQueryParamIncludeMeta](../../../sdk/models/operations/getallmedialibraryqueryparamincludemeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
|
||||
| `includeGuids` | [operations.QueryParamIncludeGuids](../../../sdk/models/operations/queryparamincludeguids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
|
||||
| `includeAdvanced` | [operations.IncludeAdvanced](../../../sdk/models/operations/includeadvanced.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeCollections` | [operations.QueryParamIncludeCollections](../../../sdk/models/operations/queryparamincludecollections.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `includeExternalMedia` | [operations.QueryParamIncludeExternalMedia](../../../sdk/models/operations/queryparamincludeexternalmedia.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `xPlexContainerStart` | *number* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
|
||||
| `xPlexContainerSize` | *number* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |
|
||||
299
docs/sdk/models/operations/getallmedialibraryresponse.md
Normal file
299
docs/sdk/models/operations/getallmedialibraryresponse.md
Normal file
@@ -0,0 +1,299 @@
|
||||
# GetAllMediaLibraryResponse
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponse,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Series",
|
||||
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
thumb: "/:/resources/show.png",
|
||||
nocache: true,
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
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,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
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: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
|
||||
| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation |
|
||||
| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
|
||||
| `object` | [operations.GetAllMediaLibraryResponseBody](../../../sdk/models/operations/getallmedialibraryresponsebody.md) | :heavy_minus_sign: | Successful response containing media container data. |
|
||||
291
docs/sdk/models/operations/getallmedialibraryresponsebody.md
Normal file
291
docs/sdk/models/operations/getallmedialibraryresponsebody.md
Normal file
@@ -0,0 +1,291 @@
|
||||
# GetAllMediaLibraryResponseBody
|
||||
|
||||
Successful response containing media container data.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import {
|
||||
GetAllMediaLibraryLibraryResponseType,
|
||||
GetAllMediaLibraryLibraryType,
|
||||
GetAllMediaLibraryResponseBody,
|
||||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetAllMediaLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
totalSize: 50,
|
||||
offset: 0,
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
librarySectionID: 2,
|
||||
librarySectionTitle: "TV Series",
|
||||
librarySectionUUID: "e69655a2-ef48-4aba-bb19-0cc34d1e7d36",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
thumb: "/:/resources/show.png",
|
||||
nocache: true,
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
meta: {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
fieldType: [
|
||||
{
|
||||
type: "tag",
|
||||
operator: [
|
||||
{
|
||||
key: "=",
|
||||
title: "is",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
metadata: [
|
||||
{
|
||||
ratingKey: "58683",
|
||||
key: "/library/metadata/58683",
|
||||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||||
slug: "4-for-texas",
|
||||
studio: "20th Century Studios",
|
||||
type: GetAllMediaLibraryLibraryType.Movie,
|
||||
title: "Avatar: The Way of Water",
|
||||
titleSort: "Whale",
|
||||
contentRating: "PG-13",
|
||||
summary:
|
||||
"Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
|
||||
+ "Once a familiar threat returns to finish what was previously started, Jake must\n"
|
||||
+ "work with Neytiri and the army of the Na'vi race to protect their home.\n"
|
||||
+ "",
|
||||
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,
|
||||
leafCount: 14,
|
||||
viewedLeafCount: 0,
|
||||
childCount: 1,
|
||||
seasonCount: 2022,
|
||||
duration: 11558112,
|
||||
originallyAvailableAt: new RFCDate("2022-12-14"),
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
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: GetAllMediaLibraryLibraryResponseType.Background,
|
||||
url: "/library/metadata/45521/thumb/1644710589",
|
||||
},
|
||||
],
|
||||
ultraBlurColors: {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
},
|
||||
media: [
|
||||
{
|
||||
id: 387322,
|
||||
duration: 9610350,
|
||||
bitrate: 25512,
|
||||
width: 3840,
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
container: "mkv",
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
exists: true,
|
||||
id: 418385,
|
||||
key: "/library/parts/418385/1735864239/file.mkv",
|
||||
indexes: "sd",
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
genre: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
country: [
|
||||
{
|
||||
tag: "United States of America",
|
||||
},
|
||||
],
|
||||
director: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
writer: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
role: [
|
||||
{
|
||||
tag: "Danny Boyle",
|
||||
},
|
||||
],
|
||||
guids: [
|
||||
{
|
||||
id: "tvdb://2337",
|
||||
},
|
||||
],
|
||||
collection: [
|
||||
{
|
||||
tag: "My Awesome Collection",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
||||
| `mediaContainer` | [operations.GetAllMediaLibraryMediaContainer](../../../sdk/models/operations/getallmedialibrarymediacontainer.md) | :heavy_minus_sign: | N/A |
|
||||
17
docs/sdk/models/operations/getallmedialibraryrole.md
Normal file
17
docs/sdk/models/operations/getallmedialibraryrole.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryRole
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryRole } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryRole = {
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |
|
||||
29
docs/sdk/models/operations/getallmedialibrarysort.md
Normal file
29
docs/sdk/models/operations/getallmedialibrarysort.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# GetAllMediaLibrarySort
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibrarySort } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibrarySort = {
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `default` | *string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `active` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `activeDirection` | [operations.GetAllMediaLibraryActiveDirection](../../../sdk/models/operations/getallmedialibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `defaultDirection` | [operations.GetAllMediaLibraryDefaultDirection](../../../sdk/models/operations/getallmedialibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `descKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `firstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||
109
docs/sdk/models/operations/getallmedialibrarystream.md
Normal file
109
docs/sdk/models/operations/getallmedialibrarystream.md
Normal file
@@ -0,0 +1,109 @@
|
||||
# GetAllMediaLibraryStream
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryStream } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryStream = {
|
||||
id: 1002625,
|
||||
streamType: 1,
|
||||
default: true,
|
||||
codec: "hevc",
|
||||
index: 0,
|
||||
bitrate: 24743,
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
doviLevel: 6,
|
||||
doviPresent: true,
|
||||
doviProfile: 8,
|
||||
dovirpuPresent: true,
|
||||
doviVersion: "1.0",
|
||||
bitDepth: 10,
|
||||
chromaLocation: "topleft",
|
||||
chromaSubsampling: "4:2:0",
|
||||
codedHeight: 1608,
|
||||
codedWidth: 3840,
|
||||
colorPrimaries: "bt2020",
|
||||
colorRange: "tv",
|
||||
colorSpace: "bt2020nc",
|
||||
colorTrc: "smpte2084",
|
||||
frameRate: 23.976,
|
||||
height: 1602,
|
||||
level: 150,
|
||||
original: true,
|
||||
hasScalingMatrix: false,
|
||||
profile: "main 10",
|
||||
scanType: "progressive",
|
||||
refFrames: 1,
|
||||
width: 3840,
|
||||
displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
|
||||
selected: true,
|
||||
forced: true,
|
||||
channels: 6,
|
||||
audioChannelLayout: "5.1(side)",
|
||||
samplingRate: 48000,
|
||||
canAutoSync: false,
|
||||
hearingImpaired: true,
|
||||
dub: true,
|
||||
title: "SDH",
|
||||
};
|
||||
```
|
||||
|
||||
## 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_check_mark: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
56
docs/sdk/models/operations/getallmedialibrarytype.md
Normal file
56
docs/sdk/models/operations/getallmedialibrarytype.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# GetAllMediaLibraryType
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
{
|
||||
filter: "genre",
|
||||
filterType: "string",
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
{
|
||||
default: "asc",
|
||||
active: false,
|
||||
descKey: "titleSort:desc",
|
||||
firstCharacterKey: "/library/sections/2/firstCharacter",
|
||||
key: "titleSort",
|
||||
title: "Title",
|
||||
},
|
||||
],
|
||||
field: [
|
||||
{
|
||||
key: "show.title",
|
||||
title: "Show Title",
|
||||
type: "string",
|
||||
subType: "rating",
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | N/A | clip |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | [operations.GetAllMediaLibraryFilter](../../../sdk/models/operations/getallmedialibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | [operations.GetAllMediaLibrarySort](../../../sdk/models/operations/getallmedialibrarysort.md)[] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | [operations.GetAllMediaLibraryField](../../../sdk/models/operations/getallmedialibraryfield.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -0,0 +1,23 @@
|
||||
# GetAllMediaLibraryUltraBlurColors
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryUltraBlurColors } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryUltraBlurColors = {
|
||||
topLeft: "11333b",
|
||||
topRight: "0a232d",
|
||||
bottomRight: "73958",
|
||||
bottomLeft: "1f5066",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| 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 |
|
||||
17
docs/sdk/models/operations/getallmedialibrarywriter.md
Normal file
17
docs/sdk/models/operations/getallmedialibrarywriter.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetAllMediaLibraryWriter
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetAllMediaLibraryWriter } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetAllMediaLibraryWriter = {
|
||||
tag: "Danny Boyle",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle |
|
||||
@@ -7,7 +7,7 @@ import { GetBandwidthStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetBandwidthStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 500,
|
||||
statusCode: 424,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,16 +7,16 @@ import { GetCountriesLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/
|
||||
|
||||
let value: GetCountriesLibraryMediaContainer = {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Country",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
@@ -32,18 +32,16 @@ let value: GetCountriesLibraryMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | N/A | By Country |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `directory` | [operations.GetCountriesLibraryDirectory](../../../sdk/models/operations/getcountrieslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -7,23 +7,23 @@ import { GetCountriesLibraryResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetCountriesLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 300,
|
||||
statusCode: 510,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Country",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -10,16 +10,16 @@ import { GetCountriesLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/op
|
||||
let value: GetCountriesLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Series",
|
||||
title2: "By Country",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -7,16 +7,16 @@ import { GetGenresLibraryMediaContainer } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetGenresLibraryMediaContainer = {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Shows (Reality)",
|
||||
title2: "By Genre",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
@@ -33,18 +33,16 @@ let value: GetGenresLibraryMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||
| `offset` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `totalSize` | *number* | :heavy_minus_sign: | N/A | |
|
||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | N/A | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | N/A | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
|
||||
| `title2` | *string* | :heavy_check_mark: | N/A | By Genre |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *number* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `nocache` | *boolean* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `directory` | [operations.GetGenresLibraryDirectory](../../../sdk/models/operations/getgenreslibrarydirectory.md)[] | :heavy_minus_sign: | N/A | |
|
||||
@@ -7,23 +7,23 @@ import { GetGenresLibraryResponse } from "@lukehagar/plexjs/sdk/models/operation
|
||||
|
||||
let value: GetGenresLibraryResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 506,
|
||||
statusCode: 428,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
object: {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Shows (Reality)",
|
||||
title2: "By Genre",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -10,16 +10,16 @@ import { GetGenresLibraryResponseBody } from "@lukehagar/plexjs/sdk/models/opera
|
||||
let value: GetGenresLibraryResponseBody = {
|
||||
mediaContainer: {
|
||||
size: 50,
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
allowSync: false,
|
||||
art: "/:/resources/show-fanart.jpg",
|
||||
content: "secondary",
|
||||
identifier: "com.plexapp.plugins.library",
|
||||
mediaTagPrefix: "/system/bundle/media/flags/",
|
||||
mediaTagVersion: 1734362201,
|
||||
nocache: true,
|
||||
thumb: "/:/resources/show.png",
|
||||
title1: "TV Shows (Reality)",
|
||||
title2: "By Genre",
|
||||
title1: "TV Series",
|
||||
title2: "By Starring Actor",
|
||||
viewGroup: "secondary",
|
||||
directory: [
|
||||
{
|
||||
|
||||
@@ -11,6 +11,7 @@ let value: GetLibraryItemsFilter = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -22,4 +23,5 @@ let value: GetLibraryItemsFilter = {
|
||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `advanced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
@@ -18,4 +18,6 @@ let value: GetLibraryItemsLibraryType = GetLibraryItemsLibraryType.Movie;
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
@@ -21,7 +21,8 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -31,6 +32,7 @@ let value: GetLibraryItemsMediaContainer = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -25,7 +25,8 @@ let value: GetLibraryItemsResponse = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -35,6 +36,7 @@ let value: GetLibraryItemsResponse = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -21,7 +21,8 @@ let value: GetLibraryItemsResponseBody = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -31,6 +32,7 @@ let value: GetLibraryItemsResponseBody = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -7,7 +7,8 @@ import { GetLibraryItemsType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetLibraryItemsType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -17,6 +18,7 @@ let value: GetLibraryItemsType = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
@@ -45,7 +47,8 @@ let value: GetLibraryItemsType = {
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | show |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | N/A | clip |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | [operations.GetLibraryItemsFilter](../../../sdk/models/operations/getlibraryitemsfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
|
||||
17
docs/sdk/models/operations/getmediametadataguids.md
Normal file
17
docs/sdk/models/operations/getmediametadataguids.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetMediaMetaDataGuids
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataGuids } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataGuids = {
|
||||
id: "imdb://tt3032476",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
|
||||
18
docs/sdk/models/operations/getmediametadatahasthumbnail.md
Normal file
18
docs/sdk/models/operations/getmediametadatahasthumbnail.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# GetMediaMetaDataHasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataHasThumbnail } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataHasThumbnail = GetMediaMetaDataHasThumbnail.True;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `False` | 0 |
|
||||
| `True` | 1 |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetMediaMetaDataLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetMediaMetaDataOptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.GetMediaMetaDataOptimizedForStreaming1 =
|
||||
GetMediaMetaDataOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -13,6 +13,7 @@ let value: GetMediaMetaDataMedia = {
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
@@ -20,6 +21,8 @@ let value: GetMediaMetaDataMedia = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
@@ -30,8 +33,11 @@ let value: GetMediaMetaDataMedia = {
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
@@ -43,6 +49,7 @@ let value: GetMediaMetaDataMedia = {
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
@@ -92,17 +99,21 @@ let value: GetMediaMetaDataMedia = {
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *number* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *number* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *number* | :heavy_check_mark: | Video width in pixels. | 3840 |
|
||||
| `height` | *number* | :heavy_check_mark: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *number* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_check_mark: | Number of audio channels. | 6 |
|
||||
| `audioCodec` | *string* | :heavy_check_mark: | Audio codec used. | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_check_mark: | Video codec used. | hevc |
|
||||
| `videoResolution` | *string* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *string* | :heavy_check_mark: | File container type. | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
|
||||
| `videoProfile` | *string* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
|
||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *number* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *number* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *number* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *number* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *number* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||
| `videoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `videoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *string* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `videoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `hasVoiceActivity` | *boolean* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | *operations.GetMediaMetaDataOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | [operations.GetMediaMetaDataPart](../../../sdk/models/operations/getmediametadatapart.md)[] | :heavy_check_mark: | An array of parts for this media item. | |
|
||||
@@ -46,6 +46,8 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
@@ -57,8 +59,8 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
addedAt: 1625505101,
|
||||
updatedAt: 1736487993,
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
@@ -73,6 +75,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
@@ -80,6 +83,8 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
@@ -90,8 +95,11 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
@@ -103,6 +111,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
@@ -178,7 +187,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
id: "imdb://tt3032476",
|
||||
},
|
||||
],
|
||||
rating: [
|
||||
ratings: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 9,
|
||||
@@ -250,7 +259,7 @@ let value: GetMediaMetaDataMediaContainer = {
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `size` | *number* | :heavy_check_mark: | N/A | 50 |
|
||||
| `size` | *number* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *number* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
|
||||
@@ -36,6 +36,8 @@ let value: GetMediaMetaDataMetadata = {
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
@@ -47,8 +49,8 @@ let value: GetMediaMetaDataMetadata = {
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
addedAt: 1625505101,
|
||||
updatedAt: 1736487993,
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
@@ -63,6 +65,7 @@ let value: GetMediaMetaDataMetadata = {
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
@@ -70,6 +73,8 @@ let value: GetMediaMetaDataMetadata = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
@@ -80,8 +85,11 @@ let value: GetMediaMetaDataMetadata = {
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
@@ -93,6 +101,7 @@ let value: GetMediaMetaDataMetadata = {
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
@@ -168,7 +177,7 @@ let value: GetMediaMetaDataMetadata = {
|
||||
id: "imdb://tt3032476",
|
||||
},
|
||||
],
|
||||
rating: [
|
||||
ratings: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 9,
|
||||
@@ -256,16 +265,18 @@ let value: GetMediaMetaDataMetadata = {
|
||||
| `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_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
|
||||
| `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_check_mark: | The audience rating for the content. | 8.7 |
|
||||
| `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 |
|
||||
@@ -273,13 +284,13 @@ let value: GetMediaMetaDataMetadata = {
|
||||
| `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_check_mark: | The original release date. | 2015-02-08 |
|
||||
| `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: | Unix timestamp when the item was added. | 1625505101 |
|
||||
| `updatedAt` | *number* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
|
||||
| `audienceRatingImage` | *string* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
|
||||
| `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 |
|
||||
@@ -289,8 +300,8 @@ let value: GetMediaMetaDataMetadata = {
|
||||
| `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.Guids](../../../sdk/models/operations/guids.md)[] | :heavy_check_mark: | An array of GUID objects. | |
|
||||
| `rating` | [operations.Rating](../../../sdk/models/operations/rating.md)[] | :heavy_check_mark: | An array of rating objects. | |
|
||||
| `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. | |
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
# GetMediaMetaDataOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.OptimizedForStreaming1`
|
||||
|
||||
```typescript
|
||||
const value: operations.OptimizedForStreaming1 = OptimizedForStreaming1.Zero;
|
||||
```
|
||||
|
||||
### `boolean`
|
||||
|
||||
```typescript
|
||||
const value: boolean = false;
|
||||
```
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# GetMediaMetaDataOptimizedForStreaming1
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMediaMetaDataOptimizedForStreaming1 } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMediaMetaDataOptimizedForStreaming1 =
|
||||
GetMediaMetaDataOptimizedForStreaming1.One;
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -14,8 +14,11 @@ let value: GetMediaMetaDataPart = {
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
@@ -27,6 +30,7 @@ let value: GetMediaMetaDataPart = {
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
@@ -71,16 +75,21 @@ let value: GetMediaMetaDataPart = {
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *number* | :heavy_check_mark: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *number* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `container` | *string* | :heavy_check_mark: | Container format of the part. | mkv |
|
||||
| `videoProfile` | *string* | :heavy_check_mark: | Video profile for the part. | main 10 |
|
||||
| `stream` | [operations.GetMediaMetaDataStream](../../../sdk/models/operations/getmediametadatastream.md)[] | :heavy_check_mark: | An array of streams for this part. | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| `accessible` | *boolean* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *boolean* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *number* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *number* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *number* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *number* | :heavy_minus_sign: | N/A | 188 |
|
||||
| `container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||
| `videoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||
| `audioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `has64bitOffsets` | *boolean* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *operations.GetMediaMetaDataLibraryOptimizedForStreaming* | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `hasThumbnail` | [operations.GetMediaMetaDataHasThumbnail](../../../sdk/models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | [operations.GetMediaMetaDataStream](../../../sdk/models/operations/getmediametadatastream.md)[] | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetMediaMetaDataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 103,
|
||||
statusCode: 226,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
@@ -53,6 +53,8 @@ let value: GetMediaMetaDataResponse = {
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
@@ -64,8 +66,8 @@ let value: GetMediaMetaDataResponse = {
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
addedAt: 1625505101,
|
||||
updatedAt: 1736487993,
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
@@ -80,6 +82,7 @@ let value: GetMediaMetaDataResponse = {
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
@@ -87,6 +90,8 @@ let value: GetMediaMetaDataResponse = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
@@ -97,8 +102,11 @@ let value: GetMediaMetaDataResponse = {
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
@@ -110,6 +118,7 @@ let value: GetMediaMetaDataResponse = {
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
@@ -185,7 +194,7 @@ let value: GetMediaMetaDataResponse = {
|
||||
id: "imdb://tt3032476",
|
||||
},
|
||||
],
|
||||
rating: [
|
||||
ratings: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 9,
|
||||
|
||||
@@ -49,6 +49,8 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
skipCount: 1,
|
||||
lastViewedAt: 1625764795,
|
||||
year: 2015,
|
||||
rating: 6,
|
||||
ratingImage: "rottentomatoes://image.rating.ripe",
|
||||
tagline: "Make the call",
|
||||
chapterSource: "media",
|
||||
primaryExtraKey: "/library/metadata/134704",
|
||||
@@ -60,8 +62,8 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
leafCount: 63,
|
||||
viewedLeafCount: 4,
|
||||
childCount: 6,
|
||||
addedAt: 1625505101,
|
||||
updatedAt: 1736487993,
|
||||
addedAt: 1556281940,
|
||||
updatedAt: 1556281940,
|
||||
audienceRatingImage: "themoviedb://image.rating",
|
||||
parentIndex: 2,
|
||||
parentThumb: "/library/metadata/48047/thumb/1671800243",
|
||||
@@ -76,6 +78,7 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
height: 1602,
|
||||
aspectRatio: 2.35,
|
||||
audioChannels: 6,
|
||||
displayOffset: 50,
|
||||
audioCodec: "eac3",
|
||||
videoCodec: "hevc",
|
||||
videoResolution: "4k",
|
||||
@@ -83,6 +86,8 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
videoFrameRate: "24p",
|
||||
videoProfile: "main 10",
|
||||
hasVoiceActivity: false,
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
part: [
|
||||
{
|
||||
accessible: true,
|
||||
@@ -93,8 +98,11 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
duration: 9610350,
|
||||
file: "/mnt/Movies_1/W/Wicked (2024).mkv",
|
||||
size: 30649952104,
|
||||
packetLength: 188,
|
||||
container: "mkv",
|
||||
videoProfile: "main 10",
|
||||
audioProfile: "dts",
|
||||
has64bitOffsets: false,
|
||||
stream: [
|
||||
{
|
||||
id: 1002625,
|
||||
@@ -106,6 +114,7 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
@@ -181,7 +190,7 @@ let value: GetMediaMetaDataResponseBody = {
|
||||
id: "imdb://tt3032476",
|
||||
},
|
||||
],
|
||||
rating: [
|
||||
ratings: [
|
||||
{
|
||||
image: "imdb://image.rating",
|
||||
value: 9,
|
||||
|
||||
@@ -15,6 +15,7 @@ let value: GetMediaMetaDataStream = {
|
||||
language: "English",
|
||||
languageTag: "en",
|
||||
languageCode: "eng",
|
||||
headerCompression: true,
|
||||
doviblCompatID: 1,
|
||||
doviblPresent: true,
|
||||
dovielPresent: false,
|
||||
@@ -64,10 +65,11 @@ let value: GetMediaMetaDataStream = {
|
||||
| `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_check_mark: | Bitrate of the stream. | 24743 |
|
||||
| `bitrate` | *number* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *string* | :heavy_check_mark: | Language of the stream. | English |
|
||||
| `languageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
|
||||
| `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 |
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetMetadataChildrenRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetMetadataChildrenRequest = {
|
||||
ratingKey: 2239.24,
|
||||
ratingKey: 6139.66,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetMetadataChildrenResponse } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetMetadataChildrenResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 226,
|
||||
statusCode: 305,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetOnDeckResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetOnDeckResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 202,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistContentsQueryParamType, GetPlaylistContentsRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistContentsRequest = {
|
||||
playlistID: 6289.82,
|
||||
playlistID: 2539.41,
|
||||
type: GetPlaylistContentsQueryParamType.TvShow,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -8,7 +8,7 @@ import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||||
|
||||
let value: GetPlaylistContentsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 503,
|
||||
statusCode: 205,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
import { GetPlaylistRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistRequest = {
|
||||
playlistID: 2168.97,
|
||||
playlistID: 8726.51,
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 407,
|
||||
statusCode: 207,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetPlaylistsResponse } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetPlaylistsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 511,
|
||||
statusCode: 506,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -11,6 +11,7 @@ let value: GetRecentlyAddedFilter = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -22,4 +23,5 @@ let value: GetRecentlyAddedFilter = {
|
||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `advanced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
@@ -18,4 +18,6 @@ let value: GetRecentlyAddedHubsType = GetRecentlyAddedHubsType.Movie;
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
@@ -11,6 +11,7 @@ let value: GetRecentlyAddedLibraryFilter = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
};
|
||||
```
|
||||
|
||||
@@ -22,4 +23,5 @@ let value: GetRecentlyAddedLibraryFilter = {
|
||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `advanced` | *boolean* | :heavy_minus_sign: | N/A | true |
|
||||
@@ -12,7 +12,8 @@ let value: GetRecentlyAddedLibraryMediaContainer = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -22,6 +23,7 @@ let value: GetRecentlyAddedLibraryMediaContainer = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -16,7 +16,8 @@ let value: GetRecentlyAddedLibraryResponse = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -26,6 +27,7 @@ let value: GetRecentlyAddedLibraryResponse = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -12,7 +12,8 @@ let value: GetRecentlyAddedLibraryResponseBody = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -22,6 +23,7 @@ let value: GetRecentlyAddedLibraryResponseBody = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -7,7 +7,8 @@ import { GetRecentlyAddedLibraryType } from "@lukehagar/plexjs/sdk/models/operat
|
||||
|
||||
let value: GetRecentlyAddedLibraryType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -17,6 +18,7 @@ let value: GetRecentlyAddedLibraryType = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
@@ -45,7 +47,8 @@ let value: GetRecentlyAddedLibraryType = {
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | show |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | N/A | clip |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | [operations.GetRecentlyAddedLibraryFilter](../../../sdk/models/operations/getrecentlyaddedlibraryfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
|
||||
@@ -22,7 +22,8 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -32,6 +33,7 @@ let value: GetRecentlyAddedMediaContainer = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -29,7 +29,8 @@ let value: GetRecentlyAddedResponse = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -39,6 +40,7 @@ let value: GetRecentlyAddedResponse = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -25,7 +25,8 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
type: [
|
||||
{
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -35,6 +36,7 @@ let value: GetRecentlyAddedResponseBody = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
|
||||
@@ -7,7 +7,8 @@ import { GetRecentlyAddedType } from "@lukehagar/plexjs/sdk/models/operations";
|
||||
|
||||
let value: GetRecentlyAddedType = {
|
||||
key: "/library/sections/2/all?type=2",
|
||||
type: "show",
|
||||
type: "filter",
|
||||
subtype: "clip",
|
||||
title: "TV Shows",
|
||||
active: false,
|
||||
filter: [
|
||||
@@ -17,6 +18,7 @@ let value: GetRecentlyAddedType = {
|
||||
key: "/library/sections/2/genre?type=2",
|
||||
title: "Genre",
|
||||
type: "filter",
|
||||
advanced: true,
|
||||
},
|
||||
],
|
||||
sort: [
|
||||
@@ -45,7 +47,8 @@ let value: GetRecentlyAddedType = {
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | show |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
| `subtype` | *string* | :heavy_minus_sign: | N/A | clip |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *boolean* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | [operations.GetRecentlyAddedFilter](../../../sdk/models/operations/getrecentlyaddedfilter.md)[] | :heavy_minus_sign: | N/A | |
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetRefreshLibraryMetadataResponse } from "@lukehagar/plexjs/sdk/models/
|
||||
|
||||
let value: GetRefreshLibraryMetadataResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 102,
|
||||
statusCode: 300,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
@@ -7,7 +7,7 @@ import { GetResourcesStatisticsResponse } from "@lukehagar/plexjs/sdk/models/ope
|
||||
|
||||
let value: GetResourcesStatisticsResponse = {
|
||||
contentType: "<value>",
|
||||
statusCode: 423,
|
||||
statusCode: 103,
|
||||
rawResponse: new Response("{\"message\": \"hello world\"}", {
|
||||
headers: { "Content-Type": "application/json" },
|
||||
}),
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user