CallbackPlugin
Callback plugin
Simple plugin executing provided callback on processing results. Useful when, for example, application needs to show a message when no object is detected in camera’s field of view or pose is not optimal for virtual try on.
Extends
Section titled “Extends”Plugin<ResultT>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”ResultT
Section titled “ResultT”ResultT extends object = { }
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CallbackPlugin<
ResultT>(callback):CallbackPlugin<ResultT>
Constructor
Parameters
Section titled “Parameters”callback
Section titled “callback”(r) => void
Callback method
Returns
Section titled “Returns”CallbackPlugin<ResultT>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”callback()
Section titled “callback()”
protectedcallback: (r) =>void
Callback method
Parameters
Section titled “Parameters”ResultT
Returns
Section titled “Returns”void
loaded
Section titled “loaded”loaded:
boolean
Loaded state
Inherited from
Section titled “Inherited from”ordinal
Section titled “ordinal”ordinal:
number
Ordinal number
Inherited from
Section titled “Inherited from”renderer?
Section titled “renderer?”
protectedoptionalrenderer:Renderer<ResultT>
Renderer loaded the plugin
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Dispose video plugin
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”load()
Section titled “load()”load(
renderer):Promise<void>
Initialize plugin
Initializes resources/instances needed by plugin. Overridden by derived classes for particular task.
Parameters
Section titled “Parameters”renderer
Section titled “renderer”Renderer<ResultT>
Renderer this plugin is attached to
Returns
Section titled “Returns”Promise<void>
Promise resolving when initialization is finished
Inherited from
Section titled “Inherited from”setupCamera()
Section titled “setupCamera()”setupCamera(
ratio,angle):void
Set camera parameters
Could be overridden to adjust plugin’s pipeline.
Parameters
Section titled “Parameters”number
Aspect ration of input video
number
Vertical field of view in radians
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setupVideo()
Section titled “setupVideo()”setupVideo(
size):void
Set video size
Could be overridden to adjust plugin’s pipeline.
Parameters
Section titled “Parameters”Resolution of input video
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”unload()
Section titled “unload()”unload():
void
Reset plugin
Releases all resources/instances created in load(). Overridden by derived classes for particular task.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”update()
Section titled “update()”update(
result,stream):Promise<void>
Update
Override executes the callback on results of video processing.
Parameters
Section titled “Parameters”result
Section titled “result”ResultT
Results of video processing
stream
Section titled “stream”HTMLCanvasElement
Captured video frame
Returns
Section titled “Returns”Promise<void>
Promise resolving when update is finished