Class: CallbackPlugin<ResultT>

@geenee/bodyrenderers-common.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.

Type parameters

Name	Type
ResultT	extends Object =

Hierarchy

• Plugin<ResultT>

  ↳ CallbackPlugin

  ↳↳ PoseCallbackPlugin

  ↳↳ FaceCallbackPlugin

Constructors

constructor

• new CallbackPlugin<ResultT>(callback)

Constructor

Type parameters

Name	Type
ResultT	extends Object =

Parameters

Name	Type	Description
callback	(r: ResultT) => void	Callback method

Overrides

Plugin.constructor

Properties

callback

• Protected callback: (r: ResultT) => void

Type declaration

▸ (r): void

Callback method

Parameters

Name	Type
r	ResultT

Returns

void

---

loaded

• loaded: boolean

Loaded state

Inherited from

Plugin.loaded

---

ordinal

• ordinal: number

Ordinal number

Inherited from

Plugin.ordinal

---

renderer

• Protected Optional renderer: Renderer<ResultT>

Renderer loaded the plugin

Inherited from

Plugin.renderer

Methods

dispose

▸ dispose(): void

Dispose video plugin

Returns

void

Inherited from

Plugin.dispose

---

load

▸ load(renderer): Promise<void>

Initialize plugin

Initializes resources/instances needed by plugin. Overridden by derived classes for particular task.

Parameters

Name	Type	Description
renderer	Renderer<ResultT>	Renderer this plugin is attached to

Returns

Promise<void>

Promise resolving when initialization is finished

Inherited from

Plugin.load

---

setupCamera

▸ setupCamera(ratio, angle): void

Set camera parameters

Could be overridden to adjust plugin's pipeline.

Parameters

Name	Type	Description
ratio	number	Aspect ration of input video
angle	number	Vertical field of view in radians

Returns

void

Inherited from

Plugin.setupCamera

---

setupVideo

▸ setupVideo(size): void

Set video size

Could be overridden to adjust plugin's pipeline.

Parameters

Name	Type	Description
size	Size	Resolution of input video

Returns

void

Inherited from

Plugin.setupVideo

---

unload

▸ unload(): void

Reset plugin

Releases all resources/instances created in load(). Overridden by derived classes for particular task.

Returns

void

Inherited from

Plugin.unload

---

update

▸ update(result, stream): Promise<void>

Update

Override executes the callback on results of video processing.

Parameters

Name	Type	Description
result	ResultT	Results of video processing
stream	HTMLCanvasElement	Captured video frame

Returns

Promise<void>

Promise resolving when update is finished

Overrides

Plugin.update