eyevinn-function-probe

Namespace

eyevinn-function-probe

Description:

  • A serverless media function to obtain media information for a media file or media stream.

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createEyevinnFunctionProbeInstance(context, body) → {EyevinnFunctionProbe}

Description:

  • Create a new Media Probe instance

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

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

Open Source Cloud configuration context
body EyevinnFunctionProbeConfig

Service instance configuration
Returns:
  • Service instance
Type
EyevinnFunctionProbe

(async, static) getEyevinnFunctionProbeInstance(context, name) → {EyevinnFunctionProbe}

Description:

  • Get a Media Probe instance

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

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

Open Source Cloud configuration context
name string

Name of the probe to be retrieved
Returns:
  • Service instance
Type
EyevinnFunctionProbe

(async, static) removeEyevinnFunctionProbeInstance(context, name)

Description:

  • Remove a Media Probe instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the probe to be removed