Raydiant SDK

A JavaScript library for interacting with the Raydiant runtime.

Installation

NPM

npm install @raydiant/sdk
# or yarn
yarn install @raydiant/sdk

import { runtime, devTools } from '@raydiant/sdk';

CDN

<script src="https://cdn.raydiant.com/lib/[email protected]"></script>

const { runtime, devTools } = window.Raydiant;

Usage

// Send 'ready' event.
runtime.ready();

// Send 'complete' event.
runtime.complete();

// Send 'complete' event with error.
runtime.complete(new Error());

// Subscribe to the runtime's 'play' event.
const unsubscribe = runtime.subscribe('play', () => {
  // ...
});

Developer Tools

Use the built-in developer tools to simulate sending and receiving events in local development. When you open your app directly in the browser the dev tools are automatically enabled.

// Check if dev tools are enabled.
devTools.isEnabled();

// Simulate receiving 'play' from the playlist runtime.
devTools.play();

// Immediately call play again after complete, simulating a single presentation in the playlist.
devTools.play(true);

// Stop looping.
devTools.disableLoop();

Contributing

See CONTRIBUTING.md for instructions on how to contribute to the Raydiant SDK.