mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 04:20:46 +00:00
138 lines
39 KiB
Markdown
138 lines
39 KiB
Markdown
# GetLibraryHubsMetadata
|
|
|
|
## Example Usage
|
|
|
|
```typescript
|
|
import { GetLibraryHubsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
|
|
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
|
|
|
|
let value: GetLibraryHubsMetadata = {
|
|
ratingKey: "14944",
|
|
key: "/library/metadata/14944",
|
|
guid: "plex://movie/5d77686eeb5d26001f1eb339",
|
|
studio: "Walt Disney Animation Studios",
|
|
type: "movie",
|
|
title: "Tangled",
|
|
librarySectionTitle: "Movies",
|
|
librarySectionID: 1,
|
|
librarySectionKey: "/library/sections/1",
|
|
contentRating: "PG",
|
|
summary:
|
|
"The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.",
|
|
rating: 8.9,
|
|
audienceRating: 8.7,
|
|
viewCount: 1,
|
|
lastViewedAt: 1704936047,
|
|
year: 2010,
|
|
tagline: "They're taking adventure to new lengths.",
|
|
thumb: "/library/metadata/14944/thumb/1705739847",
|
|
art: "/library/metadata/14944/art/1705739847",
|
|
duration: 6017237,
|
|
originallyAvailableAt: new RFCDate("2010-11-24T00:00:00Z"),
|
|
addedAt: 1589412494,
|
|
updatedAt: 1705739847,
|
|
audienceRatingImage: "rottentomatoes://image.rating.upright",
|
|
primaryExtraKey: "/library/metadata/14952",
|
|
ratingImage: "rottentomatoes://image.rating.ripe",
|
|
media: [
|
|
{
|
|
id: 38247,
|
|
duration: 6017237,
|
|
bitrate: 2051,
|
|
width: 1920,
|
|
height: 1080,
|
|
aspectRatio: 1.78,
|
|
audioChannels: 2,
|
|
audioCodec: "aac",
|
|
videoCodec: "h264",
|
|
videoResolution: "1080",
|
|
container: "mp4",
|
|
videoFrameRate: "24p",
|
|
optimizedForStreaming: 1,
|
|
audioProfile: "lc",
|
|
has64bitOffsets: false,
|
|
videoProfile: "high",
|
|
part: [
|
|
{
|
|
id: 38247,
|
|
key: "/library/parts/38247/1589412494/file.mp4",
|
|
duration: 6017237,
|
|
file: "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",
|
|
size: 1545647447,
|
|
audioProfile: "lc",
|
|
container: "mp4",
|
|
has64bitOffsets: false,
|
|
optimizedForStreaming: true,
|
|
videoProfile: "high",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
genre: [
|
|
{
|
|
tag: "Animation",
|
|
},
|
|
],
|
|
country: [
|
|
{
|
|
tag: "United States of America",
|
|
},
|
|
],
|
|
director: [
|
|
{
|
|
tag: "Nathan Greno",
|
|
},
|
|
],
|
|
role: [
|
|
{
|
|
tag: "Donna Murphy",
|
|
},
|
|
],
|
|
writer: [
|
|
{
|
|
tag: "Wilhelm Grimm",
|
|
},
|
|
],
|
|
skipCount: 1,
|
|
chapterSource: "media",
|
|
};
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 14944 |
|
|
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944 |
|
|
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77686eeb5d26001f1eb339 |
|
|
| `studio` | *string* | :heavy_minus_sign: | N/A | Walt Disney Animation Studios |
|
|
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
|
|
| `title` | *string* | :heavy_minus_sign: | N/A | Tangled |
|
|
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
|
|
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
| `librarySectionKey` | *string* | :heavy_minus_sign: | N/A | /library/sections/1 |
|
|
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG |
|
|
| `summary` | *string* | :heavy_minus_sign: | N/A | The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is. |
|
|
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.9 |
|
|
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 8.7 |
|
|
| `viewCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
| `lastViewedAt` | *number* | :heavy_minus_sign: | N/A | 1704936047 |
|
|
| `year` | *number* | :heavy_minus_sign: | N/A | 2010 |
|
|
| `tagline` | *string* | :heavy_minus_sign: | N/A | They're taking adventure to new lengths. |
|
|
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/thumb/1705739847 |
|
|
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14944/art/1705739847 |
|
|
| `duration` | *number* | :heavy_minus_sign: | N/A | 6017237 |
|
|
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2010-11-24 00:00:00 +0000 UTC |
|
|
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1589412494 |
|
|
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705739847 |
|
|
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
|
|
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/14952 |
|
|
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
|
|
| `media` | [operations.GetLibraryHubsMedia](../../../sdk/models/operations/getlibraryhubsmedia.md)[] | :heavy_minus_sign: | N/A | |
|
|
| `genre` | [operations.GetLibraryHubsGenre](../../../sdk/models/operations/getlibraryhubsgenre.md)[] | :heavy_minus_sign: | N/A | |
|
|
| `country` | [operations.GetLibraryHubsCountry](../../../sdk/models/operations/getlibraryhubscountry.md)[] | :heavy_minus_sign: | N/A | |
|
|
| `director` | [operations.GetLibraryHubsDirector](../../../sdk/models/operations/getlibraryhubsdirector.md)[] | :heavy_minus_sign: | N/A | |
|
|
| `role` | [operations.GetLibraryHubsRole](../../../sdk/models/operations/getlibraryhubsrole.md)[] | :heavy_minus_sign: | N/A | |
|
|
| `writer` | [operations.GetLibraryHubsWriter](../../../sdk/models/operations/getlibraryhubswriter.md)[] | :heavy_minus_sign: | N/A | |
|
|
| `skipCount` | *number* | :heavy_minus_sign: | N/A | 1 |
|
|
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media | |