Home Reference Source 
import OpusRecorderEngine from 'videojs-record/js/plugins/opus-recorder-plugin.js'
public class | source

OpusRecorderEngine

Extends:

Component → RecordEngine → OpusRecorderEngine

Audio-only engine for the opus-recorder library.

Audio is encoded using libopus.

Constructor Summary

Public Constructor
public

constructor(player: Player, options: Object)

Creates an instance of this class.

Member Summary

Public Members
public

The number of channels to record.
public
public
public

Mime-type for audio output.
public

Path to encoderWorker.min.js or waveWorker.min.js worker script.
public

The length of the buffer that the internal JavaScriptNode uses to capture the audio.
public

config: {"numberOfChannels": *, "bufferLength": *, "encoderSampleRate": *, "encoderPath": *, "sourceNode": *}

public

Enables console logging for debugging purposes.
public

engine: *

public
public
public

Additional configuration options for the opus-recorder library.
public

Specifies the sample rate to encode at.

Method Summary

Public Methods
public

pause()

Pause recording.
public

resume()

Resume recording.
public

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

Setup recording engine.
public

start()

Start recording.
public

stop()

Stop recording.
Private Methods
private

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.

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 audioChannels: number source

The number of channels to record. 1 = mono, 2 = stereo. Maximum 2 channels are supported.

public audioContext: * source

public audioSourceNode: * source

public audioType: string source

Mime-type for audio output. Also supports audio/wav; but make sure to use waveEncoder worker in that case.

public audioWorkerURL: string source

Path to encoderWorker.min.js or waveWorker.min.js worker script.

public bufferSize: number source

The length of the buffer that the internal JavaScriptNode uses to capture the audio. Can be tweaked if experiencing performance issues.

public config: {"numberOfChannels": *, "bufferLength": *, "encoderSampleRate": *, "encoderPath": *, "sourceNode": *} 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 opus-recorder library.

public sampleRate: number source

Specifies the sample rate to encode at. Supported values are 8000, 12000, 16000, 24000 or 48000.

Public Methods

public pause() source

Pause recording.

public resume() source

Resume recording.

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

Setup recording engine.

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.

public start() source

Start recording.

public stop() source

Stop recording.

Private Methods

private onRecordingAvailable(data: Object) source

Params:

NameTypeAttributeDescription
data Object

Audio data returned by opus-recorder.