LukeParke/plexjs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjs.git synced 2025-12-06 04:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fe48f93ccb4eeabee76d1dbab08be038c9f1df18
plexjs/docs/sdk/models/operations/getmediametadatametadata.md

94 KiB
Raw Blame History

GetMediaMetaDataMetadata

Unknown

Example Usage

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

let value: GetMediaMetaDataMetadata = {
  ratingKey: "58683",
  key: "/library/metadata/58683",
  guid: "plex://movie/5d7768ba96b655001fdc0408",
  slug: "4-for-texas",
  studio: "20th Century Studios",
  type: GetMediaMetaDataType.Movie,
  title: "Avatar: The Way of Water",
  titleSort: "Whale",
  contentRating: "PG-13",
  summary:
    "Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.\n"
    + "Once a familiar threat returns to finish what was previously started, Jake must\n"
    + "work with Neytiri and the army of the Na'vi race to protect their home.\n"
    + "",
  rating: 7.6,
  audienceRating: 9.2,
  year: 2022,
  tagline: "Return to Pandora.",
  thumb: "/library/metadata/58683/thumb/1703239236",
  art: "/library/metadata/58683/art/1703239236",
  theme: "/library/metadata/1/theme/1705636920",
  index: 1,
  leafCount: 14,
  viewedLeafCount: 0,
  childCount: 1,
  seasonCount: 2022,
  duration: 11558112,
  originallyAvailableAt: new RFCDate("2022-12-14"),
  addedAt: 1556281940,
  updatedAt: 1556281940,
  audienceRatingImage: "rottentomatoes://image.rating.upright",
  chapterSource: "media",
  primaryExtraKey: "/library/metadata/58684",
  originalTitle: "映画 ブラッククローバー 魔法帝の剣",
  parentRatingKey: "66",
  grandparentRatingKey: "66",
  parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
  grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
  grandparentSlug: "alice-in-borderland-2020",
  grandparentKey: "/library/metadata/66",
  parentKey: "/library/metadata/66",
  grandparentTitle: "Caprica",
  grandparentThumb: "/library/metadata/66/thumb/1705716261",
  grandparentTheme: "/library/metadata/66/theme/1705716261",
  grandparentArt: "/library/metadata/66/art/1705716261",
  parentTitle: "Caprica",
  parentIndex: 1,
  parentThumb: "/library/metadata/66/thumb/1705716261",
  ratingImage: "rottentomatoes://image.rating.ripe",
  viewCount: 1,
  viewOffset: 5222500,
  skipCount: 1,
  subtype: "clip",
  lastRatedAt: 1721813113,
  createdAtAccuracy: "epoch,local",
  createdAtTZOffset: "0",
  lastViewedAt: 1682752242,
  userRating: 10,
  image: [
    {
      alt: "Episode 1",
      type: GetMediaMetaDataLibraryType.Background,
      url: "/library/metadata/45521/thumb/1644710589",
    },
  ],
  ultraBlurColors: {
    topLeft: "11333b",
    topRight: "0a232d",
    bottomRight: "73958",
    bottomLeft: "1f5066",
  },
  librarySectionID: 1,
  librarySectionTitle: "Movies",
  librarySectionKey: "/library/sections/1",
  guids: [
    {
      id:
        "{\"imdbExample\":{\"summary\":\"IMDB example\",\"value\":\"imdb://tt13015952\"},\"tmdbExample\":{\"summary\":\"TMDB example\",\"value\":\"tmdb://2434012\"},\"tvdbExample\":{\"summary\":\"TVDB example\",\"value\":\"tvdb://7945991\"}}",
    },
  ],
  media: [
    {
      id: 387322,
      duration: 9610350,
      bitrate: 25512,
      width: 3840,
      height: 1602,
      aspectRatio: 2.35,
      audioChannels: 6,
      displayOffset: 50,
      audioCodec: "aac",
      videoCodec: "hevc",
      videoResolution: "4k",
      container: "mp4",
      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,
          hasThumbnail: GetMediaMetaDataHasThumbnail.True,
          stream: [
            {
              id: 1002625,
              format: "srt",
              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,
              closedCaptions: true,
              colorPrimaries: "bt2020",
              colorRange: "tv",
              colorSpace: "bt2020nc",
              colorTrc: "smpte2084",
              frameRate: 23.976,
              key: "/library/streams/216389",
              height: 1602,
              level: 150,
              original: true,
              hasScalingMatrix: false,
              profile: "main 10",
              scanType: "progressive",
              embeddedInVideo: "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",
            },
          ],
        },
      ],
    },
  ],
  genre: [
    {
      id: 259,
      tag: "Crime",
      filter: "genre=19",
    },
  ],
  country: [
    {
      id: 259,
      tag: "United States of America",
      filter: "country=19",
    },
  ],
  director: [
    {
      id: 126522,
      tag: "Danny Boyle",
      filter: "director=235876",
      tagKey: "5d776831151a60001f24d031",
      thumb:
        "https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
    },
  ],
  writer: [
    {
      id: 126522,
      tag: "Jamie P. Hanson",
      filter: "writer=126522",
      thumb:
        "https://metadata-static.plex.tv/8/people/8d65fa96804802e08f2de09fe014408e.jpg",
      tagKey: "5d77683d85719b001f3a535e",
    },
  ],
  producer: [
    {
      id: 109501,
      filter: "actor=109501",
      tag: "Bob Odenkirk",
      tagKey: "5d77683254f42c001f8c3f69",
      role: "Jimmy McGill",
      thumb:
        "https://metadata-static.plex.tv/f/people/f2ca7b474cc984efbdd5c503a096285a.jpg",
    },
  ],
  role: [
    {
      id: 126522,
      tag: "Teller",
      role: "Self - Judge",
      filter: "actor=126522",
      tagKey: "5d77683d85719b001f3a535e",
      thumb:
        "https://metadata-static.plex.tv/7/people/708568fd018d7aa8b1032dcf867747e8.jpg",
    },
  ],
  ratings: [
    {
      image: "imdb://image.rating",
      value: 9,
      type: "audience",
    },
  ],
  similar: [
    {
      id: 26,
      filter: "similar=26",
      tag: "Breaking Bad",
    },
  ],
  location: [
    {
      path: "/TV Shows/Better Call Saul",
    },
  ],
  chapter: [
    {
      id: 4,
      filter: "thumb=4",
      index: 1,
      startTimeOffset: 0,
      endTimeOffset: 100100,
      thumb: "/library/media/46883/chapterImages/1",
    },
  ],
  marker: [
    {
      id: 306970,
      type: "credits",
      startTimeOffset: 4176050,
      endTimeOffset: 4393389,
      final: true,
      attributes: {
        id: 306970,
        version: 4,
      },
    },
  ],
  extras: {
    size: 1,
  },
};

Fields

Field Type Required Description Example
ratingKey string ✔️ The rating key (Media ID) of this media item. Note: Although this is always an integer, it is represented as a string in the API. 58683
key string ✔️ The unique key for the media item. /library/metadata/58683
guid string ✔️ The globally unique identifier for the media item. plex://movie/5d7768ba96b655001fdc0408
slug string ✔️ A URL‐friendly version of the media title. 4-for-texas
studio string ➖ The studio that produced the media item. 20th Century Studios
type operations.GetMediaMetaDataType ✔️ N/A movie
title string ✔️ The title of the media item. Avatar: The Way of Water
titleSort string ✔️ The sort title used for ordering media items. Whale
contentRating string ➖ The content rating for the media item. PG-13
summary string ✔️ A synopsis of the media item. Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.
Once a familiar threat returns to finish what was previously started, Jake must
work with Neytiri and the army of the Na'vi race to protect their home.
rating number ✔️ The critic rating for the media item. 7.6
audienceRating number ✔️ The audience rating for the media item. 9.2
year number ➖ The release year of the media item. 2022
tagline string ✔️ A brief tagline for the media item. Return to Pandora.
thumb string ✔️ The thumbnail image URL for the media item. /library/metadata/58683/thumb/1703239236
art string ✔️ The art image URL for the media item. /library/metadata/58683/art/1703239236
theme string ✔️ The theme URL for the media item. /library/metadata/1/theme/1705636920
index number ✔️ The index position of the media item. 1
leafCount number ➖ The number of leaf items (end nodes) under this media item. 14
viewedLeafCount number ➖ The number of leaf items that have been viewed. 0
childCount number ✔️ The number of child items associated with this media item. 1
seasonCount number ✔️ The total number of seasons (for TV shows). 2022
duration number ✔️ The duration of the media item in milliseconds. 11558112
originallyAvailableAt RFCDate ➖ The original release date of the media item. 2022-12-14
addedAt number ✔️ N/A 1556281940
updatedAt number ➖ Unix epoch datetime in seconds 1556281940
audienceRatingImage string ➖ The URL for the audience rating image. rottentomatoes://image.rating.upright
chapterSource string ➖ The source from which chapter data is derived. media
primaryExtraKey string ➖ The primary extra key associated with this media item. /library/metadata/58684
originalTitle string ➖ The original title of the media item (if different). 映画 ブラッククローバー 魔法帝の剣
parentRatingKey string ➖ The rating key of the parent media item. 66
grandparentRatingKey string ➖ The rating key of the grandparent media item. 66
parentGuid string ➖ The GUID of the parent media item. plex://show/5d9c081b170e24001f2a7be4
grandparentGuid string ➖ The GUID of the grandparent media item. plex://show/5d9c081b170e24001f2a7be4
grandparentSlug string ➖ The slug for the grandparent media item. alice-in-borderland-2020
grandparentKey string ➖ The key of the grandparent media item. /library/metadata/66
parentKey string ➖ The key of the parent media item. /library/metadata/66
grandparentTitle string ➖ The title of the grandparent media item. Caprica
grandparentThumb string ➖ The thumbnail URL for the grandparent media item. /library/metadata/66/thumb/1705716261
grandparentTheme string ➖ The theme URL for the grandparent media item. /library/metadata/66/theme/1705716261
grandparentArt string ➖ The art URL for the grandparent media item. /library/metadata/66/art/1705716261
parentTitle string ➖ The title of the parent media item. Caprica
parentIndex number ➖ The index position of the parent media item. 1
parentThumb string ➖ The thumbnail URL for the parent media item. /library/metadata/66/thumb/1705716261
ratingImage string ➖ The URL for the rating image. rottentomatoes://image.rating.ripe
viewCount number ➖ The number of times this media item has been viewed. 1
viewOffset number ➖ The current playback offset (in milliseconds). 5222500
skipCount number ➖ The number of times this media item has been skipped. 1
subtype string ➖ A classification that further describes the type of media item. For example, 'clip' indicates that the item is a short video clip. clip
lastRatedAt number ➖ The Unix timestamp representing the last time the item was rated. 1721813113
createdAtAccuracy string ➖ The accuracy of the creation timestamp. This value indicates the format(s) provided (for example, 'epoch,local' means both epoch and local time formats are available). epoch,local
createdAtTZOffset string ➖ The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. 0
lastViewedAt number ➖ Unix timestamp for when the media item was last viewed. 1682752242
userRating number ➖ The rating provided by a user for the item. This value is expressed as a decimal number. 10
image operations.GetMediaMetaDataImage[] ➖ N/A
ultraBlurColors operations.GetMediaMetaDataUltraBlurColors ➖ N/A
librarySectionID number ➖ The identifier for the library section. 1
librarySectionTitle string ➖ The title of the library section. Movies
librarySectionKey string ➖ The key corresponding to the library section. /library/sections/1
guids operations.GetMediaMetaDataGuids[] ➖ N/A
media operations.GetMediaMetaDataMedia[] ➖ N/A
genre operations.GetMediaMetaDataGenre[] ➖ N/A
country operations.GetMediaMetaDataCountry[] ➖ N/A
director operations.GetMediaMetaDataDirector[] ➖ N/A
writer operations.GetMediaMetaDataWriter[] ➖ N/A
producer operations.GetMediaMetaDataProducer[] ➖ N/A
role operations.GetMediaMetaDataRole[] ➖ N/A
ratings operations.GetMediaMetaDataRatings[] ➖ N/A
similar operations.GetMediaMetaDataSimilar[] ➖ N/A
location operations.GetMediaMetaDataLocation[] ➖ N/A
chapter operations.GetMediaMetaDataChapter[] ➖ N/A
marker operations.GetMediaMetaDataMarker[] ➖ N/A
extras operations.GetMediaMetaDataExtras ➖ N/A