eyevinn-ograf-editor

Namespace

eyevinn-ograf-editor

Description:

  • Unleash stunning broadcast graphics effortlessly with OGraf Template Editor. Design professional templates using our intuitive drag-and-drop interface, real-time previews, and code customization. No graphic design skills required!

Author:
Copyright:
  • 2026 Eyevinn Technology AB

Methods

(async, static) createEyevinnOgrafEditorInstance(context, body) → {EyevinnOgrafEditor}

Description:

  • Create a new OGraf Template Editor instance

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

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

Open Source Cloud configuration context
body EyevinnOgrafEditorConfig

Service instance configuration
Returns:
  • Service instance
Type
EyevinnOgrafEditor

(async, static) getEyevinnOgrafEditorInstance(context, name) → {EyevinnOgrafEditor}

Description:

  • Get a OGraf Template Editor instance

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

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

Open Source Cloud configuration context
name string

Name of the ograf-editor to be retrieved
Returns:
  • Service instance
Type
EyevinnOgrafEditor

(async, static) removeEyevinnOgrafEditorInstance(context, name)

Description:

  • Remove a OGraf Template Editor instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the ograf-editor to be removed