plexjs/docs/models/operations/createplayqueuemediacontainer.md

CreatePlayQueueMediaContainer

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 { CreatePlayQueueMediaContainer } from "@lukehagar/plexjs/models/operations";

let value: CreatePlayQueueMediaContainer = {};

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.
playQueueID	number	➖	The ID of the play queue, which is used in subsequent requests.
playQueueLastAddedItemID	string	➖	Defines where the "Up Next" region starts
playQueueSelectedItemID	number	➖	The queue item ID of the currently selected item.
playQueueSelectedItemOffset	number	➖	The offset of the selected item in the play queue, from the beginning of the queue.
playQueueSelectedMetadataItemID	number	➖	The metadata item ID of the currently selected item (matches ratingKey attribute in metadata item if the media provider is a library).
playQueueShuffled	boolean	➖	Whether or not the queue is shuffled.
playQueueSourceURI	string	➖	The original URI used to create the play queue.
playQueueTotalCount	number	➖	The total number of items in the play queue.
playQueueVersion	number	➖	The version of the play queue. It increments every time a change is made to the play queue to assist clients in knowing when to refresh.