Skip to main content

Class: CanvasRecorder

Extra-Helpers.CanvasRecorder

deprecated See ACanvasRecorder

Hierarchy​

  • SimpleEventDispatcher<"starting" | "start" | "pause" | "stop" | "stopping" | "resume" | "error">

    ↳ CanvasRecorder

Methods​

GetSupportedMimeTypes​

▸ Static GetSupportedMimeTypes(types?, codecs?, firstOnly?): undefined | string | string[]

Parameters​

NameTypeDefault value
types?string[]undefined
codecs?string[]undefined
firstOnlybooleanfalse

Returns​

undefined | string | string[]

setOptions​

▸ setOptions(options): void

Parameters​

NameType
optionsPartial<CanvasRecorderOptions>

Returns​

void

isRecording​

▸ isRecording(): boolean

Returns​

boolean

start​

▸ start(): void

Returns​

void

requestFrame​

▸ requestFrame(): Promise<void>

Returns​

Promise<void>

pause​

▸ pause(): void

Returns​

void

stop​

▸ stop(recordingCallback): void

Parameters​

NameType
recordingCallback(b: Blob) => void

Returns​

void

dispose​

▸ dispose(): void

Returns​

void

Properties​

stepMode​

• stepMode: boolean = false

Constructors​

constructor​

• new CanvasRecorder(canvas, options?)

Parameters​

NameType
canvasHTMLCanvasElement
options?Partial<CanvasRecorderOptions>

Overrides​

SimpleEventDispatcher<'starting' | 'start' | 'pause' | 'stop' | 'stopping' | 'resume' | 'error'\>.constructor

Accessors​

state​

• get state(): "error" | "stopped" | "recording" | "paused"

Returns​

"error" | "stopped" | "recording" | "paused"