mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
288 lines
82 KiB
Markdown
288 lines
82 KiB
Markdown
# GetLibrarySectionsAllMetadata
|
||
|
||
Unknown
|
||
|
||
|
||
## Example Usage
|
||
|
||
```typescript
|
||
import {
|
||
GetLibrarySectionsAllHasThumbnail,
|
||
GetLibrarySectionsAllLibraryResponseType,
|
||
GetLibrarySectionsAllLibraryType,
|
||
GetLibrarySectionsAllMetadata,
|
||
} from "@lukehagar/plexjs/sdk/models/operations";
|
||
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
||
|
||
let value: GetLibrarySectionsAllMetadata = {
|
||
ratingKey: "58683",
|
||
key: "/library/metadata/58683",
|
||
guid: "plex://movie/5d7768ba96b655001fdc0408",
|
||
slug: "4-for-texas",
|
||
studio: "20th Century Studios",
|
||
type: GetLibrarySectionsAllLibraryType.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: GetLibrarySectionsAllLibraryResponseType.Background,
|
||
url: "/library/metadata/45521/thumb/1644710589",
|
||
},
|
||
],
|
||
ultraBlurColors: {
|
||
topLeft: "11333b",
|
||
topRight: "0a232d",
|
||
bottomRight: "73958",
|
||
bottomLeft: "1f5066",
|
||
},
|
||
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: "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,
|
||
hasThumbnail: GetLibrarySectionsAllHasThumbnail.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: [
|
||
{
|
||
tag: "Crime",
|
||
},
|
||
],
|
||
country: [
|
||
{
|
||
tag: "United States of America",
|
||
},
|
||
],
|
||
director: [
|
||
{
|
||
tag: "Danny Boyle",
|
||
},
|
||
],
|
||
writer: [
|
||
{
|
||
tag: "Jamie P. Hanson",
|
||
},
|
||
],
|
||
role: [
|
||
{
|
||
tag: "Teller",
|
||
},
|
||
],
|
||
collection: [
|
||
{
|
||
tag: "My Awesome Collection",
|
||
},
|
||
],
|
||
};
|
||
```
|
||
|
||
## Fields
|
||
|
||
| Field | Type | Required | Description | Example |
|
||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| `ratingKey` | *string* | :heavy_check_mark: | 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* | :heavy_check_mark: | The unique key for the media item. | /library/metadata/58683 |
|
||
| `guid` | *string* | :heavy_check_mark: | The globally unique identifier for the media item. | plex://movie/5d7768ba96b655001fdc0408 |
|
||
| `slug` | *string* | :heavy_check_mark: | A URL‐friendly version of the media title. | 4-for-texas |
|
||
| `studio` | *string* | :heavy_minus_sign: | The studio that produced the media item. | 20th Century Studios |
|
||
| `type` | [operations.GetLibrarySectionsAllLibraryType](../../../sdk/models/operations/getlibrarysectionsalllibrarytype.md) | :heavy_check_mark: | N/A | movie |
|
||
| `title` | *string* | :heavy_check_mark: | The title of the media item. | Avatar: The Way of Water |
|
||
| `titleSort` | *string* | :heavy_check_mark: | The sort title used for ordering media items. | Whale |
|
||
| `contentRating` | *string* | :heavy_minus_sign: | The content rating for the media item. | PG-13 |
|
||
| `summary` | *string* | :heavy_check_mark: | A synopsis of the media item. | Jake Sully lives with his newfound family formed on the extrasolar moon Pandora.<br/>Once a familiar threat returns to finish what was previously started, Jake must<br/>work with Neytiri and the army of the Na'vi race to protect their home.<br/> |
|
||
| `rating` | *number* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||
| `audienceRating` | *number* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||
| `year` | *number* | :heavy_minus_sign: | The release year of the media item. | 2022 |
|
||
| `tagline` | *string* | :heavy_check_mark: | A brief tagline for the media item. | Return to Pandora. |
|
||
| `thumb` | *string* | :heavy_check_mark: | The thumbnail image URL for the media item. | /library/metadata/58683/thumb/1703239236 |
|
||
| `art` | *string* | :heavy_check_mark: | The art image URL for the media item. | /library/metadata/58683/art/1703239236 |
|
||
| `theme` | *string* | :heavy_check_mark: | The theme URL for the media item. | /library/metadata/1/theme/1705636920 |
|
||
| `index` | *number* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||
| `leafCount` | *number* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||
| `viewedLeafCount` | *number* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||
| `childCount` | *number* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||
| `seasonCount` | *number* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||
| `duration` | *number* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||
| `addedAt` | *number* | :heavy_check_mark: | N/A | 1556281940 |
|
||
| `updatedAt` | *number* | :heavy_minus_sign: | Unix epoch datetime in seconds | 1556281940 |
|
||
| `audienceRatingImage` | *string* | :heavy_minus_sign: | The URL for the audience rating image. | rottentomatoes://image.rating.upright |
|
||
| `chapterSource` | *string* | :heavy_minus_sign: | The source from which chapter data is derived. | media |
|
||
| `primaryExtraKey` | *string* | :heavy_minus_sign: | The primary extra key associated with this media item. | /library/metadata/58684 |
|
||
| `originalTitle` | *string* | :heavy_minus_sign: | The original title of the media item (if different). | 映画 ブラッククローバー 魔法帝の剣 |
|
||
| `parentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the parent media item. | 66 |
|
||
| `grandparentRatingKey` | *string* | :heavy_minus_sign: | The rating key of the grandparent media item. | 66 |
|
||
| `parentGuid` | *string* | :heavy_minus_sign: | The GUID of the parent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||
| `grandparentGuid` | *string* | :heavy_minus_sign: | The GUID of the grandparent media item. | plex://show/5d9c081b170e24001f2a7be4 |
|
||
| `grandparentSlug` | *string* | :heavy_minus_sign: | The slug for the grandparent media item. | alice-in-borderland-2020 |
|
||
| `grandparentKey` | *string* | :heavy_minus_sign: | The key of the grandparent media item. | /library/metadata/66 |
|
||
| `parentKey` | *string* | :heavy_minus_sign: | The key of the parent media item. | /library/metadata/66 |
|
||
| `grandparentTitle` | *string* | :heavy_minus_sign: | The title of the grandparent media item. | Caprica |
|
||
| `grandparentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the grandparent media item. | /library/metadata/66/thumb/1705716261 |
|
||
| `grandparentTheme` | *string* | :heavy_minus_sign: | The theme URL for the grandparent media item. | /library/metadata/66/theme/1705716261 |
|
||
| `grandparentArt` | *string* | :heavy_minus_sign: | The art URL for the grandparent media item. | /library/metadata/66/art/1705716261 |
|
||
| `parentTitle` | *string* | :heavy_minus_sign: | The title of the parent media item. | Caprica |
|
||
| `parentIndex` | *number* | :heavy_minus_sign: | The index position of the parent media item. | 1 |
|
||
| `parentThumb` | *string* | :heavy_minus_sign: | The thumbnail URL for the parent media item. | /library/metadata/66/thumb/1705716261 |
|
||
| `ratingImage` | *string* | :heavy_minus_sign: | The URL for the rating image. | rottentomatoes://image.rating.ripe |
|
||
| `viewCount` | *number* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||
| `viewOffset` | *number* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||
| `skipCount` | *number* | :heavy_minus_sign: | The number of times this media item has been skipped. | 1 |
|
||
| `subtype` | *string* | :heavy_minus_sign: | 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* | :heavy_minus_sign: | The Unix timestamp representing the last time the item was rated. | 1721813113 |
|
||
| `createdAtAccuracy` | *string* | :heavy_minus_sign: | 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* | :heavy_minus_sign: | The time zone offset for the creation timestamp, represented as a string. This offset indicates the difference from UTC. | 0 |
|
||
| `lastViewedAt` | *number* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||
| `userRating` | *number* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||
| `image` | [operations.GetLibrarySectionsAllImage](../../../sdk/models/operations/getlibrarysectionsallimage.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `ultraBlurColors` | [operations.GetLibrarySectionsAllUltraBlurColors](../../../sdk/models/operations/getlibrarysectionsallultrablurcolors.md) | :heavy_minus_sign: | N/A | |
|
||
| `guids` | [operations.GetLibrarySectionsAllGuids](../../../sdk/models/operations/getlibrarysectionsallguids.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `media` | [operations.GetLibrarySectionsAllMedia](../../../sdk/models/operations/getlibrarysectionsallmedia.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `genre` | [operations.GetLibrarySectionsAllGenre](../../../sdk/models/operations/getlibrarysectionsallgenre.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `country` | [operations.GetLibrarySectionsAllCountry](../../../sdk/models/operations/getlibrarysectionsallcountry.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `director` | [operations.GetLibrarySectionsAllDirector](../../../sdk/models/operations/getlibrarysectionsalldirector.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `writer` | [operations.GetLibrarySectionsAllWriter](../../../sdk/models/operations/getlibrarysectionsallwriter.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `role` | [operations.GetLibrarySectionsAllRole](../../../sdk/models/operations/getlibrarysectionsallrole.md)[] | :heavy_minus_sign: | N/A | |
|
||
| `collection` | [operations.GetLibrarySectionsAllCollection](../../../sdk/models/operations/getlibrarysectionsallcollection.md)[] | :heavy_minus_sign: | N/A | | |