mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
65 lines
38 KiB
Markdown
65 lines
38 KiB
Markdown
# LibrarySectionsMediaContainer
|
|
|
|
`MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable.
|
|
Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination)
|
|
The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track.
|
|
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `identifier` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `offset` | *Optional\<Long>* | :heavy_minus_sign: | The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header.<br/> | |
|
|
| `size` | *Optional\<Long>* | :heavy_minus_sign: | N/A | |
|
|
| `totalSize` | *Optional\<Long>* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> | |
|
|
| `allowCameraUpload` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `allowChannelAccess` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `allowMediaDeletion` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `allowSharing` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `allowSync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `allowTuners` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `backgroundProcessing` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `certificate` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `companionProxy` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `countryCode` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `diagnostics` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `eventStream` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `friendlyName` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `hubSearch` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `itemClusters` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `livetv` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 7 |
|
|
| `machineIdentifier` | *Optional\<Object>* | :heavy_minus_sign: | N/A | 0123456789abcdef0123456789abcdef012345678 |
|
|
| `mediaProviders` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `multiuser` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `musicAnalysis` | *Optional\<Long>* | :heavy_minus_sign: | N/A | 2 |
|
|
| `myPlex` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `myPlexMappingState` | *Optional\<Object>* | :heavy_minus_sign: | N/A | mapped |
|
|
| `myPlexSigninState` | *Optional\<Object>* | :heavy_minus_sign: | N/A | ok |
|
|
| `myPlexSubscription` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `myPlexUsername` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `offlineTranscode` | *Optional\<Object>* | :heavy_minus_sign: | N/A | 1 |
|
|
| `ownerFeatures` | *Optional\<String>* | :heavy_minus_sign: | A comma-separated list of features which are enabled for the server owner | |
|
|
| `platform` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `platformVersion` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `pluginHost` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `pushNotifications` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `readOnlyLibraries` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `streamingBrainABRVersion` | *Optional\<Long>* | :heavy_minus_sign: | N/A | |
|
|
| `streamingBrainVersion` | *Optional\<Long>* | :heavy_minus_sign: | N/A | |
|
|
| `sync` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderActiveVideoSessions` | *Optional\<Long>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderAudio` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderLyrics` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderPhoto` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderSubtitles` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderVideo` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderVideoBitrates` | *Optional\<Object>* | :heavy_minus_sign: | The suggested video quality bitrates to present to the user | |
|
|
| `transcoderVideoQualities` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `transcoderVideoResolutions` | *Optional\<Object>* | :heavy_minus_sign: | The suggested video resolutions to the above quality bitrates | |
|
|
| `updatedAt` | *Optional\<Long>* | :heavy_minus_sign: | N/A | |
|
|
| `updater` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `version` | *Optional\<String>* | :heavy_minus_sign: | N/A | |
|
|
| `voiceSearch` | *Optional\<Boolean>* | :heavy_minus_sign: | N/A | |
|
|
| `directory` | List\<[LibrarySectionsDirectory](../../models/shared/LibrarySectionsDirectory.md)> | :heavy_minus_sign: | N/A | | |