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

## Java SDK Changes Detected:

Browse Source 
* `plex-api.libraryPlaylists.addPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.clearPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.moveCollectionItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.deleteCollectionItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryCollections.addCollectionItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicallySimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.butler.stopTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.butler.startTask()`:  `request` **Changed** **Breaking** ⚠️
* `plex-api.content.getSonicPath()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.downloadQueue.getItemDecision()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getAllHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getContinueWatching()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPromotedHubs()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getMetadataHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getPostplayHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getRelatedHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.hubs.getSectionHubs()`: 
  *  `request.onlyTransient` **Changed**
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getAllLeaves()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.listContent()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.search.searchHubs()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getAlbums()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryItems()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.ingestTransientItem()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryMatches()`: 
  *  `request` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.content.getMetadataItem()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getSections()`:  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.addSection()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getTags()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
* `plex-api.content.getCollectionItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getAllItemLeaves()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.status.listSessions()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.movePlayQueueItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getExtras()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.deletePlayQueueItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.unshuffle()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listMatches()`: 
  *  `request.manual` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listSonicallySimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.shuffle()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getRelatedItems()`:  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listSimilar()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.resetPlayQueue()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getItemTree()`:  `response.mediacontainer.metadataItem.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.clearPlayQueue()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.addToPlayQueue()`: 
  *  `request.next` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getCommon()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getPerson()`:  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.listPersonMedia()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playQueue.getPlayQueue()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getLibraryDetails()`: 
  *  `request.includeDetails` **Changed**
  *  `response.mediacontainer.directory.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.movePlaylistItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.autocomplete()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.library.getCollections()`: 
  *  `request.mediaQuery` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.getPlaylistGeneratorItems()`:  `response.mediacontainer.metadata` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.deletePlaylistItem()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.search.voiceSearchHubs()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.hub.[].metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.libraryPlaylists.createPlaylist()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylistItems()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.getPlaylist()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.playlist.listPlaylists()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.collections.createCollection()`: 
  *  `request.type` **Changed** **Breaking** ⚠️
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.dvRs.tuneChannel()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getSessions()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.liveTv.getLiveTvSession()`:  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.transcoder.makeDecision()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.metadata.[]` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getAllSubscriptions()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.createSubscription()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getScheduledRecordings()`:  `response.mediacontainer.mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getTemplate()`:  `response.mediacontainer.subscriptionTemplate.[].mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.getSubscription()`: 
  *  `request` **Changed**
  *  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.editSubscriptionPreferences()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.subscriptions.reorderSubscription()`:  `response.mediacontainer.mediaSubscription.[].mediaGrabOperation.[].metadata` **Changed** **Breaking** ⚠️
* `plex-api.library.addSubtitles()`:  `request` **Changed**
* `plex-api.libraryPlaylists.uploadPlaylist()`: 
  *  `request.force` **Changed**
* `plex-api.transcoder.transcodeSubtitles()`:  `request` **Changed**
* `plex-api.transcoder.startTranscodeSession()`:  `request` **Changed**
* `plex-api.library.getMediaPart()`: 
  *  `request.download` **Changed**
* `plex-api.library.detectIntros()`: 
  *  `request.force` **Changed**
* `plex-api.library.getSectionImage()`: 
  *  `request.mediaQuery` **Changed**
* `plex-api.library.deleteMediaItem()`: 
  *  `request.proxy` **Changed**
* `plex-api.library.refreshItemsMetadata()`: 
  *  `request.markUpdated` **Changed**
* `plex-api.authentication.postUsersSignInData()`: **Added**
* `plex-api.authentication.getTokenDetails()`: **Added**
* `plex-api.library.detectCredits()`:  `request` **Changed**
* `plex-api.library.setStreamSelection()`: 
  *  `request.allParts` **Changed**
* `plex-api.library.updateItems()`: 
  *  `request.field.locked` **Changed**
* `plex-api.playQueue.createPlayQueue()`:  `request` **Changed**
* `plex-api.library.deleteLibrarySection()`: 
  *  `request.async` **Changed**
* `plex-api.library.getAugmentationStatus()`: 
  *  `request.wait` **Changed**
* `plex-api.transcoder.transcodeImage()`:  `request` **Changed**
* `plex-api.devices.modifyDevice()`: 
  *  `request.enabled` **Changed**
* `plex-api.library.detectVoiceActivity()`:  `request` **Changed**
* `plex-api.library.getStream()`: 
  *  `request.autoAdjustSubtitle` **Changed**
* `plex-api.library.startBifGeneration()`: 
  *  `request.force` **Changed**
* `plex-api.library.getFirstCharacters()`: 
  *  `request.mediaQuery` **Changed**
* `plex-api.ultraBlur.getImage()`: 
  *  `request.noise` **Changed**
* `plex-api.library.generateThumbs()`: 
  *  `request.force` **Changed**
* `plex-api.updater.applyUpdates()`:  `request` **Changed**
* `plex-api.updater.checkUpdates()`: 
  *  `request.download` **Changed**
* `plex-api.library.deleteMetadataItem()`: 
  *  `request.proxy` **Changed**
* `plex-api.library.optimizeDatabase()`: 
  *  `request.async` **Changed**
* `plex-api.library.refreshSection()`: 
  *  `request.force` **Changed**
* `plex-api.hubs.updateHubVisibility()`:  `request` **Changed**
* `plex-api.hubs.createCustomHub()`:  `request` **Changed**
* `plex-api.downloadQueue.addDownloadQueueItems()`:  `request` **Changed**
* `plex-api.timeline.report()`:  `request` **Changed**
* `plex-api.general.getSourceConnectionInformation()`: 
  *  `request.refresh` **Changed**
* `plex-api.plex.getServerResources()`: **Added**
* `plex-api.users.getUsers()`: **Added**
This commit is contained in:
speakeasybot
2025-12-01 00:42:04 +00:00
parent 66d8250cb0
commit 1e29008284
344 changed files with 42375 additions and 6863 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
docs/models/operations/Metadata.md
View File

@@ -10,76 +10,80 @@ Metadata items can often live in a hierarchy with relationships between them. F
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `player` | [Optional\<Player>](../../models/shared/Player.md) | :heavy_minus_sign: | Information about the player being used for playback |
| `session` | [Optional\<Session>](../../models/shared/Session.md) | :heavy_minus_sign: | Information about the playback session |
| `user` | [Optional\<User>](../../models/shared/User.md) | :heavy_minus_sign: | The user playing the content |
| `title` | *Optional\<Object>* | :heavy_minus_sign: | The title of the item (e.g. “300” or “The Simpsons”) |
| `type` | *Optional\<Object>* | :heavy_minus_sign: | The type of the video item, such as `movie`, `episode`, or `clip`. |
| `absoluteIndex` | *Optional\<Long>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. |
| `addedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was added to the library. |
| `art` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. |
| `audienceRating` | *Optional\<Double>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings |
| `audienceRatingImage` | *Optional\<Object>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). |
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `banner` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. |
| `chapterSource` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). |
| `composite` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). |
| `contentRating` | *Optional\<Object>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. |
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `duration` | *Optional\<Long>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. |
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent |
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent |
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent |
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent |
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent |
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent |
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent |
| `guid` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `hero` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. |
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A |
| `index` | *Optional\<Long>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. |
| `key` | *Optional\<Object>* | :heavy_minus_sign: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. |
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | When a user has watched or listened to an item, this contains a timestamp (epoch seconds) for that last consumption time. |
| `leafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. |
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A |
| `originallyAvailableAt` | *Optional\<Object>* | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. |
| `originalTitle` | *Optional\<Object>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. |
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent |
| `parentIndex` | *Optional\<Long>* | :heavy_minus_sign: | The `index` of the parent |
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent |
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent |
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent |
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent |
| `primaryExtraKey` | *Optional\<Object>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. |
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) |
| `rating` | *Optional\<Double>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. |
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `ratingCount` | *Optional\<Long>* | :heavy_minus_sign: | Number of ratings under this metadata |
| `ratingImage` | *Optional\<Object>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. |
| `ratingKey` | *Optional\<Object>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. |
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory |
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. |
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. |
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). |
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level |
| `studio` | *Optional\<Object>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). |
| `subtype` | *Optional\<Object>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library |
| `summary` | *Optional\<Object>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). |
| `tagline` | *Optional\<Object>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). |
| `theme` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). |
| `thumb` | *Optional\<Object>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. |
| `titleSort` | *Optional\<Object>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). |
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). |
| `userRating` | *Optional\<Double>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating |
| `viewCount` | *Optional\<Long>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. |
| `viewedLeafCount` | *Optional\<Long>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. |
| `viewOffset` | *Optional\<Long>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. |
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A |
| `year` | *Optional\<Long>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). |
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `player` | [Optional\<Player>](../../models/shared/Player.md) | :heavy_minus_sign: | Information about the player being used for playback | |
| `session` | [Optional\<Session>](../../models/shared/Session.md) | :heavy_minus_sign: | Information about the playback session | |
| `user` | [Optional\<User>](../../models/shared/User.md) | :heavy_minus_sign: | The user playing the content | |
| `title` | *String* | :heavy_check_mark: | The title of the item (e.g. “300” or “The Simpsons”) | |
| `type` | *String* | :heavy_check_mark: | The type of the video item, such as `movie`, `episode`, or `clip`. | |
| `absoluteIndex` | *Optional\<Integer>* | :heavy_minus_sign: | When present, contains the disc number for a track on multi-disc albums. | |
| `addedAt` | *long* | :heavy_check_mark: | In units of seconds since the epoch, returns the time at which the item was added to the library. | |
| `art` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the background artwork for the item. | /library/metadata/58683/art/1703239236 |
| `audienceRating` | *Optional\<Float>* | :heavy_minus_sign: | Some rating systems separate reviewer ratings from audience ratings | |
| `audienceRatingImage` | *Optional\<String>* | :heavy_minus_sign: | A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled). | |
| `autotag` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
| `banner` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a banner graphic for the item. | |
| `chapterSource` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two). | media |
| `childCount` | *Optional\<Integer>* | :heavy_minus_sign: | The number of child items associated with this media item. | 1 |
| `composite` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists). | |
| `contentRating` | *Optional\<String>* | :heavy_minus_sign: | If known, the content rating (e.g. MPAA) for an item. | |
| `country` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
| `director` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
| `duration` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the duration for the item, in units of milliseconds. | |
| `filter` | List\<[Filter](../../models/shared/Filter.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
| `genre` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
| `grandparentArt` | *Optional\<String>* | :heavy_minus_sign: | The `art` of the grandparent | |
| `grandparentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `grandparentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the grandparent | |
| `grandparentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the grandparent | |
| `grandparentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the grandparent | |
| `grandparentTheme` | *Optional\<String>* | :heavy_minus_sign: | The `theme` of the grandparent | |
| `grandparentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the grandparent | |
| `grandparentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the grandparent | |
| `guid` | *Optional\<String>* | :heavy_minus_sign: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
| `guids` | List\<[Guids](../../models/operations/Guids.md)> | :heavy_minus_sign: | N/A | |
| `hero` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for a hero image for the item. | |
| `image` | List\<[Image](../../models/shared/Image.md)> | :heavy_minus_sign: | N/A | |
| `index` | *Optional\<Integer>* | :heavy_minus_sign: | When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks. | |
| `key` | *String* | :heavy_check_mark: | The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details. | |
| `lastViewedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 1556281940 |
| `leafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of total episodes. | |
| `media` | List\<[Media](../../models/shared/Media.md)> | :heavy_minus_sign: | N/A | |
| `originallyAvailableAt` | [LocalDate](https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html) | :heavy_minus_sign: | When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well. | 2022-12-14 |
| `originalTitle` | *Optional\<String>* | :heavy_minus_sign: | When present, used to indicate an item's original title, e.g. a movie's foreign title. | |
| `parentGuid` | *Optional\<String>* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
| `parentHero` | *Optional\<String>* | :heavy_minus_sign: | The `hero` of the parent | |
| `parentIndex` | *Optional\<Integer>* | :heavy_minus_sign: | The `index` of the parent | |
| `parentKey` | *Optional\<String>* | :heavy_minus_sign: | The `key` of the parent | |
| `parentRatingKey` | *Optional\<String>* | :heavy_minus_sign: | The `ratingKey` of the parent | |
| `parentThumb` | *Optional\<String>* | :heavy_minus_sign: | The `thumb` of the parent | |
| `parentTitle` | *Optional\<String>* | :heavy_minus_sign: | The `title` of the parent | |
| `primaryExtraKey` | *Optional\<String>* | :heavy_minus_sign: | Indicates that the item has a primary extra; for a movie, this is a trailer, and for a music track it is a music video. The URL points to the metadata details endpoint for the item. | |
| `prompt` | *Optional\<String>* | :heavy_minus_sign: | Prompt to give the user for this directory (such as `Search Movies`) | |
| `rating` | *Optional\<Float>* | :heavy_minus_sign: | When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from. | |
| `ratingArray` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
| `ratingCount` | *Optional\<Integer>* | :heavy_minus_sign: | Number of ratings under this metadata | |
| `ratingImage` | *Optional\<String>* | :heavy_minus_sign: | When present, indicates an image to be shown with the rating. This is passed back as a small set of defined URI values, e.g. rottentomatoes://image.rating.rotten. | |
| `ratingKey` | *Optional\<String>* | :heavy_minus_sign: | This is the opaque string to be passed into timeline, scrobble, and rating endpoints to identify them. While it often appears to be numeric, this is not guaranteed. | |
| `role` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
| `search` | *Optional\<Boolean>* | :heavy_minus_sign: | Indicates this is a search directory | |
| `secondary` | *Optional\<Boolean>* | :heavy_minus_sign: | Used by old clients to provide nested menus allowing for primative (but structured) navigation. | |
| `skipChildren` | *Optional\<Boolean>* | :heavy_minus_sign: | When found on a show item, indicates that the children (seasons) should be skipped in favor of the grandchildren (episodes). Useful for mini-series, etc. | |
| `skipParent` | *Optional\<Boolean>* | :heavy_minus_sign: | When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show). | |
| `sort` | List\<[Sort](../../models/shared/Sort.md)> | :heavy_minus_sign: | Typically only seen in metadata at a library's top level | |
| `studio` | *Optional\<String>* | :heavy_minus_sign: | When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums). | |
| `subtype` | *Optional\<String>* | :heavy_minus_sign: | The subtype of the video item, such as `photo` when the video item is in a photo library | |
| `summary` | *Optional\<String>* | :heavy_minus_sign: | When present, the extended textual information about the item (e.g. movie plot, artist biography, album review). | |
| `tagline` | *Optional\<String>* | :heavy_minus_sign: | When present, a pithy one-liner about the item (usually only seen for movies). | |
| `theme` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for theme music for the item (usually only for TV shows). | /library/metadata/1/theme/1705636920 |
| `thumb` | *Optional\<String>* | :heavy_minus_sign: | When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail. | /library/metadata/58683/thumb/1703239236 |
| `titleSort` | *Optional\<String>* | :heavy_minus_sign: | Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”). | |
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated). | |
| `userRating` | *Optional\<Float>* | :heavy_minus_sign: | When the user has rated an item, this contains the user rating | |
| `viewCount` | *Optional\<Integer>* | :heavy_minus_sign: | When a users has completed watched or listened to an item, this attribute contains the number of consumptions. | |
| `viewedLeafCount` | *Optional\<Integer>* | :heavy_minus_sign: | For shows and seasons, contains the number of viewed episodes. | |
| `viewOffset` | *Optional\<Integer>* | :heavy_minus_sign: | When a user is in the process of viewing or listening to this item, this attribute contains the current offset, in units of milliseconds. | |
| `writer` | List\<[Tag](../../models/shared/Tag.md)> | :heavy_minus_sign: | N/A | |
| `year` | *Optional\<Integer>* | :heavy_minus_sign: | When present, the year associated with the item's release (e.g. release year for a movie). | |
| `additionalProperties` | Map\<String, *Object*> | :heavy_minus_sign: | N/A | |