birme-stream-gfx

Namespace

birme-stream-gfx

Description:

  • Enhance your live streams with customizable countdowns and overlay slates! Choose from 10 stunning themes to create engaging visuals. Perfect for OBS Studio, making stream setup a breeze. Elevate your stream now!

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createBirmeStreamGfxInstance(context, body) → {BirmeStreamGfx}

Description:

  • Create a new Stream Graphics Generator instance

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

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

Open Source Cloud configuration context
body BirmeStreamGfxConfig

Service instance configuration
Returns:
  • Service instance
Type
BirmeStreamGfx

(async, static) getBirmeStreamGfxInstance(context, name) → {BirmeStreamGfx}

Description:

  • Get a Stream Graphics Generator instance

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

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

Open Source Cloud configuration context
name string

Name of the stream-gfx to be retrieved
Returns:
  • Service instance
Type
BirmeStreamGfx

(async, static) removeBirmeStreamGfxInstance(context, name)

Description:

  • Remove a Stream Graphics Generator instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the stream-gfx to be removed