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[]
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:290
setOptions
▸ setOptions(options): void
Parameters
| Name | Type |
|---|---|
options | Partial<CanvasRecorderOptions> |
Returns
void
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:35
isRecording
▸ isRecording(): boolean
Returns
boolean
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:58
start
▸ start(): void
Returns
void
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:62
requestFrame
▸ requestFrame(): Promise<void>
Returns
Promise<void>
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:151
pause
▸ pause(): void
Returns
void
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:178
stop
▸ stop(recordingCallback): void
Parameters
| Name | Type |
|---|---|
recordingCallback | (b: Blob) => void |
Returns
void
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:187
dispose
▸ dispose(): void
Returns
void
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:209
Properties
stepMode
• stepMode: boolean = false
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:44
Constructors
constructor
• new CanvasRecorder(canvas, options?)
Parameters
| Name | Type |
|---|---|
canvas | HTMLCanvasElement |
options? | Partial<CanvasRecorderOptions> |
Overrides
SimpleEventDispatcher<'starting' | 'start' | 'pause' | 'stop' | 'stopping' | 'resume' | 'error'\>.constructor
Defined in
webgi/src/extras/canvas_recorder/CanvasRecorder.ts:46
Accessors
state
• get state(): "error" | "stopped" | "recording" | "paused"
Returns
"error" | "stopped" | "recording" | "paused"