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[]


setState​

▸ setState(value, event?): void

Parameters​

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

Returns​

void

Inherited from​

ACanvasRecorder.setState


isRecording​

▸ isRecording(): boolean

Returns​

boolean

Inherited from​

ACanvasRecorder.isRecording


setOptions​

▸ setOptions(options): void

Parameters​

NameType
optionsPartial<CanvasRecorderOptions>

Returns​

void

Overrides​

ACanvasRecorder.setOptions


start​

▸ start(): void

Returns​

void

Overrides​

ACanvasRecorder.start


requestFrame​

▸ requestFrame(): boolean

Returns​

boolean

Overrides​

ACanvasRecorder.requestFrame


pause​

▸ pause(): void

Returns​

void

Overrides​

ACanvasRecorder.pause


stop​

▸ stop(recordingCallback): void

Parameters​

NameType
recordingCallback(b: Blob) => void

Returns​

void

Overrides​

ACanvasRecorder.stop


dispose​

▸ dispose(): void

Returns​

void

Overrides​

ACanvasRecorder.dispose


_setOptions​

▸ Protected _setOptions(value): void

Parameters​

NameType
valuePartial<CanvasRecorderOptions>

Returns​

void

Overrides​

ACanvasRecorder._setOptions

Properties​

options​

• options: CanvasRecorderOptions

Inherited from​

ACanvasRecorder.options


_canvas​

• Protected _canvas: HTMLCanvasElement

Inherited from​

ACanvasRecorder._canvas


_console​

• Protected _console: Console = console

Inherited from​

ACanvasRecorder._console


_currentRecording​

• Protected _currentRecording: Blob[] = []

Inherited from​

ACanvasRecorder._currentRecording


_frameCount​

• Protected _frameCount: number = 0

Inherited from​

ACanvasRecorder._frameCount


_ondataavailable​

• Protected _ondataavailable: (event: BlobEvent) => void

Type declaration​

▸ (event): void

Parameters​
NameType
eventBlobEvent
Returns​

void

Inherited from​

ACanvasRecorder._ondataavailable

Accessors​

state​

• get state(): TRecorderStates

Returns​

TRecorderStates

Inherited from​

ACanvasRecorder.state

Constructors​

constructor​

• new CanvasMediaRecorder(canvas, options?)

Parameters​

NameType
canvasHTMLCanvasElement
options?Partial<CanvasRecorderOptions>

Overrides​

ACanvasRecorder.constructor