plexjs/docs/sdk/models/operations/getlibraryitemsmetadata.md

GetLibraryItemsMetadata

Example Usage

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

let value: GetLibraryItemsMetadata = {
    ratingKey: "58683",
    key: "/library/metadata/58683",
    guid: "plex://movie/5d7768ba96b655001fdc0408",
    studio: "20th Century Studios",
    type: "movie",
    title: "Avatar: The Way of Water",
    contentRating: "PG-13",
    summary:
        "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: 7.6,
    audienceRating: 9.2,
    year: 2022,
    tagline: "Return to Pandora.",
    thumb: "/library/metadata/58683/thumb/1703239236",
    art: "/library/metadata/58683/art/1703239236",
    duration: 11558112,
    originallyAvailableAt: new RFCDate("2022-12-14T00:00:00Z"),
    addedAt: 1680457607,
    updatedAt: 1703239236,
    audienceRatingImage: "rottentomatoes://image.rating.upright",
    chapterSource: "media",
    primaryExtraKey: "/library/metadata/58684",
    ratingImage: "rottentomatoes://image.rating.ripe",
    grandparentRatingKey: "66",
    grandparentGuid: "plex://show/5d9c081b170e24001f2a7be4",
    grandparentKey: "/library/metadata/66",
    grandparentTitle: "Caprica",
    grandparentThumb: "/library/metadata/66/thumb/1705716261",
    grandparentArt: "/library/metadata/66/art/1705716261",
    grandparentTheme: "/library/metadata/66/theme/1705716261",
    media: [
        {
            id: 119534,
            duration: 11558112,
            bitrate: 25025,
            width: 3840,
            height: 2072,
            aspectRatio: 1.85,
            audioChannels: 6,
            audioCodec: "eac3",
            videoCodec: "hevc",
            videoResolution: "4k",
            container: "mkv",
            videoFrameRate: "24p",
            videoProfile: "main 10",
            part: [
                {
                    id: 119542,
                    key: "/library/parts/119542/1680457526/file.mkv",
                    duration: 11558112,
                    file: "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
                    size: 36158371307,
                    container: "mkv",
                    videoProfile: "main 10",
                },
            ],
        },
    ],
    genre: [
        {
            tag: "Adventure",
        },
    ],
    country: [
        {
            tag: "United States of America",
        },
    ],
    director: [
        {
            tag: "James Cameron",
        },
    ],
    writer: [
        {
            tag: "James Cameron",
        },
    ],
    role: [
        {
            tag: "Sigourney Weaver",
        },
    ],
    titleSort: "Whale",
    viewCount: 1,
    lastViewedAt: 1682752242,
    originalTitle: "映画 ブラッククローバー 魔法帝の剣",
    viewOffset: 5222500,
    skipCount: 1,
    index: 1,
    theme: "/library/metadata/1/theme/1705636920",
    leafCount: 14,
    viewedLeafCount: 0,
    childCount: 1,
    hasPremiumExtras: "1",
    hasPremiumPrimaryExtra: "1",
    parentRatingKey: "66",
    parentGuid: "plex://show/5d9c081b170e24001f2a7be4",
    parentStudio: "UCP",
    parentKey: "/library/metadata/66",
    parentTitle: "Caprica",
    parentIndex: 1,
    parentYear: 2010,
    parentThumb: "/library/metadata/66/thumb/1705716261",
    parentTheme: "/library/metadata/66/theme/1705716261",
};

Fields

Field	Type	Required	Description	Example
ratingKey	string	➖	N/A	58683
key	string	➖	N/A	/library/metadata/58683
guid	string	➖	N/A	plex://movie/5d7768ba96b655001fdc0408
studio	string	➖	N/A	20th Century Studios
type	string	➖	N/A	movie
title	string	➖	N/A	Avatar: The Way of Water
contentRating	string	➖	N/A	PG-13
summary	string	➖	N/A	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	➖	N/A	7.6
audienceRating	number	➖	N/A	9.2
year	number	➖	N/A	2022
tagline	string	➖	N/A	Return to Pandora.
thumb	string	➖	N/A	/library/metadata/58683/thumb/1703239236
art	string	➖	N/A	/library/metadata/58683/art/1703239236
duration	number	➖	N/A	11558112
originallyAvailableAt	RFCDate	➖	N/A	2022-12-14 00:00:00 +0000 UTC
addedAt	number	➖	N/A	1680457607
updatedAt	number	➖	N/A	1703239236
audienceRatingImage	string	➖	N/A	rottentomatoes://image.rating.upright
chapterSource	string	➖	N/A	media
primaryExtraKey	string	➖	N/A	/library/metadata/58684
ratingImage	string	➖	N/A	rottentomatoes://image.rating.ripe
grandparentRatingKey	string	➖	N/A	66
grandparentGuid	string	➖	N/A	plex://show/5d9c081b170e24001f2a7be4
grandparentKey	string	➖	N/A	/library/metadata/66
grandparentTitle	string	➖	N/A	Caprica
grandparentThumb	string	➖	N/A	/library/metadata/66/thumb/1705716261
grandparentArt	string	➖	N/A	/library/metadata/66/art/1705716261
grandparentTheme	string	➖	N/A	/library/metadata/66/theme/1705716261
media	operations.GetLibraryItemsMedia[]	➖	N/A
genre	operations.GetLibraryItemsGenre[]	➖	N/A
country	operations.GetLibraryItemsCountry[]	➖	N/A
director	operations.GetLibraryItemsDirector[]	➖	N/A
writer	operations.GetLibraryItemsWriter[]	➖	N/A
role	operations.GetLibraryItemsRole[]	➖	N/A
titleSort	string	➖	N/A	Whale
viewCount	number	➖	N/A	1
lastViewedAt	number	➖	N/A	1682752242
originalTitle	string	➖	N/A	映画 ブラッククローバー 魔法帝の剣
viewOffset	number	➖	N/A	5222500
skipCount	number	➖	N/A	1
index	number	➖	N/A	1
theme	string	➖	N/A	/library/metadata/1/theme/1705636920
leafCount	number	➖	N/A	14
viewedLeafCount	number	➖	N/A	0
childCount	number	➖	N/A	1
hasPremiumExtras	string	➖	N/A	1
hasPremiumPrimaryExtra	string	➖	N/A	1
parentRatingKey	string	➖	N/A	66
parentGuid	string	➖	N/A	plex://show/5d9c081b170e24001f2a7be4
parentStudio	string	➖	N/A	UCP
parentKey	string	➖	N/A	/library/metadata/66
parentTitle	string	➖	N/A	Caprica
parentIndex	number	➖	N/A	1
parentYear	number	➖	N/A	2010
parentThumb	string	➖	N/A	/library/metadata/66/thumb/1705716261
parentTheme	string	➖	N/A	/library/metadata/66/theme/1705716261