Processor

Core generic processor

Processor is a computational core of any application and the most essential part of the Engine in an app’s pipeline. Processing results are used by Renderer to update scene. Every processor must define methods to initialize and release instances required for image processing, and evaluation of processing results on provided image (where all logic happens). Processor is a generic abstract class defining common API.

Extends

• EventEmitterT<ProcessorEvents>

Extended by

Type Parameters

• ResultT extends object = object

Type of processing results

• ParamsT extends ProcParams = ProcParams

Type of processor parameters

Constructors

new Processor()

new Processor<ResultT, ParamsT>(): Processor<ResultT, ParamsT>

Constructor

Returns

Processor<ResultT, ParamsT>

Overrides

EventEmitterT.constructor

Properties

cameraAngle

cameraAngle: number

Camera vertical angle in radians

---

cameraRatio

cameraRatio: number

Camera aspect ratio

---

optimalSize

optimalSize: number = 1024

Recommended maximum size of input

---

params

protected params: Partial<ParamsT> = {}

Processor parameters

---

videoRatio

protected videoRatio: number

Aspect ratio of input video

---

videoSize

protected videoSize: Size

Resolution of input video

Methods

addListener()

addListener<E>(event, listener): this

Adds the listener function to the end of the listeners array

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

• listener: ProcessorEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

EventEmitterT.addListener

---

dispose()

dispose(): void

Dispose processor object

Releases resources and instances allocated by processor. Processor object cannot be used after calling dispose(). Overridden by derived classes for particular processing.

Returns

void

---

emit()

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

Synchronously calls each of the listeners registered for the event

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

• …args: Args<ProcessorEvents[E]>

Arguments passed to the listeners

Returns

boolean

True if the event had listeners, False otherwise

Inherited from

EventEmitterT.emit

---

eventNames()

eventNames(): (string | symbol)[]

List of emitter’s events

Returns

(string | symbol)[]

List of emitter’s events

Inherited from

EventEmitterT.eventNames

---

getMaxListeners()

getMaxListeners(): number

Maximum number of listeners per event

Returns

number

Maximum number of listeners per event

Inherited from

EventEmitterT.getMaxListeners

---

init()

init(params, size?, ratio?): Promise<boolean>

Initialize processor

Initializes all resources required for video processing. Overridden by derived classes for particular application.

Parameters

• params: ParamsT

Processor parameters

• size?: Size

Resolution of input video

• ratio?: number

Aspect ration of input video

Returns

Promise<boolean>

Status of initialization

---

listenerCount()

listenerCount<E>(event): number

The number of listeners listening to the event

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

Returns

number

Number of listeners

Inherited from

EventEmitterT.listenerCount

---

listeners()

listeners<E>(event): Function[]

Copy of the array of listeners for the event

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

EventEmitterT.listeners

---

off()

off<E>(event, listener): this

Removes the listener from the listener array for the event

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

• listener: ProcessorEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

EventEmitterT.off

---

on()

on<E>(event, listener): this

Adds the listener function to the event

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

• listener: ProcessorEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

EventEmitterT.on

---

once()

once<E>(event, listener): this

Adds a one-time listener function for the event

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

• listener: ProcessorEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

EventEmitterT.once

---

prependListener()

prependListener<E>(event, listener): this

Adds the listener function to the beginning of the listeners array

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

• listener: ProcessorEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

EventEmitterT.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 ProcessorEvents

Parameters

• event: E

The name of the event

• listener: ProcessorEvents[E]

The callback function

Returns

this

Inherited from

EventEmitterT.prependOnceListener

---

process()

process(input, timestamp?): Promise<ResultT>

Process the image

Main method defining the logic of video processing. Overridden by derived classes for particular application.

Parameters

• input: ImageInput

Image

• timestamp?: number

Timestamp

Returns

Promise<ResultT>

---

rawListeners()

rawListeners<E>(event): Function[]

Copy of the array of listeners for the event including wrappers

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

EventEmitterT.rawListeners

---

removeAllListeners()

removeAllListeners<E>(event?): this

Removes all listeners, or those of the specified event

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event?: E

The name of the event

Returns

this

This EventEmitter

Inherited from

EventEmitterT.removeAllListeners

---

removeListener()

removeListener<E>(event, listener): this

Removes the specified listener from the listener array

Type Parameters

• E extends keyof ProcessorEvents

Parameters

• event: E

The name of the event

• listener: ProcessorEvents[E]

The callback function

Returns

this

This EventEmitter

Inherited from

EventEmitterT.removeListener

---

reset()

reset(): void

Reset processor

Resets all processing instances to the initial state. Overridden by derived classes for particular processing.

Returns

void

---

setMaxListeners()

setMaxListeners(n): this

Sets maximum number of listeners per event

Parameters

• n: number

Maximum number of listeners

Returns

this

This EventEmitter

Inherited from

EventEmitterT.setMaxListeners

---

setupVideo()

setupVideo(size, ratio?): void

Set resolution of the input video

Could be overridden to adjust processing pipeline.

Parameters

• size: Size

Resolution of input video

• ratio?: number

Aspect ration of input video

Returns

void