import VmsgEngine from 'videojs-record/js/plugins/vmsg-plugin.js'

public class | source

VmsgEngine

Extends:

Component → RecordEngine → VmsgEngine

Audio-only engine for the vmsg library.

Constructor Summary

Public Constructor
public	constructor(player: Player, options: Object) Creates an instance of this class.

Member Summary

Public Members
public	audioContext: *
public	audioSourceNode: *
public	audioWebAssemblyURL: string Path to `vmsg.wasm` WebAssembly script.
public	config: {"wasmURL": *}
public	debug: boolean Enables console logging for debugging purposes.
public	engine: *
public	inputStream: *
public	mediaType: *
public	pluginLibraryOptions: object Additional configuration options for the vmsg library.
public	processor: *

Method Summary

Public Methods
public	destroy() Destroy engine.
public	setup(stream: LocalMediaStream, mediaType: Object, debug: Boolean) Setup recording engine.
public	start() Start recording.
public	stop() Stop recording.

Private Methods
private	onAudioProcess(event: object) Continuous encoding of audio data.
private	onRecordingAvailable()

Inherited Summary

From class RecordEngine
public	recordedData: *
public	addFileInfo(fileObj: Blob \| File) Add filename and timestamp to recorded file object.
public	destroy() Destroy engine.
public	saveAs(name: Object): void Show save as dialog in browser so the user can store the recorded media locally.
private	dispose() Remove any temporary data and references to streams.
private	onStopRecording(data: blob) Invoked when recording is stopped and resulting stream is available.

Public Constructors

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

Creates an instance of this class.

Override:

RecordEngine#constructor

Params:

Name	Type	Attribute	Description
player	Player		The `Player` that this class should be attached to.
options	Object	optional	The key/value store of player options.

Public Members

public audioContext: * source

public audioSourceNode: * source

public audioWebAssemblyURL: string source

Path to vmsg.wasm WebAssembly script.

public config: {"wasmURL": *} source

public debug: boolean source

Enables console logging for debugging purposes.

public engine: * source

public inputStream: * source

public mediaType: * source

public pluginLibraryOptions: object source

Additional configuration options for the vmsg library.

public processor: * source

Public Methods

public destroy() source

Destroy engine.

Override:

RecordEngine#destroy

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

Setup recording engine.

Params:

Name	Type	Attribute	Description
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.

public start() source

Start recording.

public stop() source

Stop recording.

Private Methods

private onAudioProcess(event: object) source

Continuous encoding of audio data.

Params:

Name	Type	Attribute	Description
event	object		Audio buffer.

VmsgEngine

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

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

Override:

Params:

Public Members

public audioContext: * source

public audioSourceNode: * source

public audioWebAssemblyURL: string source

public config: {"wasmURL": *} source

public debug: boolean source

public engine: * source

public inputStream: * source

public mediaType: * source

public pluginLibraryOptions: object source

public processor: * source

Public Methods

public destroy() source

Override:

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

Params:

public start() source

public stop() source

Private Methods

private onAudioProcess(event: object) source

Params:

private onRecordingAvailable() source