Files
plexgo/docs/models/components/librarysectionsmediacontainer.md

38 KiB
Raw Blame History

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 *string N/A
Offset *int64 The offset of where this container page starts among the total objects available. Also provided in the X-Plex-Container-Start header.
Size *int64 N/A
TotalSize *int64 The total size of objects available. Also provided in the X-Plex-Container-Total-Size header.
AllowCameraUpload *bool N/A
AllowChannelAccess *bool N/A
AllowMediaDeletion *bool N/A
AllowSharing *bool N/A
AllowSync *bool N/A
AllowTuners *bool N/A
BackgroundProcessing *bool N/A
Certificate *bool N/A
CompanionProxy *bool N/A
CountryCode *string N/A
Diagnostics *string N/A
EventStream *bool N/A
FriendlyName *string N/A
HubSearch *bool N/A
ItemClusters *bool N/A
Livetv *int64 N/A 7
MachineIdentifier any N/A 0123456789abcdef0123456789abcdef012345678
MediaProviders *bool N/A
Multiuser *bool N/A
MusicAnalysis *int64 N/A 2
MyPlex *bool N/A
MyPlexMappingState any N/A mapped
MyPlexSigninState any N/A ok
MyPlexSubscription *bool N/A
MyPlexUsername *string N/A
OfflineTranscode any N/A 1
OwnerFeatures *string A comma-separated list of features which are enabled for the server owner
Platform *string N/A
PlatformVersion *string N/A
PluginHost *bool N/A
PushNotifications *bool N/A
ReadOnlyLibraries *bool N/A
StreamingBrainABRVersion *int64 N/A
StreamingBrainVersion *int64 N/A
Sync *bool N/A
TranscoderActiveVideoSessions *int64 N/A
TranscoderAudio *bool N/A
TranscoderLyrics *bool N/A
TranscoderPhoto *bool N/A
TranscoderSubtitles *bool N/A
TranscoderVideo *bool N/A
TranscoderVideoBitrates any The suggested video quality bitrates to present to the user
TranscoderVideoQualities *string N/A
TranscoderVideoResolutions any The suggested video resolutions to the above quality bitrates
UpdatedAt *int64 N/A
Updater *bool N/A
Version *string N/A
VoiceSearch *bool N/A
Directory []components.LibrarySectionsDirectory N/A