tuomoku-spx-gc

Namespace

tuomoku-spx-gc

Description:
  • Elevate your live productions with SPX Graphics Controller! Seamlessly manage HTML graphics across platforms like OBS, vMix, and more. Ideal for stunning live streams and broadcasts with powerful customization.

Author:

Methods

(async, static) createTuomokuSpxGcInstance(context, body) → {TuomokuSpxGc}

Description:
  • Create a new SPX Graphics Controller instance

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

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

Open Source Cloud configuration context

body TuomokuSpxGcConfig

Service instance configuration

Returns:
  • Service instance
Type
TuomokuSpxGc

(async, static) getTuomokuSpxGcInstance(context, name) → {TuomokuSpxGc}

Description:
  • Get a SPX Graphics Controller instance

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

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

Open Source Cloud configuration context

name string

Name of the controller to be retrieved

Returns:
  • Service instance
Type
TuomokuSpxGc

(async, static) removeTuomokuSpxGcInstance(context, name)

Description:
  • Remove a SPX Graphics Controller instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the controller to be removed