Class: PoseCallbackPlugin

@geenee/bodyrenderers-common.PoseCallbackPlugin

Callback plugin for pose detection

Specialization of CallbackPlugin for pose detection results.

Hierarchy

• CallbackPlugin<PoseResult>

  ↳ PoseCallbackPlugin

Constructors

constructor

• new PoseCallbackPlugin(callback)

Constructor

Parameters

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

Inherited from

CallbackPlugin.constructor

Properties

callback

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

Type declaration

▸ (r): void

Callback method

Parameters

Name	Type
r	PoseResult

Returns

void

Inherited from

CallbackPlugin.callback

---

loaded

• loaded: boolean

Loaded state

Inherited from

CallbackPlugin.loaded

---

ordinal

• ordinal: number

Ordinal number

Inherited from

CallbackPlugin.ordinal

---

renderer

• Protected Optional renderer: Renderer<PoseResult>

Renderer loaded the plugin

Inherited from

CallbackPlugin.renderer

Methods

dispose

▸ dispose(): void

Dispose video plugin

Returns

void

Inherited from

CallbackPlugin.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<PoseResult>	Renderer this plugin is attached to

Returns

Promise<void>

Promise resolving when initialization is finished

Inherited from

CallbackPlugin.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

CallbackPlugin.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

CallbackPlugin.setupVideo

---

unload

▸ unload(): void

Reset plugin

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

Returns

void

Inherited from

CallbackPlugin.unload

---

update

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

Update

Override executes the callback on results of video processing.

Parameters

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

Returns

Promise<void>

Promise resolving when update is finished

Inherited from

CallbackPlugin.update