eyevinn-smb-whip-bridge

Namespace

eyevinn-smb-whip-bridge

Description:

  • Elevate your video streaming with SMB WHIP Bridge! Seamlessly integrate WHIP clients with Symphony Media Bridge SFU for superior media streams.

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createEyevinnSmbWhipBridgeInstance(context, body) → {EyevinnSmbWhipBridge}

Description:

  • Create a new Symphony Media Bridge WHIP Gateway instance

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

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

Open Source Cloud configuration context
body EyevinnSmbWhipBridgeConfig

Service instance configuration
Returns:
  • Service instance
Type
EyevinnSmbWhipBridge

(async, static) getEyevinnSmbWhipBridgeInstance(context, name) → {EyevinnSmbWhipBridge}

Description:

  • Get a Symphony Media Bridge WHIP Gateway instance

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

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

Open Source Cloud configuration context
name string

Name of the gateway to be retrieved
Returns:
  • Service instance
Type
EyevinnSmbWhipBridge

(async, static) removeEyevinnSmbWhipBridgeInstance(context, name)

Description:

  • Remove a Symphony Media Bridge WHIP Gateway instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the gateway to be removed