import OpusMediaRecorderEngine from 'videojs-record/js/plugins/opus-media-recorder-plugin.js'

public class | source

OpusMediaRecorderEngine

Extends:

Component → RecordEngine → OpusMediaRecorderEngine

Audio-only engine for the opus-media-recorder library.

opus-media-recorder uses WebAssembly compiled from popular libraries (e.g libopus, libogg, libwebm, and speexdsp) to ensure good performance and standards-compliance.

Constructor Summary

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

Member Summary

Public Members
public	audioType: string Mime-type for audio output.
public	chunks: *[]
public	debug: *
public	engine: *
public	inputStream: *
public	mediaType: *
public	recAvailableCallback: *

Method Summary

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

Private Methods
private	onData(event: Object)
private	onRecordingAvailable(event: Object)

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 audioType: string source

Mime-type for audio output.

Choose desired format like audio/webm. Default is audio/ogg.

public chunks: *[] source

public debug: * source

public engine: * source

public inputStream: * source

public mediaType: * source

public recAvailableCallback: * source

Public Methods

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 onData(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object		ondataavailable responded with data object.

private onRecordingAvailable(event: Object) source

Params:

Name	Type	Attribute	Description
event	Object		Audio data returned by opus-media-recorder.