MaskEngine

Mask engine

Specialization of @geenee/armature!Engine for MaskProcessor. Straightforward wrapper, instead of new Engine(MaskProcessor, ...) you can use simpler const engine = new MaskEngine(...}).

Extends

Engine<MaskResult, MaskParams, MaskProcessor>

Constructors

new MaskEngine()

new MaskEngine(engineParams?, Source?): MaskEngine

Constructor

Parameters

• engineParams?: EngineParams

Parameters of the engine

• Source? = VideoCapture

Video source class or instance

Returns

MaskEngine

Overrides

Engine.constructor

Properties

engineParams?

protected optional engineParams: EngineParams

Parameters of the engine

Inherited from

Engine.engineParams

init()

init: (procParams) => Promise<boolean>

Initialize engine. Sets up processor.

The SDK access token is required parameter that authenticates the user and enables the SDK on the current url. By default, path to required wasm modules provided with SDK packages is the current url. You can change the root path to wasms passing root parameter.

Parameters

• procParams: MaskParams

Parameters of the processor

Returns

Promise<boolean>

Status of initialization

Inherited from

Engine.init

iterate()

protected iterate: () => Promise<void>

Iterate

Returns

Promise<void>

Inherited from

Engine.iterate

pause()

pause: () => void

Pause pipeline.

Nothing happens if pipeline is not started yet.

Returns

void

Inherited from

Engine.pause

processCanvas?

protected optional processCanvas: HTMLCanvasElement

Shallow copy of canvas with video for processors

Inherited from

Engine.processCanvas

processor

protected processor: MaskProcessor

Processor utilized by the engine

Inherited from

Engine.processor

processSize

protected processSize: Size

Size of video for processors

Inherited from

Engine.processSize

renderers

protected renderers: Renderer<MaskResult>[]

Renderer attached to the engine

Inherited from

Engine.renderers

reset()

reset: () => void

Reset pipeline

Stops pipeline, resets video capture and processor. After reset one needs to reinitialize video capture calling setup() before pipeline can be started again.

Returns

void

Inherited from

Engine.reset

resizeBuffer?

protected optional resizeBuffer: ImageBuffer

Buffer to resize frames

Inherited from

Engine.resizeBuffer

resizeEnabled

protected resizeEnabled: boolean

Original stream is resized

Inherited from

Engine.resizeEnabled

setup()

setup: (videoParams?) => Promise<boolean>

Setup engine. Initializes video capture.

Video capture can be setup by simplified VideoParams opening default front/rear camera with provided resolution, custom MediaStreamConstraints providing the most flexible way to setup video stream (e.g. set deviceId), or external MediaStream allowing custom video sources (e.g. from file).

Parameters

• videoParams?: VideoSourceParams

Parameters of video capture

Returns

Promise<boolean>

Status of initialization

Inherited from

Engine.setup

start()

start: () => Promise<void>

Start pipeline.

Pipeline can be started only after successful init and setup.

Returns

Promise<void>

Inherited from

Engine.start

streamCanvas?

protected optional streamCanvas: HTMLCanvasElement

Shallow copy of canvas with video for renderers

Inherited from

Engine.streamCanvas

streamSize

protected streamSize: Size

Size of video for renderers

Inherited from

Engine.streamSize

video

protected video: VideoSource

Video source instance

Inherited from

Engine.video

videoRatio

protected videoRatio: number

Ratio of video stream

Inherited from

Engine.videoRatio

Methods

addListener()

addListener<E>(event, listener): this

Adds the listener function to the end of the listeners array

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• listener: EngineEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

Engine.addListener

addRenderer()

addRenderer(renderer): Promise<void>

Attach Renderer to the engine

Parameters

• renderer: Renderer<MaskResult>

Object to be attached

Returns

Promise<void>

Inherited from

Engine.addRenderer

emit()

emit<E>(event, …args): boolean

Synchronously calls each of the listeners registered for the event

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• …args: Args<EngineEvents[E]>

Arguments passed to the listeners

Returns

boolean

True if the event had listeners, False otherwise

Inherited from

Engine.emit

enqueue()

protected enqueue(): void

Enqueue the next iteration

Returns

void

Inherited from

Engine.enqueue

eventNames()

eventNames(): (string | symbol)[]

List of emitter’s events

Returns

(string | symbol)[]

List of emitter’s events

Inherited from

Engine.eventNames

getMaxListeners()

getMaxListeners(): number

Maximum number of listeners per event

Returns

number

Maximum number of listeners per event

Inherited from

Engine.getMaxListeners

listenerCount()

listenerCount<E>(event): number

The number of listeners listening to the event

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

Returns

number

Number of listeners

Inherited from

Engine.listenerCount

listeners()

listeners<E>(event): Function[]

Copy of the array of listeners for the event

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

Engine.listeners

off()

off<E>(event, listener): this

Removes the listener from the listener array for the event

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• listener: EngineEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

Engine.off

on()

on<E>(event, listener): this

Adds the listener function to the event

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• listener: EngineEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

Engine.on

once()

once<E>(event, listener): this

Adds a one-time listener function for the event

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• listener: EngineEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

Engine.once

prependListener()

prependListener<E>(event, listener): this

Adds the listener function to the beginning of the listeners array

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• listener: EngineEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

Engine.prependListener

prependOnceListener()

prependOnceListener<E>(event, listener): this

Adds a one-time listener function to the beginning of the listeners array

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• listener: EngineEvents[E]

The callback function

Returns

this

Inherited from

Engine.prependOnceListener

rawListeners()

rawListeners<E>(event): Function[]

Copy of the array of listeners for the event including wrappers

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

Engine.rawListeners

removeAllListeners()

removeAllListeners<E>(event?): this

Removes all listeners, or those of the specified event

Type Parameters

• E extends keyof EngineEvents

Parameters

• event?: E

The name of the event

Returns

this

This EventEmitter

Inherited from

Engine.removeAllListeners

removeListener()

removeListener<E>(event, listener): this

Removes the specified listener from the listener array

Type Parameters

• E extends keyof EngineEvents

Parameters

• event: E

The name of the event

• listener: EngineEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

Engine.removeListener

removeRenderer()

removeRenderer(renderer): void

Remove attached Renderer

Parameters

• renderer: Renderer<MaskResult>

Renderer to be removed

Returns

void

Inherited from

Engine.removeRenderer

resizeVideo()

protected resizeVideo(size): void

Callback called when video resolution is changed

Parameters

• size: Size

Size of the video

Returns

void

Inherited from

Engine.resizeVideo

setMaxListeners()

setMaxListeners(n): this

Sets maximum number of listeners per event

Parameters

• n: number

Maximum number of listeners

Returns

this

This EventEmitter

Inherited from

Engine.setMaxListeners

setupProcessor()

protected setupProcessor(procParams): Promise<boolean>

Setup processor

Parameters

• procParams: MaskParams

Returns

Promise<boolean>

Inherited from

Engine.setupProcessor

setupSize()

protected setupSize(size): Promise<void>

Setup video size

Parameters

• size: Size

Returns

Promise<void>

Inherited from

Engine.setupSize

setupVideo()

protected setupVideo(videoParams?): Promise<boolean>

Setup video capture

Parameters

• videoParams?: VideoSourceParams

Returns

Promise<boolean>

Inherited from

Engine.setupVideo