plexjs/docs/models/shared/librarysectionsmediacontainer.md

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.

Example Usage

import { LibrarySectionsMediaContainer } from "@lukehagar/plexjs/models/shared";

let value: LibrarySectionsMediaContainer = {
  livetv: 7,
  machineIdentifier: "0123456789abcdef0123456789abcdef012345678",
  musicAnalysis: 2,
  myPlexMappingState: "mapped",
  myPlexSigninState: "ok",
  offlineTranscode: 1,
};

Fields

Field	Type	Required	Description	Example
identifier	string	➖	N/A
offset	number	➖	The offset of where this container page starts among the total objects available. Also provided in the X-Plex-Container-Start header.
size	number	➖	N/A
totalSize	number	➖	The total size of objects available. Also provided in the X-Plex-Container-Total-Size header.
allowCameraUpload	boolean	➖	N/A
allowChannelAccess	boolean	➖	N/A
allowMediaDeletion	boolean	➖	N/A
allowSharing	boolean	➖	N/A
allowSync	boolean	➖	N/A
allowTuners	boolean	➖	N/A
backgroundProcessing	boolean	➖	N/A
certificate	boolean	➖	N/A
companionProxy	boolean	➖	N/A
countryCode	string	➖	N/A
diagnostics	string	➖	N/A
eventStream	boolean	➖	N/A
friendlyName	string	➖	N/A
hubSearch	boolean	➖	N/A
itemClusters	boolean	➖	N/A
livetv	number	➖	N/A	7
machineIdentifier	any	➖	N/A	0123456789abcdef0123456789abcdef012345678
mediaProviders	boolean	➖	N/A
multiuser	boolean	➖	N/A
musicAnalysis	number	➖	N/A	2
myPlex	boolean	➖	N/A
myPlexMappingState	any	➖	N/A	mapped
myPlexSigninState	any	➖	N/A	ok
myPlexSubscription	boolean	➖	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	boolean	➖	N/A
pushNotifications	boolean	➖	N/A
readOnlyLibraries	boolean	➖	N/A
streamingBrainABRVersion	number	➖	N/A
streamingBrainVersion	number	➖	N/A
sync	boolean	➖	N/A
transcoderActiveVideoSessions	number	➖	N/A
transcoderAudio	boolean	➖	N/A
transcoderLyrics	boolean	➖	N/A
transcoderPhoto	boolean	➖	N/A
transcoderSubtitles	boolean	➖	N/A
transcoderVideo	boolean	➖	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	number	➖	N/A
updater	boolean	➖	N/A
version	string	➖	N/A
voiceSearch	boolean	➖	N/A
directory	shared.DirectoryResponse[]	➖	N/A