Skip to main content

Class: CanvasMediaRecorder

Extra-Helpers.CanvasMediaRecorder

Hierarchy

Methods

GetSupportedMimeTypes

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

Parameters

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

Returns

undefined | string | string[]

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:173


setState

setState(value, event?): void

Parameters

NameType
value"error" | "stopped" | "recording" | "paused" | "starting" | "stopping"
event?any

Returns

void

Inherited from

ACanvasRecorder.setState

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:38


isRecording

isRecording(): boolean

Returns

boolean

Inherited from

ACanvasRecorder.isRecording

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:64


setOptions

setOptions(options): void

Parameters

NameType
optionsPartial<CanvasRecorderOptions>

Returns

void

Overrides

ACanvasRecorder.setOptions

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:27


start

start(): void

Returns

void

Overrides

ACanvasRecorder.start

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:38


requestFrame

requestFrame(): boolean

Returns

boolean

Overrides

ACanvasRecorder.requestFrame

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:98


pause

pause(): void

Returns

void

Overrides

ACanvasRecorder.pause

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:108


stop

stop(recordingCallback): void

Parameters

NameType
recordingCallback(b: Blob) => void

Returns

void

Overrides

ACanvasRecorder.stop

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:120


dispose

dispose(): void

Returns

void

Overrides

ACanvasRecorder.dispose

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:135


_setOptions

Protected _setOptions(value): void

Parameters

NameType
valuePartial<CanvasRecorderOptions>

Returns

void

Overrides

ACanvasRecorder._setOptions

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:8

Properties

options

options: CanvasRecorderOptions

Inherited from

ACanvasRecorder.options

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:28


_canvas

Protected _canvas: HTMLCanvasElement

Inherited from

ACanvasRecorder._canvas

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:29


_console

Protected _console: Console = console

Inherited from

ACanvasRecorder._console

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:31


_currentRecording

Protected _currentRecording: Blob[] = []

Inherited from

ACanvasRecorder._currentRecording

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:32


_frameCount

Protected _frameCount: number = 0

Inherited from

ACanvasRecorder._frameCount

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:68


_ondataavailable

Protected _ondataavailable: (event: BlobEvent) => void

Type declaration

▸ (event): void

Parameters
NameType
eventBlobEvent
Returns

void

Inherited from

ACanvasRecorder._ondataavailable

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:92

Accessors

state

get state(): TRecorderStates

Returns

TRecorderStates

Inherited from

ACanvasRecorder.state

Defined in

webgi/src/extras/canvas_recorder/ACanvasRecorder.ts:34

Constructors

constructor

new CanvasMediaRecorder(canvas, options?)

Parameters

NameType
canvasHTMLCanvasElement
options?Partial<CanvasRecorderOptions>

Overrides

ACanvasRecorder.constructor

Defined in

webgi/src/extras/canvas_recorder/CanvasMediaRecorder.ts:34