Files
plexjs/docs/sdk/models/operations/getplaylistcontentsmetadata.md

134 lines
47 KiB
Markdown

# GetPlaylistContentsMetadata
## Example Usage
```typescript
import { GetPlaylistContentsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
import { RFCDate } from "@lukehagar/plexjs/sdk/types";
let value: GetPlaylistContentsMetadata = {
ratingKey: "17",
key: "/library/metadata/17",
guid: "plex://movie/5d77683f6f4521001ea9dc53",
studio: "Universal Pictures",
type: "movie",
title: "Serenity",
titleSort: "Amazing Spider-Man 2",
librarySectionTitle: "Movies",
librarySectionID: 1,
librarySectionKey: "/library/sections/1",
contentRating: "PG-13",
summary:
"Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
rating: 8.2,
audienceRating: 9.1,
year: 2005,
tagline: "They aim to misbehave.",
thumb: "/library/metadata/17/thumb/1705637165",
art: "/library/metadata/17/art/1705637165",
duration: 141416,
originallyAvailableAt: new RFCDate("2005-09-29T00:00:00Z"),
addedAt: 1705637164,
updatedAt: 1705637165,
audienceRatingImage: "rottentomatoes://image.rating.upright",
hasPremiumExtras: "1",
hasPremiumPrimaryExtra: "1",
ratingImage: "rottentomatoes://image.rating.ripe",
media: [
{
id: 15,
duration: 141416,
bitrate: 2273,
width: 1920,
height: 814,
aspectRatio: 2.35,
audioChannels: 2,
audioCodec: "aac",
videoCodec: "h264",
videoResolution: "1080",
container: "mp4",
videoFrameRate: "24p",
optimizedForStreaming: 0,
audioProfile: "lc",
has64bitOffsets: false,
videoProfile: "high",
part: [
{
id: 15,
key: "/library/parts/15/1705637151/file.mp4",
duration: 141416,
file: "/movies/Serenity (2005)/Serenity (2005).mp4",
size: 40271948,
audioProfile: "lc",
container: "mp4",
has64bitOffsets: false,
optimizedForStreaming: false,
videoProfile: "high",
},
],
},
],
genre: [
{
tag: "Action",
},
],
country: [
{
tag: "United States of America",
},
],
director: [
{
tag: "Joss Whedon",
},
],
writer: [
{
tag: "Joss Whedon",
},
],
role: [
{
tag: "Gina Torres",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ratingKey` | *string* | :heavy_minus_sign: | N/A | 17 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17 |
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d77683f6f4521001ea9dc53 |
| `studio` | *string* | :heavy_minus_sign: | N/A | Universal Pictures |
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
| `title` | *string* | :heavy_minus_sign: | N/A | Serenity |
| `titleSort` | *string* | :heavy_minus_sign: | N/A | Amazing Spider-Man 2 |
| `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-13 |
| `summary` | *string* | :heavy_minus_sign: | N/A | Serenity continues the story of the TV series it was based upon ("Firefly"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job. |
| `rating` | *number* | :heavy_minus_sign: | N/A | 8.2 |
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 9.1 |
| `year` | *number* | :heavy_minus_sign: | N/A | 2005 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | They aim to misbehave. |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/thumb/1705637165 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/17/art/1705637165 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 141416 |
| `originallyAvailableAt` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | N/A | 2005-09-29 00:00:00 +0000 UTC |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1705637164 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1705637165 |
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `hasPremiumExtras` | *string* | :heavy_minus_sign: | N/A | 1 |
| `hasPremiumPrimaryExtra` | *string* | :heavy_minus_sign: | N/A | 1 |
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `media` | [operations.GetPlaylistContentsMedia](../../../sdk/models/operations/getplaylistcontentsmedia.md)[] | :heavy_minus_sign: | N/A | |
| `genre` | [operations.GetPlaylistContentsGenre](../../../sdk/models/operations/getplaylistcontentsgenre.md)[] | :heavy_minus_sign: | N/A | |
| `country` | [operations.GetPlaylistContentsCountry](../../../sdk/models/operations/getplaylistcontentscountry.md)[] | :heavy_minus_sign: | N/A | |
| `director` | [operations.GetPlaylistContentsDirector](../../../sdk/models/operations/getplaylistcontentsdirector.md)[] | :heavy_minus_sign: | N/A | |
| `writer` | [operations.GetPlaylistContentsWriter](../../../sdk/models/operations/getplaylistcontentswriter.md)[] | :heavy_minus_sign: | N/A | |
| `role` | [operations.GetPlaylistContentsRole](../../../sdk/models/operations/getplaylistcontentsrole.md)[] | :heavy_minus_sign: | N/A | |