import LibVorbisEngine from 'videojs-record/js/plugins/libvorbis-plugin.js'

public class | source

LibVorbisEngine

Extends:

Component → RecordEngine → LibVorbisEngine

Audio-only engine for the libvorbis.js library.

Constructor Summary

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

Member Summary

Public Members
public	chunks: *[]
public	debug: boolean Enables console logging for debugging purposes.
public	engine: *
public	inputStream: *
public	mediaType: *
public	options: {"audioBitsPerSecond": *}
public	sampleRate: number Specifies the sample rate to encode at.

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()

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 chunks: *[] source

public debug: boolean source

Enables console logging for debugging purposes.

public engine: * source

public inputStream: * source

public mediaType: * source

public options: {"audioBitsPerSecond": *} source

public sampleRate: number source

Specifies the sample rate to encode at.

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.

LibVorbisEngine

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

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

Override:

Params:

Public Members

public chunks: *[] source

public debug: boolean source

public engine: * source

public inputStream: * source

public mediaType: * source

public options: {"audioBitsPerSecond": *} source

public sampleRate: number source

Public Methods

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

Params:

public start() source

public stop() source

Private Methods

private onData(event: Object) source

Params:

private onRecordingAvailable() source