plexpy/docs/models/components/metadataitem.md

MetadataItem

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
title	Optional[Any]	➖	The title of the item (e.g. “300” or “The Simpsons”)
type	Optional[Any]	➖	The type of the video item, such as movie, episode, or clip.
absolute_index	Optional[int]	➖	When present, contains the disc number for a track on multi-disc albums.
added_at	Optional[int]	➖	In units of seconds since the epoch, returns the time at which the item was added to the library.
art	Optional[Any]	➖	When present, the URL for the background artwork for the item.
audience_rating	Optional[float]	➖	Some rating systems separate reviewer ratings from audience ratings
audience_rating_image	Optional[Any]	➖	A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled).
autotag	List[components.Tag]	➖	N/A
banner	Optional[Any]	➖	When present, the URL for a banner graphic for the item.
chapter_source	Optional[Any]	➖	When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two).
composite	Optional[Any]	➖	When present, the URL for a composite image for descendent items (e.g. photo albums or playlists).
content_rating	Optional[Any]	➖	If known, the content rating (e.g. MPAA) for an item.
country	List[components.Tag]	➖	N/A
director	List[components.Tag]	➖	N/A
duration	Optional[int]	➖	When present, the duration for the item, in units of milliseconds.
filter_	List[components.Filter]	➖	Typically only seen in metadata at a library's top level
genre	List[components.Tag]	➖	N/A
grandparent_art	Optional[str]	➖	The art of the grandparent
grandparent_hero	Optional[str]	➖	The hero of the grandparent
grandparent_key	Optional[str]	➖	The key of the grandparent
grandparent_rating_key	Optional[str]	➖	The ratingKey of the grandparent
grandparent_theme	Optional[str]	➖	The theme of the grandparent
grandparent_thumb	Optional[str]	➖	The thumb of the grandparent
grandparent_title	Optional[str]	➖	The title of the grandparent
guid	List[components.Tag]	➖	N/A
hero	Optional[Any]	➖	When present, the URL for a hero image for the item.
image	List[components.Image]	➖	N/A
index	Optional[int]	➖	When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks.
key	Optional[Any]	➖	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.
last_viewed_at	Optional[int]	➖	When a user has watched or listened to an item, this contains a timestamp (epoch seconds) for that last consumption time.
leaf_count	Optional[int]	➖	For shows and seasons, contains the number of total episodes.
media	List[components.Media]	➖	N/A
originally_available_at	Optional[Any]	➖	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.
original_title	Optional[Any]	➖	When present, used to indicate an item's original title, e.g. a movie's foreign title.
parent_hero	Optional[str]	➖	The hero of the parent
parent_index	Optional[int]	➖	The index of the parent
parent_key	Optional[str]	➖	The key of the parent
parent_rating_key	Optional[str]	➖	The ratingKey of the parent
parent_thumb	Optional[str]	➖	The thumb of the parent
parent_title	Optional[str]	➖	The title of the parent
primary_extra_key	Optional[Any]	➖	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[str]	➖	Prompt to give the user for this directory (such as Search Movies)
rating	Optional[float]	➖	When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from.
rating_array	List[components.Tag]	➖	N/A
rating_count	Optional[int]	➖	Number of ratings under this metadata
rating_image	Optional[Any]	➖	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.
rating_key	Optional[Any]	➖	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[components.Tag]	➖	N/A
search	Optional[bool]	➖	Indicates this is a search directory
secondary	Optional[bool]	➖	Used by old clients to provide nested menus allowing for primative (but structured) navigation.
skip_children	Optional[bool]	➖	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.
skip_parent	Optional[bool]	➖	When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show).
sort	List[components.Sort]	➖	Typically only seen in metadata at a library's top level
studio	Optional[Any]	➖	When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums).
subtype	Optional[Any]	➖	The subtype of the video item, such as photo when the video item is in a photo library
summary	Optional[Any]	➖	When present, the extended textual information about the item (e.g. movie plot, artist biography, album review).
tagline	Optional[Any]	➖	When present, a pithy one-liner about the item (usually only seen for movies).
theme	Optional[Any]	➖	When present, the URL for theme music for the item (usually only for TV shows).
thumb	Optional[Any]	➖	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.
title_sort	Optional[Any]	➖	Whene present, this is the string used for sorting the item. It's usually the title with any leading articles removed (e.g. “Simpsons”).
updated_at	Optional[int]	➖	In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated).
user_rating	Optional[float]	➖	When the user has rated an item, this contains the user rating
view_count	Optional[int]	➖	When a users has completed watched or listened to an item, this attribute contains the number of consumptions.
viewed_leaf_count	Optional[int]	➖	For shows and seasons, contains the number of viewed episodes.
view_offset	Optional[int]	➖	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[components.Tag]	➖	N/A
year	Optional[int]	➖	When present, the year associated with the item's release (e.g. release year for a movie).
metadata_item	List[components.Items]	➖	N/A
__pydantic_extra__	Dict[str, Any]	➖	N/A