birme-playout-ui

Namespace

birme-playout-ui

Description:
  • Elevate your media scheduling with Playout UI! Seamlessly manage playlists with live time display, real-time progress tracking, and backend flexibility. Effortlessly organize, edit, and control playback. Ideal for dynamic environments!

Author:

Methods

(async, static) createBirmePlayoutUiInstance(context, body) → {BirmePlayoutUi}

Description:
  • Create a new Playout UI instance

Example
import { Context } from '@osaas/client-core';
import { createBirmePlayoutUiInstance } from '@osaas/client-services';

const ctx = new Context();
const body: BirmePlayoutUiConfig = { name: 'myinstance', ... };
const instance = await createBirmePlayoutUiInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

body BirmePlayoutUiConfig

Service instance configuration

Returns:
  • Service instance
Type
BirmePlayoutUi

(async, static) getBirmePlayoutUiInstance(context, name) → {BirmePlayoutUi}

Description:
  • Get a Playout UI instance

Example
import { Context } from '@osaas/client-core';
import { getBirmePlayoutUiInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getBirmePlayoutUiInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the playout-ui to be retrieved

Returns:
  • Service instance
Type
BirmePlayoutUi

(async, static) removeBirmePlayoutUiInstance(context, name)

Description:
  • Remove a Playout UI instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the playout-ui to be removed