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

Name	Type	Default value
types?	string[]	undefined
codecs?	string[]	undefined
firstOnly	boolean	false

Returns

undefined | string | string[]

---

setOptions

▸ setOptions(options): void

Parameters

Name	Type
options	Partial<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

Name	Type
recordingCallback	(b: Blob) => void

Returns

void

---

dispose

▸ dispose(): void

Returns

void

Properties

stepMode

• stepMode: boolean = false

Constructors

constructor

• new CanvasRecorder(canvas, options?)

Parameters

Name	Type
canvas	HTMLCanvasElement
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"