Skip to main content

Class: UniRecorder

@geenee/armature.UniRecorder

Recorder helper (one layer verstion)

Records a video of a layer of the ResponsiveCanvas backing a CanvasRenderer. Simple and straightforward recording of a canvas. Encoded video chunks are cached to later be merged into one blob containing the final video file.

Constructors

constructor

new UniRecorder(renderer, layer?, type?, bitRate?)

Constructor

Parameters

NameTypeDefault valueDescription
rendererCanvasRenderer<>undefinedRenderer to record video from
layernumber0Layer that will be recorded
typestring"video/webm"Media/video type
bitRate?numberundefinedVideo stream bit rate

Properties

bitRate

Protected Optional bitRate: number

Video stream bit rate


layer

Protected layer: number = 0

Layer that will be recorded


recorder

Protected Optional recorder: MediaRecorder

Video recorder


records

Protected records: Blob[] = []

Record chunks


renderer

Protected renderer: CanvasRenderer<>

Renderer to record video from


stream

Protected Optional stream: MediaStream

Video stream


type

Protected type: string = "video/webm"

Media/video type

Methods

start

start(): boolean

Start video recording

Recorder encodes video stream associated with the canvas layer. Chunks of encoded media stream are cached to later be merged into one blob on stop().

Returns

boolean

True if recording started, False otherwise


stop

stop(): Promise<undefined | Blob>

Stop video recording

Renderer stops recording and then merges encoded video stream chunks into one blob returned to user.

Returns

Promise<undefined | Blob>

Promise resolved to Blob containing encoded video