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

132 lines
57 KiB
Markdown

# GetSearchResultsMetadata
## Example Usage
```typescript
import { GetSearchResultsMetadata } from "@lukehagar/plexjs/sdk/models/operations";
let value: GetSearchResultsMetadata = {
librarySectionID: 1,
librarySectionTitle: "Movies",
librarySectionUUID: "322a231a-b7f7-49f5-920f-14c61199cd30",
sourceTitle: "Hera",
ratingKey: 10398,
key: "/library/metadata/10398",
guid: "plex://movie/5d7768284de0ee001fcc8f52",
studio: "Paramount",
type: "movie",
title: "Mission: Impossible",
contentRating: "PG-13",
summary:
"When Ethan Hunt the leader of a crack espionage team whose perilous operation has gone awry with no explanation discovers that a mole has penetrated the CIA he's surprised to learn that he's the No. 1 suspect. To clear his name Hunt now must ferret out the real double agent and in the process even the score.",
rating: 6.6,
audienceRating: 7.1,
year: 1996,
tagline: "Expect the impossible.",
thumb: "/library/metadata/10398/thumb/1679505055",
art: "/library/metadata/10398/art/1679505055",
duration: 6612628,
originallyAvailableAt: new Date("1996-05-22T00:00:00Z"),
addedAt: 1589234571,
updatedAt: 1679505055,
audienceRatingImage: "rottentomatoes://image.rating.upright",
chapterSource: "media",
primaryExtraKey: "/library/metadata/10501",
ratingImage: "rottentomatoes://image.rating.ripe",
media: [
{
id: 26610,
duration: 6612628,
bitrate: 4751,
width: 1916,
height: 796,
aspectRatio: 2.35,
audioChannels: 6,
audioCodec: "aac",
videoCodec: "hevc",
videoResolution: 1080,
container: "mkv",
videoFrameRate: "24p",
audioProfile: "lc",
videoProfile: "main 10",
part: [
{
id: 26610,
key: "/library/parts/26610/1589234571/file.mkv",
duration: 6612628,
file:
"/movies/Mission Impossible (1996)/Mission Impossible (1996) Bluray-1080p.mkv",
size: 3926903851,
audioProfile: "lc",
container: "mkv",
videoProfile: "main 10",
},
],
},
],
genre: [
{
tag: "Action",
},
],
director: [
{
tag: "Brian De Palma",
},
],
writer: [
{
tag: "David Koepp",
},
],
country: [
{
tag: "United States of America",
},
],
role: [
{
tag: "Tom Cruise",
},
],
};
```
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `allowSync` | *boolean* | :heavy_minus_sign: | N/A | |
| `librarySectionID` | *number* | :heavy_minus_sign: | N/A | 1 |
| `librarySectionTitle` | *string* | :heavy_minus_sign: | N/A | Movies |
| `librarySectionUUID` | *string* | :heavy_minus_sign: | N/A | 322a231a-b7f7-49f5-920f-14c61199cd30 |
| `personal` | *boolean* | :heavy_minus_sign: | N/A | |
| `sourceTitle` | *string* | :heavy_minus_sign: | N/A | Hera |
| `ratingKey` | *number* | :heavy_minus_sign: | N/A | 10398 |
| `key` | *string* | :heavy_minus_sign: | N/A | /library/metadata/10398 |
| `guid` | *string* | :heavy_minus_sign: | N/A | plex://movie/5d7768284de0ee001fcc8f52 |
| `studio` | *string* | :heavy_minus_sign: | N/A | Paramount |
| `type` | *string* | :heavy_minus_sign: | N/A | movie |
| `title` | *string* | :heavy_minus_sign: | N/A | Mission: Impossible |
| `contentRating` | *string* | :heavy_minus_sign: | N/A | PG-13 |
| `summary` | *string* | :heavy_minus_sign: | N/A | When Ethan Hunt the leader of a crack espionage team whose perilous operation has gone awry with no explanation discovers that a mole has penetrated the CIA he's surprised to learn that he's the No. 1 suspect. To clear his name Hunt now must ferret out the real double agent and in the process even the score. |
| `rating` | *number* | :heavy_minus_sign: | N/A | 6.6 |
| `audienceRating` | *number* | :heavy_minus_sign: | N/A | 7.1 |
| `year` | *number* | :heavy_minus_sign: | N/A | 1996 |
| `tagline` | *string* | :heavy_minus_sign: | N/A | Expect the impossible. |
| `thumb` | *string* | :heavy_minus_sign: | N/A | /library/metadata/10398/thumb/1679505055 |
| `art` | *string* | :heavy_minus_sign: | N/A | /library/metadata/10398/art/1679505055 |
| `duration` | *number* | :heavy_minus_sign: | N/A | 6612628 |
| `originallyAvailableAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 1996-05-22 00:00:00 +0000 UTC |
| `addedAt` | *number* | :heavy_minus_sign: | N/A | 1589234571 |
| `updatedAt` | *number* | :heavy_minus_sign: | N/A | 1679505055 |
| `audienceRatingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.upright |
| `chapterSource` | *string* | :heavy_minus_sign: | N/A | media |
| `primaryExtraKey` | *string* | :heavy_minus_sign: | N/A | /library/metadata/10501 |
| `ratingImage` | *string* | :heavy_minus_sign: | N/A | rottentomatoes://image.rating.ripe |
| `media` | [operations.GetSearchResultsMedia](../../../sdk/models/operations/getsearchresultsmedia.md)[] | :heavy_minus_sign: | N/A | |
| `genre` | [operations.GetSearchResultsGenre](../../../sdk/models/operations/getsearchresultsgenre.md)[] | :heavy_minus_sign: | N/A | |
| `director` | [operations.GetSearchResultsDirector](../../../sdk/models/operations/getsearchresultsdirector.md)[] | :heavy_minus_sign: | N/A | |
| `writer` | [operations.GetSearchResultsWriter](../../../sdk/models/operations/getsearchresultswriter.md)[] | :heavy_minus_sign: | N/A | |
| `country` | [operations.GetSearchResultsCountry](../../../sdk/models/operations/getsearchresultscountry.md)[] | :heavy_minus_sign: | N/A | |
| `role` | [operations.GetSearchResultsRole](../../../sdk/models/operations/getsearchresultsrole.md)[] | :heavy_minus_sign: | N/A | |