Home Reference Source
public class | source

WebmWasmEngine

Extends:

ComponentRecordEngineRecordRTCEngine → WebmWasmEngine

Video engine plugin for the webm-wasm library.

Constructor Summary

Public Constructor
public

constructor(player: Player, options: Object)

Creates an instance of this class.

Member Summary

Public Members
public

bitRate: *

public

Enables console logging for debugging purposes.

public
public
public

Video bitrate in kbps.

public

Video frame rate in fps.

public

Path to webm-wasm.wasm WebAssembly script.

public

Path to webm-worker.js worker script.

public

Method Summary

Public Methods
public

setup(stream: LocalMediaStream, mediaType: Object, debug: Boolean)

Setup recording engine.

Inherited Summary

From class RecordEngine
public
public

addFileInfo(fileObj: Blob | File)

Add filename and timestamp to recorded file object.

public

Destroy engine.

public

saveAs(name: Object): void

Show save as dialog in browser so the user can store the recorded media locally.

private

Remove any temporary data and references to streams.

private

onStopRecording(data: blob)

Invoked when recording is stopped and resulting stream is available.

From class RecordRTCEngine
public

debug: *

public

engine: *

public
public
public
public

Destroy engine.

public

Remove any temporary data and references to streams.

public

pause()

Pause recording.

public

resume()

Resume recording.

public

saveAs(name: object)

Show save as dialog in browser so the user can store the recorded media locally.

public

setup(stream: LocalMediaStream, mediaType: Object, debug: Boolean)

Setup recording engine.

public

start()

Start recording.

public

stop()

Stop recording.

private

onStopRecording(audioVideoURL: string, type: string)

Invoked when recording is stopped and resulting stream is available.

private

onTimeStamp(current: float, all: array)

Received new timestamp (when timeSlice option is enabled).

Public Constructors

public constructor(player: Player, options: Object) source

Creates an instance of this class.

Override:

RecordEngine#constructor

Params:

NameTypeAttributeDescription
player Player

The Player that this class should be attached to.

options Object
  • optional

The key/value store of player options.

Public Members

public bitRate: * source

public debug: boolean source

Enables console logging for debugging purposes.

Override:

RecordRTCEngine#debug

public frameRate: * source

public recorderType: * source

public videoBitRate: number source

Video bitrate in kbps.

public videoFrameRate: number source

Video frame rate in fps.

public videoWebAssemblyURL: string source

Path to webm-wasm.wasm WebAssembly script.

public videoWorkerURL: string source

Path to webm-worker.js worker script.

public workerPath: * source

Public Methods

public setup(stream: LocalMediaStream, mediaType: Object, debug: Boolean) source

Setup recording engine.

Override:

RecordRTCEngine#setup

Params:

NameTypeAttributeDescription
stream LocalMediaStream

Media stream to record.

mediaType Object

Object describing the media type of this engine.

debug Boolean

Indicating whether or not debug messages should be printed in the console.