mirror of
https://github.com/LukeHagar/plexpy.git
synced 2025-12-06 12:47:44 +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[str] | ➖ | N/A | |
offset |
Optional[int] | ➖ | The offset of where this container page starts among the total objects available. Also provided in the X-Plex-Container-Start header. |
|
size |
Optional[int] | ➖ | N/A | |
total_size |
Optional[int] | ➖ | The total size of objects available. Also provided in the X-Plex-Container-Total-Size header. |
|
allow_camera_upload |
Optional[bool] | ➖ | N/A | |
allow_channel_access |
Optional[bool] | ➖ | N/A | |
allow_media_deletion |
Optional[bool] | ➖ | N/A | |
allow_sharing |
Optional[bool] | ➖ | N/A | |
allow_sync |
Optional[bool] | ➖ | N/A | |
allow_tuners |
Optional[bool] | ➖ | N/A | |
background_processing |
Optional[bool] | ➖ | N/A | |
certificate |
Optional[bool] | ➖ | N/A | |
companion_proxy |
Optional[bool] | ➖ | N/A | |
country_code |
Optional[str] | ➖ | N/A | |
diagnostics |
Optional[str] | ➖ | N/A | |
event_stream |
Optional[bool] | ➖ | N/A | |
friendly_name |
Optional[str] | ➖ | N/A | |
hub_search |
Optional[bool] | ➖ | N/A | |
item_clusters |
Optional[bool] | ➖ | N/A | |
livetv |
Optional[int] | ➖ | N/A | 7 |
machine_identifier |
Optional[Any] | ➖ | N/A | 0123456789abcdef0123456789abcdef012345678 |
media_providers |
Optional[bool] | ➖ | N/A | |
multiuser |
Optional[bool] | ➖ | N/A | |
music_analysis |
Optional[int] | ➖ | N/A | 2 |
my_plex |
Optional[bool] | ➖ | N/A | |
my_plex_mapping_state |
Optional[Any] | ➖ | N/A | mapped |
my_plex_signin_state |
Optional[Any] | ➖ | N/A | ok |
my_plex_subscription |
Optional[bool] | ➖ | N/A | |
my_plex_username |
Optional[str] | ➖ | N/A | |
offline_transcode |
Optional[Any] | ➖ | N/A | 1 |
owner_features |
Optional[str] | ➖ | A comma-separated list of features which are enabled for the server owner | |
platform |
Optional[str] | ➖ | N/A | |
platform_version |
Optional[str] | ➖ | N/A | |
plugin_host |
Optional[bool] | ➖ | N/A | |
push_notifications |
Optional[bool] | ➖ | N/A | |
read_only_libraries |
Optional[bool] | ➖ | N/A | |
streaming_brain_abr_version |
Optional[int] | ➖ | N/A | |
streaming_brain_version |
Optional[int] | ➖ | N/A | |
sync |
Optional[bool] | ➖ | N/A | |
transcoder_active_video_sessions |
Optional[int] | ➖ | N/A | |
transcoder_audio |
Optional[bool] | ➖ | N/A | |
transcoder_lyrics |
Optional[bool] | ➖ | N/A | |
transcoder_photo |
Optional[bool] | ➖ | N/A | |
transcoder_subtitles |
Optional[bool] | ➖ | N/A | |
transcoder_video |
Optional[bool] | ➖ | N/A | |
transcoder_video_bitrates |
Optional[Any] | ➖ | The suggested video quality bitrates to present to the user | |
transcoder_video_qualities |
Optional[str] | ➖ | N/A | |
transcoder_video_resolutions |
Optional[Any] | ➖ | The suggested video resolutions to the above quality bitrates | |
updated_at |
Optional[int] | ➖ | N/A | |
updater |
Optional[bool] | ➖ | N/A | |
version |
Optional[str] | ➖ | N/A | |
voice_search |
Optional[bool] | ➖ | N/A | |
directory |
List[components.LibrarySectionsDirectory] | ➖ | N/A |