bbc-brave

Namespace

bbc-brave

Description:
  • Brave is a Basic real-time (remote) audio/video editor. It allows LIVE video (and/or audio) to be received, manipulated, and sent elsewhere. Forwarding RTMP from one place to another, mixing two or more inputs or add basic graphics are some example of usage.

Author:
See:

Methods

(async, static) createBbcBraveInstance(context, body) → {BbcBrave}

Description:
  • Create a new Brave instance

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

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

Open Source Cloud configuration context

body BbcBraveConfig

Service instance configuration

Returns:
  • Service instance
Type
BbcBrave

(async, static) getBbcBraveInstance(context, name) → {BbcBrave}

Description:
  • Get a Brave instance

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

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

Open Source Cloud configuration context

name string

Name of the mixer to be retrieved

Returns:
  • Service instance
Type
BbcBrave

(async, static) removeBbcBraveInstance(context, name)

Description:
  • Remove a Brave instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the mixer to be removed