Playlist Methods

Control Studio playlist navigation and timing.

Overview

The Playlist Methods allow applications embedded within Studio pages to control playlist navigation. Applications can advance to the next page, return to the previous page, or dynamically adjust the current page's display duration.

Note: These methods are specific to applications running within Studio pages. They're not available to root applications.

Importing

import { playlist } from '@telemetryos/sdk';

Methods

nextPage()

Advance to the next page in the playlist.

Signature:

async nextPage(): Promise<boolean>

Returns: Promise<boolean> - true if successful

Example:

// Move to next page after user interaction
button.addEventListener('click', async () => {
  await playlist().nextPage();
});

Throws: Error if operation fails

previousPage()

Return to the previous page in the playlist.

Signature:

async previousPage(): Promise<boolean>

Returns: Promise<boolean> - true if successful

Example:

// Go back to previous page
await playlist().previousPage();

Throws: Error if operation fails

setDuration()

Set the display duration for the current page.

Signature:

async setDuration(duration: number): Promise<boolean>

Parameters:

• duration - Duration in milliseconds

Returns: Promise<boolean> - true if successful

Example:

// Set page to display for 30 seconds
await playlist().setDuration(30000);

Throws: Error if operation fails

Next Steps

• Overrides API - Emergency alerts and content overrides
• Storage API - Persist navigation state
• Code Examples - Complete playlist control examples