GetMediaMetaDataMetadata

Example Usage

import { GetMediaMetaDataMetadata } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";

let value: GetMediaMetaDataMetadata = {
  ratingKey: "44288",
  parentRatingKey: "48047",
  grandparentRatingKey: "45520",
  parentGuid: "plex://season/618b89208dde18df707ad15c",
  grandparentGuid: "plex://show/5e16253691c20300412003a8",
  grandparentSlug: "alice-in-borderland-2020",
  grandparentKey: "/library/metadata/45520",
  parentKey: "/library/metadata/48047",
  key: "/library/metadata/44288/children",
  guid: "plex://show/5d9c08254eefaa001f5d6dcb",
  slug: "better-call-saul",
  studio: "Sony Pictures Television",
  type: "show",
  title: "Better Call Saul",
  originalTitle: "Wicked: Part I",
  librarySectionTitle: "TV Series ",
  librarySectionID: 2,
  librarySectionKey: "/library/sections/2",
  contentRating: "TV-MA",
  summary:
    "Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to \"Breaking Bad\" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.",
  index: 1,
  grandparentTitle: "Alice in Borderland",
  parentTitle: "Season 2",
  audienceRating: 8.7,
  viewCount: 4,
  skipCount: 1,
  lastViewedAt: 1625764795,
  year: 2015,
  rating: 6,
  ratingImage: "rottentomatoes://image.rating.ripe",
  tagline: "Make the call",
  chapterSource: "media",
  primaryExtraKey: "/library/metadata/134704",
  thumb: "/library/metadata/44288/thumb/1736487993",
  art: "/library/metadata/44288/art/1736487993",
  theme: "/library/metadata/44288/theme/1736487993",
  duration: 2700000,
  originallyAvailableAt: new RFCDate("2015-02-08"),
  leafCount: 63,
  viewedLeafCount: 4,
  childCount: 6,
  addedAt: 1556281940,
  updatedAt: 1556281940,
  audienceRatingImage: "themoviedb://image.rating",
  parentIndex: 2,
  parentThumb: "/library/metadata/48047/thumb/1671800243",
  grandparentThumb: "/library/metadata/45520/thumb/1736488003",
  grandparentArt: "/library/metadata/45520/art/1736488003",
  media: [
    {
      id: 387322,
      duration: 9610350,
      bitrate: 25512,
      width: 3840,
      height: 1602,
      aspectRatio: 2.35,
      audioChannels: 6,
      displayOffset: 50,
      audioCodec: "eac3",
      videoCodec: "hevc",
      videoResolution: "4k",
      container: "mkv",
      videoFrameRate: "24p",
      videoProfile: "main 10",
      hasVoiceActivity: false,
      audioProfile: "dts",
      has64bitOffsets: false,
      part: [
        {
          accessible: true,
          exists: true,
          id: 418385,
          key: "/library/parts/418385/1735864239/file.mkv",
          indexes: "sd",
          duration: 9610350,
          file: "/mnt/Movies_1/W/Wicked (2024).mkv",
          size: 30649952104,
          packetLength: 188,
          container: "mkv",
          videoProfile: "main 10",
          audioProfile: "dts",
          has64bitOffsets: false,
          stream: [
            {
              id: 1002625,
              streamType: 1,
              default: true,
              codec: "hevc",
              index: 0,
              bitrate: 24743,
              language: "English",
              languageTag: "en",
              languageCode: "eng",
              headerCompression: true,
              doviblCompatID: 1,
              doviblPresent: true,
              dovielPresent: false,
              doviLevel: 6,
              doviPresent: true,
              doviProfile: 8,
              dovirpuPresent: true,
              doviVersion: "1.0",
              bitDepth: 10,
              chromaLocation: "topleft",
              chromaSubsampling: "4:2:0",
              codedHeight: 1608,
              codedWidth: 3840,
              colorPrimaries: "bt2020",
              colorRange: "tv",
              colorSpace: "bt2020nc",
              colorTrc: "smpte2084",
              frameRate: 23.976,
              height: 1602,
              level: 150,
              original: true,
              hasScalingMatrix: false,
              profile: "main 10",
              scanType: "progressive",
              refFrames: 1,
              width: 3840,
              displayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
              extendedDisplayTitle: "4K DoVi/HDR10 (HEVC Main 10)",
              selected: true,
              forced: true,
              channels: 6,
              audioChannelLayout: "5.1(side)",
              samplingRate: 48000,
              canAutoSync: false,
              hearingImpaired: true,
              dub: true,
              title: "SDH",
            },
          ],
        },
      ],
    },
  ],
  image: [
    {
      alt: "Better Call Saul",
      type: "coverPoster",
      url: "/library/metadata/44288/thumb/1736487993",
    },
  ],
  ultraBlurColors: {
    topLeft: "11333a",
    topRight: "1d2721",
    bottomRight: "5c451d",
    bottomLeft: "372c10",
  },
  genre: [
    {
      id: 1057,
      filter: "genre=1057",
      tag: "Crime",
    },
  ],
  country: [
    {
      id: 58591,
      filter: "country=58591",
      tag: "United States of America",
    },
  ],
  guids: [
    {
      id: "imdb://tt3032476",
    },
  ],
  ratings: [
    {
      image: "imdb://image.rating",
      value: 9,
      type: "audience",
    },
  ],
  role: [
    {
      id: 109501,
      filter: "actor=109501",
      tag: "Bob Odenkirk",
      tagKey: "5d77683254f42c001f8c3f69",
      role: "Jimmy McGill",
      thumb:
        "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
    },
  ],
  director: [
    {
      id: 109501,
      filter: "actor=109501",
      tag: "Bob Odenkirk",
      tagKey: "5d77683254f42c001f8c3f69",
      role: "Jimmy McGill",
      thumb:
        "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
    },
  ],
  writer: [
    {
      id: 109501,
      filter: "actor=109501",
      tag: "Bob Odenkirk",
      tagKey: "5d77683254f42c001f8c3f69",
      role: "Jimmy McGill",
      thumb:
        "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
    },
  ],
  producer: [
    {
      id: 109501,
      filter: "actor=109501",
      tag: "Bob Odenkirk",
      tagKey: "5d77683254f42c001f8c3f69",
      role: "Jimmy McGill",
      thumb:
        "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
    },
  ],
  similar: [
    {
      id: 26,
      filter: "similar=26",
      tag: "Breaking Bad",
    },
  ],
  location: [
    {
      path: "/TV Shows/Better Call Saul",
    },
  ],
};

Fields

Field	Type	Required	Description	Example
`ratingKey`	string	✔️	The rating key of the metadata item.	44288
`parentRatingKey`	string	➖	The rating key of the parent of this metadata item.	48047
`grandparentRatingKey`	string	➖	The rating key of the grandparent of this metadata item.	45520
`parentGuid`	string	➖	A GUID identifying the parent entity (e.g., season) for the item.	plex://season/618b89208dde18df707ad15c
`grandparentGuid`	string	➖	A GUID identifying the grandparent entity (e.g., show).	plex://show/5e16253691c20300412003a8
`grandparentSlug`	string	➖	A URL-friendly identifier (slug) for the grandparent entity.	alice-in-borderland-2020
`grandparentKey`	string	➖	A key identifying the grandparent metadata in the library.	/library/metadata/45520
`parentKey`	string	➖	A key identifying the parent metadata in the library.	/library/metadata/48047
`key`	string	✔️	The API key to access metadata details.	/library/metadata/44288/children
`guid`	string	✔️	The globally unique identifier for the item.	plex://show/5d9c08254eefaa001f5d6dcb
`slug`	string	➖	A URL-friendly identifier for the item.	better-call-saul
`studio`	string	➖	The studio that produced the content.	Sony Pictures Television
`type`	string	✔️	The type of content (e.g., show, movie).	show
`title`	string	✔️	The title of the content.	Better Call Saul
`originalTitle`	string	➖	The original title of the content.	Wicked: Part I
`librarySectionTitle`	string	✔️	The title of the library section.	TV Series
`librarySectionID`	number	✔️	The ID of the library section.	2
`librarySectionKey`	string	✔️	The key of the library section.	/library/sections/2
`contentRating`	string	➖	The content rating (e.g., TV-MA).	TV-MA
`summary`	string	✔️	A summary of the content.	Before Saul Goodman, he was Jimmy McGill. And if you're calling Jimmy, you're in real trouble. The prequel to "Breaking Bad" follows small-time attorney, Jimmy McGill, as he transforms into Walter White's morally challenged lawyer, Saul Goodman.
`index`	number	➖	The index or order of the item.	1
`grandparentTitle`	string	➖	The title of the grandparent entity (typically the show's title).	Alice in Borderland
`parentTitle`	string	➖	The title of the parent entity (typically the season's title).	Season 2
`audienceRating`	number	➖	The audience rating for the content.	8.7
`viewCount`	number	➖	The number of times the item has been viewed.	4
`skipCount`	number	➖	The number of times the item has been skipped.	1
`lastViewedAt`	number	➖	Unix timestamp of when the item was last viewed.	1625764795
`year`	number	✔️	The release year.	2015
`rating`	number	➖	The general rating	6
`ratingImage`	string	➖	The URL or identifier for the rating image (e.g., Rotten Tomatoes rating image).	rottentomatoes://image.rating.ripe
`tagline`	string	➖	The tagline of the content.	Make the call
`chapterSource`	string	➖	N/A	media
`primaryExtraKey`	string	➖	N/A	/library/metadata/134704
`thumb`	string	✔️	URL of the thumbnail image.	/library/metadata/44288/thumb/1736487993
`art`	string	✔️	URL of the art image.	/library/metadata/44288/art/1736487993
`theme`	string	➖	URL of the theme image.	/library/metadata/44288/theme/1736487993
`duration`	number	✔️	Duration of the content in milliseconds.	2700000
`originallyAvailableAt`	RFCDate	➖	The original release date.	2015-02-08
`leafCount`	number	➖	The total number of episodes (or leaves).	63
`viewedLeafCount`	number	➖	The number of episodes that have been viewed.	4
`childCount`	number	➖	The number of child items.	6
`addedAt`	number	✔️	N/A	1556281940
`updatedAt`	number	✔️	N/A	1556281940
`audienceRatingImage`	string	➖	The URL for the audience rating image.	themoviedb://image.rating
`parentIndex`	number	➖	The index number of the parent entity, which could indicate its order or position.	2
`parentThumb`	string	➖	The URL of the parent's thumbnail image.	/library/metadata/48047/thumb/1671800243
`grandparentThumb`	string	➖	The URL of the grandparent's thumbnail image.	/library/metadata/45520/thumb/1736488003
`grandparentArt`	string	➖	The URL of the grandparent's art image.	/library/metadata/45520/art/1736488003
`media`	operations.GetMediaMetaDataMedia[]	➖	N/A
`image`	operations.GetMediaMetaDataImage[]	✔️	An array of image objects.
`ultraBlurColors`	operations.GetMediaMetaDataUltraBlurColors	✔️	N/A
`genre`	operations.GetMediaMetaDataGenre[]	➖	An array of genre tags.
`country`	operations.GetMediaMetaDataCountry[]	➖	An array of country tags.
`guids`	operations.GetMediaMetaDataGuids[]	➖	An array of GUID objects.
`ratings`	operations.Ratings[]	➖	An array of rating objects.
`role`	operations.GetMediaMetaDataRole[]	➖	An array of Actor roles.
`director`	operations.GetMediaMetaDataDirector[]	➖	An array of Director roles.
`writer`	operations.GetMediaMetaDataWriter[]	➖	An array of Writer roles.
`producer`	operations.Producer[]	➖	An array of Writer roles.
`similar`	operations.Similar[]	➖	An array of similar content objects.
`location`	operations.GetMediaMetaDataLocation[]	➖	An array of location objects.

83 KiB Raw Blame History Unescape Escape

GetMediaMetaDataMetadata

Example Usage

Fields

83 KiB

Raw Blame History