mirror of
https://github.com/LukeHagar/plexjava.git
synced 2025-12-06 12:37:47 +00:00
38 KiB
38 KiB
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> | ➖ | N/A | |
offset |
Optional<Long> | ➖ | The offset of where this container page starts among the total objects available. Also provided in the X-Plex-Container-Start header. |
|
size |
Optional<Long> | ➖ | N/A | |
totalSize |
Optional<Long> | ➖ | The total size of objects available. Also provided in the X-Plex-Container-Total-Size header. |
|
allowCameraUpload |
Optional<Boolean> | ➖ | N/A | |
allowChannelAccess |
Optional<Boolean> | ➖ | N/A | |
allowMediaDeletion |
Optional<Boolean> | ➖ | N/A | |
allowSharing |
Optional<Boolean> | ➖ | N/A | |
allowSync |
Optional<Boolean> | ➖ | N/A | |
allowTuners |
Optional<Boolean> | ➖ | N/A | |
backgroundProcessing |
Optional<Boolean> | ➖ | N/A | |
certificate |
Optional<Boolean> | ➖ | N/A | |
companionProxy |
Optional<Boolean> | ➖ | N/A | |
countryCode |
Optional<String> | ➖ | N/A | |
diagnostics |
Optional<String> | ➖ | N/A | |
eventStream |
Optional<Boolean> | ➖ | N/A | |
friendlyName |
Optional<String> | ➖ | N/A | |
hubSearch |
Optional<Boolean> | ➖ | N/A | |
itemClusters |
Optional<Boolean> | ➖ | N/A | |
livetv |
Optional<Long> | ➖ | N/A | 7 |
machineIdentifier |
Optional<Object> | ➖ | N/A | 0123456789abcdef0123456789abcdef012345678 |
mediaProviders |
Optional<Boolean> | ➖ | N/A | |
multiuser |
Optional<Boolean> | ➖ | N/A | |
musicAnalysis |
Optional<Long> | ➖ | N/A | 2 |
myPlex |
Optional<Boolean> | ➖ | N/A | |
myPlexMappingState |
Optional<Object> | ➖ | N/A | mapped |
myPlexSigninState |
Optional<Object> | ➖ | N/A | ok |
myPlexSubscription |
Optional<Boolean> | ➖ | N/A | |
myPlexUsername |
Optional<String> | ➖ | N/A | |
offlineTranscode |
Optional<Object> | ➖ | N/A | 1 |
ownerFeatures |
Optional<String> | ➖ | A comma-separated list of features which are enabled for the server owner | |
platform |
Optional<String> | ➖ | N/A | |
platformVersion |
Optional<String> | ➖ | N/A | |
pluginHost |
Optional<Boolean> | ➖ | N/A | |
pushNotifications |
Optional<Boolean> | ➖ | N/A | |
readOnlyLibraries |
Optional<Boolean> | ➖ | N/A | |
streamingBrainABRVersion |
Optional<Long> | ➖ | N/A | |
streamingBrainVersion |
Optional<Long> | ➖ | N/A | |
sync |
Optional<Boolean> | ➖ | N/A | |
transcoderActiveVideoSessions |
Optional<Long> | ➖ | N/A | |
transcoderAudio |
Optional<Boolean> | ➖ | N/A | |
transcoderLyrics |
Optional<Boolean> | ➖ | N/A | |
transcoderPhoto |
Optional<Boolean> | ➖ | N/A | |
transcoderSubtitles |
Optional<Boolean> | ➖ | N/A | |
transcoderVideo |
Optional<Boolean> | ➖ | N/A | |
transcoderVideoBitrates |
Optional<Object> | ➖ | The suggested video quality bitrates to present to the user | |
transcoderVideoQualities |
Optional<String> | ➖ | N/A | |
transcoderVideoResolutions |
Optional<Object> | ➖ | The suggested video resolutions to the above quality bitrates | |
updatedAt |
Optional<Long> | ➖ | N/A | |
updater |
Optional<Boolean> | ➖ | N/A | |
version |
Optional<String> | ➖ | N/A | |
voiceSearch |
Optional<Boolean> | ➖ | N/A | |
directory |
List<LibrarySectionsDirectory> | ➖ | N/A |