eyevinn-preview-hls-service

Namespace

eyevinn-preview-hls-service

Description:

  • A service to generate a preview video (mp4) or an image (png) from an HLS stream

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createEyevinnPreviewHlsServiceInstance(context, body) → {EyevinnPreviewHlsService}

Description:

  • Create a new HLS Preview Generator instance

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

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

Open Source Cloud configuration context
body EyevinnPreviewHlsServiceConfig

Service instance configuration
Returns:
  • Service instance
Type
EyevinnPreviewHlsService

(async, static) getEyevinnPreviewHlsServiceInstance(context, name) → {EyevinnPreviewHlsService}

Description:

  • Get a HLS Preview Generator instance

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

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

Open Source Cloud configuration context
name string

Name of the preview-generator to be retrieved
Returns:
  • Service instance
Type
EyevinnPreviewHlsService

(async, static) removeEyevinnPreviewHlsServiceInstance(context, name)

Description:

  • Remove a HLS Preview Generator instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the preview-generator to be removed