PerfDevPlugin
Performance metrics plugin
Simple plugin measuring basic performance metrics of a renderer (fps). Executes provided callback when metrics are updated (every 30 rendered frames).
Extends
Section titled “Extends”Plugin<any>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PerfDevPlugin(
callback):PerfDevPlugin
Constructor
Parameters
Section titled “Parameters”callback
Section titled “callback”(fps) => void
Callback method
Returns
Section titled “Returns”PerfDevPlugin
Overrides
Section titled “Overrides”Properties
Section titled “Properties”callback()
Section titled “callback()”
protectedcallback: (fps) =>void
Callback method
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
fpsCount
Section titled “fpsCount”
protectedfpsCount:number=0
Frame counter
fpsStart
Section titled “fpsStart”
protectedfpsStart:number
Start of measurement interval
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<any>
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
Resets performance counters.
Parameters
Section titled “Parameters”renderer
Section titled “renderer”Renderer<any>
Renderer this plugin is attached to
Returns
Section titled “Returns”Promise<void>
Promise resolving when initialization is finished
Overrides
Section titled “Overrides”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
Evaluates metrics and increments counters. Every N rendered frames executes callback on current measurements of performance metrics.
Parameters
Section titled “Parameters”result
Section titled “result”any
Results of video processing
stream
Section titled “stream”HTMLCanvasElement
Captured video frame
Returns
Section titled “Returns”Promise<void>
Promise resolving when update is finished