mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-06 04:20:51 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.558.1
This commit is contained in:
speakeasybot
File diff suppressed because one or more lines are too long
@@ -17,12 +17,13 @@ generation:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
oAuth2PasswordEnabled: false
|
||||
php:
|
||||
version: 0.14.9
|
||||
version: 0.14.10
|
||||
additionalDependencies:
|
||||
autoload: {}
|
||||
autoload-dev: {}
|
||||
require: {}
|
||||
require-dev: {}
|
||||
baseErrorName: PlexAPIError
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: SDKException
|
||||
flattenGlobalSecurity: true
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
speakeasyVersion: 1.555.3
|
||||
speakeasyVersion: 1.558.1
|
||||
sources:
|
||||
my-source:
|
||||
sourceNamespace: my-source
|
||||
@@ -9,19 +9,19 @@ sources:
|
||||
- main
|
||||
plexapi:
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
||||
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
||||
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||
tags:
|
||||
- latest
|
||||
- speakeasy-sdk-regen-1749082302
|
||||
- speakeasy-sdk-regen-1749514303
|
||||
targets:
|
||||
plexphp:
|
||||
source: plexapi
|
||||
sourceNamespace: plexapi
|
||||
sourceRevisionDigest: sha256:78d07ad78ff60d0e9918696208d8c68a562e170d4e9c431797c02995fb8816d0
|
||||
sourceBlobDigest: sha256:d38dd2a36c1b2fd73409267f7b30c2d5d45d709616141803ea01db424ec68ae4
|
||||
sourceRevisionDigest: sha256:dafcc1192236829b85bc924e0462432c0eb7318a17c542f46e3dd05a9a6265df
|
||||
sourceBlobDigest: sha256:bc072115d585e1695cb8393db901a3d36be1dcd57a69bad2b91a1ba7ac3c9c4b
|
||||
codeSamplesNamespace: code-samples-php-plexphp
|
||||
codeSamplesRevisionDigest: sha256:4ca8d0766e43f9b1d14040ccc0fef1806a7a1b762560ecc219d955f4cc05e011
|
||||
codeSamplesRevisionDigest: sha256:8b2b7270f7415ee4a61be4aaa71c1a33ac039a2e6568b38020afb48771e31767
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
|
||||
12
RELEASES.md
12
RELEASES.md
@@ -892,4 +892,14 @@ Based on:
|
||||
### Generated
|
||||
- [php v0.14.9] .
|
||||
### Releases
|
||||
- [Composer v0.14.9] https://packagist.org/packages/lukehagar/plex-api#v0.14.9 - .
|
||||
- [Composer v0.14.9] https://packagist.org/packages/lukehagar/plex-api#v0.14.9 - .
|
||||
|
||||
## 2025-06-10 00:11:27
|
||||
### Changes
|
||||
Based on:
|
||||
- OpenAPI Doc
|
||||
- Speakeasy CLI 1.558.1 (2.623.4) https://github.com/speakeasy-api/speakeasy
|
||||
### Generated
|
||||
- [php v0.14.10] .
|
||||
### Releases
|
||||
- [Composer v0.14.10] https://packagist.org/packages/lukehagar/plex-api#v0.14.10 - .
|
||||
@@ -1,11 +0,0 @@
|
||||
# EnableCreditsMarkerGeneration
|
||||
|
||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# EpisodeSort
|
||||
|
||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
@@ -3,6 +3,7 @@
|
||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
|
||||
@@ -16,5 +16,5 @@
|
||||
| `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 |
|
||||
| `viewMode` | *string* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||
| `viewMode` | *?string* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||
| `directory` | array<[Operations\GetActorsLibraryDirectory](../../Models/Operations/GetActorsLibraryDirectory.md)> | :heavy_minus_sign: | An array of actor entries for media items. | |
|
||||
@@ -3,6 +3,6 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
@@ -9,5 +9,4 @@
|
||||
| `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` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
8
docs/Models/Operations/GetLibraryItemsGuids.md
Normal file
8
docs/Models/Operations/GetLibraryItemsGuids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetLibraryItemsGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||
@@ -1,5 +1,8 @@
|
||||
# GetLibraryItemsHasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [Operations\GetLibraryItemsLibraryResponse200Type](../../Models/Operations/GetLibraryItemsLibraryResponse200Type.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [Operations\GetLibraryItemsLibraryResponseType](../../Models/Operations/GetLibraryItemsLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetLibraryItemsLibraryActiveDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetLibraryItemsLibraryDefaultDirection
|
||||
|
||||
The direction of the sort. Can be either `asc` or `desc`.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Ascending` | asc |
|
||||
| `Descending` | desc |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryItemsLibraryField
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | show.title |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Show Title |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `subType` | *?string* | :heavy_minus_sign: | N/A | rating |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetLibraryItemsLibraryFieldType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | tag |
|
||||
| `operator` | array<[Operations\GetLibraryItemsLibraryOperator](../../Models/Operations/GetLibraryItemsLibraryOperator.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetLibraryItemsLibraryFilter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | genre |
|
||||
| `filterType` | *string* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | filter |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetLibraryItemsLibraryOperator
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | = |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | is |
|
||||
@@ -0,0 +1,26 @@
|
||||
# GetLibraryItemsLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `Operations\GetLibraryItemsOptimizedForStreaming1`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var Operations\GetLibraryItemsOptimizedForStreaming1
|
||||
*/
|
||||
Operations\GetLibraryItemsOptimizedForStreaming1 $value = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var bool
|
||||
*/
|
||||
bool $value = /* values here */
|
||||
```
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryItemsLibraryResponse200Type
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
@@ -1,14 +1,11 @@
|
||||
# GetLibraryItemsLibraryResponseType
|
||||
|
||||
|
||||
## Fields
|
||||
## Values
|
||||
|
||||
| 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 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | array<[Operations\GetLibraryItemsLibraryFilter](../../Models/Operations/GetLibraryItemsLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | array<[Operations\GetLibraryItemsLibrarySort](../../Models/Operations/GetLibraryItemsLibrarySort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | array<[Operations\GetLibraryItemsLibraryField](../../Models/Operations/GetLibraryItemsLibraryField.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `CoverPoster` | coverPoster |
|
||||
| `Background` | background |
|
||||
| `Snapshot` | snapshot |
|
||||
| `ClearLogo` | clearLogo |
|
||||
@@ -1,15 +0,0 @@
|
||||
# GetLibraryItemsLibrarySort
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
||||
| `default` | *?string* | :heavy_minus_sign: | N/A | asc |
|
||||
| `active` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `activeDirection` | [?Operations\GetLibraryItemsLibraryActiveDirection](../../Models/Operations/GetLibraryItemsLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `defaultDirection` | [?Operations\GetLibraryItemsLibraryDefaultDirection](../../Models/Operations/GetLibraryItemsLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `descKey` | *?string* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `firstCharacterKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Title |
|
||||
@@ -1,20 +1,14 @@
|
||||
# GetLibraryItemsLibraryType
|
||||
|
||||
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||
|
||||
## Fields
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| `Track` | track |
|
||||
| `PhotoAlbum` | photoalbum |
|
||||
| `Photo` | photo |
|
||||
| `Collection` | collection |
|
||||
| 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 |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | array<[Operations\GetLibraryItemsFilter](../../Models/Operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | array<[Operations\GetLibraryItemsSort](../../Models/Operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | array<[Operations\GetLibraryItemsField](../../Models/Operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,8 +1,10 @@
|
||||
# GetLibraryItemsLocation
|
||||
|
||||
The folder path for the media item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `path` | *?string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `path` | *string* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||
@@ -3,23 +3,24 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [?Operations\GetLibraryItemsOptimizedForStreaming](../../Models/Operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | array<[Operations\GetLibraryItemsPart](../../Models/Operations/GetLibraryItemsPart.md)> | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||
| `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: | Container format of the media. | mp4 |
|
||||
| `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` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | [Operations\OptimizedForStreaming1\|bool\|null](../../Models/Operations/GetLibraryItemsOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
|
||||
| `part` | array<[Operations\GetLibraryItemsPart](../../Models/Operations/GetLibraryItemsPart.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,33 +1,28 @@
|
||||
# GetLibraryItemsMediaContainer
|
||||
|
||||
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `type` | array<[Operations\GetLibraryItemsType](../../Models/Operations/GetLibraryItemsType.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `fieldType` | array<[Operations\GetLibraryItemsFieldType](../../Models/Operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
|
||||
| `totalSize` | *int* | :heavy_check_mark: | N/A | 170 |
|
||||
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `content` | *string* | :heavy_check_mark: | N/A | secondary |
|
||||
| `allowSync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `nocache` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *string* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `librarySectionID` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `librarySectionUUID` | *string* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *int* | :heavy_check_mark: | N/A | 1701731894 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `title1` | *string* | :heavy_check_mark: | N/A | Movies |
|
||||
| `title2` | *string* | :heavy_check_mark: | N/A | Recently Released |
|
||||
| `viewGroup` | *string* | :heavy_check_mark: | N/A | movie |
|
||||
| `viewMode` | *?int* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `mixedParents` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `meta` | [?Operations\GetLibraryItemsMeta](../../Models/Operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `allowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `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 |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *int* | :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 |
|
||||
| `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 |
|
||||
| `viewMode` | *?string* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||
| `mixedParents` | *?bool* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
|
||||
| `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
|
||||
| `meta` | [?Operations\GetLibraryItemsMeta](../../Models/Operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
|
||||
@@ -6,7 +6,7 @@ The Meta object is only included in the response if the `includeMeta` parameter
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
|
||||
| `type` | array<[Operations\GetLibraryItemsLibraryResponseType](../../Models/Operations/GetLibraryItemsLibraryResponseType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | array<[Operations\GetLibraryItemsLibraryFieldType](../../Models/Operations/GetLibraryItemsLibraryFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
||||
| `type` | array<[Operations\GetLibraryItemsLibraryType](../../Models/Operations/GetLibraryItemsLibraryType.md)> | :heavy_minus_sign: | N/A |
|
||||
| `fieldType` | array<[Operations\GetLibraryItemsFieldType](../../Models/Operations/GetLibraryItemsFieldType.md)> | :heavy_minus_sign: | N/A |
|
||||
@@ -1,83 +1,88 @@
|
||||
# GetLibraryItemsMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `type` | [Operations\GetLibraryItemsLibraryType](../../Models/Operations/GetLibraryItemsLibraryType.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *?int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `seasonCount` | *?int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *?string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flattenSeasons` | [?Operations\FlattenSeasons](../../Models/Operations/FlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||
| `episodeSort` | [?Operations\EpisodeSort](../../Models/Operations/EpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||
| `enableCreditsMarkerGeneration` | [?Operations\EnableCreditsMarkerGeneration](../../Models/Operations/EnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `showOrdering` | [?Operations\ShowOrdering](../../Models/Operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentArt` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | array<[Operations\GetLibraryItemsMedia](../../Models/Operations/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | array<[Operations\GetLibraryItemsGenre](../../Models/Operations/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | array<[Operations\GetLibraryItemsCountry](../../Models/Operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | array<[Operations\GetLibraryItemsDirector](../../Models/Operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | array<[Operations\GetLibraryItemsWriter](../../Models/Operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | array<[Operations\GetLibraryItemsCollection](../../Models/Operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | array<[Operations\GetLibraryItemsRole](../../Models/Operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | array<[Operations\GetLibraryItemsLocation](../../Models/Operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | array<[Operations\MediaGuid](../../Models/Operations/MediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [?Operations\GetLibraryItemsUltraBlurColors](../../Models/Operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | array<[Operations\MetaDataRating](../../Models/Operations/MetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `image` | array<[Operations\GetLibraryItemsImage](../../Models/Operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *?string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *?int* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *?string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *?int* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leafCount` | *?int* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `childCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumExtras` | *?string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *?string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentStudio` | *?string* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parentIndex` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentYear` | *?int* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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\GetLibraryItemsType](../../Models/Operations/GetLibraryItemsType.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `banner` | *string* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
|
||||
| `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` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `year` | *?int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *?int* | :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` | *?int* | :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` | *?int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *?int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `skipCount` | *?int* | :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` | *?int* | :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` | *?int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `userRating` | *?float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | array<[Operations\GetLibraryItemsImage](../../Models/Operations/GetLibraryItemsImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [?Operations\GetLibraryItemsUltraBlurColors](../../Models/Operations/GetLibraryItemsUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | array<[Operations\GetLibraryItemsGuids](../../Models/Operations/GetLibraryItemsGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `librarySectionKey` | *?string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `showOrdering` | [?Operations\ShowOrdering](../../Models/Operations/ShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
|
||||
| `flattenSeasons` | [?Operations\FlattenSeasons](../../Models/Operations/FlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).<br/> | 1 |
|
||||
| `skipChildren` | *?bool* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||
| `media` | array<[Operations\GetLibraryItemsMedia](../../Models/Operations/GetLibraryItemsMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | array<[Operations\GetLibraryItemsGenre](../../Models/Operations/GetLibraryItemsGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | array<[Operations\GetLibraryItemsCountry](../../Models/Operations/GetLibraryItemsCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | array<[Operations\GetLibraryItemsDirector](../../Models/Operations/GetLibraryItemsDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | array<[Operations\GetLibraryItemsWriter](../../Models/Operations/GetLibraryItemsWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | array<[Operations\GetLibraryItemsProducer](../../Models/Operations/GetLibraryItemsProducer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | array<[Operations\GetLibraryItemsCollection](../../Models/Operations/GetLibraryItemsCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | array<[Operations\GetLibraryItemsRole](../../Models/Operations/GetLibraryItemsRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | array<[Operations\Ratings](../../Models/Operations/Ratings.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | array<[Operations\GetLibraryItemsSimilar](../../Models/Operations/GetLibraryItemsSimilar.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | array<[Operations\GetLibraryItemsLocation](../../Models/Operations/GetLibraryItemsLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | array<[Operations\Chapter](../../Models/Operations/Chapter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | array<[Operations\Marker](../../Models/Operations/Marker.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [?Operations\Extras](../../Models/Operations/Extras.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,9 +1,25 @@
|
||||
# GetLibraryItemsOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
## Supported Types
|
||||
|
||||
### `Operations\OptimizedForStreaming1`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var Operations\OptimizedForStreaming1
|
||||
*/
|
||||
Operations\OptimizedForStreaming1 $value = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var bool
|
||||
*/
|
||||
bool $value = /* values here */
|
||||
```
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetLibraryItemsOptimizedForStreaming1
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -3,18 +3,20 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `hasThumbnail` | [?Operations\GetLibraryItemsHasThumbnail](../../Models/Operations/GetLibraryItemsHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | array<[Operations\GetLibraryItemsStream](../../Models/Operations/GetLibraryItemsStream.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *?string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *?string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *?int* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *?int* | :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` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Operations\GetLibraryItemsOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetLibraryItemsLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||
| `hasThumbnail` | [?Operations\GetLibraryItemsHasThumbnail](../../Models/Operations/GetLibraryItemsHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
13
docs/Models/Operations/GetLibraryItemsProducer.md
Normal file
13
docs/Models/Operations/GetLibraryItemsProducer.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# GetLibraryItemsProducer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique role identifier. | 109501 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tagKey` | *string* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *?string* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | URL for the role thumbnail image. | https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg |
|
||||
@@ -3,11 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *?int* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `filter` | *?string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `tagKey` | *?string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `role` | *?string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `role` | *?string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||
10
docs/Models/Operations/GetLibraryItemsSimilar.md
Normal file
10
docs/Models/Operations/GetLibraryItemsSimilar.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# GetLibraryItemsSimilar
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique similar item identifier. | 26 |
|
||||
| `filter` | *string* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The tag or title of the similar content. | Breaking Bad |
|
||||
@@ -1,45 +0,0 @@
|
||||
# GetLibraryItemsStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 272796 |
|
||||
| `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `colorSpace` | *?string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `colorTrc` | *?string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `bitDepth` | *?int* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `chromaLocation` | *?string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `streamIdentifier` | *?string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `codedHeight` | *?int* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `codedWidth` | *?int* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `frameRate` | *?float* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `level` | *?int* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `profile` | *?string* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `scanType` | *?string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `width` | *?int* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `displayTitle` | *?string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `extendedDisplayTitle` | *?string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `language` | *?string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `languageCode` | *?string* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `title` | *?string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
@@ -1,15 +1,20 @@
|
||||
# GetLibraryItemsType
|
||||
|
||||
The type of media content in the Plex library. This can represent videos, music, or photos.
|
||||
|
||||
## 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` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter` | array<[Operations\GetLibraryItemsFilter](../../Models/Operations/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | array<[Operations\GetLibraryItemsSort](../../Models/Operations/GetLibraryItemsSort.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `field` | array<[Operations\GetLibraryItemsField](../../Models/Operations/GetLibraryItemsField.md)> | :heavy_minus_sign: | N/A | |
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `Movie` | movie |
|
||||
| `TvShow` | show |
|
||||
| `Season` | season |
|
||||
| `Episode` | episode |
|
||||
| `Artist` | artist |
|
||||
| `Album` | album |
|
||||
| `Track` | track |
|
||||
| `PhotoAlbum` | photoalbum |
|
||||
| `Photo` | photo |
|
||||
| `Collection` | collection |
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
@@ -5,13 +5,13 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `Operations\GetLibrarySectionsAllOptimizedForStreaming1`
|
||||
### `Operations\GetLibrarySectionsAllOptimizedForStreamingLibrary1`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var Operations\GetLibrarySectionsAllOptimizedForStreaming1
|
||||
* @var Operations\GetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||
*/
|
||||
Operations\GetLibrarySectionsAllOptimizedForStreaming1 $value = /* values here */
|
||||
Operations\GetLibrarySectionsAllOptimizedForStreamingLibrary1 $value = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
@@ -3,24 +3,24 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *?int* | :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` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | [Operations\OptimizedForStreaming1\|bool\|null](../../Models/Operations/GetLibrarySectionsAllOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | array<[Operations\GetLibrarySectionsAllPart](../../Models/Operations/GetLibrarySectionsAllPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *?int* | :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` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | [Operations\GetLibrarySectionsAllOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetLibrarySectionsAllOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | array<[Operations\GetLibrarySectionsAllPart](../../Models/Operations/GetLibrarySectionsAllPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
@@ -12,8 +12,8 @@
|
||||
| `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` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
|
||||
@@ -31,7 +31,7 @@ Unknown
|
||||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *?int* | :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 |
|
||||
|
||||
@@ -5,13 +5,13 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `Operations\OptimizedForStreaming1`
|
||||
### `Operations\GetLibrarySectionsAllOptimizedForStreaming1`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var Operations\OptimizedForStreaming1
|
||||
* @var Operations\GetLibrarySectionsAllOptimizedForStreaming1
|
||||
*/
|
||||
Operations\OptimizedForStreaming1 $value = /* values here */
|
||||
Operations\GetLibrarySectionsAllOptimizedForStreaming1 $value = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -3,21 +3,21 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :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` | *?int* | :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` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *?int* | :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` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Operations\GetLibrarySectionsAllOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetLibrarySectionsAllLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `hasThumbnail` | [?Operations\GetLibrarySectionsAllHasThumbnail](../../Models/Operations/GetLibrarySectionsAllHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | array<[Operations\GetLibrarySectionsAllStream](../../Models/Operations/GetLibrarySectionsAllStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :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` | *?int* | :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` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *?int* | :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` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Operations\GetLibrarySectionsAllOptimizedForStreamingLibrary1\|bool\|null](../../Models/Operations/GetLibrarySectionsAllLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `hasThumbnail` | [?Operations\GetLibrarySectionsAllHasThumbnail](../../Models/Operations/GetLibrarySectionsAllHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | array<[Operations\GetLibrarySectionsAllStream](../../Models/Operations/GetLibrarySectionsAllStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
@@ -3,56 +3,56 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | [Operations\GetLibrarySectionsAllStreamType](../../Models/Operations/GetLibrarySectionsAllStreamType.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format` | *?string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *?int* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *?string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `dovielPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *?int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *?int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *?string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *?int* | :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` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *?string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *?float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *?string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *?int* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *?bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *?int* | :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` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *?bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *?string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | *int* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||
| `format` | *?string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *?int* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *?string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `dovielPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *?int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *?int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *?string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *?int* | :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` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *?string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *?float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *?string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *?int* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *?bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *?int* | :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` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *?bool* | :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 |
|
||||
@@ -1,16 +0,0 @@
|
||||
# GetLibrarySectionsAllStreamType
|
||||
|
||||
Stream type:
|
||||
- 1 = video
|
||||
- 2 = audio
|
||||
- 3 = subtitle
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Video` | 1 |
|
||||
| `Audio` | 2 |
|
||||
| `Subtitle` | 3 |
|
||||
11
docs/Models/Operations/GetMediaMetaDataAttributes.md
Normal file
11
docs/Models/Operations/GetMediaMetaDataAttributes.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# GetMediaMetaDataAttributes
|
||||
|
||||
Attributes associated with the marker.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The identifier for the attributes. | 306970 |
|
||||
| `version` | *?int* | :heavy_minus_sign: | The version number of the marker attributes. | 4 |
|
||||
15
docs/Models/Operations/GetMediaMetaDataChapter.md
Normal file
15
docs/Models/Operations/GetMediaMetaDataChapter.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetMediaMetaDataChapter
|
||||
|
||||
The thumbnail for the chapter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 4 |
|
||||
| `filter` | *string* | :heavy_check_mark: | N/A | thumb=4 |
|
||||
| `index` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `startTimeOffset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `endTimeOffset` | *int* | :heavy_check_mark: | N/A | 100100 |
|
||||
| `thumb` | *string* | :heavy_check_mark: | N/A | /library/media/46883/chapterImages/1 |
|
||||
8
docs/Models/Operations/GetMediaMetaDataExtras.md
Normal file
8
docs/Models/Operations/GetMediaMetaDataExtras.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetMediaMetaDataExtras
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||
| `size` | *?int* | :heavy_minus_sign: | The size of the extras. | 1 |
|
||||
@@ -3,6 +3,7 @@
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `Operations\GetMediaMetaDataOptimizedForStreamingLibrary1`
|
||||
|
||||
15
docs/Models/Operations/GetMediaMetaDataMarker.md
Normal file
15
docs/Models/Operations/GetMediaMetaDataMarker.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# GetMediaMetaDataMarker
|
||||
|
||||
The final status of the marker
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 306970 |
|
||||
| `type` | *string* | :heavy_check_mark: | N/A | credits |
|
||||
| `startTimeOffset` | *int* | :heavy_check_mark: | N/A | 4176050 |
|
||||
| `endTimeOffset` | *int* | :heavy_check_mark: | N/A | 4393389 |
|
||||
| `final` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `attributes` | [?Operations\GetMediaMetaDataAttributes](../../Models/Operations/GetMediaMetaDataAttributes.md) | :heavy_minus_sign: | Attributes associated with the marker. | |
|
||||
@@ -3,24 +3,24 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *?int* | :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` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | array<[Operations\GetMediaMetaDataPart](../../Models/Operations/GetMediaMetaDataPart.md)> | :heavy_minus_sign: | An array of parts for this media item. | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||
| `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: | Container format of the media. | mp4 |
|
||||
| `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` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
|
||||
| `part` | array<[Operations\GetMediaMetaDataPart](../../Models/Operations/GetMediaMetaDataPart.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -8,8 +8,8 @@
|
||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *bool* | :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` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
|
||||
@@ -31,7 +31,7 @@ Unknown
|
||||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *?int* | :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 |
|
||||
@@ -64,9 +64,9 @@ Unknown
|
||||
| `userRating` | *?float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | array<[Operations\GetMediaMetaDataImage](../../Models/Operations/GetMediaMetaDataImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [?Operations\GetMediaMetaDataUltraBlurColors](../../Models/Operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `librarySectionID` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `librarySectionKey` | *?string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `guids` | array<[Operations\GetMediaMetaDataGuids](../../Models/Operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `media` | array<[Operations\GetMediaMetaDataMedia](../../Models/Operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | array<[Operations\GetMediaMetaDataGenre](../../Models/Operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -75,9 +75,9 @@ Unknown
|
||||
| `writer` | array<[Operations\GetMediaMetaDataWriter](../../Models/Operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | array<[Operations\GetMediaMetaDataProducer](../../Models/Operations/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | array<[Operations\GetMediaMetaDataRole](../../Models/Operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | array<[Operations\Ratings](../../Models/Operations/Ratings.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | array<[Operations\GetMediaMetaDataRatings](../../Models/Operations/GetMediaMetaDataRatings.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | array<[Operations\GetMediaMetaDataSimilar](../../Models/Operations/GetMediaMetaDataSimilar.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | array<[Operations\GetMediaMetaDataLocation](../../Models/Operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | array<[Operations\Chapter](../../Models/Operations/Chapter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | array<[Operations\Marker](../../Models/Operations/Marker.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [?Operations\Extras](../../Models/Operations/Extras.md) | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | array<[Operations\GetMediaMetaDataChapter](../../Models/Operations/GetMediaMetaDataChapter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | array<[Operations\GetMediaMetaDataMarker](../../Models/Operations/GetMediaMetaDataMarker.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [?Operations\GetMediaMetaDataExtras](../../Models/Operations/GetMediaMetaDataExtras.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -8,16 +8,16 @@
|
||||
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `key` | *?string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *?int* | :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` | *int* | :heavy_check_mark: | File size in bytes. | 30649952104 |
|
||||
| `file` | *?string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *?int* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *?int* | :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` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreamingLibrary1\|bool\|null](../../Models/Operations/GetMediaMetaDataLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `optimizedForStreaming` | [Operations\GetMediaMetaDataOptimizedForStreamingLibrary1\|bool\|null](../../Models/Operations/GetMediaMetaDataLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||
| `hasThumbnail` | [?Operations\GetMediaMetaDataHasThumbnail](../../Models/Operations/GetMediaMetaDataHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | array<[Operations\GetMediaMetaDataStream](../../Models/Operations/GetMediaMetaDataStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
| `stream` | array<[Operations\GetMediaMetaDataStream](../../Models/Operations/GetMediaMetaDataStream.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,10 +1,10 @@
|
||||
# MetaDataRating
|
||||
# GetMediaMetaDataRatings
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||
| `image` | *string* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
|
||||
| `value` | *float* | :heavy_check_mark: | The rating value. | 9 |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -3,56 +3,56 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | [Operations\GetMediaMetaDataStreamType](../../Models/Operations/GetMediaMetaDataStreamType.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format` | *?string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *?int* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *?string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `dovielPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *?int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *?int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *?string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *?int* | :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` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *?string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *?float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *?string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *?int* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *?bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *?int* | :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` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *?bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *?string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | *int* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||
| `format` | *?string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *?string* | :heavy_minus_sign: | Codec used by the stream. | hevc |
|
||||
| `index` | *?int* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *?string* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `languageCode` | *?string* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `headerCompression` | *?bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `doviblCompatID` | *?int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `doviblPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `dovielPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `doviLevel` | *?int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `doviPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `doviProfile` | *?int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpuPresent` | *?bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `doviVersion` | *?string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bitDepth` | *?int* | :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` | *?int* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `codedWidth` | *?int* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `colorPrimaries` | *?string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `colorRange` | *?string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `colorSpace` | *?string* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `colorTrc` | *?string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frameRate` | *?float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *?string* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *?int* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *?bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *?string* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scanType` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `displayTitle` | *?string* | :heavy_minus_sign: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extendedDisplayTitle` | *?string* | :heavy_minus_sign: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *?bool* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *?bool* | :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 |
|
||||
@@ -1,16 +0,0 @@
|
||||
# GetMediaMetaDataStreamType
|
||||
|
||||
Stream type:
|
||||
- 1 = video
|
||||
- 2 = audio
|
||||
- 3 = subtitle
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Video` | 1 |
|
||||
| `Audio` | 2 |
|
||||
| `Subtitle` | 3 |
|
||||
@@ -32,11 +32,11 @@ Unknown
|
||||
| `lastRatedAt` | *?int* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `lastViewedAt` | *?int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `librarySectionID` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `librarySectionKey` | *?string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `originalTitle` | *?string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `parentGuid` | *?string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentIndex` | *?int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parentKey` | *?string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetSearchAllLibrariesCollection
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | United States of America |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique identifier for the country.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the director. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
20
docs/Models/Operations/GetSearchAllLibrariesDirectory.md
Normal file
20
docs/Models/Operations/GetSearchAllLibrariesDirectory.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# GetSearchAllLibrariesDirectory
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_check_mark: | The unique identifier path for the search result item. | /library/sections/3/all?actor=197429 |
|
||||
| `librarySectionID` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `librarySectionKey` | *string* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `librarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `librarySectionType` | *?int* | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of the directory. | tag |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 197429 |
|
||||
| `filter` | *?string* | :heavy_minus_sign: | The filter string used to query this specific item in the library. | actor=197429 |
|
||||
| `tag` | *string* | :heavy_check_mark: | N/A | Ben Stiller |
|
||||
| `tagType` | *?int* | :heavy_minus_sign: | The type of tag associated with this search result (e.g., Director, Actor). | |
|
||||
| `tagKey` | *?string* | :heavy_minus_sign: | The unique identifier for the tag associated with this search result. | 5d776826999c64001ec2c606 |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The URL to the thumbnail image associated with this search result. | https://metadata-static.plex.tv/5/people/57bd7c7d6c5c9e2881251b30e5603d3d.jpg |
|
||||
| `count` | *?int* | :heavy_minus_sign: | The number of items associated with this search result. | 10 |
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetSearchAllLibrariesEnableCreditsMarkerGeneration
|
||||
|
||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `Disabled` | 0 |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetSearchAllLibrariesEpisodeSort
|
||||
|
||||
Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------- | ---------------- |
|
||||
| `LibraryDefault` | -1 |
|
||||
| `OldestFirst` | 0 |
|
||||
| `NewestFirst` | 1 |
|
||||
@@ -3,6 +3,7 @@
|
||||
Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | Adventure |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique identifier for the genre.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 259 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The genre name of this media-item<br/> | Crime |
|
||||
8
docs/Models/Operations/GetSearchAllLibrariesGuids.md
Normal file
8
docs/Models/Operations/GetSearchAllLibrariesGuids.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# GetSearchAllLibrariesGuids
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | The unique identifier for the Guid. Can be prefixed with imdb://, tmdb://, tvdb://<br/> | {<br/>"imdbExample": {<br/>"summary": "IMDB example",<br/>"value": "imdb://tt13015952"<br/>},<br/>"tmdbExample": {<br/>"summary": "TMDB example",<br/>"value": "tmdb://2434012"<br/>},<br/>"tvdbExample": {<br/>"summary": "TVDB example",<br/>"value": "tvdb://7945991"<br/>}<br/>} |
|
||||
@@ -1,5 +1,8 @@
|
||||
# GetSearchAllLibrariesHasThumbnail
|
||||
|
||||
Indicates if the part has a thumbnail.
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
# GetSearchAllLibrariesLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `Operations\GetSearchAllLibrariesOptimizedForStreamingLibrary1`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var Operations\GetSearchAllLibrariesOptimizedForStreamingLibrary1
|
||||
*/
|
||||
Operations\GetSearchAllLibrariesOptimizedForStreamingLibrary1 $value = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var bool
|
||||
*/
|
||||
bool $value = /* values here */
|
||||
```
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
# GetSearchAllLibrariesLocation
|
||||
|
||||
The folder path for the media item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `path` | *?string* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `path` | *string* | :heavy_check_mark: | N/A | /TV Shows/Clarkson's Farm |
|
||||
@@ -3,23 +3,24 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119534 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audioCodec` | *?string* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `videoCodec` | *?string* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `videoResolution` | *?string* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *string* | :heavy_check_mark: | N/A | mkv |
|
||||
| `videoFrameRate` | *?string* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `hasVoiceActivity` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [?Operations\GetSearchAllLibrariesOptimizedForStreaming](../../Models/Operations/GetSearchAllLibrariesOptimizedForStreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | array<[Operations\GetSearchAllLibrariesPart](../../Models/Operations/GetSearchAllLibrariesPart.md)> | :heavy_check_mark: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique media identifier. | 387322 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *?int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspectRatio` | *?float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audioChannels` | *?int* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `displayOffset` | *?int* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audioCodec` | *?string* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||
| `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: | Container format of the media. | mp4 |
|
||||
| `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` | *?bool* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimizedForStreaming` | [Operations\GetSearchAllLibrariesOptimizedForStreaming1\|bool\|null](../../Models/Operations/GetSearchAllLibrariesOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | Indicates whether the media has 64-bit offsets.<br/>This is relevant for media files that may require larger offsets than what 32-bit integers can provide.<br/> | false |
|
||||
| `part` | array<[Operations\GetSearchAllLibrariesPart](../../Models/Operations/GetSearchAllLibrariesPart.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -3,7 +3,14 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `size` | *float* | :heavy_check_mark: | N/A |
|
||||
| `searchResult` | array<[Operations\SearchResult](../../Models/Operations/SearchResult.md)> | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||||
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
||||
| `allowSync` | *bool* | :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` | *?int* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `searchResult` | array<[Operations\SearchResult](../../Models/Operations/SearchResult.md)> | :heavy_check_mark: | N/A | |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetSearchAllLibrariesMediaGuid
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetSearchAllLibrariesMetaDataRating
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *string* | :heavy_check_mark: | A URI or path to the rating image. | themoviedb://image.rating |
|
||||
| `value` | *float* | :heavy_check_mark: | The value of the rating. | 3 |
|
||||
| `type` | *string* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -1,83 +1,82 @@
|
||||
# GetSearchAllLibrariesMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `ratingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item.<br/>Note: This is always an integer, but is represented as a string in the API.<br/> | 58683 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *string* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *?string* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skipChildren` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `librarySectionKey` | *?string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
||||
| `type` | [Operations\GetSearchAllLibrariesType](../../Models/Operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | The type of media content in the Plex library. This can represent videos, music, or photos.<br/> | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *?string* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `contentRating` | *?string* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *string* | :heavy_check_mark: | N/A | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home. |
|
||||
| `rating` | *?float* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audienceRating` | *?float* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *?int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `seasonCount` | *?int* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *?string* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flattenSeasons` | [?Operations\GetSearchAllLibrariesFlattenSeasons](../../Models/Operations/GetSearchAllLibrariesFlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). | 1 |
|
||||
| `episodeSort` | [?Operations\GetSearchAllLibrariesEpisodeSort](../../Models/Operations/GetSearchAllLibrariesEpisodeSort.md) | :heavy_minus_sign: | Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). | 0 |
|
||||
| `enableCreditsMarkerGeneration` | [?Operations\GetSearchAllLibrariesEnableCreditsMarkerGeneration](../../Models/Operations/GetSearchAllLibrariesEnableCreditsMarkerGeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `showOrdering` | [?Operations\GetSearchAllLibrariesShowOrdering](../../Models/Operations/GetSearchAllLibrariesShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>None = Library default,<br/>tmdbAiring = The Movie Database (Aired),<br/>aired = TheTVDB (Aired),<br/>dvd = TheTVDB (DVD),<br/>absolute = TheTVDB (Absolute)).<br/> | absolute |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `addedAt` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audienceRatingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapterSource` | *?string* | :heavy_minus_sign: | N/A | media |
|
||||
| `primaryExtraKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `ratingImage` | *?string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparentRatingKey` | *?string* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentSlug` | *?string* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparentArt` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | array<[Operations\GetSearchAllLibrariesMedia](../../Models/Operations/GetSearchAllLibrariesMedia.md)> | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | array<[Operations\GetSearchAllLibrariesGenre](../../Models/Operations/GetSearchAllLibrariesGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | array<[Operations\GetSearchAllLibrariesCountry](../../Models/Operations/GetSearchAllLibrariesCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | array<[Operations\GetSearchAllLibrariesDirector](../../Models/Operations/GetSearchAllLibrariesDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | array<[Operations\GetSearchAllLibrariesWriter](../../Models/Operations/GetSearchAllLibrariesWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | array<[Operations\GetSearchAllLibrariesCollection](../../Models/Operations/GetSearchAllLibrariesCollection.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | array<[Operations\GetSearchAllLibrariesRole](../../Models/Operations/GetSearchAllLibrariesRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | array<[Operations\GetSearchAllLibrariesLocation](../../Models/Operations/GetSearchAllLibrariesLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `mediaGuid` | array<[Operations\GetSearchAllLibrariesMediaGuid](../../Models/Operations/GetSearchAllLibrariesMediaGuid.md)> | :heavy_minus_sign: | The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.<br/> | |
|
||||
| `ultraBlurColors` | [?Operations\GetSearchAllLibrariesUltraBlurColors](../../Models/Operations/GetSearchAllLibrariesUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metaDataRating` | array<[Operations\GetSearchAllLibrariesMetaDataRating](../../Models/Operations/GetSearchAllLibrariesMetaDataRating.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `image` | array<[Operations\GetSearchAllLibrariesImage](../../Models/Operations/GetSearchAllLibrariesImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `titleSort` | *?string* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `viewCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `lastViewedAt` | *?int* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `originalTitle` | *?string* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `viewOffset` | *?int* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skipCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leafCount` | *?int* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `childCount` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumExtras` | *?string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `hasPremiumPrimaryExtra` | *?string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentRatingKey` | *?string* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parentGuid` | *?string* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parentStudio` | *?string* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parentKey` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parentTitle` | *?string* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parentIndex` | *?int* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parentYear` | *?int* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parentThumb` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parentTheme` | *?string* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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\GetSearchAllLibrariesType](../../Models/Operations/GetSearchAllLibrariesType.md) | :heavy_check_mark: | N/A | movie |
|
||||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `banner` | *string* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
|
||||
| `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` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||||
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `year` | *?int* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||||
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updatedAt` | *?int* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `parentYear` | *?int* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||
| `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` | *?int* | :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` | *?int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `viewOffset` | *?int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `skipCount` | *?int* | :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` | *?int* | :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` | *?int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `userRating` | *?float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | array<[Operations\GetSearchAllLibrariesImage](../../Models/Operations/GetSearchAllLibrariesImage.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `ultraBlurColors` | [?Operations\GetSearchAllLibrariesUltraBlurColors](../../Models/Operations/GetSearchAllLibrariesUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | array<[Operations\GetSearchAllLibrariesGuids](../../Models/Operations/GetSearchAllLibrariesGuids.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `librarySectionKey` | *?string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `showOrdering` | [?Operations\GetSearchAllLibrariesShowOrdering](../../Models/Operations/GetSearchAllLibrariesShowOrdering.md) | :heavy_minus_sign: | Setting that indicates the episode ordering for the show.<br/>Options:<br/> - None = Library default<br/> - tmdbAiring = The Movie Database (Aired)<br/> - aired = TheTVDB (Aired)<br/> - dvd = TheTVDB (DVD)<br/> - absolute = TheTVDB (Absolute)<br/> | absolute |
|
||||
| `flattenSeasons` | [?Operations\GetSearchAllLibrariesFlattenSeasons](../../Models/Operations/GetSearchAllLibrariesFlattenSeasons.md) | :heavy_minus_sign: | Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).<br/> | 1 |
|
||||
| `skipChildren` | *?bool* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||
| `media` | array<[Operations\GetSearchAllLibrariesMedia](../../Models/Operations/GetSearchAllLibrariesMedia.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | array<[Operations\GetSearchAllLibrariesGenre](../../Models/Operations/GetSearchAllLibrariesGenre.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `country` | array<[Operations\GetSearchAllLibrariesCountry](../../Models/Operations/GetSearchAllLibrariesCountry.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `director` | array<[Operations\GetSearchAllLibrariesDirector](../../Models/Operations/GetSearchAllLibrariesDirector.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | array<[Operations\GetSearchAllLibrariesWriter](../../Models/Operations/GetSearchAllLibrariesWriter.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `role` | array<[Operations\GetSearchAllLibrariesRole](../../Models/Operations/GetSearchAllLibrariesRole.md)> | :heavy_minus_sign: | N/A | |
|
||||
| `location` | array<[Operations\GetSearchAllLibrariesLocation](../../Models/Operations/GetSearchAllLibrariesLocation.md)> | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,9 +1,25 @@
|
||||
# GetSearchAllLibrariesOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `Disable` | 0 |
|
||||
| `Enable` | 1 |
|
||||
## Supported Types
|
||||
|
||||
### `Operations\GetSearchAllLibrariesOptimizedForStreaming1`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var Operations\GetSearchAllLibrariesOptimizedForStreaming1
|
||||
*/
|
||||
Operations\GetSearchAllLibrariesOptimizedForStreaming1 $value = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```php
|
||||
/**
|
||||
* @var bool
|
||||
*/
|
||||
bool $value = /* values here */
|
||||
```
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetSearchAllLibrariesOptimizedForStreaming1
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetSearchAllLibrariesOptimizedForStreamingLibrary1
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `Zero` | 0 |
|
||||
| `One` | 1 |
|
||||
@@ -3,18 +3,20 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 119542 |
|
||||
| `key` | *string* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *string* | :heavy_check_mark: | N/A | /movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv |
|
||||
| `size` | *int* | :heavy_check_mark: | N/A | 36158371307 |
|
||||
| `container` | *string* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audioProfile` | *?string* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bitOffsets` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `videoProfile` | *?string* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `hasThumbnail` | [?Operations\GetSearchAllLibrariesHasThumbnail](../../Models/Operations/GetSearchAllLibrariesHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | array<[Operations\GetSearchAllLibrariesStream](../../Models/Operations/GetSearchAllLibrariesStream.md)> | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `accessible` | *?bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *?bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *?string* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *?string* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *?int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *?string* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *?int* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||
| `packetLength` | *?int* | :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` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimizedForStreaming` | [Operations\GetSearchAllLibrariesOptimizedForStreamingLibrary1\|bool\|null](../../Models/Operations/GetSearchAllLibrariesLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||
| `hasThumbnail` | [?Operations\GetSearchAllLibrariesHasThumbnail](../../Models/Operations/GetSearchAllLibrariesHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -3,11 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *?int* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `filter` | *?string* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `tagKey` | *?string* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `role` | *?string* | :heavy_minus_sign: | The role of the actor or tag in the media. | Self |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | The unique identifier for the role.<br/>NOTE: This is different for each Plex server and is not globally unique.<br/> | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `role` | *?string* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the actor. | https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg |
|
||||
@@ -1,11 +1,12 @@
|
||||
# GetSearchAllLibrariesShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show.
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
Options:
|
||||
- None = Library default
|
||||
- tmdbAiring = The Movie Database (Aired)
|
||||
- aired = TheTVDB (Aired)
|
||||
- dvd = TheTVDB (DVD)
|
||||
- absolute = TheTVDB (Absolute)
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
# GetSearchAllLibrariesStream
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 272796 |
|
||||
| `streamType` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `selected` | *?bool* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `bitrate` | *?int* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `colorPrimaries` | *?string* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `colorRange` | *?string* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `colorSpace` | *?string* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `colorTrc` | *?string* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `bitDepth` | *?int* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `chromaLocation` | *?string* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `streamIdentifier` | *?string* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `chromaSubsampling` | *?string* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `codedHeight` | *?int* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `codedWidth` | *?int* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `frameRate` | *?float* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `hasScalingMatrix` | *?bool* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `hearingImpaired` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `closedCaptions` | *?bool* | :heavy_minus_sign: | N/A | false |
|
||||
| `embeddedInVideo` | *?string* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `height` | *?int* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `level` | *?int* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `profile` | *?string* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `refFrames` | *?int* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `scanType` | *?string* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `width` | *?int* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `displayTitle` | *?string* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `extendedDisplayTitle` | *?string* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `channels` | *?int* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `language` | *?string* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `languageTag` | *?string* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `languageCode` | *?string* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `audioChannelLayout` | *?string* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `samplingRate` | *?int* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `title` | *?string* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `canAutoSync` | *?bool* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *?string* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||
| `tag` | *string* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
| `thumb` | *?string* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
@@ -1,8 +0,0 @@
|
||||
# MediaGuid
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `id` | *string* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||
@@ -3,7 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `score` | *float* | :heavy_check_mark: | N/A |
|
||||
| `metadata` | [Operations\GetSearchAllLibrariesMetadata](../../Models/Operations/GetSearchAllLibrariesMetadata.md) | :heavy_check_mark: | N/A |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `score` | *float* | :heavy_check_mark: | The score of the search result, typically a float value between 0 and 1. | 0.92 |
|
||||
| `directory` | [?Operations\GetSearchAllLibrariesDirectory](../../Models/Operations/GetSearchAllLibrariesDirectory.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metadata` | [?Operations\GetSearchAllLibrariesMetadata](../../Models/Operations/GetSearchAllLibrariesMetadata.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,11 +1,12 @@
|
||||
# ShowOrdering
|
||||
|
||||
Setting that indicates the episode ordering for the show.
|
||||
None = Library default,
|
||||
tmdbAiring = The Movie Database (Aired),
|
||||
aired = TheTVDB (Aired),
|
||||
dvd = TheTVDB (DVD),
|
||||
absolute = TheTVDB (Absolute)).
|
||||
Options:
|
||||
- None = Library default
|
||||
- tmdbAiring = The Movie Database (Aired)
|
||||
- aired = TheTVDB (Aired)
|
||||
- dvd = TheTVDB (DVD)
|
||||
- absolute = TheTVDB (Absolute)
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `streamType` | [Operations\StreamType](../../Models/Operations/StreamType.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `streamType` | *int* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||
| `format` | *?string* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *?bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
|
||||
@@ -1,16 +0,0 @@
|
||||
# StreamType
|
||||
|
||||
Stream type:
|
||||
- 1 = video
|
||||
- 2 = audio
|
||||
- 3 = subtitle
|
||||
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------- | ---------- |
|
||||
| `Video` | 1 |
|
||||
| `Audio` | 2 |
|
||||
| `Subtitle` | 3 |
|
||||
@@ -1,17 +0,0 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace LukeHagar\Plex_API\Models\Operations;
|
||||
|
||||
|
||||
/** Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). */
|
||||
enum EnableCreditsMarkerGeneration: string
|
||||
{
|
||||
case LibraryDefault = '-1';
|
||||
case Disabled = '0';
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace LukeHagar\Plex_API\Models\Operations;
|
||||
|
||||
|
||||
/** Setting that indicates how episodes are sorted for the show. (-1 = Library default, 0 = Oldest first, 1 = Newest first). */
|
||||
enum EpisodeSort: string
|
||||
{
|
||||
case LibraryDefault = '-1';
|
||||
case OldestFirst = '0';
|
||||
case NewestFirst = '1';
|
||||
}
|
||||
@@ -9,7 +9,11 @@ declare(strict_types=1);
|
||||
namespace LukeHagar\Plex_API\Models\Operations;
|
||||
|
||||
|
||||
/** Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show). */
|
||||
/**
|
||||
* Setting that indicates if seasons are set to hidden for the show. (-1 = Library default, 0 = Hide, 1 = Show).
|
||||
*
|
||||
*
|
||||
*/
|
||||
enum FlattenSeasons: string
|
||||
{
|
||||
case LibraryDefault = '-1';
|
||||
|
||||
@@ -102,10 +102,11 @@ class GetActorsLibraryMediaContainer
|
||||
/**
|
||||
* Identifier for the view mode.
|
||||
*
|
||||
* @var string $viewMode
|
||||
* @var ?string $viewMode
|
||||
*/
|
||||
#[\Speakeasy\Serializer\Annotation\SerializedName('viewMode')]
|
||||
public string $viewMode;
|
||||
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
|
||||
public ?string $viewMode = null;
|
||||
|
||||
/**
|
||||
* An array of actor entries for media items.
|
||||
@@ -129,11 +130,11 @@ class GetActorsLibraryMediaContainer
|
||||
* @param string $title1
|
||||
* @param string $title2
|
||||
* @param string $viewGroup
|
||||
* @param string $viewMode
|
||||
* @param ?string $viewMode
|
||||
* @param ?array<GetActorsLibraryDirectory> $directory
|
||||
* @phpstan-pure
|
||||
*/
|
||||
public function __construct(int $size, bool $allowSync, string $art, string $identifier, string $mediaTagPrefix, int $mediaTagVersion, bool $nocache, string $thumb, string $title1, string $title2, string $viewGroup, string $viewMode, ?array $directory = null)
|
||||
public function __construct(int $size, bool $allowSync, string $art, string $identifier, string $mediaTagPrefix, int $mediaTagVersion, bool $nocache, string $thumb, string $title1, string $title2, string $viewGroup, ?string $viewMode = null, ?array $directory = null)
|
||||
{
|
||||
$this->size = $size;
|
||||
$this->allowSync = $allowSync;
|
||||
|
||||
@@ -12,18 +12,18 @@ namespace LukeHagar\Plex_API\Models\Operations;
|
||||
class GetLibraryItemsCollection
|
||||
{
|
||||
/**
|
||||
* The user-made collection this media item belongs to
|
||||
*
|
||||
* @var ?string $tag
|
||||
* @var string $tag
|
||||
*/
|
||||
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
|
||||
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
|
||||
public ?string $tag = null;
|
||||
public string $tag;
|
||||
|
||||
/**
|
||||
* @param ?string $tag
|
||||
* @param string $tag
|
||||
* @phpstan-pure
|
||||
*/
|
||||
public function __construct(?string $tag = null)
|
||||
public function __construct(string $tag)
|
||||
{
|
||||
$this->tag = $tag;
|
||||
}
|
||||
|
||||
@@ -12,19 +12,32 @@ namespace LukeHagar\Plex_API\Models\Operations;
|
||||
class GetLibraryItemsCountry
|
||||
{
|
||||
/**
|
||||
* The unique identifier for the country.
|
||||
*
|
||||
* @var ?string $tag
|
||||
* NOTE: This is different for each Plex server and is not globally unique.
|
||||
*
|
||||
*
|
||||
* @var int $id
|
||||
*/
|
||||
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
|
||||
#[\Speakeasy\Serializer\Annotation\SkipWhenNull]
|
||||
public ?string $tag = null;
|
||||
#[\Speakeasy\Serializer\Annotation\SerializedName('id')]
|
||||
public int $id;
|
||||
|
||||
/**
|
||||
* @param ?string $tag
|
||||
* The country of origin of this media item
|
||||
*
|
||||
* @var string $tag
|
||||
*/
|
||||
#[\Speakeasy\Serializer\Annotation\SerializedName('tag')]
|
||||
public string $tag;
|
||||
|
||||
/**
|
||||
* @param int $id
|
||||
* @param string $tag
|
||||
* @phpstan-pure
|
||||
*/
|
||||
public function __construct(?string $tag = null)
|
||||
public function __construct(int $id, string $tag)
|
||||
{
|
||||
$this->id = $id;
|
||||
$this->tag = $tag;
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user