Class: VideoRenderer<ResultT>

@geenee/armature.VideoRenderer

Generic video renderer

VideoRenderer is based on CanvasRenderer and uses two canvas layers: one for video stream and another to render 3D scene on top of it. This usage pattern is the easiest to implement, but more limited as video is not embedded into the scene and e.g. renderer's postprocess effects or advanced techniques can't be applied to video.

Type parameters

Name	Type	Description
ResultT	extends Object = {}	Type of processing results

Hierarchy

• CanvasRenderer<ResultT>

  ↳ VideoRenderer

  ↳↳ SceneRenderer

Constructors

constructor

• new VideoRenderer<ResultT>(params)

Constructor

Type parameters

Name	Type
ResultT	extends Object = {}

Parameters

Name	Type	Description
params	CanvasParams	Parameters of responsive canvas

Overrides

CanvasRenderer.constructor

Properties

cameraAngle

• Protected cameraAngle: number

Camera vertical angle in radians

Inherited from

CanvasRenderer.cameraAngle

---

cameraRatio

• Protected cameraRatio: number

Camera aspect ratio

Inherited from

CanvasRenderer.cameraRatio

---

canvas

• canvas: ResponsiveCanvas

Responsive canvas

Inherited from

CanvasRenderer.canvas

---

loaded

• Protected loaded: boolean = false

Loaded state

Inherited from

CanvasRenderer.loaded

---

padCtx

• Protected padCtx: [null | CanvasRenderingContext2D, null | CanvasRenderingContext2D]

Drawing context of padding canvases

---

videoCtx

• Protected videoCtx: null | CanvasRenderingContext2D = null

Drawing context of video canvas layer

---

videoRatio

• Protected videoRatio: number

Aspect ratio of input video

Inherited from

CanvasRenderer.videoRatio

---

videoSize

• Protected videoSize: Size

Resolution of input video

Inherited from

CanvasRenderer.videoSize

Methods

addListener

▸ addListener<E>(event, listener): VideoRenderer<ResultT>

Adds the listener function to the end of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.addListener

---

dispose

▸ dispose(): void

Dispose renderer object

Returns

void

Inherited from

CanvasRenderer.dispose

---

emit

▸ emit<E>(event, ...args): boolean

Synchronously calls each of the listeners registered for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
...args	Args<RendererEvents[E]>	Arguments passed to the listeners

Returns

boolean

True if the event had listeners, False otherwise

Inherited from

CanvasRenderer.emit

---

eventNames

▸ eventNames(): (string | symbol)[]

List of emitter's events

Returns

(string | symbol)[]

List of emitter's events

Inherited from

CanvasRenderer.eventNames

---

getMaxListeners

▸ getMaxListeners(): number

Maximum number of listeners per event

Returns

number

Maximum number of listeners per event

Inherited from

CanvasRenderer.getMaxListeners

---

listenerCount

▸ listenerCount<E>(event): number

The number of listeners listening to the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

number

Number of listeners

Inherited from

CanvasRenderer.listenerCount

---

listeners

▸ listeners<E>(event): Function[]

Copy of the array of listeners for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

CanvasRenderer.listeners

---

load

▸ load(): Promise<void>

Initialize renderer

Initializes renderer, all required assets, and the scene. Overridden by derived classes for particular application.

Returns

Promise<void>

Promise resolving when initialization is finished

Inherited from

CanvasRenderer.load

---

off

▸ off<E>(event, listener): VideoRenderer<ResultT>

Removes the listener from the listener array for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.off

---

on

▸ on<E>(event, listener): VideoRenderer<ResultT>

Adds the listener function to the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.on

---

once

▸ once<E>(event, listener): VideoRenderer<ResultT>

Adds a one-time listener function for the event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.once

---

prependListener

▸ prependListener<E>(event, listener): VideoRenderer<ResultT>

Adds the listener function to the beginning of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.prependListener

---

prependOnceListener

▸ prependOnceListener<E>(event, listener): VideoRenderer<ResultT>

Adds a one-time listener function to the beginning of the listeners array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

VideoRenderer<ResultT>

Inherited from

CanvasRenderer.prependOnceListener

---

rawListeners

▸ rawListeners<E>(event): Function[]

Copy of the array of listeners for the event including wrappers

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event

Returns

Function[]

Copy of the listeners array

Inherited from

CanvasRenderer.rawListeners

---

removeAllListeners

▸ removeAllListeners<E>(event?): VideoRenderer<ResultT>

Removes all listeners, or those of the specified event

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event?	E	The name of the event

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.removeAllListeners

---

removeListener

▸ removeListener<E>(event, listener): VideoRenderer<ResultT>

Removes the specified listener from the listener array

Type parameters

Name	Type
E	extends keyof RendererEvents

Parameters

Name	Type	Description
event	E	The name of the event
listener	RendererEvents[E]	The callback function

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.removeListener

---

setMaxListeners

▸ setMaxListeners(n): VideoRenderer<ResultT>

Sets maximum number of listeners per event

Parameters

Name	Type	Description
n	number	Maximum number of listeners

Returns

VideoRenderer<ResultT>

This EventEmitter

Inherited from

CanvasRenderer.setMaxListeners

---

setMirror

▸ setMirror(mirror): void

Set mirror mode

CanvasRenderer sets mirror mode of ResponsiveCanvas.

Parameters

Name	Type
mirror	boolean

Returns

void

Inherited from

CanvasRenderer.setMirror

---

setupCamera

▸ setupCamera(ratio, angle): void

Set camera parameters

Some video processors statically define camera parameters from just a video resolution. In this cases setupCamera() is used to pass these static camera parameters to renderer.

Parameters

Name	Type	Description
ratio	number	Aspect ration of input video
angle	number	-

Returns

void

Inherited from

CanvasRenderer.setupCamera

---

setupPadding

▸ setupPadding(): void

Setup padding canvases

Callback sets up size of padding canvases.

Returns

void

---

setupVideo

▸ setupVideo(size, ratio?): void

Set video parameters

Callback sets up size of video canvas layer.

Parameters

Name	Type	Description
size	Size	Resolution of input video
ratio?	number	Aspect ration of input video

Returns

void

Overrides

CanvasRenderer.setupVideo

---

unload

▸ unload(): void

Reset renderer

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

Returns

void

Inherited from

CanvasRenderer.unload

---

update

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

Update the scene

Draws input video frame on corresponding canvas layer.

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

CanvasRenderer.update

---

updateVideo

▸ Protected updateVideo(stream): void

Update the video

Draws input video frame on corresponding canvas layer.

Parameters

Name	Type	Description
stream	HTMLCanvasElement	Captured video frame

Returns

void