mirror of
https://github.com/LukeHagar/plexjs.git
synced 2025-12-06 12:37:46 +00:00
6.2 KiB
6.2 KiB
GetSectionsMediaContainer
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 { GetSectionsMediaContainer } from "@lukehagar/plexjs/models/operations";
import { MediaTypeString } from "@lukehagar/plexjs/models/shared";
let value: GetSectionsMediaContainer = {
directory: [
{
title: "Movies",
type: MediaTypeString.Movie,
contentChangedAt: 1556281940,
createdAt: 1556281940,
language: "<value>",
uuid: "e69655a2-ef48-4aba-bb19-d3cc3401e7d6",
scannedAt: 1556281940,
updatedAt: 1556281940,
},
],
};
Fields
| Field | Type | Required | Description |
|---|---|---|---|
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. |
allowSync |
boolean | ➖ | N/A |
directory |
shared.LibrarySection[] | ➖ | N/A |
title1 |
string | ➖ | Typically just "Plex Library" |