mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-09 20:47:47 +00:00
43 lines
9.2 KiB
Markdown
43 lines
9.2 KiB
Markdown
# GetMediaMetaDataRequest
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { GetMediaMetaDataRequest } from "@lukehagar/plexjs/sdk/models/operations";
|
|
|
|
let value: GetMediaMetaDataRequest = {
|
|
ratingKey: "21119,21617",
|
|
includeConcerts: true,
|
|
includeExtras: true,
|
|
includeOnDeck: true,
|
|
includePopularLeaves: true,
|
|
includePreferences: true,
|
|
includeReviews: true,
|
|
includeChapters: true,
|
|
includeStations: true,
|
|
includeExternalMedia: true,
|
|
asyncAugmentMetadata: true,
|
|
asyncCheckFiles: true,
|
|
asyncRefreshAnalysis: true,
|
|
asyncRefreshLocalMediaAgent: true,
|
|
};
|
|
```
|
|
|
|
## 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` | *boolean* | :heavy_minus_sign: | Include concerts data if set to true. | true |
|
|
| `includeExtras` | *boolean* | :heavy_minus_sign: | Include extra content (e.g. bonus features). | true |
|
|
| `includeOnDeck` | *boolean* | :heavy_minus_sign: | Include on-deck items. | true |
|
|
| `includePopularLeaves` | *boolean* | :heavy_minus_sign: | Include popular leaves (episodes/chapters). | true |
|
|
| `includePreferences` | *boolean* | :heavy_minus_sign: | Include preferences information. | true |
|
|
| `includeReviews` | *boolean* | :heavy_minus_sign: | Include reviews for the content. | true |
|
|
| `includeChapters` | *boolean* | :heavy_minus_sign: | Include chapter details. | true |
|
|
| `includeStations` | *boolean* | :heavy_minus_sign: | Include station data. | true |
|
|
| `includeExternalMedia` | *boolean* | :heavy_minus_sign: | Include external media data. | true |
|
|
| `asyncAugmentMetadata` | *boolean* | :heavy_minus_sign: | Trigger asynchronous metadata augmentation. | true |
|
|
| `asyncCheckFiles` | *boolean* | :heavy_minus_sign: | Trigger asynchronous file checking. | true |
|
|
| `asyncRefreshAnalysis` | *boolean* | :heavy_minus_sign: | Trigger asynchronous refresh of analysis. | true |
|
|
| `asyncRefreshLocalMediaAgent` | *boolean* | :heavy_minus_sign: | Trigger asynchronous refresh of the local media agent. | true | |