eyevinn-open-live

Namespace

eyevinn-open-live

Description:
  • Supercharge your broadcast productions with Open Live's central API server. Built with cutting-edge tech, streamline workflows, activate productions swiftly, and manage sources seamlessly. Elevate now!

Author:
See:

Methods

(async, static) createEyevinnOpenLiveInstance(context, body) → {EyevinnOpenLive}

Description:
  • Create a new Open Live instance

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

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

Open Source Cloud configuration context

body EyevinnOpenLiveConfig

Service instance configuration

Returns:
  • Service instance
Type
EyevinnOpenLive

(async, static) getEyevinnOpenLiveInstance(context, name) → {EyevinnOpenLive}

Description:
  • Get a Open Live instance

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

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

Open Source Cloud configuration context

name string

Name of the open-live to be retrieved

Returns:
  • Service instance
Type
EyevinnOpenLive

(async, static) removeEyevinnOpenLiveInstance(context, name)

Description:
  • Remove a Open Live instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the open-live to be removed