owncast-owncast

Namespace

owncast-owncast

Description:
  • Revolutionize your live streaming experience with Owncast! Take control over your content, interface, and audience with this self-hosted, open-source platform. Explore the possibilities today.

Author:
See:

Methods

(async, static) createOwncastOwncastInstance(context, body) → {OwncastOwncast}

Description:
  • Create a new owncast instance

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

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

Open Source Cloud configuration context

body OwncastOwncastConfig

Service instance configuration

Returns:
  • Service instance
Type
OwncastOwncast

(async, static) getOwncastOwncastInstance(context, name) → {OwncastOwncast}

Description:
  • Get a owncast instance

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

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

Open Source Cloud configuration context

name string

Name of the owncast to be retrieved

Returns:
  • Service instance
Type
OwncastOwncast

(async, static) removeOwncastOwncastInstance(context, name)

Description:
  • Remove a owncast instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the owncast to be removed