mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
21 lines
4.5 KiB
Markdown
21 lines
4.5 KiB
Markdown
# GetMediaMetaDataRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
|
|
| `ratingKey` | *long* | :heavy_check_mark: | the id of the library item to return the children of. | 9518 |
|
|
| `includeConcerts` | *Optional\<Boolean>* | :heavy_minus_sign: | Include concerts data if set to true. | true |
|
|
| `includeExtras` | *Optional\<Boolean>* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
|
|
| `includeOnDeck` | *Optional\<Boolean>* | :heavy_minus_sign: | Include on-deck items. | true |
|
|
| `includePopularLeaves` | *Optional\<Boolean>* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
|
| `includePreferences` | *Optional\<Boolean>* | :heavy_minus_sign: | Include preferences information. | true |
|
|
| `includeReviews` | *Optional\<Boolean>* | :heavy_minus_sign: | Include reviews for the content. | true |
|
|
| `includeChapters` | *Optional\<Boolean>* | :heavy_minus_sign: | Include chapter details. | true |
|
|
| `includeStations` | *Optional\<Boolean>* | :heavy_minus_sign: | Include station data. | true |
|
|
| `includeExternalMedia` | *Optional\<Boolean>* | :heavy_minus_sign: | Include external media data. | true |
|
|
| `asyncAugmentMetadata` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
|
| `asyncCheckFiles` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
|
|
| `asyncRefreshAnalysis` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
|
|
| `asyncRefreshLocalMediaAgent` | *Optional\<Boolean>* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true | |