Interface: QueueHandlerMethods

Defined in: packages/media-session/src/queue-handler.ts:32

The surface withQueueHandling adds on top of a MediaHandler.

Properties

currentItem

readonly currentItem: NativeMediaItem | undefined;

Defined in: packages/media-session/src/queue-handler.ts:36

---

queue

readonly queue: readonly NativeMediaItem[];

Defined in: packages/media-session/src/queue-handler.ts:33

---

queueIndex

readonly queueIndex: number;

Defined in: packages/media-session/src/queue-handler.ts:35

Index of the item last handed to playQueueItem, or -1.

---

wrapAround

wrapAround: boolean;

Defined in: packages/media-session/src/queue-handler.ts:38

Whether skips wrap at the ends. Mutable — it is a user preference.

Methods

playQueueItem()

playQueueItem(item: NativeMediaItem, index: number): void | Promise<void>;

Defined in: packages/media-session/src/queue-handler.ts:55

Play item. The only thing a subclass has to write.

Called by skipToNext/skipToPrevious/skipToQueueItem after the index has already been resolved and stored.

Parameters

Parameter	Type
item	NativeMediaItem
index	number

Returns

void | Promise<void>

---

setQueue()

setQueue(items: NativeMediaItem[], startIndex?: number): void;

Defined in: packages/media-session/src/queue-handler.ts:47

Replace the queue and broadcast it.

Parameters

Parameter	Type	Description
items	NativeMediaItem[]	-
startIndex?	number	index to treat as current without playing it. Pass the index you are about to play, or leave it at -1 and call skipToQueueItem to start playback.

Returns

void