superflytv-ograf-server

Namespace

superflytv-ograf-server

Description:
  • Elevate your live production with OGraf! Seamlessly render, upload, and control graphics across platforms like OBS and Vmix with ease. Streamline workflows with our intuitive web server and controller.

Author:

Methods

(async, static) createSuperflytvOgrafServerInstance(context, body) → {SuperflytvOgrafServer}

Description:
  • Create a new OGraf Rendering Server instance

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

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

Open Source Cloud configuration context

body SuperflytvOgrafServerConfig

Service instance configuration

Returns:
  • Service instance
Type
SuperflytvOgrafServer

(async, static) getSuperflytvOgrafServerInstance(context, name) → {SuperflytvOgrafServer}

Description:
  • Get a OGraf Rendering Server instance

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

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

Open Source Cloud configuration context

name string

Name of the server to be retrieved

Returns:
  • Service instance
Type
SuperflytvOgrafServer

(async, static) removeSuperflytvOgrafServerInstance(context, name)

Description:
  • Remove a OGraf Rendering Server instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the server to be removed