eyevinn-chaos-stream-proxy

Namespace

eyevinn-chaos-stream-proxy

Description:
  • Chaos Stream Proxy is an open-source tool designed to simulate network impairments in video streaming environments. It acts as a proxy between the client and the streaming server, allowing developers and QA engineers to introduce various network conditions such as latency, jitter, and packet loss to test and improve the resilience and performance of streaming applications. This tool is crucial for ensuring a smooth streaming experience under different network scenarios, making it an invaluable asset for optimizing video delivery in real-world conditions.

Author:
See:

Methods

(async, static) createEyevinnChaosStreamProxyInstance(context, body) → {EyevinnChaosStreamProxy}

Description:
  • Create a new Chaos Stream Proxy instance

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

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

Open Source Cloud configuration context

body EyevinnChaosStreamProxyConfig

Service instance configuration

Returns:
  • Service instance
Type
EyevinnChaosStreamProxy

(async, static) getEyevinnChaosStreamProxyInstance(context, name) → {EyevinnChaosStreamProxy}

Description:
  • Get a Chaos Stream Proxy instance

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

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

Open Source Cloud configuration context

name string

Name of the chaos-stream-proxy to be retrieved

Returns:
  • Service instance
Type
EyevinnChaosStreamProxy

(async, static) removeEyevinnChaosStreamProxyInstance(context, name)

Description:
  • Remove a Chaos Stream Proxy instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the chaos-stream-proxy to be removed