mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-06 12:37:47 +00:00
83 lines
87 KiB
Markdown
83 lines
87 KiB
Markdown
# GetMediaMetaDataMetadata
|
||
|
||
Unknown
|
||
|
||
|
||
|
||
## 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\GetMediaMetaDataType](../../Models/Operations/GetMediaMetaDataType.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` | *float* | :heavy_check_mark: | The critic rating for the media item. | 7.6 |
|
||
| `audienceRating` | *float* | :heavy_check_mark: | The audience rating for the media item. | 9.2 |
|
||
| `year` | *?int* | :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` | *int* | :heavy_check_mark: | The index position of the media item. | 1 |
|
||
| `leafCount` | *?int* | :heavy_minus_sign: | The number of leaf items (end nodes) under this media item. | 14 |
|
||
| `viewedLeafCount` | *?int* | :heavy_minus_sign: | The number of leaf items that have been viewed. | 0 |
|
||
| `childCount` | *int* | :heavy_check_mark: | The number of child items associated with this media item. | 1 |
|
||
| `seasonCount` | *int* | :heavy_check_mark: | The total number of seasons (for TV shows). | 2022 |
|
||
| `duration` | *int* | :heavy_check_mark: | The duration of the media item in milliseconds. | 11558112 |
|
||
| `originallyAvailableAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The original release date of the media item. | 2022-12-14 |
|
||
| `addedAt` | *int* | :heavy_check_mark: | N/A | 1556281940 |
|
||
| `updatedAt` | *?int* | :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` | *?int* | :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` | *?int* | :heavy_minus_sign: | The number of times this media item has been viewed. | 1 |
|
||
| `viewOffset` | *?int* | :heavy_minus_sign: | The current playback offset (in milliseconds). | 5222500 |
|
||
| `skipCount` | *?int* | :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` | *?int* | :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` | *?int* | :heavy_minus_sign: | Unix timestamp for when the media item was last viewed. | 1682752242 |
|
||
| `userRating` | *?float* | :heavy_minus_sign: | The rating provided by a user for the item. This value is expressed as a decimal number. | 10 |
|
||
| `image` | array<[Operations\GetMediaMetaDataImage](../../Models/Operations/GetMediaMetaDataImage.md)> | :heavy_minus_sign: | N/A | |
|
||
| `ultraBlurColors` | [?Operations\GetMediaMetaDataUltraBlurColors](../../Models/Operations/GetMediaMetaDataUltraBlurColors.md) | :heavy_minus_sign: | N/A | |
|
||
| `librarySectionID` | *?int* | :heavy_minus_sign: | The identifier for the library section. | 1 |
|
||
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | Movies |
|
||
| `librarySectionKey` | *?string* | :heavy_minus_sign: | The key corresponding to the library section. | /library/sections/1 |
|
||
| `guids` | array<[Operations\GetMediaMetaDataGuids](../../Models/Operations/GetMediaMetaDataGuids.md)> | :heavy_minus_sign: | N/A | |
|
||
| `media` | array<[Operations\GetMediaMetaDataMedia](../../Models/Operations/GetMediaMetaDataMedia.md)> | :heavy_minus_sign: | N/A | |
|
||
| `genre` | array<[Operations\GetMediaMetaDataGenre](../../Models/Operations/GetMediaMetaDataGenre.md)> | :heavy_minus_sign: | N/A | |
|
||
| `country` | array<[Operations\GetMediaMetaDataCountry](../../Models/Operations/GetMediaMetaDataCountry.md)> | :heavy_minus_sign: | N/A | |
|
||
| `director` | array<[Operations\GetMediaMetaDataDirector](../../Models/Operations/GetMediaMetaDataDirector.md)> | :heavy_minus_sign: | N/A | |
|
||
| `writer` | array<[Operations\GetMediaMetaDataWriter](../../Models/Operations/GetMediaMetaDataWriter.md)> | :heavy_minus_sign: | N/A | |
|
||
| `producer` | array<[Operations\GetMediaMetaDataProducer](../../Models/Operations/GetMediaMetaDataProducer.md)> | :heavy_minus_sign: | N/A | |
|
||
| `role` | array<[Operations\GetMediaMetaDataRole](../../Models/Operations/GetMediaMetaDataRole.md)> | :heavy_minus_sign: | N/A | |
|
||
| `ratings` | array<[Operations\GetMediaMetaDataRatings](../../Models/Operations/GetMediaMetaDataRatings.md)> | :heavy_minus_sign: | N/A | |
|
||
| `similar` | array<[Operations\GetMediaMetaDataSimilar](../../Models/Operations/GetMediaMetaDataSimilar.md)> | :heavy_minus_sign: | N/A | |
|
||
| `location` | array<[Operations\GetMediaMetaDataLocation](../../Models/Operations/GetMediaMetaDataLocation.md)> | :heavy_minus_sign: | N/A | |
|
||
| `chapter` | array<[Operations\GetMediaMetaDataChapter](../../Models/Operations/GetMediaMetaDataChapter.md)> | :heavy_minus_sign: | N/A | |
|
||
| `marker` | array<[Operations\GetMediaMetaDataMarker](../../Models/Operations/GetMediaMetaDataMarker.md)> | :heavy_minus_sign: | N/A | |
|
||
| `extras` | [?Operations\GetMediaMetaDataExtras](../../Models/Operations/GetMediaMetaDataExtras.md) | :heavy_minus_sign: | N/A | | |