Overrides Methods

Manage content overrides for emergency alerts and priority content.

Overview

The Overrides Methods allow applications to temporarily override normal playlist flow to display priority content. This is commonly used for emergency alerts, special announcements, or time-sensitive information that must interrupt regular content.

Note: These methods are specific to applications running within Studio pages.

Importing

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

Methods

setOverride()

Activate a named override.

Signature:

async setOverride(name: string): Promise<boolean>

Parameters:

• name - Override identifier (string)

Returns: Promise<boolean> - true if successful

Example:

await overrides().setOverride('emergency-alert');

Throws: Error if operation fails

clearOverride()

Deactivate a named override.

Signature:

async clearOverride(name: string): Promise<boolean>

Parameters:

• name - Override identifier to clear

Returns: Promise<boolean> - true if successful

Example:

await overrides().clearOverride('emergency-alert');

Throws: Error if operation fails

Next Steps

• Playlist API - Control playlist navigation
• Storage API - Store override data
• Code Examples - Complete override system examples