mirror of
https://github.com/LukeHagar/plexcsharp.git
synced 2025-12-06 04:20:46 +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` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `Offset` | *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` | *long* | :heavy_minus_sign: | N/A | |
|
|
| `TotalSize` | *long* | :heavy_minus_sign: | The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header.<br/> | |
|
|
| `AllowCameraUpload` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `AllowChannelAccess` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `AllowMediaDeletion` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `AllowSharing` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `AllowSync` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `AllowTuners` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `BackgroundProcessing` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `Certificate` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `CompanionProxy` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `CountryCode` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `Diagnostics` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `EventStream` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `FriendlyName` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `HubSearch` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `ItemClusters` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `Livetv` | *long* | :heavy_minus_sign: | N/A | 7 |
|
|
| `MachineIdentifier` | *object* | :heavy_minus_sign: | N/A | 0123456789abcdef0123456789abcdef012345678 |
|
|
| `MediaProviders` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `Multiuser` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `MusicAnalysis` | *long* | :heavy_minus_sign: | N/A | 2 |
|
|
| `MyPlex` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `MyPlexMappingState` | *object* | :heavy_minus_sign: | N/A | mapped |
|
|
| `MyPlexSigninState` | *object* | :heavy_minus_sign: | N/A | ok |
|
|
| `MyPlexSubscription` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `MyPlexUsername` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `OfflineTranscode` | *object* | :heavy_minus_sign: | N/A | 1 |
|
|
| `OwnerFeatures` | *string* | :heavy_minus_sign: | A comma-separated list of features which are enabled for the server owner | |
|
|
| `Platform` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `PlatformVersion` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `PluginHost` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `PushNotifications` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `ReadOnlyLibraries` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `StreamingBrainABRVersion` | *long* | :heavy_minus_sign: | N/A | |
|
|
| `StreamingBrainVersion` | *long* | :heavy_minus_sign: | N/A | |
|
|
| `Sync` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderActiveVideoSessions` | *long* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderAudio` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderLyrics` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderPhoto` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderSubtitles` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderVideo` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderVideoBitrates` | *object* | :heavy_minus_sign: | The suggested video quality bitrates to present to the user | |
|
|
| `TranscoderVideoQualities` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `TranscoderVideoResolutions` | *object* | :heavy_minus_sign: | The suggested video resolutions to the above quality bitrates | |
|
|
| `UpdatedAt` | *long* | :heavy_minus_sign: | N/A | |
|
|
| `Updater` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `Version` | *string* | :heavy_minus_sign: | N/A | |
|
|
| `VoiceSearch` | *bool* | :heavy_minus_sign: | N/A | |
|
|
| `Directory` | List<[LibrarySectionsDirectory](../../Models/Components/LibrarySectionsDirectory.md)> | :heavy_minus_sign: | N/A | | |