mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 04:20:52 +00:00
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.558.1
This commit is contained in:
speakeasybot
@@ -1,11 +0,0 @@
|
||||
# EnableCreditsMarkerGeneration
|
||||
|
||||
Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------- | ----------------- |
|
||||
| `LIBRARY_DEFAULT` | -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 |
|
||||
| ----------------- | ----------------- |
|
||||
| `LIBRARY_DEFAULT` | -1 |
|
||||
| `OLDEST_FIRST` | 0 |
|
||||
| `NEWEST_FIRST` | 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` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `view_mode` | *str* | :heavy_check_mark: | Identifier for the view mode. | 131131 |
|
||||
| `view_mode` | *Optional[str]* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||
| `directory` | List[[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` | *Optional[str]* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `tag` | *str* | :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` | *Optional[str]* | :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` | *str* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
| `thumb` | *Optional[str]* | :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 @@
|
||||
| `filter_type` | *str* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | filter |
|
||||
| `advanced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | filter |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional[str]* | :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` | *str* | :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` | *str* | :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` | *str* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetLibraryItemsLibraryResponse200Type](../../models/operations/getlibraryitemslibraryresponse200type.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *str* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `alt` | *str* | :heavy_check_mark: | N/A | Episode 1 |
|
||||
| `type` | [operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md) | :heavy_check_mark: | N/A | background |
|
||||
| `url` | *str* | :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` | *str* | :heavy_check_mark: | N/A | show.title |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | Show Title |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | string |
|
||||
| `sub_type` | *Optional[str]* | :heavy_minus_sign: | N/A | rating |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetLibraryItemsLibraryFieldType
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | tag |
|
||||
| `operator` | List[[operations.GetLibraryItemsLibraryOperator](../../models/operations/getlibraryitemslibraryoperator.md)] | :heavy_check_mark: | N/A | |
|
||||
@@ -1,12 +0,0 @@
|
||||
# GetLibraryItemsLibraryFilter
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `filter_` | *str* | :heavy_check_mark: | N/A | genre |
|
||||
| `filter_type` | *str* | :heavy_check_mark: | N/A | string |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | Genre |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | filter |
|
||||
@@ -1,9 +0,0 @@
|
||||
# GetLibraryItemsLibraryOperator
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | = |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | is |
|
||||
@@ -0,0 +1,20 @@
|
||||
# GetLibraryItemsLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetLibraryItemsOptimizedForStreaming1`
|
||||
|
||||
```python
|
||||
value: operations.GetLibraryItemsOptimizedForStreaming1 = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```python
|
||||
value: bool = /* values here */
|
||||
```
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
# GetLibraryItemsLibraryResponse200Type
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `COVER_POSTER` | coverPoster |
|
||||
| `BACKGROUND` | background |
|
||||
| `SNAPSHOT` | snapshot |
|
||||
| `CLEAR_LOGO` | clearLogo |
|
||||
@@ -1,14 +1,11 @@
|
||||
# GetLibraryItemsLibraryResponseType
|
||||
|
||||
|
||||
## Fields
|
||||
## Values
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | show |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter_` | List[[operations.GetLibraryItemsLibraryFilter](../../models/operations/getlibraryitemslibraryfilter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List[[operations.GetLibraryItemsLibrarySort](../../models/operations/getlibraryitemslibrarysort.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List[[operations.GetLibraryItemsLibraryField](../../models/operations/getlibraryitemslibraryfield.md)] | :heavy_minus_sign: | N/A | |
|
||||
| Name | Value |
|
||||
| -------------- | -------------- |
|
||||
| `COVER_POSTER` | coverPoster |
|
||||
| `BACKGROUND` | background |
|
||||
| `SNAPSHOT` | snapshot |
|
||||
| `CLEAR_LOGO` | clearLogo |
|
||||
@@ -1,15 +0,0 @@
|
||||
# GetLibraryItemsLibrarySort
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `default` | *Optional[str]* | :heavy_minus_sign: | N/A | asc |
|
||||
| `active` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `active_direction` | [Optional[operations.GetLibraryItemsLibraryActiveDirection]](../../models/operations/getlibraryitemslibraryactivedirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `default_direction` | [Optional[operations.GetLibraryItemsLibraryDefaultDirection]](../../models/operations/getlibraryitemslibrarydefaultdirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
|
||||
| `desc_key` | *Optional[str]* | :heavy_minus_sign: | N/A | titleSort:desc |
|
||||
| `first_character_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | titleSort |
|
||||
| `title` | *str* | :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 |
|
||||
| `TV_SHOW` | show |
|
||||
| `SEASON` | season |
|
||||
| `EPISODE` | episode |
|
||||
| `ARTIST` | artist |
|
||||
| `ALBUM` | album |
|
||||
| `TRACK` | track |
|
||||
| `PHOTO_ALBUM` | photoalbum |
|
||||
| `PHOTO` | photo |
|
||||
| `COLLECTION` | collection |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
|
||||
| `key` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | show |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter_` | List[[operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List[[operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List[[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` | *Optional[str]* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `path` | *str* | :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` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetLibraryItemsOptimizedForStreaming]](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | List[[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` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetLibraryItemsOptimizedForStreaming]](../../models/operations/getlibraryitemsoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bit_offsets` | *Optional[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` | List[[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` | List[[operations.GetLibraryItemsType](../../models/operations/getlibraryitemstype.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `size` | *int* | :heavy_check_mark: | N/A | 70 |
|
||||
| `total_size` | *int* | :heavy_check_mark: | N/A | 170 |
|
||||
| `offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `content` | *str* | :heavy_check_mark: | N/A | secondary |
|
||||
| `allow_sync` | *bool* | :heavy_check_mark: | N/A | true |
|
||||
| `nocache` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `art` | *str* | :heavy_check_mark: | N/A | /:/resources/movie-fanart.jpg |
|
||||
| `identifier` | *str* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `library_section_title` | *str* | :heavy_check_mark: | N/A | Movies |
|
||||
| `library_section_uuid` | *str* | :heavy_check_mark: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
|
||||
| `media_tag_prefix` | *str* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *int* | :heavy_check_mark: | N/A | 1701731894 |
|
||||
| `thumb` | *str* | :heavy_check_mark: | N/A | /:/resources/movie.png |
|
||||
| `title1` | *str* | :heavy_check_mark: | N/A | Movies |
|
||||
| `title2` | *str* | :heavy_check_mark: | N/A | Recently Released |
|
||||
| `view_group` | *str* | :heavy_check_mark: | N/A | movie |
|
||||
| `view_mode` | *Optional[int]* | :heavy_minus_sign: | N/A | 65592 |
|
||||
| `mixed_parents` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | List[[operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `meta` | [Optional[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 |
|
||||
| `total_size` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
||||
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
||||
| `content` | *str* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
||||
| `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `thumb` | *str* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
||||
| `title1` | *str* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
||||
| `title2` | *str* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
||||
| `view_group` | *str* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
||||
| `view_mode` | *Optional[str]* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
||||
| `mixed_parents` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
|
||||
| `metadata` | List[[operations.GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)] | :heavy_check_mark: | An array of metadata items. | |
|
||||
| `meta` | [Optional[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` | List[[operations.GetLibraryItemsLibraryResponseType](../../models/operations/getlibraryitemslibraryresponsetype.md)] | :heavy_minus_sign: | N/A |
|
||||
| `field_type` | List[[operations.GetLibraryItemsLibraryFieldType](../../models/operations/getlibraryitemslibraryfieldtype.md)] | :heavy_minus_sign: | N/A |
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `type` | List[[operations.GetLibraryItemsLibraryType](../../models/operations/getlibraryitemslibrarytype.md)] | :heavy_minus_sign: | N/A |
|
||||
| `field_type` | List[[operations.GetLibraryItemsFieldType](../../models/operations/getlibraryitemsfieldtype.md)] | :heavy_minus_sign: | N/A |
|
||||
@@ -1,83 +1,88 @@
|
||||
# GetLibraryItemsMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *str* | :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` | *str* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *str* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_key` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *str* | :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` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flatten_seasons` | [Optional[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 |
|
||||
| `episode_sort` | [Optional[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 |
|
||||
| `enable_credits_marker_generation` | [Optional[operations.EnableCreditsMarkerGeneration]](../../models/operations/enablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `show_ordering` | [Optional[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` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `added_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | List[[operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | List[[operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List[[operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List[[operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List[[operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List[[operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `media_guid` | List[[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/> | |
|
||||
| `ultra_blur_colors` | [Optional[operations.GetLibraryItemsUltraBlurColors]](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `meta_data_rating` | List[[operations.MetaDataRating](../../models/operations/metadatarating.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `image` | List[[operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `original_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *str* | :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` | *str* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `slug` | *str* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `banner` | *str* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
|
||||
| `title_sort` | *str* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `summary` | *str* | :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 |
|
||||
| `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `tagline` | *str* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `thumb` | *str* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *str* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `theme` | *str* | :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 |
|
||||
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `season_count` | *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 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `view_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `subtype` | *Optional[str]* | :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 |
|
||||
| `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `created_at_accuracy` | *Optional[str]* | :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 |
|
||||
| `created_at_tz_offset` | *Optional[str]* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | List[[operations.GetLibraryItemsImage](../../models/operations/getlibraryitemsimage.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `ultra_blur_colors` | [Optional[operations.GetLibraryItemsUltraBlurColors]](../../models/operations/getlibraryitemsultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | List[[operations.GetLibraryItemsGuids](../../models/operations/getlibraryitemsguids.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `show_ordering` | [Optional[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 |
|
||||
| `flatten_seasons` | [Optional[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 |
|
||||
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||
| `media` | List[[operations.GetLibraryItemsMedia](../../models/operations/getlibraryitemsmedia.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List[[operations.GetLibraryItemsGenre](../../models/operations/getlibraryitemsgenre.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List[[operations.GetLibraryItemsCountry](../../models/operations/getlibraryitemscountry.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List[[operations.GetLibraryItemsDirector](../../models/operations/getlibraryitemsdirector.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List[[operations.GetLibraryItemsWriter](../../models/operations/getlibraryitemswriter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | List[[operations.GetLibraryItemsProducer](../../models/operations/getlibraryitemsproducer.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List[[operations.GetLibraryItemsCollection](../../models/operations/getlibraryitemscollection.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List[[operations.GetLibraryItemsRole](../../models/operations/getlibraryitemsrole.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | List[[operations.Ratings](../../models/operations/ratings.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | List[[operations.GetLibraryItemsSimilar](../../models/operations/getlibraryitemssimilar.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List[[operations.GetLibraryItemsLocation](../../models/operations/getlibraryitemslocation.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | List[[operations.Chapter](../../models/operations/chapter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | List[[operations.Marker](../../models/operations/marker.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [Optional[operations.Extras]](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,9 +1,19 @@
|
||||
# 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`
|
||||
|
||||
```python
|
||||
value: operations.OptimizedForStreaming1 = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```python
|
||||
value: bool = /* 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` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *str* | :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` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
|
||||
| `has_thumbnail` | [Optional[operations.GetLibraryItemsHasThumbnail]](../../models/operations/getlibraryitemshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | List[[operations.GetLibraryItemsStream](../../models/operations/getlibraryitemsstream.md)] | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *Optional[str]* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||
| `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetLibraryItemsLibraryOptimizedForStreaming]](../../models/operations/getlibraryitemslibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||
| `has_thumbnail` | [Optional[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_` | *str* | :heavy_check_mark: | The filter string for the role. | actor=109501 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The actor's name. | Bob Odenkirk |
|
||||
| `tag_key` | *str* | :heavy_check_mark: | A key associated with the actor tag. | 5d77683254f42c001f8c3f69 |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | The character name or role. | Jimmy McGill |
|
||||
| `thumb` | *Optional[str]* | :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` | *Optional[int]* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `role` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `thumb` | *Optional[str]* | :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_` | *str* | :heavy_check_mark: | The filter string for similar items. | similar=26 |
|
||||
| `tag` | *str* | :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 |
|
||||
| `stream_type` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `stream_identifier` | *Optional[str]* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `display_title` | *Optional[str]* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `language` | *Optional[str]* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `language_code` | *Optional[str]* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `title` | *Optional[str]* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `can_auto_sync` | *Optional[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` | *str* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
|
||||
| `type` | *str* | :heavy_check_mark: | N/A | filter |
|
||||
| `subtype` | *Optional[str]* | :heavy_minus_sign: | N/A | clip |
|
||||
| `title` | *str* | :heavy_check_mark: | N/A | TV Shows |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | false |
|
||||
| `filter_` | List[[operations.GetLibraryItemsFilter](../../models/operations/getlibraryitemsfilter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `sort` | List[[operations.GetLibraryItemsSort](../../models/operations/getlibraryitemssort.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `field` | List[[operations.GetLibraryItemsField](../../models/operations/getlibraryitemsfield.md)] | :heavy_minus_sign: | N/A | |
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `MOVIE` | movie |
|
||||
| `TV_SHOW` | show |
|
||||
| `SEASON` | season |
|
||||
| `EPISODE` | episode |
|
||||
| `ARTIST` | artist |
|
||||
| `ALBUM` | album |
|
||||
| `TRACK` | track |
|
||||
| `PHOTO_ALBUM` | photoalbum |
|
||||
| `PHOTO` | photo |
|
||||
| `COLLECTION` | collection |
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The absolute URL of the thumbnail image for the writer. | https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg |
|
||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetLibrarySectionsAllOptimizedForStreaming1`
|
||||
### `operations.GetLibrarySectionsAllOptimizedForStreamingLibrary1`
|
||||
|
||||
```python
|
||||
value: operations.GetLibrarySectionsAllOptimizedForStreaming1 = /* values here */
|
||||
value: operations.GetLibrarySectionsAllOptimizedForStreamingLibrary1 = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
@@ -12,8 +12,8 @@
|
||||
| `art` | *str* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
||||
| `content` | *str* | :heavy_check_mark: | The content type or mode. | secondary |
|
||||
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
|
||||
@@ -31,7 +31,7 @@ Unknown
|
||||
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `season_count` | *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 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
|
||||
@@ -5,10 +5,10 @@ Has this media been optimized for streaming. NOTE: This can be 0, 1, false or tr
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.OptimizedForStreaming1`
|
||||
### `operations.GetLibrarySectionsAllOptimizedForStreaming1`
|
||||
|
||||
```python
|
||||
value: operations.OptimizedForStreaming1 = /* values here */
|
||||
value: operations.GetLibrarySectionsAllOptimizedForStreaming1 = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# GetLibrarySectionsAllOptimizedForStreamingLibrary1
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `ZERO` | 0 |
|
||||
| `ONE` | 1 |
|
||||
@@ -3,56 +3,56 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
|
||||
| `stream_type` | [operations.GetLibrarySectionsAllStreamType](../../models/operations/getlibrarysectionsallstreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `display_title` | *str* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extended_display_title` | *str* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *Optional[str]* | :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 |
|
||||
| `stream_type` | *Literal[1]* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `display_title` | *str* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extended_display_title` | *str* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *Optional[str]* | :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` | *Optional[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_` | *str* | :heavy_check_mark: | N/A | thumb=4 |
|
||||
| `index` | *int* | :heavy_check_mark: | N/A | 1 |
|
||||
| `start_time_offset` | *int* | :heavy_check_mark: | N/A | 0 |
|
||||
| `end_time_offset` | *int* | :heavy_check_mark: | N/A | 100100 |
|
||||
| `thumb` | *str* | :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` | *Optional[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` | *str* | :heavy_check_mark: | N/A | credits |
|
||||
| `start_time_offset` | *int* | :heavy_check_mark: | N/A | 4176050 |
|
||||
| `end_time_offset` | *int* | :heavy_check_mark: | N/A | 4393389 |
|
||||
| `final` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `attributes` | [Optional[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` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | eac3 |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | File container type. | mkv |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataOptimizedForStreaming]](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | List[[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` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataOptimizedForStreaming]](../../models/operations/getmediametadataoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bit_offsets` | *Optional[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` | List[[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 |
|
||||
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *int* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | TV Series |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
|
||||
@@ -31,7 +31,7 @@ Unknown
|
||||
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `season_count` | *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 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
@@ -64,9 +64,9 @@ Unknown
|
||||
| `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | List[[operations.GetMediaMetaDataImage](../../models/operations/getmediametadataimage.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `ultra_blur_colors` | [Optional[operations.GetMediaMetaDataUltraBlurColors]](../../models/operations/getmediametadataultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `library_section_id` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `library_section_key` | *str* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `guids` | List[[operations.GetMediaMetaDataGuids](../../models/operations/getmediametadataguids.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `media` | List[[operations.GetMediaMetaDataMedia](../../models/operations/getmediametadatamedia.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List[[operations.GetMediaMetaDataGenre](../../models/operations/getmediametadatagenre.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -75,9 +75,9 @@ Unknown
|
||||
| `writer` | List[[operations.GetMediaMetaDataWriter](../../models/operations/getmediametadatawriter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `producer` | List[[operations.GetMediaMetaDataProducer](../../models/operations/getmediametadataproducer.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List[[operations.GetMediaMetaDataRole](../../models/operations/getmediametadatarole.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | List[[operations.Ratings](../../models/operations/ratings.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `ratings` | List[[operations.GetMediaMetaDataRatings](../../models/operations/getmediametadataratings.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `similar` | List[[operations.GetMediaMetaDataSimilar](../../models/operations/getmediametadatasimilar.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List[[operations.GetMediaMetaDataLocation](../../models/operations/getmediametadatalocation.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | List[[operations.Chapter](../../models/operations/chapter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | List[[operations.Marker](../../models/operations/marker.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [Optional[operations.Extras]](../../models/operations/extras.md) | :heavy_minus_sign: | N/A | |
|
||||
| `chapter` | List[[operations.GetMediaMetaDataChapter](../../models/operations/getmediametadatachapter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `marker` | List[[operations.GetMediaMetaDataMarker](../../models/operations/getmediametadatamarker.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `extras` | [Optional[operations.GetMediaMetaDataExtras]](../../models/operations/getmediametadataextras.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -8,16 +8,16 @@
|
||||
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *str* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *str* | :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` | *Optional[str]* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||
| `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataLibraryOptimizedForStreaming]](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetMediaMetaDataLibraryOptimizedForStreaming]](../../models/operations/getmediametadatalibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||
| `has_thumbnail` | [Optional[operations.GetMediaMetaDataHasThumbnail]](../../models/operations/getmediametadatahasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | List[[operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)] | :heavy_minus_sign: | An array of streams for this part. | |
|
||||
| `stream` | List[[operations.GetMediaMetaDataStream](../../models/operations/getmediametadatastream.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,10 +1,10 @@
|
||||
# MetaDataRating
|
||||
# GetMediaMetaDataRatings
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *str* | :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` | *str* | :heavy_check_mark: | The image or reference for the rating. | imdb://image.rating |
|
||||
| `value` | *float* | :heavy_check_mark: | The rating value. | 9 |
|
||||
| `type` | *str* | :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 |
|
||||
| `stream_type` | [operations.GetMediaMetaDataStreamType](../../models/operations/getmediametadatastreamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream. | hevc |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `display_title` | *str* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extended_display_title` | *str* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *Optional[str]* | :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 |
|
||||
| `stream_type` | *Literal[1]* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *Optional[str]* | :heavy_minus_sign: | Codec used by the stream. | hevc |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | Index of the stream. | 0 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
|
||||
| `language` | *Optional[str]* | :heavy_minus_sign: | Language of the stream. | English |
|
||||
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag (e.g., en). | en |
|
||||
| `language_code` | *Optional[str]* | :heavy_minus_sign: | ISO language code. | eng |
|
||||
| `header_compression` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
|
||||
| `dovibl_compat_id` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
|
||||
| `dovibl_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
|
||||
| `doviel_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
|
||||
| `dovi_level` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision level. | 6 |
|
||||
| `dovi_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
|
||||
| `dovi_profile` | *Optional[int]* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
|
||||
| `dovirpu_present` | *Optional[bool]* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
|
||||
| `dovi_version` | *Optional[str]* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | Chroma sample location. | topleft |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | Coded video height. | 1608 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | Coded video width. | 3840 |
|
||||
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | Color primaries used. | bt2020 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | Color space. | bt2020nc |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
|
||||
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this stream part. | /library/streams/216389 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Height of the video stream. | 1602 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | Video level. | 150 |
|
||||
| `original` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | Video profile. | main 10 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | progressive |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames. | 1 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Width of the video stream. | 3840 |
|
||||
| `display_title` | *Optional[str]* | :heavy_minus_sign: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
|
||||
| `forced` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
|
||||
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
|
||||
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
|
||||
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
|
||||
| `dub` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
|
||||
| `title` | *Optional[str]* | :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
|
||||
| `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `library_section_id` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `library_section_key` | *str* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parent_key` | *Optional[str]* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | Working NL Subs |
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `tag` | *Optional[str]* | :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` | *str* | :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` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the director. | 126522 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The role of Director | Danny Boyle |
|
||||
| `thumb` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | The unique identifier path for the search result item. | /library/sections/3/all?actor=197429 |
|
||||
| `library_section_id` | *int* | :heavy_check_mark: | The identifier for the library section. | 1 |
|
||||
| `library_section_key` | *str* | :heavy_check_mark: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `library_section_title` | *str* | :heavy_check_mark: | The title of the library section. | Movies |
|
||||
| `library_section_type` | *Optional[Literal[1]]* | :heavy_minus_sign: | N/A | |
|
||||
| `type` | *str* | :heavy_check_mark: | The type of the directory. | tag |
|
||||
| `id` | *int* | :heavy_check_mark: | N/A | 197429 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | The filter string used to query this specific item in the library. | actor=197429 |
|
||||
| `tag` | *str* | :heavy_check_mark: | N/A | Ben Stiller |
|
||||
| `tag_type` | *Optional[Literal[4]]* | :heavy_minus_sign: | The type of tag associated with this search result (e.g., Director, Actor). | |
|
||||
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | The unique identifier for the tag associated with this search result. | 5d776826999c64001ec2c606 |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The URL to the thumbnail image associated with this search result. | https://metadata-static.plex.tv/5/people/57bd7c7d6c5c9e2881251b30e5603d3d.jpg |
|
||||
| `count` | *Optional[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 |
|
||||
| ----------------- | ----------------- |
|
||||
| `LIBRARY_DEFAULT` | -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 |
|
||||
| ----------------- | ----------------- |
|
||||
| `LIBRARY_DEFAULT` | -1 |
|
||||
| `OLDEST_FIRST` | 0 |
|
||||
| `NEWEST_FIRST` | 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` | *Optional[str]* | :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` | *str* | :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` | *str* | :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,20 @@
|
||||
# GetSearchAllLibrariesLibraryOptimizedForStreaming
|
||||
|
||||
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
|
||||
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
### `operations.GetSearchAllLibrariesOptimizedForStreamingLibrary1`
|
||||
|
||||
```python
|
||||
value: operations.GetSearchAllLibrariesOptimizedForStreamingLibrary1 = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```python
|
||||
value: bool = /* values here */
|
||||
```
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
# GetSearchAllLibrariesLocation
|
||||
|
||||
The folder path for the media item.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `path` | *Optional[str]* | :heavy_minus_sign: | N/A | /TV Shows/House |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- |
|
||||
| `path` | *str* | :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` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | N/A | 25025 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | N/A | 3840 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | N/A | 2072 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | N/A | 1.85 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | N/A | 6 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | eac3 |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | N/A | hevc |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | N/A | 4k |
|
||||
| `container` | *str* | :heavy_check_mark: | N/A | mkv |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | N/A | 24p |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetSearchAllLibrariesOptimizedForStreaming]](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `part` | List[[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` | *Optional[int]* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | Video width in pixels. | 3840 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | Video height in pixels. | 1602 |
|
||||
| `aspect_ratio` | *Optional[float]* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
|
||||
| `audio_channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels. | 6 |
|
||||
| `display_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 50 |
|
||||
| `audio_codec` | *Optional[str]* | :heavy_minus_sign: | Audio codec used. | aac |
|
||||
| `video_codec` | *Optional[str]* | :heavy_minus_sign: | Video codec used. | hevc |
|
||||
| `video_resolution` | *Optional[str]* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the media. | mp4 |
|
||||
| `video_frame_rate` | *Optional[str]* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
|
||||
| `has_voice_activity` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether voice activity is detected. | false |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetSearchAllLibrariesOptimizedForStreaming]](../../models/operations/getsearchalllibrariesoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
|
||||
| `has64bit_offsets` | *Optional[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` | List[[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 |
|
||||
| `search_result` | List[[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 |
|
||||
| `allow_sync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
||||
| `identifier` | *str* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
||||
| `library_section_uuid` | *Optional[str]* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
||||
| `media_tag_prefix` | *str* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
||||
| `media_tag_version` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
||||
| `search_result` | List[[operations.SearchResult](../../models/operations/searchresult.md)] | :heavy_check_mark: | N/A | |
|
||||
@@ -1,8 +0,0 @@
|
||||
# GetSearchAllLibrariesMediaGUID
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| `id` | *str* | :heavy_check_mark: | Can be one of the following formats:<br/>imdb://tt13015952, tmdb://2434012, tvdb://7945991<br/> | imdb://tt13015952 |
|
||||
@@ -1,83 +1,82 @@
|
||||
# GetSearchAllLibrariesMetadata
|
||||
|
||||
Unknown
|
||||
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *str* | :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` | *str* | :heavy_check_mark: | N/A | /library/metadata/58683 |
|
||||
| `guid` | *str* | :heavy_check_mark: | N/A | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `studio` | *Optional[str]* | :heavy_minus_sign: | N/A | 20th Century Studios |
|
||||
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Movies |
|
||||
| `library_section_key` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | N/A | Avatar: The Way of Water |
|
||||
| `slug` | *Optional[str]* | :heavy_minus_sign: | N/A | 4-for-texas |
|
||||
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | N/A | PG-13 |
|
||||
| `summary` | *str* | :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` | *Optional[float]* | :heavy_minus_sign: | N/A | 7.6 |
|
||||
| `audience_rating` | *Optional[float]* | :heavy_minus_sign: | N/A | 9.2 |
|
||||
| `year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `season_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 2022 |
|
||||
| `tagline` | *Optional[str]* | :heavy_minus_sign: | N/A | Return to Pandora. |
|
||||
| `flatten_seasons` | [Optional[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 |
|
||||
| `episode_sort` | [Optional[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 |
|
||||
| `enable_credits_marker_generation` | [Optional[operations.GetSearchAllLibrariesEnableCreditsMarkerGeneration]](../../models/operations/getsearchalllibrariesenablecreditsmarkergeneration.md) | :heavy_minus_sign: | Setting that indicates if credits markers detection is enabled. (-1 = Library default, 0 = Disabled). | -1 |
|
||||
| `show_ordering` | [Optional[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` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/art/1703239236 |
|
||||
| `banner` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58683/banner/1703239236 |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | N/A | 2022-12-14 00:00:00 +0000 UTC |
|
||||
| `added_at` | *int* | :heavy_check_mark: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | N/A | media |
|
||||
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/58684 |
|
||||
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
||||
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | N/A | 66 |
|
||||
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | N/A | alice-in-borderland-2020 |
|
||||
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/art/1705716261 |
|
||||
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| `media` | List[[operations.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)] | :heavy_minus_sign: | The Media object is only included when type query is `4` or higher.<br/> | |
|
||||
| `genre` | List[[operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List[[operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List[[operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List[[operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `collection` | List[[operations.GetSearchAllLibrariesCollection](../../models/operations/getsearchalllibrariescollection.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List[[operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List[[operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `media_guid` | List[[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/> | |
|
||||
| `ultra_blur_colors` | [Optional[operations.GetSearchAllLibrariesUltraBlurColors]](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `meta_data_rating` | List[[operations.GetSearchAllLibrariesMetaDataRating](../../models/operations/getsearchalllibrariesmetadatarating.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `image` | List[[operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `title_sort` | *Optional[str]* | :heavy_minus_sign: | N/A | Whale |
|
||||
| `view_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | N/A | 1682752242 |
|
||||
| `original_title` | *Optional[str]* | :heavy_minus_sign: | N/A | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | N/A | 5222500 |
|
||||
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/1/theme/1705636920 |
|
||||
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 |
|
||||
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 0 |
|
||||
| `child_count` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has_premium_extras` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `has_premium_primary_extra` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent item.<br/> | 66 |
|
||||
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | N/A | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `parent_studio` | *Optional[str]* | :heavy_minus_sign: | N/A | UCP |
|
||||
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66 |
|
||||
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | N/A | Caprica |
|
||||
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | N/A | 2010 |
|
||||
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/thumb/1705716261 |
|
||||
| `parent_theme` | *Optional[str]* | :heavy_minus_sign: | N/A | /library/metadata/66/theme/1705716261 |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rating_key` | *str* | :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` | *str* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||||
| `guid` | *str* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||||
| `slug` | *str* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||||
| `studio` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||||
| `banner` | *str* | :heavy_check_mark: | The banner image URL for the media item. | /library/metadata/58683/banner/1703239236 |
|
||||
| `title_sort` | *str* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||||
| `content_rating` | *Optional[str]* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||||
| `summary` | *str* | :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 |
|
||||
| `audience_rating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||||
| `year` | *Optional[int]* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||||
| `tagline` | *str* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||||
| `thumb` | *str* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||||
| `art` | *str* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||||
| `theme` | *str* | :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 |
|
||||
| `leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||||
| `viewed_leaf_count` | *Optional[int]* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||||
| `child_count` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||||
| `season_count` | *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 |
|
||||
| `originally_available_at` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||||
| `added_at` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||||
| `updated_at` | *Optional[int]* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||||
| `parent_year` | *Optional[int]* | :heavy_minus_sign: | The release year of the parent media item. | 2010 |
|
||||
| `audience_rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||||
| `chapter_source` | *Optional[str]* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||||
| `primary_extra_key` | *Optional[str]* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||||
| `original_title` | *Optional[str]* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||||
| `parent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||||
| `grandparent_rating_key` | *Optional[str]* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||||
| `parent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparent_guid` | *Optional[str]* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||||
| `grandparent_slug` | *Optional[str]* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||||
| `grandparent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||||
| `parent_key` | *Optional[str]* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||||
| `grandparent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||||
| `grandparent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `grandparent_theme` | *Optional[str]* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||||
| `grandparent_art` | *Optional[str]* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||||
| `parent_title` | *Optional[str]* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||||
| `parent_index` | *Optional[int]* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||||
| `parent_thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||||
| `rating_image` | *Optional[str]* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||||
| `view_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||||
| `view_offset` | *Optional[int]* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||||
| `skip_count` | *Optional[int]* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||||
| `subtype` | *Optional[str]* | :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 |
|
||||
| `last_rated_at` | *Optional[int]* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||||
| `created_at_accuracy` | *Optional[str]* | :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 |
|
||||
| `created_at_tz_offset` | *Optional[str]* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||||
| `last_viewed_at` | *Optional[int]* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||||
| `user_rating` | *Optional[float]* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||||
| `image` | List[[operations.GetSearchAllLibrariesImage](../../models/operations/getsearchalllibrariesimage.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `ultra_blur_colors` | [Optional[operations.GetSearchAllLibrariesUltraBlurColors]](../../models/operations/getsearchalllibrariesultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||||
| `guids` | List[[operations.GetSearchAllLibrariesGuids](../../models/operations/getsearchalllibrariesguids.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `library_section_id` | *Optional[int]* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||||
| `library_section_title` | *Optional[str]* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||||
| `library_section_key` | *Optional[str]* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||||
| `show_ordering` | [Optional[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 |
|
||||
| `flatten_seasons` | [Optional[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 |
|
||||
| `skip_children` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether child items should be skipped. | false |
|
||||
| `media` | List[[operations.GetSearchAllLibrariesMedia](../../models/operations/getsearchalllibrariesmedia.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `genre` | List[[operations.GetSearchAllLibrariesGenre](../../models/operations/getsearchalllibrariesgenre.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `country` | List[[operations.GetSearchAllLibrariesCountry](../../models/operations/getsearchalllibrariescountry.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `director` | List[[operations.GetSearchAllLibrariesDirector](../../models/operations/getsearchalllibrariesdirector.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `writer` | List[[operations.GetSearchAllLibrariesWriter](../../models/operations/getsearchalllibrarieswriter.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `role` | List[[operations.GetSearchAllLibrariesRole](../../models/operations/getsearchalllibrariesrole.md)] | :heavy_minus_sign: | N/A | |
|
||||
| `location` | List[[operations.GetSearchAllLibrariesLocation](../../models/operations/getsearchalllibrarieslocation.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -1,10 +0,0 @@
|
||||
# GetSearchAllLibrariesMetaDataRating
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
|
||||
| `image` | *str* | :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` | *str* | :heavy_check_mark: | The type of rating (e.g., audience, critic). | audience |
|
||||
@@ -1,9 +1,19 @@
|
||||
# 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`
|
||||
|
||||
```python
|
||||
value: operations.GetSearchAllLibrariesOptimizedForStreaming1 = /* values here */
|
||||
```
|
||||
|
||||
### `bool`
|
||||
|
||||
```python
|
||||
value: bool = /* 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` | *str* | :heavy_check_mark: | N/A | /library/parts/119542/1680457526/file.mkv |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | N/A | 11558112 |
|
||||
| `file` | *str* | :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` | *str* | :heavy_check_mark: | The container format of the media file.<br/> | mkv |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | dts |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | N/A | main 10 |
|
||||
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
|
||||
| `has_thumbnail` | [Optional[operations.GetSearchAllLibrariesHasThumbnail]](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
| `stream` | List[[operations.GetSearchAllLibrariesStream](../../models/operations/getsearchalllibrariesstream.md)] | :heavy_minus_sign: | N/A | |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `accessible` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
|
||||
| `exists` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the part exists. | true |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique part identifier. | 418385 |
|
||||
| `key` | *Optional[str]* | :heavy_minus_sign: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
|
||||
| `indexes` | *Optional[str]* | :heavy_minus_sign: | N/A | sd |
|
||||
| `duration` | *Optional[int]* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
|
||||
| `file` | *Optional[str]* | :heavy_minus_sign: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
|
||||
| `size` | *Optional[int]* | :heavy_minus_sign: | File size in bytes. | 30649952104 |
|
||||
| `packet_length` | *Optional[int]* | :heavy_minus_sign: | N/A | 188 |
|
||||
| `container` | *Optional[str]* | :heavy_minus_sign: | Container format of the part. | mkv |
|
||||
| `video_profile` | *Optional[str]* | :heavy_minus_sign: | Video profile for the part. | main 10 |
|
||||
| `audio_profile` | *Optional[str]* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
|
||||
| `has64bit_offsets` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `optimized_for_streaming` | [Optional[operations.GetSearchAllLibrariesLibraryOptimizedForStreaming]](../../models/operations/getsearchalllibrarieslibraryoptimizedforstreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true<br/> | |
|
||||
| `has_thumbnail` | [Optional[operations.GetSearchAllLibrariesHasThumbnail]](../../models/operations/getsearchalllibrarieshasthumbnail.md) | :heavy_minus_sign: | N/A | 1 |
|
||||
@@ -3,11 +3,9 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *Optional[int]* | :heavy_minus_sign: | The ID of the tag or actor. | 294129 |
|
||||
| `filter_` | *Optional[str]* | :heavy_minus_sign: | The filter used to find the actor or tag. | actor=294129 |
|
||||
| `thumb` | *Optional[str]* | :heavy_minus_sign: | The thumbnail of the actor | https://metadata-static.plex.tv/2/people/27b85844536c39f3f9ac943aaad46608.jpg |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | The name of the tag or actor. | Mike Smith |
|
||||
| `tag_key` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the tag. | 668e7e7b22bcad9064350c91 |
|
||||
| `role` | *Optional[str]* | :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` | *str* | :heavy_check_mark: | The display tag for the actor (typically the actor's name). | Teller |
|
||||
| `role` | *Optional[str]* | :heavy_minus_sign: | The role played by the actor in the media item. | Self - Judge |
|
||||
| `thumb` | *Optional[str]* | :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 |
|
||||
| `stream_type` | *int* | :heavy_check_mark: | Type of stream (1 = video, 2 = audio, 3 = subtitle) | 1 |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this is the default stream | true |
|
||||
| `selected` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream is selected | true |
|
||||
| `codec` | *str* | :heavy_check_mark: | Codec used by the stream | h264 |
|
||||
| `index` | *int* | :heavy_check_mark: | The index of the stream | 0 |
|
||||
| `bitrate` | *Optional[int]* | :heavy_minus_sign: | The bitrate of the stream in kbps | 6273 |
|
||||
| `color_primaries` | *Optional[str]* | :heavy_minus_sign: | The color primaries of the video stream | bt709 |
|
||||
| `color_range` | *Optional[str]* | :heavy_minus_sign: | The color range of the video stream | tv |
|
||||
| `color_space` | *Optional[str]* | :heavy_minus_sign: | The color space of the video stream | bt709 |
|
||||
| `color_trc` | *Optional[str]* | :heavy_minus_sign: | The transfer characteristics (TRC) of the video stream | bt709 |
|
||||
| `bit_depth` | *Optional[int]* | :heavy_minus_sign: | The bit depth of the video stream | 8 |
|
||||
| `chroma_location` | *Optional[str]* | :heavy_minus_sign: | The chroma location of the video stream | left |
|
||||
| `stream_identifier` | *Optional[str]* | :heavy_minus_sign: | The identifier of the video stream | 2 |
|
||||
| `chroma_subsampling` | *Optional[str]* | :heavy_minus_sign: | The chroma subsampling format | 4:2:0 |
|
||||
| `coded_height` | *Optional[int]* | :heavy_minus_sign: | The coded height of the video stream | 1088 |
|
||||
| `coded_width` | *Optional[int]* | :heavy_minus_sign: | The coded width of the video stream | 1920 |
|
||||
| `frame_rate` | *Optional[float]* | :heavy_minus_sign: | The frame rate of the video stream | 29.97 |
|
||||
| `has_scaling_matrix` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the stream has a scaling matrix | false |
|
||||
| `hearing_impaired` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `closed_captions` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `embedded_in_video` | *Optional[str]* | :heavy_minus_sign: | N/A | 1 |
|
||||
| `height` | *Optional[int]* | :heavy_minus_sign: | The height of the video stream | 1080 |
|
||||
| `level` | *Optional[int]* | :heavy_minus_sign: | The level of the video codec | 40 |
|
||||
| `profile` | *Optional[str]* | :heavy_minus_sign: | The profile of the video codec | main |
|
||||
| `ref_frames` | *Optional[int]* | :heavy_minus_sign: | Number of reference frames | 4 |
|
||||
| `scan_type` | *Optional[str]* | :heavy_minus_sign: | The scan type (progressive or interlaced) | progressive |
|
||||
| `width` | *Optional[int]* | :heavy_minus_sign: | The width of the video stream | 1920 |
|
||||
| `display_title` | *Optional[str]* | :heavy_minus_sign: | Display title of the stream | 1080p (H.264) |
|
||||
| `extended_display_title` | *Optional[str]* | :heavy_minus_sign: | Extended display title of the stream | 1080p (H.264) |
|
||||
| `channels` | *Optional[int]* | :heavy_minus_sign: | Number of audio channels (for audio streams) | 2 |
|
||||
| `language` | *Optional[str]* | :heavy_minus_sign: | The language of the stream (for audio/subtitle streams) | English |
|
||||
| `language_tag` | *Optional[str]* | :heavy_minus_sign: | Language tag of the stream | en |
|
||||
| `language_code` | *Optional[str]* | :heavy_minus_sign: | Language code of the stream | eng |
|
||||
| `audio_channel_layout` | *Optional[str]* | :heavy_minus_sign: | The audio channel layout | stereo |
|
||||
| `sampling_rate` | *Optional[int]* | :heavy_minus_sign: | Sampling rate of the audio stream in Hz | 48000 |
|
||||
| `title` | *Optional[str]* | :heavy_minus_sign: | Title of the subtitle track (for subtitle streams) | English |
|
||||
| `can_auto_sync` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the subtitle stream can auto-sync | false |
|
||||
@@ -3,6 +3,8 @@
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `tag` | *Optional[str]* | :heavy_minus_sign: | N/A | James Cameron |
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `id` | *int* | :heavy_check_mark: | Unique identifier for the writer. | 126522 |
|
||||
| `tag` | *str* | :heavy_check_mark: | The role of Writer | Jamie P. Hanson |
|
||||
| `thumb` | *Optional[str]* | :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` | *str* | :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` | [Optional[operations.GetSearchAllLibrariesDirectory]](../../models/operations/getsearchalllibrariesdirectory.md) | :heavy_minus_sign: | N/A | |
|
||||
| `metadata` | [Optional[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 |
|
||||
| `stream_type` | [operations.StreamType](../../models/operations/streamtype.md) | :heavy_check_mark: | Stream type:<br/> - 1 = video<br/> - 2 = audio<br/> - 3 = subtitle<br/> | 1 |
|
||||
| `stream_type` | *Literal[1]* | :heavy_check_mark: | Stream type:<br/> - VIDEO = 1<br/> - AUDIO = 2<br/> - SUBTITLE = 3<br/> | |
|
||||
| `format_` | *Optional[str]* | :heavy_minus_sign: | Format of the stream (e.g., srt). | srt |
|
||||
| `default` | *Optional[bool]* | :heavy_minus_sign: | Indicates if this stream is default. | true |
|
||||
| `codec` | *str* | :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 |
|
||||
Reference in New Issue
Block a user