plexjs/docs/sdk/models/operations/getmediametadatarequest.md

GetMediaMetaDataRequest

Example Usage

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	✔️	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	➖	Include concerts data if set to true.	true
includeExtras	boolean	➖	Include extra content (e.g. bonus features).	true
includeOnDeck	boolean	➖	Include on-deck items.	true
includePopularLeaves	boolean	➖	Include popular leaves (episodes/chapters).	true
includePreferences	boolean	➖	Include preferences information.	true
includeReviews	boolean	➖	Include reviews for the content.	true
includeChapters	boolean	➖	Include chapter details.	true
includeStations	boolean	➖	Include station data.	true
includeExternalMedia	boolean	➖	Include external media data.	true
asyncAugmentMetadata	boolean	➖	Trigger asynchronous metadata augmentation.	true
asyncCheckFiles	boolean	➖	Trigger asynchronous file checking.	true
asyncRefreshAnalysis	boolean	➖	Trigger asynchronous refresh of analysis.	true
asyncRefreshLocalMediaAgent	boolean	➖	Trigger asynchronous refresh of the local media agent.	true