Streamer
Streamer helper
Streams video of the ResponsiveCanvas backing a CanvasRenderer. ResponsiveCanvas is multi-layer, Every rendering update Streamer merges all snapshots onto the recording canvas. MediaStream instance is created for this canvas and provides access the generated video stream. There’re several modes for resolution of the streamed video: “video” - streams in the same resolution as the video stream, “max”/“min” - in maximum/minimum size among layers of canvas. Additionally one can limit maximum resolution of the stream.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Streamer(
renderer,mirror,sizeMode,sizeMax?):Streamer
Constructor
Parameters
Section titled “Parameters”renderer
Section titled “renderer”Renderer to record video from
mirror
Section titled “mirror”boolean = false
Mirror captured images
sizeMode
Section titled “sizeMode”Video size mode
"video" | "max" | "min"
sizeMax?
Section titled “sizeMax?”number
Maximum video size
Returns
Section titled “Returns”Streamer
Properties
Section titled “Properties”canvas
Section titled “canvas”
protectedcanvas:HTMLCanvasElement
Canvas to capture video
context
Section titled “context”
protectedcontext:null|CanvasRenderingContext2D=null
Drawing context of capturing canvas
mirror
Section titled “mirror”
protectedmirror:boolean=false
Mirror captured images
renderer
Section titled “renderer”
protectedrenderer:CanvasRenderer
Renderer to record video from
sizeMax?
Section titled “sizeMax?”
protectedoptionalsizeMax:number
Maximum video size
sizeMode
Section titled “sizeMode”
protectedsizeMode:"video"|"max"|"min"="video"
Video size mode
stream?
Section titled “stream?”
protectedoptionalstream:MediaStream
Output video stream
Methods
Section titled “Methods”mediaStream()
Section titled “mediaStream()”mediaStream():
undefined|MediaStream
Media stream of generated video
Returns
Section titled “Returns”undefined | MediaStream
Media stream
pause()
Section titled “pause()”pause():
void
Pause video streaming
Stops drawing Renderer layers onto recording canvas.
Returns
Section titled “Returns”void
render()
Section titled “render()”
protectedrender():void
Render
Every Renderer update Streamer merges snapshots of multilayer ResponsiveCanvas onto recording canvas.
Returns
Section titled “Returns”void
start()
Section titled “start()”start():
boolean
Start video streaming
On every Renderer update Streamer draws all layers onto recording canvas. The canvas is a source of video stream.
Returns
Section titled “Returns”boolean
True if recording started, False otherwise