eyevinn-continue-watching-api

Namespace

eyevinn-continue-watching-api

Description:
  • A user of a streaming service expects that they can pick up where they left on any of their devices. To handle that you would need to develop a service with endpoints for the application to write and read from. This open source cloud component take care of that and all you need is to have a Redis database running on Redis Cloud for example.

Author:
See:

Methods

(async, static) createEyevinnContinueWatchingApiInstance(context, body) → {EyevinnContinueWatchingApi}

Description:
  • Create a new Continue Watching Service instance

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

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

Open Source Cloud configuration context

body EyevinnContinueWatchingApiConfig

Service instance configuration

Returns:
  • Service instance
Type
EyevinnContinueWatchingApi

(async, static) getEyevinnContinueWatchingApiInstance(context, name) → {EyevinnContinueWatchingApi}

Description:
  • Get a Continue Watching Service instance

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

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

Open Source Cloud configuration context

name string

Name of the service to be retrieved

Returns:
  • Service instance
Type
EyevinnContinueWatchingApi

(async, static) removeEyevinnContinueWatchingApiInstance(context, name)

Description:
  • Remove a Continue Watching Service instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context

name string

Name of the service to be removed