mirror of
https://github.com/LukeHagar/plexphp.git
synced 2025-12-06 12:37:47 +00:00
28 lines
11 KiB
Markdown
28 lines
11 KiB
Markdown
# GetLibraryItemsMediaContainer
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
|
|
| `size` | *int* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
|
| `totalSize` | *int* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
|
| `offset` | *int* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
|
| `content` | *string* | :heavy_check_mark: | The content type or mode. | secondary |
|
|
| `allowSync` | *bool* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
|
| `nocache` | *bool* | :heavy_check_mark: | Specifies whether caching is disabled. | true |
|
|
| `art` | *string* | :heavy_check_mark: | URL for the background artwork of the media container. | /:/resources/show-fanart.jpg |
|
|
| `identifier` | *string* | :heavy_check_mark: | An plugin identifier for the media container. | com.plexapp.plugins.library |
|
|
| `librarySectionID` | *?int* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
|
| `librarySectionTitle` | *?string* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
|
| `librarySectionUUID` | *?string* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
|
| `mediaTagPrefix` | *string* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
|
| `mediaTagVersion` | *int* | :heavy_check_mark: | The version number for media tags. | 1734362201 |
|
|
| `thumb` | *string* | :heavy_check_mark: | URL for the thumbnail image of the media container. | /:/resources/show.png |
|
|
| `title1` | *string* | :heavy_check_mark: | The primary title of the media container. | TV Series |
|
|
| `title2` | *string* | :heavy_check_mark: | The secondary title of the media container. | By Starring Actor |
|
|
| `viewGroup` | *string* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
|
| `viewMode` | *?string* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
|
| `mixedParents` | *?bool* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
|
|
| `metadata` | array<[Operations\GetLibraryItemsMetadata](../../Models/Operations/GetLibraryItemsMetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
|
|
| `meta` | [?Operations\GetLibraryItemsMeta](../../Models/Operations/GetLibraryItemsMeta.md) | :heavy_minus_sign: | The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.<br/> | | |