@tritondigitaldev/omny-player-sdk-js

The Omny Player SDK for JavaScript is a package that provides:

• a HTML-compatible audio player with consumption analytics built-in
• abstractions to handle playing individual clips, or multiple clips in a playlist
• a simple and type-safe way of accessing the consumer API to fetch metadata about programs, playlists and clips

Installation

npm install @tritondigitaldev/omny-player-sdk-js

# or

yarn add @tritondigitaldev/omny-player-sdk-js

Usage example

import { OmnyPlayer, OmnyConsumerApi } from '@tritondigitaldev/omny-player-sdk-js';

const player = new OmnyPlayer({ consumptionSource: 'Web' });
const api = new OmnyConsumerApi({ organizationId: '<organization-id-here>' });
let clipPlayer;

async function load() {
    const clipResponse = await api.getClipById({
        clipId: '<clip-id-here>',
    });

    if (!clipResponse.success) {
        console.error('Error loading clip');
        return;
    }

    const { payload: clip } = clipResponse;
    clipPlayer = player.createClipPlayer({ clip, preferredMediaType: 'audio' });
    clipPlayer.play();
}

// If you no longer need the player instance, you can call destroy to stop the media playback and have all callbacks cleared.
clipPlayer.destroy();

If using the UMD bundle, use the Omny prefix. For example:

const player = new Omny.OmnyPlayer({ consumptionSource: 'Web' });
const api = new Omny.OmnyConsumerApi({ organizationId: '<organization-id-here>' });