Files
plexcsharp/docs/Models/Requests/GetMediaMetaDataRequest.md

21 lines
8.7 KiB
Markdown

# GetMediaMetaDataRequest
## Fields
| Field | Type | Required | Description | Example |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `RatingKey` | *string* | :heavy_check_mark: | The id(s) of the library item(s) to return metadata for. Can be a single ID or comma-separated list of IDs. | 21119,21617 |
| `IncludeConcerts` | *bool* | :heavy_minus_sign: | Include concerts data if set to true. | true |
| `IncludeExtras` | *bool* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
| `IncludeOnDeck` | *bool* | :heavy_minus_sign: | Include on-deck items. | true |
| `IncludePopularLeaves` | *bool* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
| `IncludePreferences` | *bool* | :heavy_minus_sign: | Include preferences information. | true |
| `IncludeReviews` | *bool* | :heavy_minus_sign: | Include reviews for the content. | true |
| `IncludeChapters` | *bool* | :heavy_minus_sign: | Include chapter details. | true |
| `IncludeStations` | *bool* | :heavy_minus_sign: | Include station data. | true |
| `IncludeExternalMedia` | *bool* | :heavy_minus_sign: | Include external media data. | true |
| `AsyncAugmentMetadata` | *bool* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
| `AsyncCheckFiles` | *bool* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
| `AsyncRefreshAnalysis` | *bool* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
| `AsyncRefreshLocalMediaAgent` | *bool* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true |