LukeParke/plexcsharp
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexcsharp.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.1

Browse Source
This commit is contained in:
speakeasybot
2025-02-10 00:23:35 +00:00
parent d976a079a9
commit 3e00ddc6b1
172 changed files with 4640 additions and 265 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Models/Requests/GetActorsLibraryMediaContainer.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Size` | *double* | :heavy_check_mark: | N/A | 50 |
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |

12
docs/Models/Requests/GetAllMediaLibraryActiveDirection.md Normal file
View File

@@ -0,0 +1,12 @@
# GetAllMediaLibraryActiveDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

8
docs/Models/Requests/GetAllMediaLibraryCollection.md Normal file
View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryCollection
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
| `Tag` | *string* | :heavy_check_mark: | The user-made collection this media item belongs to | My Awesome Collection |

8
docs/Models/Requests/GetAllMediaLibraryCountry.md Normal file
View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryCountry
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |

12
docs/Models/Requests/GetAllMediaLibraryDefaultDirection.md Normal file
View File

@@ -0,0 +1,12 @@
# GetAllMediaLibraryDefaultDirection
The direction of the sort. Can be either `asc` or `desc`.
## Values
| Name | Value |
| ------------ | ------------ |
| `Ascending` | asc |
| `Descending` | desc |

8
docs/Models/Requests/GetAllMediaLibraryDirector.md Normal file
View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryDirector
## Fields
| Field | Type | Required | Description | Example |
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
| `Tag` | *string* | :heavy_check_mark: | The role of Director | Danny Boyle |

11
docs/Models/Requests/GetAllMediaLibraryField.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllMediaLibraryField
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Key` | *string* | :heavy_check_mark: | N/A | show.title |
| `Title` | *string* | :heavy_check_mark: | N/A | Show Title |
| `Type` | *string* | :heavy_check_mark: | N/A | string |
| `SubType` | *string* | :heavy_minus_sign: | N/A | rating |

9
docs/Models/Requests/GetAllMediaLibraryFieldType.md Normal file
View File

@@ -0,0 +1,9 @@
# GetAllMediaLibraryFieldType
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `Type` | *string* | :heavy_check_mark: | N/A | tag |
| `Operator` | List<[GetAllMediaLibraryOperator](../../Models/Requests/GetAllMediaLibraryOperator.md)> | :heavy_check_mark: | N/A | |

13
docs/Models/Requests/GetAllMediaLibraryFilter.md Normal file
View File

@@ -0,0 +1,13 @@
# GetAllMediaLibraryFilter
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
| `Filter` | *string* | :heavy_check_mark: | N/A | genre |
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Advanced` | *bool* | :heavy_minus_sign: | N/A | true |

8
docs/Models/Requests/GetAllMediaLibraryGenre.md Normal file
View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryGenre
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| `Tag` | *string* | :heavy_check_mark: | The country of origin of this media item | United States of America |

11
docs/Models/Requests/GetAllMediaLibraryHasThumbnail.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllMediaLibraryHasThumbnail
Indicates if the part has a thumbnail.
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |

10
docs/Models/Requests/GetAllMediaLibraryImage.md Normal file
View File

@@ -0,0 +1,10 @@
# GetAllMediaLibraryImage
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `Alt` | *string* | :heavy_check_mark: | N/A | Episode 1 |
| `Type` | [GetAllMediaLibraryLibraryResponseType](../../Models/Requests/GetAllMediaLibraryLibraryResponseType.md) | :heavy_check_mark: | N/A | background |
| `Url` | *string* | :heavy_check_mark: | N/A | /library/metadata/45521/thumb/1644710589 |

18
docs/Models/Requests/GetAllMediaLibraryLibraryOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,18 @@
# GetAllMediaLibraryLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### GetAllMediaLibraryOptimizedForStreaming1
```csharp
GetAllMediaLibraryLibraryOptimizedForStreaming.CreateGetAllMediaLibraryOptimizedForStreaming1(/* values here */);
```
### Boolean
```csharp
GetAllMediaLibraryLibraryOptimizedForStreaming.CreateBoolean(/* values here */);
```

11
docs/Models/Requests/GetAllMediaLibraryLibraryResponseType.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllMediaLibraryLibraryResponseType
## Values
| Name | Value |
| ------------- | ------------- |
| `CoverPoster` | coverPoster |
| `Background` | background |
| `Snapshot` | snapshot |
| `ClearLogo` | clearLogo |

16
docs/Models/Requests/GetAllMediaLibraryLibraryType.md Normal file
View File

@@ -0,0 +1,16 @@
# GetAllMediaLibraryLibraryType
The type of media content
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

26
docs/Models/Requests/GetAllMediaLibraryMedia.md Normal file
View File

@@ -0,0 +1,26 @@
# GetAllMediaLibraryMedia
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `Width` | *int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `Height` | *int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `AspectRatio` | *float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `AudioChannels` | *int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `DisplayOffset` | *int* | :heavy_minus_sign: | N/A | 50 |
| `AudioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `VideoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
| `VideoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `Container` | *string* | :heavy_minus_sign: | File container type. | mkv |
| `VideoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `OptimizedForStreaming` | [GetAllMediaLibraryOptimizedForStreaming](../../Models/Requests/GetAllMediaLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `Part` | List<[GetAllMediaLibraryPart](../../Models/Requests/GetAllMediaLibraryPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |

26
docs/Models/Requests/GetAllMediaLibraryMediaContainer.md Normal file
View File

@@ -0,0 +1,26 @@
# GetAllMediaLibraryMediaContainer
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `TotalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
| `Offset` | *long* | :heavy_check_mark: | Offset value for pagination. | 0 |
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `Content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `LibrarySectionID` | *long* | :heavy_check_mark: | The unique identifier for the library section. | 2 |
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `LibrarySectionUUID` | *string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `MediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `Thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `Nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `Title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `Title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `ViewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `Meta` | [GetAllMediaLibraryMeta](../../Models/Requests/GetAllMediaLibraryMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | |
| `Metadata` | List<[GetAllMediaLibraryMetadata](../../Models/Requests/GetAllMediaLibraryMetadata.md)> | :heavy_minus_sign: | An array of metadata items. | |

12
docs/Models/Requests/GetAllMediaLibraryMeta.md Normal file
View File

@@ -0,0 +1,12 @@
# GetAllMediaLibraryMeta
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `Type` | List<[GetAllMediaLibraryType](../../Models/Requests/GetAllMediaLibraryType.md)> | :heavy_minus_sign: | N/A |
| `FieldType` | List<[GetAllMediaLibraryFieldType](../../Models/Requests/GetAllMediaLibraryFieldType.md)> | :heavy_minus_sign: | N/A |

74
docs/Models/Requests/GetAllMediaLibraryMetadata.md Normal file
View File

@@ -0,0 +1,74 @@
# GetAllMediaLibraryMetadata
Unknown
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `RatingKey` | *string* | :heavy_check_mark: | The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. | 58683 |
| `Key` | *string* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
| `Guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `Slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
| `Studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
| `Type` | [GetAllMediaLibraryLibraryType](../../Models/Requests/GetAllMediaLibraryLibraryType.md) | :heavy_check_mark: | N/A | movie |
| `Title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
| `TitleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
| `ContentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
| `Summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
| `Rating` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
| `AudienceRating` | *double* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
| `Year` | *int* | :heavy_check_mark: | The release year of the media item. | 2022 |
| `Tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
| `Thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
| `Art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
| `Theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
| `Index` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
| `LeafCount` | *int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
| `ViewedLeafCount` | *int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
| `ChildCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
| `SeasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
| `Duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
| `OriginallyAvailableAt` | [LocalDate](https://nodatime.org/3.1.x/api/NodaTime.LocalDate.html) | :heavy_check_mark: | The original release date of the media item. | 2022-12-14 |
| `AddedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `UpdatedAt` | *long* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
| `AudienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
| `ChapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
| `PrimaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
| `OriginalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
| `ParentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
| `GrandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
| `ParentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `GrandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `GrandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
| `GrandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
| `ParentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
| `GrandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
| `GrandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
| `GrandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
| `GrandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
| `ParentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
| `ParentIndex` | *int* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
| `ParentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
| `RatingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
| `ViewCount` | *int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
| `ViewOffset` | *int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
| `SkipCount` | *int* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
| `Subtype` | *string* | :heavy_minus_sign: | A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. | clip |
| `LastRatedAt` | *long* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
| `CreatedAtAccuracy` | *string* | :heavy_minus_sign: | The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). | epoch,local |
| `CreatedAtTZOffset` | *string* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
| `LastViewedAt` | *int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
| `UserRating` | *float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
| `Image` | List<[GetAllMediaLibraryImage](../../Models/Requests/GetAllMediaLibraryImage.md)> | :heavy_minus_sign: | N/A | |
| `UltraBlurColors` | [GetAllMediaLibraryUltraBlurColors](../../Models/Requests/GetAllMediaLibraryUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
| `Media` | List<[GetAllMediaLibraryMedia](../../Models/Requests/GetAllMediaLibraryMedia.md)> | :heavy_minus_sign: | N/A | |
| `Genre` | List<[GetAllMediaLibraryGenre](../../Models/Requests/GetAllMediaLibraryGenre.md)> | :heavy_minus_sign: | N/A | |
| `Country` | List<[GetAllMediaLibraryCountry](../../Models/Requests/GetAllMediaLibraryCountry.md)> | :heavy_minus_sign: | N/A | |
| `Director` | List<[GetAllMediaLibraryDirector](../../Models/Requests/GetAllMediaLibraryDirector.md)> | :heavy_minus_sign: | N/A | |
| `Writer` | List<[GetAllMediaLibraryWriter](../../Models/Requests/GetAllMediaLibraryWriter.md)> | :heavy_minus_sign: | N/A | |
| `Role` | List<[GetAllMediaLibraryRole](../../Models/Requests/GetAllMediaLibraryRole.md)> | :heavy_minus_sign: | N/A | |
| `Guids` | List<[Guids](../../Models/Requests/Guids.md)> | :heavy_minus_sign: | N/A | |
| `Collection` | List<[GetAllMediaLibraryCollection](../../Models/Requests/GetAllMediaLibraryCollection.md)> | :heavy_minus_sign: | N/A | |

9
docs/Models/Requests/GetAllMediaLibraryOperator.md Normal file
View File

@@ -0,0 +1,9 @@
# GetAllMediaLibraryOperator
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Key` | *string* | :heavy_check_mark: | N/A | = |
| `Title` | *string* | :heavy_check_mark: | N/A | is |

18
docs/Models/Requests/GetAllMediaLibraryOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,18 @@
# GetAllMediaLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### One
```csharp
GetAllMediaLibraryOptimizedForStreaming.CreateOne(/* values here */);
```
### Boolean
```csharp
GetAllMediaLibraryOptimizedForStreaming.CreateBoolean(/* values here */);
```

9
docs/Models/Requests/GetAllMediaLibraryOptimizedForStreaming1.md Normal file
View File

@@ -0,0 +1,9 @@
# GetAllMediaLibraryOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

23
docs/Models/Requests/GetAllMediaLibraryPart.md Normal file
View File

@@ -0,0 +1,23 @@
# GetAllMediaLibraryPart
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `Accessible` | *bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `Exists` | *bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `Id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `Indexes` | *string* | :heavy_minus_sign: | N/A | sd |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `Size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `PacketLength` | *int* | :heavy_minus_sign: | N/A | 188 |
| `Container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `OptimizedForStreaming` | [GetAllMediaLibraryLibraryOptimizedForStreaming](../../Models/Requests/GetAllMediaLibraryLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `HasThumbnail` | [GetAllMediaLibraryHasThumbnail](../../Models/Requests/GetAllMediaLibraryHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `Stream` | List<[GetAllMediaLibraryStream](../../Models/Requests/GetAllMediaLibraryStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

12
docs/Models/Requests/GetAllMediaLibraryQueryParamIncludeMeta.md Normal file
View File

@@ -0,0 +1,12 @@
# GetAllMediaLibraryQueryParamIncludeMeta
Adds the Meta object to the response
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

22
docs/Models/Requests/GetAllMediaLibraryQueryParamType.md Normal file
View File

@@ -0,0 +1,22 @@
# GetAllMediaLibraryQueryParamType
The type of media to retrieve or filter by.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
## Values
| Name | Value |
| --------- | --------- |
| `Movie` | 1 |
| `TvShow` | 2 |
| `Season` | 3 |
| `Episode` | 4 |
| `Audio` | 8 |
| `Album` | 9 |
| `Track` | 10 |

16
docs/Models/Requests/GetAllMediaLibraryRequest.md Normal file
View File

@@ -0,0 +1,16 @@
# GetAllMediaLibraryRequest
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SectionKey` | *int* | :heavy_check_mark: | The unique key of the Plex library. <br/>Note: This is unique in the context of the Plex server.<br/> | 9518 |
| `Type` | [GetAllMediaLibraryQueryParamType](../../Models/Requests/GetAllMediaLibraryQueryParamType.md) | :heavy_check_mark: | The type of media to retrieve or filter by.<br/>1 = movie<br/>2 = show<br/>3 = season<br/>4 = episode<br/>E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries<br/> | 2 |
| `IncludeMeta` | [GetAllMediaLibraryQueryParamIncludeMeta](../../Models/Requests/GetAllMediaLibraryQueryParamIncludeMeta.md) | :heavy_minus_sign: | Adds the Meta object to the response<br/> | 1 |
| `IncludeGuids` | [QueryParamIncludeGuids](../../Models/Requests/QueryParamIncludeGuids.md) | :heavy_minus_sign: | Adds the Guid object to the response<br/> | 1 |
| `IncludeAdvanced` | [IncludeAdvanced](../../Models/Requests/IncludeAdvanced.md) | :heavy_minus_sign: | N/A | 1 |
| `IncludeCollections` | [QueryParamIncludeCollections](../../Models/Requests/QueryParamIncludeCollections.md) | :heavy_minus_sign: | N/A | 1 |
| `IncludeExternalMedia` | [QueryParamIncludeExternalMedia](../../Models/Requests/QueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | N/A | 1 |
| `XPlexContainerStart` | *int* | :heavy_minus_sign: | The index of the first item to return. If not specified, the first item will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 0<br/> | 0 |
| `XPlexContainerSize` | *int* | :heavy_minus_sign: | The number of items to return. If not specified, all items will be returned.<br/>If the number of items exceeds the limit, the response will be paginated.<br/>By default this is 50<br/> | 50 |

11
docs/Models/Requests/GetAllMediaLibraryResponse.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllMediaLibraryResponse
## Fields
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation |
| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
| `Object` | [GetAllMediaLibraryResponseBody](../../Models/Requests/GetAllMediaLibraryResponseBody.md) | :heavy_minus_sign: | Successful response containing media container data. |

10
docs/Models/Requests/GetAllMediaLibraryResponseBody.md Normal file
View File

@@ -0,0 +1,10 @@
# GetAllMediaLibraryResponseBody
Successful response containing media container data.
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `MediaContainer` | [GetAllMediaLibraryMediaContainer](../../Models/Requests/GetAllMediaLibraryMediaContainer.md) | :heavy_minus_sign: | N/A |

8
docs/Models/Requests/GetAllMediaLibraryRole.md Normal file
View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryRole
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
| `Tag` | *string* | :heavy_check_mark: | The name of the actor for this role | Danny Boyle |

15
docs/Models/Requests/GetAllMediaLibrarySort.md Normal file
View File

@@ -0,0 +1,15 @@
# GetAllMediaLibrarySort
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `Default` | *string* | :heavy_minus_sign: | N/A | asc |
| `Active` | *bool* | :heavy_minus_sign: | N/A | false |
| `ActiveDirection` | [GetAllMediaLibraryActiveDirection](../../Models/Requests/GetAllMediaLibraryActiveDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `DefaultDirection` | [GetAllMediaLibraryDefaultDirection](../../Models/Requests/GetAllMediaLibraryDefaultDirection.md) | :heavy_minus_sign: | The direction of the sort. Can be either `asc` or `desc`.<br/> | asc |
| `DescKey` | *string* | :heavy_minus_sign: | N/A | titleSort:desc |
| `FirstCharacterKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/2/firstCharacter |
| `Key` | *string* | :heavy_check_mark: | N/A | titleSort |
| `Title` | *string* | :heavy_check_mark: | N/A | Title |

54
docs/Models/Requests/GetAllMediaLibraryStream.md Normal file
View File

@@ -0,0 +1,54 @@
# GetAllMediaLibraryStream
## Fields
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `StreamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `Default` | *bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `Index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `Language` | *string* | :heavy_check_mark: | Language of the stream. | English |
| `LanguageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `LanguageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
| `HeaderCompression` | *bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `DOVIBLCompatID` | *int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `DOVIBLPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `DOVIELPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `DOVILevel` | *int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `DOVIPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `DOVIProfile` | *int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `DOVIRPUPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `DOVIVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `BitDepth` | *int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `ChromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `ChromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `CodedHeight` | *int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `CodedWidth` | *int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `ColorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `ColorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `ColorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `ColorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `FrameRate` | *float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `Height` | *int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `Level` | *int* | :heavy_minus_sign: | Video level. | 150 |
| `Original` | *bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `HasScalingMatrix` | *bool* | :heavy_minus_sign: | N/A | false |
| `Profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `ScanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `RefFrames` | *int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `Width` | *int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `Selected` | *bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `Forced` | *bool* | :heavy_minus_sign: | N/A | true |
| `Channels` | *int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `AudioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `SamplingRate` | *int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `CanAutoSync` | *bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `HearingImpaired` | *bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `Dub` | *bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |
| `Title` | *string* | :heavy_minus_sign: | Optional title for the stream (e.g., language variant). | SDH |

15
docs/Models/Requests/GetAllMediaLibraryType.md Normal file
View File

@@ -0,0 +1,15 @@
# GetAllMediaLibraryType
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Subtype` | *string* | :heavy_minus_sign: | N/A | clip |
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | List<[GetAllMediaLibraryFilter](../../Models/Requests/GetAllMediaLibraryFilter.md)> | :heavy_minus_sign: | N/A | |
| `Sort` | List<[GetAllMediaLibrarySort](../../Models/Requests/GetAllMediaLibrarySort.md)> | :heavy_minus_sign: | N/A | |
| `Field` | List<[GetAllMediaLibraryField](../../Models/Requests/GetAllMediaLibraryField.md)> | :heavy_minus_sign: | N/A | |

11
docs/Models/Requests/GetAllMediaLibraryUltraBlurColors.md Normal file
View File

@@ -0,0 +1,11 @@
# GetAllMediaLibraryUltraBlurColors
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `TopLeft` | *string* | :heavy_check_mark: | N/A | 11333b |
| `TopRight` | *string* | :heavy_check_mark: | N/A | 0a232d |
| `BottomRight` | *string* | :heavy_check_mark: | N/A | 73958 |
| `BottomLeft` | *string* | :heavy_check_mark: | N/A | 1f5066 |

8
docs/Models/Requests/GetAllMediaLibraryWriter.md Normal file
View File

@@ -0,0 +1,8 @@
# GetAllMediaLibraryWriter
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Tag` | *string* | :heavy_check_mark: | The role of Writer | Danny Boyle |

26
docs/Models/Requests/GetCountriesLibraryMediaContainer.md
View File

@@ -5,18 +5,16 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `Size` | *double* | :heavy_check_mark: | N/A | 50 |
| `Offset` | *int* | :heavy_minus_sign: | N/A | |
| `TotalSize` | *int* | :heavy_minus_sign: | N/A | |
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
| `MediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *long* | :heavy_check_mark: | N/A | 1734362201 |
| `Nocache` | *bool* | :heavy_check_mark: | N/A | true |
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `Title1` | *string* | :heavy_check_mark: | N/A | TV Series |
| `Title2` | *string* | :heavy_check_mark: | N/A | By Country |
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `Content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `MediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `Nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `Thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `Title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `Title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `ViewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `Directory` | List<[GetCountriesLibraryDirectory](../../Models/Requests/GetCountriesLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |

26
docs/Models/Requests/GetGenresLibraryMediaContainer.md
View File

@@ -5,18 +5,16 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `Size` | *double* | :heavy_check_mark: | N/A | 50 |
| `Offset` | *int* | :heavy_minus_sign: | N/A | |
| `TotalSize` | *int* | :heavy_minus_sign: | N/A | |
| `Identifier` | *string* | :heavy_check_mark: | N/A | com.plexapp.plugins.library |
| `AllowSync` | *bool* | :heavy_check_mark: | N/A | false |
| `Art` | *string* | :heavy_check_mark: | N/A | /:/resources/show-fanart.jpg |
| `Content` | *string* | :heavy_check_mark: | N/A | secondary |
| `MediaTagPrefix` | *string* | :heavy_check_mark: | N/A | /system/bundle/media/flags/ |
| `MediaTagVersion` | *long* | :heavy_check_mark: | N/A | 1734362201 |
| `Nocache` | *bool* | :heavy_check_mark: | N/A | true |
| `Thumb` | *string* | :heavy_check_mark: | N/A | /:/resources/show.png |
| `Title1` | *string* | :heavy_check_mark: | N/A | TV Shows (Reality) |
| `Title2` | *string* | :heavy_check_mark: | N/A | By Genre |
| `ViewGroup` | *string* | :heavy_check_mark: | N/A | secondary |
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `Art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
| `Content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `MediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
| `MediaTagVersion` | *long* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
| `Nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
| `Thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
| `Title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
| `Title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
| `ViewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
| `Directory` | List<[GetGenresLibraryDirectory](../../Models/Requests/GetGenresLibraryDirectory.md)> | :heavy_minus_sign: | N/A | |

3
docs/Models/Requests/GetLibraryItemsFilter.md
View File

@@ -9,4 +9,5 @@
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Advanced` | *bool* | :heavy_minus_sign: | N/A | true |

4
docs/Models/Requests/GetLibraryItemsLibraryType.md
View File

@@ -11,4 +11,6 @@ The type of media content
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

3
docs/Models/Requests/GetLibraryItemsType.md
View File

@@ -6,7 +6,8 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `Type` | *string* | :heavy_check_mark: | N/A | show |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Subtype` | *string* | :heavy_minus_sign: | N/A | clip |
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | List<[GetLibraryItemsFilter](../../Models/Requests/GetLibraryItemsFilter.md)> | :heavy_minus_sign: | N/A | |

2
docs/Models/Requests/GetMediaMetaDataCountry.md
View File

@@ -5,6 +5,6 @@
| Field | Type | Required | Description | Example |
| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
| `Id` | *long* | :heavy_check_mark: | The unique country identifier. | 58591 |
| `Id` | *int* | :heavy_check_mark: | The unique country identifier. | 58591 |
| `Filter` | *string* | :heavy_check_mark: | The filter string for the country. | country=58591 |
| `Tag` | *string* | :heavy_check_mark: | The country name. | United States of America |

8
docs/Models/Requests/GetMediaMetaDataGuids.md Normal file
View File

@@ -0,0 +1,8 @@
# GetMediaMetaDataGuids
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Id` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |

11
docs/Models/Requests/GetMediaMetaDataHasThumbnail.md Normal file
View File

@@ -0,0 +1,11 @@
# GetMediaMetaDataHasThumbnail
Indicates if the part has a thumbnail.
## Values
| Name | Value |
| ------- | ------- |
| `False` | 0 |
| `True` | 1 |

18
docs/Models/Requests/GetMediaMetaDataLibraryOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,18 @@
# GetMediaMetaDataLibraryOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### GetMediaMetaDataOptimizedForStreaming1
```csharp
GetMediaMetaDataLibraryOptimizedForStreaming.CreateGetMediaMetaDataOptimizedForStreaming1(/* values here */);
```
### Boolean
```csharp
GetMediaMetaDataLibraryOptimizedForStreaming.CreateBoolean(/* values here */);
```

38
docs/Models/Requests/GetMediaMetaDataMedia.md
View File

@@ -3,20 +3,24 @@
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `Duration` | *long* | :heavy_check_mark: | Duration of the media in milliseconds. | 9610350 |
| `Bitrate` | *long* | :heavy_check_mark: | Bitrate in bits per second. | 25512 |
| `Width` | *long* | :heavy_check_mark: | Video width in pixels. | 3840 |
| `Height` | *long* | :heavy_check_mark: | Video height in pixels. | 1602 |
| `AspectRatio` | *float* | :heavy_check_mark: | Aspect ratio of the video. | 2.35 |
| `AudioChannels` | *long* | :heavy_check_mark: | Number of audio channels. | 6 |
| `AudioCodec` | *string* | :heavy_check_mark: | Audio codec used. | eac3 |
| `VideoCodec` | *string* | :heavy_check_mark: | Video codec used. | hevc |
| `VideoResolution` | *string* | :heavy_check_mark: | Video resolution (e.g., 4k). | 4k |
| `Container` | *string* | :heavy_check_mark: | File container type. | mkv |
| `VideoFrameRate` | *string* | :heavy_check_mark: | Frame rate of the video (e.g., 24p). | 24p |
| `VideoProfile` | *string* | :heavy_check_mark: | Video profile (e.g., main 10). | main 10 |
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `Part` | List<[GetMediaMetaDataPart](../../Models/Requests/GetMediaMetaDataPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique media identifier. | 387322 |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the media in milliseconds. | 9610350 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate in bits per second. | 25512 |
| `Width` | *int* | :heavy_minus_sign: | Video width in pixels. | 3840 |
| `Height` | *int* | :heavy_minus_sign: | Video height in pixels. | 1602 |
| `AspectRatio` | *float* | :heavy_minus_sign: | Aspect ratio of the video. | 2.35 |
| `AudioChannels` | *int* | :heavy_minus_sign: | Number of audio channels. | 6 |
| `DisplayOffset` | *int* | :heavy_minus_sign: | N/A | 50 |
| `AudioCodec` | *string* | :heavy_minus_sign: | Audio codec used. | eac3 |
| `VideoCodec` | *string* | :heavy_minus_sign: | Video codec used. | hevc |
| `VideoResolution` | *string* | :heavy_minus_sign: | Video resolution (e.g., 4k). | 4k |
| `Container` | *string* | :heavy_minus_sign: | File container type. | mkv |
| `VideoFrameRate` | *string* | :heavy_minus_sign: | Frame rate of the video. Values found include NTSC, PAL, 24p<br/> | 24p |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile (e.g., main 10). | main 10 |
| `HasVoiceActivity` | *bool* | :heavy_check_mark: | Indicates whether voice activity is detected. | false |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `OptimizedForStreaming` | [GetMediaMetaDataOptimizedForStreaming](../../Models/Requests/GetMediaMetaDataOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `Part` | List<[GetMediaMetaDataPart](../../Models/Requests/GetMediaMetaDataPart.md)> | :heavy_check_mark: | An array of parts for this media item. | |

2
docs/Models/Requests/GetMediaMetaDataMediaContainer.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `Size` | *double* | :heavy_check_mark: | N/A | 50 |
| `Size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
| `AllowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
| `Identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
| `LibrarySectionID` | *long* | :heavy_check_mark: | The unique identifier for the library section. | 2 |

24
docs/Models/Requests/GetMediaMetaDataMetadata.md
View File

@@ -23,30 +23,32 @@
| `LibrarySectionTitle` | *string* | :heavy_check_mark: | The title of the library section. | TV Series |
| `LibrarySectionID` | *long* | :heavy_check_mark: | The ID of the library section. | 2 |
| `LibrarySectionKey` | *string* | :heavy_check_mark: | The key of the library section. | /library/sections/2 |
| `ContentRating` | *string* | :heavy_check_mark: | The content rating (e.g., TV-MA). | TV-MA |
| `ContentRating` | *string* | :heavy_minus_sign: | The content rating (e.g., TV-MA). | TV-MA |
| `Summary` | *string* | :heavy_check_mark: | A summary of the content. | Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman. |
| `Index` | *long* | :heavy_minus_sign: | The index or order of the item. | 1 |
| `GrandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent entity (typically the show's title). | Alice in Borderland |
| `ParentTitle` | *string* | :heavy_minus_sign: | The title of the parent entity (typically the season's title). | Season 2 |
| `AudienceRating` | *float* | :heavy_check_mark: | The audience rating for the content. | 8.7 |
| `AudienceRating` | *float* | :heavy_minus_sign: | The audience rating for the content. | 8.7 |
| `ViewCount` | *long* | :heavy_minus_sign: | The number of times the item has been viewed. | 4 |
| `SkipCount` | *long* | :heavy_minus_sign: | The number of times the item has been skipped. | 1 |
| `LastViewedAt` | *long* | :heavy_minus_sign: | Unix timestamp of when the item was last viewed. | 1625764795 |
| `Year` | *long* | :heavy_check_mark: | The release year. | 2015 |
| `Year` | *int* | :heavy_check_mark: | The release year. | 2015 |
| `Rating` | *float* | :heavy_minus_sign: | The general rating | 6 |
| `RatingImage` | *string* | :heavy_minus_sign: | The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image). | rottentomatoes://image.rating.ripe |
| `Tagline` | *string* | :heavy_minus_sign: | The tagline of the content. | Make the call |
| `ChapterSource` | *string* | :heavy_minus_sign: | N/A | media |
| `PrimaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/134704 |
| `Thumb` | *string* | :heavy_check_mark: | URL of the thumbnail image. | /library/metadata/44288/thumb/1736487993 |
| `Art` | *string* | :heavy_check_mark: | URL of the art image. | /library/metadata/44288/art/1736487993 |
| `Theme` | *string* | :heavy_minus_sign: | URL of the theme image. | /library/metadata/44288/theme/1736487993 |
| `Duration` | *long* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `OriginallyAvailableAt` | [LocalDate](https://nodatime.org/3.1.x/api/NodaTime.LocalDate.html) | :heavy_check_mark: | The original release date. | 2015-02-08 |
| `Duration` | *int* | :heavy_check_mark: | Duration of the content in milliseconds. | 2700000 |
| `OriginallyAvailableAt` | [LocalDate](https://nodatime.org/3.1.x/api/NodaTime.LocalDate.html) | :heavy_minus_sign: | The original release date. | 2015-02-08 |
| `LeafCount` | *long* | :heavy_minus_sign: | The total number of episodes (or leaves). | 63 |
| `ViewedLeafCount` | *long* | :heavy_minus_sign: | The number of episodes that have been viewed. | 4 |
| `ChildCount` | *long* | :heavy_minus_sign: | The number of child items. | 6 |
| `AddedAt` | *long* | :heavy_check_mark: | Unix timestamp when the item was added. | 1625505101 |
| `UpdatedAt` | *long* | :heavy_check_mark: | Unix timestamp when the item was last updated. | 1736487993 |
| `AudienceRatingImage` | *string* | :heavy_check_mark: | The URL for the audience rating image. | themoviedb://image.rating |
| `ChildCount` | *int* | :heavy_minus_sign: | The number of child items. | 6 |
| `AddedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `UpdatedAt` | *long* | :heavy_check_mark: | N/A | 1556281940 |
| `AudienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | themoviedb://image.rating |
| `ParentIndex` | *long* | :heavy_minus_sign: | The index number of the parent entity, which could indicate its order or position. | 2 |
| `ParentThumb` | *string* | :heavy_minus_sign: | The URL of the parent's thumbnail image. | /library/metadata/48047/thumb/1671800243 |
| `GrandparentThumb` | *string* | :heavy_minus_sign: | The URL of the grandparent's thumbnail image. | /library/metadata/45520/thumb/1736488003 |
@@ -56,8 +58,8 @@
| `UltraBlurColors` | [GetMediaMetaDataUltraBlurColors](../../Models/Requests/GetMediaMetaDataUltraBlurColors.md) | :heavy_check_mark: | N/A | |
| `Genre` | List<[GetMediaMetaDataGenre](../../Models/Requests/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | An array of genre tags. | |
| `Country` | List<[GetMediaMetaDataCountry](../../Models/Requests/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | An array of country tags. | |
| `Guids` | List<[Guids](../../Models/Requests/Guids.md)> | :heavy_check_mark: | An array of GUID objects. | |
| `Rating` | List<[Rating](../../Models/Requests/Rating.md)> | :heavy_check_mark: | An array of rating objects. | |
| `Guids` | List<[GetMediaMetaDataGuids](../../Models/Requests/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | An array of GUID objects. | |
| `Ratings` | List<[Ratings](../../Models/Requests/Ratings.md)> | :heavy_minus_sign: | An array of rating objects. | |
| `Role` | List<[GetMediaMetaDataRole](../../Models/Requests/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | An array of Actor roles. | |
| `Director` | List<[GetMediaMetaDataDirector](../../Models/Requests/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | An array of Director roles. | |
| `Writer` | List<[GetMediaMetaDataWriter](../../Models/Requests/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | An array of Writer roles. | |

18
docs/Models/Requests/GetMediaMetaDataOptimizedForStreaming.md Normal file
View File

@@ -0,0 +1,18 @@
# GetMediaMetaDataOptimizedForStreaming
Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true
## Supported Types
### OptimizedForStreaming1
```csharp
GetMediaMetaDataOptimizedForStreaming.CreateOptimizedForStreaming1(/* values here */);
```
### Boolean
```csharp
GetMediaMetaDataOptimizedForStreaming.CreateBoolean(/* values here */);
```

9
docs/Models/Requests/GetMediaMetaDataOptimizedForStreaming1.md Normal file
View File

@@ -0,0 +1,9 @@
# GetMediaMetaDataOptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

31
docs/Models/Requests/GetMediaMetaDataPart.md
View File

@@ -3,16 +3,21 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `Accessible` | *bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `Exists` | *bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `Id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `Indexes` | *string* | :heavy_minus_sign: | N/A | sd |
| `Duration` | *long* | :heavy_check_mark: | Duration of the part in milliseconds. | 9610350 |
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `Size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `Container` | *string* | :heavy_check_mark: | Container format of the part. | mkv |
| `VideoProfile` | *string* | :heavy_check_mark: | Video profile for the part. | main 10 |
| `Stream` | List<[GetMediaMetaDataStream](../../Models/Requests/GetMediaMetaDataStream.md)> | :heavy_check_mark: | An array of streams for this part. | |
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `Accessible` | *bool* | :heavy_minus_sign: | Indicates if the part is accessible. | true |
| `Exists` | *bool* | :heavy_minus_sign: | Indicates if the part exists. | true |
| `Id` | *long* | :heavy_check_mark: | Unique part identifier. | 418385 |
| `Key` | *string* | :heavy_check_mark: | Key to access this part. | /library/parts/418385/1735864239/file.mkv |
| `Indexes` | *string* | :heavy_minus_sign: | N/A | sd |
| `Duration` | *int* | :heavy_minus_sign: | Duration of the part in milliseconds. | 9610350 |
| `File` | *string* | :heavy_check_mark: | File path for the part. | /mnt/Movies_1/W/Wicked (2024).mkv |
| `Size` | *long* | :heavy_check_mark: | File size in bytes. | 30649952104 |
| `PacketLength` | *int* | :heavy_minus_sign: | N/A | 188 |
| `Container` | *string* | :heavy_minus_sign: | Container format of the part. | mkv |
| `VideoProfile` | *string* | :heavy_minus_sign: | Video profile for the part. | main 10 |
| `AudioProfile` | *string* | :heavy_minus_sign: | The audio profile used for the media (e.g., DTS, Dolby Digital, etc.). | dts |
| `Has64bitOffsets` | *bool* | :heavy_minus_sign: | N/A | false |
| `OptimizedForStreaming` | [GetMediaMetaDataLibraryOptimizedForStreaming](../../Models/Requests/GetMediaMetaDataLibraryOptimizedForStreaming.md) | :heavy_minus_sign: | Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true | |
| `HasThumbnail` | [GetMediaMetaDataHasThumbnail](../../Models/Requests/GetMediaMetaDataHasThumbnail.md) | :heavy_minus_sign: | N/A | 1 |
| `Stream` | List<[GetMediaMetaDataStream](../../Models/Requests/GetMediaMetaDataStream.md)> | :heavy_minus_sign: | An array of streams for this part. | |

31
docs/Models/Requests/GetMediaMetaDataStream.md
View File

@@ -6,47 +6,48 @@
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `Id` | *long* | :heavy_check_mark: | Unique stream identifier. | 1002625 |
| `StreamType` | *long* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `StreamType` | *int* | :heavy_check_mark: | Stream type (1=video, 2=audio, 3=subtitle). | 1 |
| `Default` | *bool* | :heavy_minus_sign: | Indicates if this stream is default. | true |
| `Codec` | *string* | :heavy_check_mark: | Codec used by the stream. | hevc |
| `Index` | *long* | :heavy_check_mark: | Index of the stream. | 0 |
| `Bitrate` | *long* | :heavy_check_mark: | Bitrate of the stream. | 24743 |
| `Index` | *int* | :heavy_check_mark: | Index of the stream. | 0 |
| `Bitrate` | *int* | :heavy_minus_sign: | Bitrate of the stream. | 24743 |
| `Language` | *string* | :heavy_check_mark: | Language of the stream. | English |
| `LanguageTag` | *string* | :heavy_check_mark: | Language tag (e.g., en). | en |
| `LanguageCode` | *string* | :heavy_check_mark: | ISO language code. | eng |
| `DOVIBLCompatID` | *long* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `HeaderCompression` | *bool* | :heavy_minus_sign: | Indicates whether header compression is enabled. | true |
| `DOVIBLCompatID` | *int* | :heavy_minus_sign: | Dolby Vision BL compatibility ID. | 1 |
| `DOVIBLPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision BL is present. | true |
| `DOVIELPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision EL is present. | false |
| `DOVILevel` | *long* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `DOVILevel` | *int* | :heavy_minus_sign: | Dolby Vision level. | 6 |
| `DOVIPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision is present. | true |
| `DOVIProfile` | *long* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `DOVIProfile` | *int* | :heavy_minus_sign: | Dolby Vision profile. | 8 |
| `DOVIRPUPresent` | *bool* | :heavy_minus_sign: | Indicates if Dolby Vision RPU is present. | true |
| `DOVIVersion` | *string* | :heavy_minus_sign: | Dolby Vision version. | 1.0 |
| `BitDepth` | *long* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `BitDepth` | *int* | :heavy_minus_sign: | Bit depth of the video stream. | 10 |
| `ChromaLocation` | *string* | :heavy_minus_sign: | Chroma sample location. | topleft |
| `ChromaSubsampling` | *string* | :heavy_minus_sign: | Chroma subsampling format. | 4:2:0 |
| `CodedHeight` | *long* | :heavy_minus_sign: | Coded video height. | 1608 |
| `CodedWidth` | *long* | :heavy_minus_sign: | Coded video width. | 3840 |
| `CodedHeight` | *int* | :heavy_minus_sign: | Coded video height. | 1608 |
| `CodedWidth` | *int* | :heavy_minus_sign: | Coded video width. | 3840 |
| `ColorPrimaries` | *string* | :heavy_minus_sign: | Color primaries used. | bt2020 |
| `ColorRange` | *string* | :heavy_minus_sign: | Color range (e.g., tv). | tv |
| `ColorSpace` | *string* | :heavy_minus_sign: | Color space. | bt2020nc |
| `ColorTrc` | *string* | :heavy_minus_sign: | Color transfer characteristics. | smpte2084 |
| `FrameRate` | *float* | :heavy_minus_sign: | Frame rate of the stream. | 23.976 |
| `Height` | *long* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `Level` | *long* | :heavy_minus_sign: | Video level. | 150 |
| `Height` | *int* | :heavy_minus_sign: | Height of the video stream. | 1602 |
| `Level` | *int* | :heavy_minus_sign: | Video level. | 150 |
| `Original` | *bool* | :heavy_minus_sign: | Indicates if this is the original stream. | true |
| `HasScalingMatrix` | *bool* | :heavy_minus_sign: | N/A | false |
| `Profile` | *string* | :heavy_minus_sign: | Video profile. | main 10 |
| `ScanType` | *string* | :heavy_minus_sign: | N/A | progressive |
| `RefFrames` | *long* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `Width` | *long* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `RefFrames` | *int* | :heavy_minus_sign: | Number of reference frames. | 1 |
| `Width` | *int* | :heavy_minus_sign: | Width of the video stream. | 3840 |
| `DisplayTitle` | *string* | :heavy_check_mark: | Display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `ExtendedDisplayTitle` | *string* | :heavy_check_mark: | Extended display title for the stream. | 4K DoVi/HDR10 (HEVC Main 10) |
| `Selected` | *bool* | :heavy_minus_sign: | Indicates if this stream is selected (applicable for audio streams). | true |
| `Forced` | *bool* | :heavy_minus_sign: | N/A | true |
| `Channels` | *long* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `Channels` | *int* | :heavy_minus_sign: | Number of audio channels (for audio streams). | 6 |
| `AudioChannelLayout` | *string* | :heavy_minus_sign: | Audio channel layout. | 5.1(side) |
| `SamplingRate` | *long* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `SamplingRate` | *int* | :heavy_minus_sign: | Sampling rate for the audio stream. | 48000 |
| `CanAutoSync` | *bool* | :heavy_minus_sign: | Indicates if the stream can auto-sync. | false |
| `HearingImpaired` | *bool* | :heavy_minus_sign: | Indicates if the stream is for the hearing impaired. | true |
| `Dub` | *bool* | :heavy_minus_sign: | Indicates if the stream is a dub. | true |

3
docs/Models/Requests/GetRecentlyAddedFilter.md
View File

@@ -9,4 +9,5 @@
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Advanced` | *bool* | :heavy_minus_sign: | N/A | true |

4
docs/Models/Requests/GetRecentlyAddedHubsType.md
View File

@@ -11,4 +11,6 @@ The type of media content
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

3
docs/Models/Requests/GetRecentlyAddedLibraryFilter.md
View File

@@ -9,4 +9,5 @@
| `FilterType` | *string* | :heavy_check_mark: | N/A | string |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/genre?type=2 |
| `Title` | *string* | :heavy_check_mark: | N/A | Genre |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Advanced` | *bool* | :heavy_minus_sign: | N/A | true |

3
docs/Models/Requests/GetRecentlyAddedLibraryType.md
View File

@@ -6,7 +6,8 @@
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `Type` | *string* | :heavy_check_mark: | N/A | show |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Subtype` | *string* | :heavy_minus_sign: | N/A | clip |
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | List<[GetRecentlyAddedLibraryFilter](../../Models/Requests/GetRecentlyAddedLibraryFilter.md)> | :heavy_minus_sign: | N/A | |

2
docs/Models/Requests/GetRecentlyAddedMediaContainer.md
View File

@@ -5,7 +5,7 @@
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `Size` | *double* | :heavy_check_mark: | N/A | 50 |
| `Size` | *long* | :heavy_check_mark: | N/A | 50 |
| `Offset` | *int* | :heavy_minus_sign: | N/A | |
| `TotalSize` | *int* | :heavy_minus_sign: | N/A | |
| `Identifier` | *string* | :heavy_minus_sign: | N/A | com.plexapp.plugins.library |

3
docs/Models/Requests/GetRecentlyAddedType.md
View File

@@ -6,7 +6,8 @@
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `Key` | *string* | :heavy_check_mark: | N/A | /library/sections/2/all?type=2 |
| `Type` | *string* | :heavy_check_mark: | N/A | show |
| `Type` | *string* | :heavy_check_mark: | N/A | filter |
| `Subtype` | *string* | :heavy_minus_sign: | N/A | clip |
| `Title` | *string* | :heavy_check_mark: | N/A | TV Shows |
| `Active` | *bool* | :heavy_check_mark: | N/A | false |
| `Filter` | List<[GetRecentlyAddedFilter](../../Models/Requests/GetRecentlyAddedFilter.md)> | :heavy_minus_sign: | N/A | |

11
docs/Models/Requests/GetSearchAllLibrariesQueryParamIncludeCollections.md Normal file
View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesQueryParamIncludeCollections
Whether to include collections in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

11
docs/Models/Requests/GetSearchAllLibrariesQueryParamIncludeExternalMedia.md Normal file
View File

@@ -0,0 +1,11 @@
# GetSearchAllLibrariesQueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

16
docs/Models/Requests/GetSearchAllLibrariesRequest.md
View File

@@ -3,11 +3,11 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `Query` | *string* | :heavy_check_mark: | The search query term. | |
| `ClientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `Limit` | *long* | :heavy_minus_sign: | Limit the number of results returned. | |
| `SearchTypes` | List<[SearchTypes](../../Models/Requests/SearchTypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `IncludeCollections` | [QueryParamIncludeCollections](../../Models/Requests/QueryParamIncludeCollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
| `IncludeExternalMedia` | [QueryParamIncludeExternalMedia](../../Models/Requests/QueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `Query` | *string* | :heavy_check_mark: | The search query term. | |
| `ClientID` | *string* | :heavy_check_mark: | An opaque identifier unique to the client (UUID, serial number, or other unique device ID) | 3381b62b-9ab7-4e37-827b-203e9809eb58 |
| `Limit` | *long* | :heavy_minus_sign: | Limit the number of results returned. | |
| `SearchTypes` | List<[SearchTypes](../../Models/Requests/SearchTypes.md)> | :heavy_minus_sign: | A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.<br/> | movies,music,otherVideos,people,tv |
| `IncludeCollections` | [GetSearchAllLibrariesQueryParamIncludeCollections](../../Models/Requests/GetSearchAllLibrariesQueryParamIncludeCollections.md) | :heavy_minus_sign: | Whether to include collections in the search results. | 1 |
| `IncludeExternalMedia` | [GetSearchAllLibrariesQueryParamIncludeExternalMedia](../../Models/Requests/GetSearchAllLibrariesQueryParamIncludeExternalMedia.md) | :heavy_minus_sign: | Whether to include external media in the search results. | 1 |

4
docs/Models/Requests/GetSearchAllLibrariesType.md
View File

@@ -11,4 +11,6 @@ The type of media content
| `Movie` | movie |
| `TvShow` | show |
| `Season` | season |
| `Episode` | episode |
| `Episode` | episode |
| `Artist` | artist |
| `Album` | album |

6
docs/Models/Requests/Guids.md
View File

@@ -3,6 +3,6 @@
## Fields
| Field | Type | Required | Description | Example |
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
| `Id` | *string* | :heavy_check_mark: | The GUID value. | imdb://tt3032476 |
| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `Id` | *string* | :heavy_minus_sign: | The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337<br/> | tvdb://2337 |

9
docs/Models/Requests/IncludeAdvanced.md Normal file
View File

@@ -0,0 +1,9 @@
# IncludeAdvanced
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

9
docs/Models/Requests/One.md Normal file
View File

@@ -0,0 +1,9 @@
# One
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

9
docs/Models/Requests/OptimizedForStreaming1.md Normal file
View File

@@ -0,0 +1,9 @@
# OptimizedForStreaming1
## Values
| Name | Value |
| ------ | ------ |
| `Zero` | 0 |
| `One` | 1 |

2
docs/Models/Requests/QueryParamIncludeCollections.md
View File

@@ -1,7 +1,5 @@
# QueryParamIncludeCollections
Whether to include collections in the search results.
## Values

2
docs/Models/Requests/QueryParamIncludeExternalMedia.md
View File

@@ -1,7 +1,5 @@
# QueryParamIncludeExternalMedia
Whether to include external media in the search results.
## Values

12
docs/Models/Requests/QueryParamIncludeGuids.md Normal file
View File

@@ -0,0 +1,12 @@
# QueryParamIncludeGuids
Adds the Guid object to the response
## Values
| Name | Value |
| --------- | --------- |
| `Disable` | 0 |
| `Enable` | 1 |

2
docs/Models/Requests/Rating.md → docs/Models/Requests/Ratings.md
View File

@@ -1,4 +1,4 @@
# Rating
# Ratings
## Fields

4
docs/Models/Requests/Tag.md
View File

@@ -7,7 +7,6 @@ A key representing a specific tag within the section.
| Name | Value |
| ---------------- | ---------------- |
| `All` | all |
| `Unwatched` | unwatched |
| `Newest` | newest |
| `RecentlyAdded` | recentlyAdded |
@@ -15,12 +14,9 @@ A key representing a specific tag within the section.
| `OnDeck` | onDeck |
| `Collection` | collection |
| `Edition` | edition |
| `Genre` | genre |
| `Year` | year |
| `Decade` | decade |
| `Director` | director |
| `Actor` | actor |
| `Country` | country |
| `ContentRating` | contentRating |
| `Rating` | rating |
| `Resolution` | resolution |