# MediaContainerWithPlaylistMetadataMetadata

Items in a library are referred to as "metadata items." These metadata items are distinct from "media items" which represent actual instances of media that can be consumed. Consider a TV library that has a single video file in it for a particular episode of a show. The library has a single media item, but it has three metadata items: one for the show, one for the season, and one for the episode. Consider a movie library that has two video files in it: the same movie, but two different resolutions. The library has a single metadata item for the movie, but that metadata item has two media items, one for each resolution. Additionally a "media item" will have one or more "media parts" where the the parts are intended to be watched together, such as a CD1 and CD2 parts of the same movie.

Note that when a metadata item has multiple media items, those media items should be isomorphic. That is, a 4K version and 1080p version of a movie are different versions of the same movie. They have the same duration, same summary, same rating, etc. and they can generally be considered interchangeable. A theatrical release vs. director's cut vs. unrated version on the other hand would be separate metadata items.

Metadata items can often live in a hierarchy with relationships between them.  For example, the metadata item for an episodes is associated with a season metadata item which is associated with a show metadata item.  A similar hierarchy exists with track, album, and artist and photos and photo album.  The relationships may be expressed via relative terms and absolute terms.  For example, "leaves" refer to metadata items which has associated media (there is no media for a season nor show).  A show will have "children" in the form of seasons and a season will have "children" in the form of episodes and episodes have "parent" in the form of a season which has a "parent" in the form of a show.  Similarly, a show has "grandchildren" in the form of episodse and an episode has a "grandparent" in the form of a show.



## Fields

| Field                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Required                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `readOnly`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | *Optional\<Boolean>*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | If we return this as true then this playlist cannot be altered or deleted directly by the client.                                                                                                                                                                                                                                                                                                                                                                                                       |
| `composite`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | *Optional\<Object>*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | When present, the URL for a composite image for descendent items (e.g. photo albums or playlists).                                                                                                                                                                                                                                                                                                                                                                                                      |
| `duration`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | *Optional\<Long>*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | When present, the duration for the item, in units of milliseconds.                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `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.                                                                                                                                                                                                                                                                                       |
| `leafCount`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | *Optional\<Long>*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | For shows and seasons, contains the number of total episodes.                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `playlistType`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [Optional\<PlaylistType>](../../models/shared/PlaylistType.md)                                                                                                                                                                                                                                                                                                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | The type of the playlist.                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `smart`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | *Optional\<Boolean>*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Whether or not the playlist is smart.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `specialPlaylistType`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | *Optional\<String>*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | If this is a special playlist, this returns its type (e.g. favorites).                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `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).                                                                                                                                                                                                                                                                                      |
| `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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `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.                                                                                                                                                                                                                                                                                                                                                                             |
| `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.                                                                                                                                                                                                                                                                                                                                                                               |
| `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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |