plexjs/docs/sdk/models/shared/metadata.md

Metadata

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.

Example Usage

import { Metadata } from "@lukehagar/plexjs/sdk/models/shared";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";

let value: Metadata = {
  title: "<value>",
  type: "<value>",
  addedAt: 29550,
  art: "/library/metadata/58683/art/1703239236",
  autotag: [
    {
      filter: "actor=49",
      ratingKey: "58683",
      role: "Secretary",
      tag: "Shaun Lawton",
      tagKey: "5d3ee12c4cde6a001c3e0b27",
      thumb:
        "http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
    },
  ],
  chapterSource: "media",
  childCount: 1,
  country: [
    {
      filter: "actor=49",
      ratingKey: "58683",
      role: "Secretary",
      tag: "Shaun Lawton",
      tagKey: "5d3ee12c4cde6a001c3e0b27",
      thumb:
        "http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
    },
  ],
  director: [
    {
      filter: "actor=49",
      ratingKey: "58683",
      role: "Secretary",
      tag: "Shaun Lawton",
      tagKey: "5d3ee12c4cde6a001c3e0b27",
      thumb:
        "http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
    },
  ],
  genre: [
    {
      filter: "actor=49",
      ratingKey: "58683",
      role: "Secretary",
      tag: "Shaun Lawton",
      tagKey: "5d3ee12c4cde6a001c3e0b27",
      thumb:
        "http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
    },
  ],
  grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
  guid: "plex://movie/5d7768ba96b655001fdc0408",
  guids: [
    {
      id:
        "{\"imdbExample\":{\"summary\":\"IMDB example\",\"value\":\"imdb://tt13015952\"},\"tmdbExample\":{\"summary\":\"TMDB example\",\"value\":\"tmdb://2434012\"},\"tvdbExample\":{\"summary\":\"TVDB example\",\"value\":\"tvdb://7945991\"}}",
    },
  ],
  key: "<key>",
  lastViewedAt: 1556281940,
  media: [
    {
      aspectRatio: 2.35,
      audioChannels: 2,
      audioCodec: "aac",
      audioProfile: "lc",
      bitrate: 5612,
      container: "mov",
      duration: 150192,
      has64bitOffsets: false,
      hasVoiceActivity: true,
      height: 544,
      id: 1,
      optimizedForStreaming: false,
      part: [
        {
          accessible: true,
          audioProfile: "lc",
          container: "mov",
          duration: 150192,
          exists: true,
          file: "/home/schuyler/Videos/Trailers/Cloud Atlas (2012).mov",
          has64bitOffsets: false,
          id: 1,
          indexes: "sd",
          key: "/library/parts/1/1531779263/file.mov",
          optimizedForStreaming: false,
          size: 105355654,
          stream: [
            {
              default: true,
              audioChannelLayout: "5.1(side)",
              channels: 6,
              bitDepth: 10,
              doviblCompatID: 1,
              doviblPresent: true,
              dovielPresent: false,
              doviLevel: 6,
              doviPresent: true,
              doviProfile: 8,
              dovirpuPresent: true,
              doviVersion: "1.0",
              bitrate: 24743,
              canAutoSync: false,
              chromaLocation: "topleft",
              chromaSubsampling: "4:2:0",
              codedHeight: 1608,
              codedWidth: 3840,
              closedCaptions: true,
              codec: "hevc",
              colorPrimaries: "bt2020",
              colorRange: "tv",
              colorSpace: "bt2020nc",
              colorTrc: "smpte2084",
              displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
              extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
              frameRate: 23.976,
              hasScalingMatrix: false,
              height: 1602,
              id: 1002625,
              index: 0,
              key: "/library/streams/216389",
              language: "English",
              languageCode: "eng",
              languageTag: "en",
              format: "srt",
              headerCompression: true,
              level: 150,
              original: true,
              profile: "main 10",
              refFrames: 1,
              samplingRate: 48000,
              scanType: "progressive",
              embeddedInVideo: "progressive",
              selected: true,
              forced: true,
              hearingImpaired: true,
              dub: true,
              title: "SDH",
              streamIdentifier: 1,
              width: 3840,
            },
          ],
          videoProfile: "main",
        },
      ],
      videoCodec: "h264",
      videoFrameRate: "24p",
      videoProfile: "main",
      videoResolution: "720",
      width: 1280,
    },
  ],
  originallyAvailableAt: new RFCDate("2022-12-14"),
  parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
  ratingArray: [
    {
      filter: "actor=49",
      ratingKey: "58683",
      role: "Secretary",
      tag: "Shaun Lawton",
      tagKey: "5d3ee12c4cde6a001c3e0b27",
      thumb:
        "http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
    },
  ],
  role: [
    {
      filter: "actor=49",
      ratingKey: "58683",
      role: "Secretary",
      tag: "Shaun Lawton",
      tagKey: "5d3ee12c4cde6a001c3e0b27",
      thumb:
        "http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
    },
  ],
  theme: "/library/metadata/1/theme/1705636920",
  thumb: "/library/metadata/58683/thumb/1703239236",
  writer: [
    {
      filter: "actor=49",
      ratingKey: "58683",
      role: "Secretary",
      tag: "Shaun Lawton",
      tagKey: "5d3ee12c4cde6a001c3e0b27",
      thumb:
        "http://image.tmdb.org/t/p/original/lcJ8qM51ClAR2UzXU1mkZGfnn3o.jpg",
    },
  ],
};

Fields

Field	Type	Required	Description	Example
title	string	✔️	The title of the item (e.g. “300” or “The Simpsons”)
type	string	✔️	The type of the video item, such as movie, episode, or clip.
absoluteIndex	number	➖	When present, contains the disc number for a track on multi-disc albums.
addedAt	number	✔️	In units of seconds since the epoch, returns the time at which the item was added to the library.
art	string	➖	When present, the URL for the background artwork for the item.	/library/metadata/58683/art/1703239236
audienceRating	number	➖	Some rating systems separate reviewer ratings from audience ratings
audienceRatingImage	string	➖	A URI representing the image to be shown with the audience rating (e.g. rottentomatoes://image.rating.spilled).
autotag	shared.Tag[]	➖	N/A
banner	string	➖	When present, the URL for a banner graphic for the item.
chapterSource	string	➖	When present, indicates the source for the chapters in the media file. Can be media (the chapters were embedded in the media itself), agent (a metadata agent computed them), or mixed (a combination of the two).	media
childCount	number	➖	The number of child items associated with this media item.	1
composite	string	➖	When present, the URL for a composite image for descendent items (e.g. photo albums or playlists).
contentRating	string	➖	If known, the content rating (e.g. MPAA) for an item.
country	shared.Tag[]	➖	N/A
director	shared.Tag[]	➖	N/A
duration	number	➖	When present, the duration for the item, in units of milliseconds.
filter	shared.Filter[]	➖	Typically only seen in metadata at a library's top level
genre	shared.Tag[]	➖	N/A
grandparentArt	string	➖	The art of the grandparent
grandparentGuid	string	➖	The GUID of the grandparent media item.	plex://show/5d9c081b170e24001f2a7be4
grandparentHero	string	➖	The hero of the grandparent
grandparentKey	string	➖	The key of the grandparent
grandparentRatingKey	string	➖	The ratingKey of the grandparent
grandparentTheme	string	➖	The theme of the grandparent
grandparentThumb	string	➖	The thumb of the grandparent
grandparentTitle	string	➖	The title of the grandparent
guid	string	➖	The globally unique identifier for the media item.	plex://movie/5d7768ba96b655001fdc0408
guids	shared.MetadataGuid[]	➖	N/A
hero	string	➖	When present, the URL for a hero image for the item.
image	shared.Image[]	➖	N/A
index	number	➖	When present, this represents the episode number for episodes, season number for seasons, or track number for audio tracks.
key	string	✔️	The key at which the item's details can be fetched. In many cases a metadata item may be passed without all the details (such as in a hub) and this key corresponds to the endpoint to fetch additional details.
lastViewedAt	number	➖	N/A	1556281940
leafCount	number	➖	For shows and seasons, contains the number of total episodes.
media	shared.Media[]	➖	N/A
originallyAvailableAt	RFCDate	➖	When present, in the format YYYY-MM-DD [HH:MM:SS] (the hours/minutes/seconds part is not always present). The air date, or a higher resolution release date for an item, depending on type. For example, episodes usually have air date like 1979-08-10 (we don't use epoch seconds because media existed prior to 1970). In some cases, recorded over-the-air content has higher resolution air date which includes a time component. Albums and movies may have day-resolution release dates as well.	2022-12-14
originalTitle	string	➖	When present, used to indicate an item's original title, e.g. a movie's foreign title.
parentGuid	string	➖	The GUID of the parent media item.	plex://show/5d9c081b170e24001f2a7be4
parentHero	string	➖	The hero of the parent
parentIndex	number	➖	The index of the parent
parentKey	string	➖	The key of the parent
parentRatingKey	string	➖	The ratingKey of the parent
parentThumb	string	➖	The thumb of the parent
parentTitle	string	➖	The title of the parent
primaryExtraKey	string	➖	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	string	➖	Prompt to give the user for this directory (such as Search Movies)
rating	number	➖	When present, the rating for the item. The exact meaning and representation depends on where the rating was sourced from.
ratingArray	shared.Tag[]	➖	N/A
ratingCount	number	➖	Number of ratings under this metadata
ratingImage	string	➖	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	string	➖	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	shared.Tag[]	➖	N/A
search	boolean	➖	Indicates this is a search directory
secondary	boolean	➖	Used by old clients to provide nested menus allowing for primative (but structured) navigation.
skipChildren	boolean	➖	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	boolean	➖	When present on an episode or track item, indicates parent should be skipped in favor of grandparent (show).
sort	shared.Sort[]	➖	Typically only seen in metadata at a library's top level
studio	string	➖	When present, the studio or label which produced an item (e.g. movie studio for movies, record label for albums).
subtype	string	➖	The subtype of the video item, such as photo when the video item is in a photo library
summary	string	➖	When present, the extended textual information about the item (e.g. movie plot, artist biography, album review).
tagline	string	➖	When present, a pithy one-liner about the item (usually only seen for movies).
theme	string	➖	When present, the URL for theme music for the item (usually only for TV shows).	/library/metadata/1/theme/1705636920
thumb	string	➖	When present, the URL for the poster or thumbnail for the item. When available for types like movie, it will be the poster graphic, but fall-back to the extracted media thumbnail.	/library/metadata/58683/thumb/1703239236
titleSort	string	➖	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	number	➖	In units of seconds since the epoch, returns the time at which the item was last changed (e.g. had its metadata updated).
userRating	number	➖	When the user has rated an item, this contains the user rating
viewCount	number	➖	When a users has completed watched or listened to an item, this attribute contains the number of consumptions.
viewedLeafCount	number	➖	For shows and seasons, contains the number of viewed episodes.
viewOffset	number	➖	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	shared.Tag[]	➖	N/A
year	number	➖	When present, the year associated with the item's release (e.g. release year for a movie).
additionalProperties	Record<string, any>	➖	N/A