mirror of
https://github.com/LukeHagar/plexruby.git
synced 2025-12-07 12:47:45 +00:00
28 lines
12 KiB
Markdown
28 lines
12 KiB
Markdown
# GetLibraryItemsMediaContainer
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
| `size` | *::Integer* | :heavy_check_mark: | Number of media items returned in this response. | 50 |
|
|
| `total_size` | *::Integer* | :heavy_check_mark: | Total number of media items in the library. | 50 |
|
|
| `offset` | *::Integer* | :heavy_check_mark: | Offset value for pagination. | 0 |
|
|
| `content` | *::String* | :heavy_check_mark: | The content type or mode. | secondary |
|
|
| `allow_sync` | *T::Boolean* | :heavy_check_mark: | Indicates whether syncing is allowed. | false |
|
|
| `nocache` | *T::Boolean* | :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 |
|
|
| `library_section_id` | *T.nilable(::Integer)* | :heavy_minus_sign: | The unique identifier for the library section. | 2 |
|
|
| `library_section_title` | *T.nilable(::String)* | :heavy_minus_sign: | The title of the library section. | TV Series |
|
|
| `library_section_uuid` | *T.nilable(::String)* | :heavy_minus_sign: | The universally unique identifier for the library section. | e69655a2-ef48-4aba-bb19-0cc34d1e7d36 |
|
|
| `media_tag_prefix` | *::String* | :heavy_check_mark: | The prefix used for media tag resource paths. | /system/bundle/media/flags/ |
|
|
| `media_tag_version` | *::Integer* | :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 |
|
|
| `view_group` | *::String* | :heavy_check_mark: | Identifier for the view group layout. | secondary |
|
|
| `view_mode` | *T.nilable(::String)* | :heavy_minus_sign: | Identifier for the view mode. | 131131 |
|
|
| `mixed_parents` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Indicates if the media container has mixed parents. | true |
|
|
| `metadata` | T::Array<[Models::Operations::GetLibraryItemsMetadata](../../models/operations/getlibraryitemsmetadata.md)> | :heavy_check_mark: | An array of metadata items. | |
|
|
| `meta` | [T.nilable(Models::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/> | | |