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. It's possible to draw on top of the video stream using 2d canvas context, for example to add simple 2d effects. Effects can be encapsulated in a form of render plugins. Plugins are levels of abstraction allowing to single out ready-made helpers that are used as atomic building blocks.
Type parameters
Name | Type | Description |
---|---|---|
ResultT | extends Object = | Type of processing results |
Hierarchy
-
CanvasRenderer
<ResultT
>↳
VideoRenderer
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
Properties
cameraAngle
• Protected
cameraAngle: number
Camera vertical angle in radians
Inherited from
cameraRatio
• Protected
cameraRatio: number
Camera aspect ratio
Inherited from
canvas
• canvas: ResponsiveCanvas
Responsive canvas
Inherited from
loaded
• Protected
loaded: boolean
= false
Loaded state
Inherited from
padCtx
• Protected
padCtx: [null
| CanvasRenderingContext2D
, null
| CanvasRenderingContext2D
]
Drawing context of padding canvases
Inherited from
plugins
• Protected
plugins: Plugin
<ResultT
>[] = []
Attached plugins
Inherited from
videoCtx
• videoCtx: null
| CanvasRenderingContext2D
= null
Drawing context of video canvas layer
videoRatio
• Protected
videoRatio: number
Aspect ratio of input video
Inherited from
videoSize
• Protected
videoSize: Size
Resolution of input video
Inherited from
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
addPlugin
▸ addPlugin(plugin
): Promise
<void
>
Add render plugin
Initializes the plugin if it's not loaded yet but renderer is ready. Renderer takes ownership of the plugin instance meaning it will release it when plugin is detached or renderer is disposed itself.
Parameters
Name | Type |
---|---|
plugin | Plugin <ResultT > |
Returns
Promise
<void
>
Inherited from
dispose
▸ dispose(): void
Dispose renderer object
Extended to dispose responsive canvas
Returns
void
Inherited from
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
eventNames
▸ eventNames(): (string
| symbol
)[]
List of emitter's events
Returns
(string
| symbol
)[]
List of emitter's events
Inherited from
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
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
load
▸ load(): Promise
<void
>
Initialize renderer
Initializes all attached plugins.
Returns
Promise
<void
>
Promise resolving when initialization is finished
Inherited from
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
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
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
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
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
removeAllPlugins
▸ removeAllPlugins(): void
Remove all render plugins
Renderer will dispose all plugins before detaching them.
Returns
void
Inherited from
CanvasRenderer.removeAllPlugins
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
removePlugin
▸ removePlugin(plugin
): void
Remove render plugin
Renderer will dispose the plugin before detaching it.
Parameters
Name | Type |
---|---|
plugin | Plugin <ResultT > |
Returns
void
Inherited from
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 | Description |
---|---|---|
mirror | boolean | Mirror the output |
Returns
void
Inherited from
setMode
▸ setMode(mode
): void
Set fitting mode
CanvasRenderer sets fitting mode of ResponsiveCanvas.
Parameters
Name | Type | Description |
---|---|---|
mode | CanvasMode | Fitting mode |
Returns
void
Inherited from
setupCamera
▸ setupCamera(ratio
, angle
): void
Set camera parameters
Callback sets up all attached plugins.
Parameters
Name | Type | Description |
---|---|---|
ratio | number | Camera aspect ratio |
angle | number | Camera vertical angle in radians |
Returns
void
Inherited from
setupPadding
▸ Protected
setupPadding(): void
Setup padding canvases
Callback sets up size of padding canvases.
Returns
void
Inherited from
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
unload
▸ unload(): void
Reset renderer
Resets all attached plugins.
Returns
void
Inherited from
update
▸ update(result
, stream
): Promise
<void
>
Update the scene
Updates all attached plugins.
Parameters
Name | Type | Description |
---|---|---|
result | ResultT | Results of video processing |
stream | HTMLCanvasElement | Captured video frame |
Returns
Promise
<void
>
Promise resolving when update is finished
Inherited from
updatePads
▸ Protected
updatePads(stream
): void
Update padding canvases
Updates padding canvases using portions of video frame.
Parameters
Name | Type | Description |
---|---|---|
stream | HTMLCanvasElement | Captured video frame |
Returns
void
Inherited from
updatePlugins
▸ Protected
updatePlugins(result
, stream
): Promise
<void
>
Update attached plugins
Calls update() of all attached plugins.
Parameters
Name | Type | Description |
---|---|---|
result | ResultT | Results of video processing |
stream | HTMLCanvasElement | Captured video frame |
Returns
Promise
<void
>
Promise resolving when update is finished
Inherited from
updateScene
▸ Protected
updateScene(): void
Update and render the scene
Virtual method updating and rendering the scene. Overridden by implementation of derived renderer.
Returns
void
Inherited from
updateVideo
▸ Protected
updateVideo(stream
): void
Update the video layer
Draws input video frame on corresponding canvas layer.
Parameters
Name | Type | Description |
---|---|---|
stream | HTMLCanvasElement | Captured video frame |
Returns
void