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
Section titled “Extends”EventEmitterT<ProcessorEvents>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”ResultT
Section titled “ResultT”ResultT extends object = { }
Type of processing results
ParamsT
Section titled “ParamsT”ParamsT extends ProcParams = ProcParams
Type of processor parameters
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Processor<
ResultT,ParamsT>():Processor<ResultT,ParamsT>
Constructor
Returns
Section titled “Returns”Processor<ResultT, ParamsT>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”cameraAngle
Section titled “cameraAngle”cameraAngle:
number
Camera vertical angle in radians
cameraRatio
Section titled “cameraRatio”cameraRatio:
number
Camera aspect ratio
optimalSize
Section titled “optimalSize”optimalSize:
number=1024
Recommended maximum size of input
params
Section titled “params”
protectedparams:Partial<ParamsT> ={}
Processor parameters
videoRatio
Section titled “videoRatio”
protectedvideoRatio:number
Aspect ratio of input video
videoSize
Section titled “videoSize”
protectedvideoSize:Size
Resolution of input video
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener<
E>(event,listener):this
Adds the listener function to the end of the listeners array
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
listener
Section titled “listener”ProcessorEvents[E]
The callback function
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”dispose()
Section titled “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
Section titled “Returns”void
emit()
Section titled “emit()”emit<
E>(event, …args):boolean
Synchronously calls each of the listeners registered for the event
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
…Args<ProcessorEvents[E]>
Arguments passed to the listeners
Returns
Section titled “Returns”boolean
True if the event had listeners, False otherwise
Inherited from
Section titled “Inherited from”eventNames()
Section titled “eventNames()”eventNames(): (
string|symbol)[]
List of emitter’s events
Returns
Section titled “Returns”(string | symbol)[]
List of emitter’s events
Inherited from
Section titled “Inherited from”getMaxListeners()
Section titled “getMaxListeners()”getMaxListeners():
number
Maximum number of listeners per event
Returns
Section titled “Returns”number
Maximum number of listeners per event
Inherited from
Section titled “Inherited from”init()
Section titled “init()”init(
params,size?,ratio?):Promise<boolean>
Initialize processor
Initializes all resources required for video processing. Overridden by derived classes for particular application.
Parameters
Section titled “Parameters”params
Section titled “params”ParamsT
Processor parameters
Resolution of input video
ratio?
Section titled “ratio?”number
Aspect ration of input video
Returns
Section titled “Returns”Promise<boolean>
Status of initialization
listenerCount()
Section titled “listenerCount()”listenerCount<
E>(event):number
The number of listeners listening to the event
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
Returns
Section titled “Returns”number
Number of listeners
Inherited from
Section titled “Inherited from”listeners()
Section titled “listeners()”listeners<
E>(event):Function[]
Copy of the array of listeners for the event
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
Returns
Section titled “Returns”Function[]
Copy of the listeners array
Inherited from
Section titled “Inherited from”off<
E>(event,listener):this
Removes the listener from the listener array for the event
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
listener
Section titled “listener”ProcessorEvents[E]
The callback function
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”on<
E>(event,listener):this
Adds the listener function to the event
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
listener
Section titled “listener”ProcessorEvents[E]
The callback function
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”once()
Section titled “once()”once<
E>(event,listener):this
Adds a one-time listener function for the event
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
listener
Section titled “listener”ProcessorEvents[E]
The callback function
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”prependListener()
Section titled “prependListener()”prependListener<
E>(event,listener):this
Adds the listener function to the beginning of the listeners array
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
listener
Section titled “listener”ProcessorEvents[E]
The callback function
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”prependOnceListener()
Section titled “prependOnceListener()”prependOnceListener<
E>(event,listener):this
Adds a one-time listener function to the beginning of the listeners array
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
listener
Section titled “listener”ProcessorEvents[E]
The callback function
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitterT.prependOnceListener
process()
Section titled “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
Section titled “Parameters”Image
timestamp?
Section titled “timestamp?”number
Timestamp
Returns
Section titled “Returns”Promise<ResultT>
rawListeners()
Section titled “rawListeners()”rawListeners<
E>(event):Function[]
Copy of the array of listeners for the event including wrappers
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
Returns
Section titled “Returns”Function[]
Copy of the listeners array
Inherited from
Section titled “Inherited from”removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners<
E>(event?):this
Removes all listeners, or those of the specified event
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”event?
Section titled “event?”E
The name of the event
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”EventEmitterT.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener<
E>(event,listener):this
Removes the specified listener from the listener array
Type Parameters
Section titled “Type Parameters”E extends keyof ProcessorEvents
Parameters
Section titled “Parameters”E
The name of the event
listener
Section titled “listener”ProcessorEvents[E]
The callback function
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”reset()
Section titled “reset()”reset():
void
Reset processor
Resets all processing instances to the initial state. Overridden by derived classes for particular processing.
Returns
Section titled “Returns”void
setMaxListeners()
Section titled “setMaxListeners()”setMaxListeners(
n):this
Sets maximum number of listeners per event
Parameters
Section titled “Parameters”number
Maximum number of listeners
Returns
Section titled “Returns”this
This EventEmitter
Inherited from
Section titled “Inherited from”setupVideo()
Section titled “setupVideo()”setupVideo(
size,ratio?):void
Set resolution of the input video
Could be overridden to adjust processing pipeline.
Parameters
Section titled “Parameters”Resolution of input video
ratio?
Section titled “ratio?”number
Aspect ration of input video
Returns
Section titled “Returns”void