altihou / videojs-record

video.js plugin for recording audio/video/image files

Video.js Record

Video.js plugin for recording audio/video/image files.

Table of Contents

• Installation
• Supported browsers
• Dependencies
• Usage
  • Audio/video/image
  • Audio-only
• Examples
• Options
• Methods
• Events
• Media constraints
• Get recorded data
  • Save data
  • Convert data
  • Timestamps
  • Upload data
• Controlling the input and output devices
• Responsive layout
• Customizing controls
• Hotkeys
• Picture-in-Picture
• Other audio libraries
• Other video libraries
• Localization
• Webpack
• Using with React
• Using with Angular
• More features using other plugins
• Development
• Font
• License
• Donate

Installation

Use npm (npm install videojs-record) to install the plugin or download the library and dependencies elsewhere. If you want to try the examples, check these instructions below.

Since v2.0 this plugin is compatible with video.js 6.0 and videojs-wavesurfer 2.0 or newer. If you want to use this plugin with an older version, check the archived releases for a 1.7.x or older release.

Take a look at the changelog when upgrading from a previous version of videojs-record.

Supported browsers

Check the wiki for supported browsers information.

Dependencies

The plugin has the following mandatory dependencies:

• Video.js - HTML5 media player that provides the user interface.
• webrtc-adapter - Provides cross-browser support for getUserMedia and other browser APIs used in this plugin.

When recording audio and/or video you also need:

• RecordRTC - Adds support for audio/video/GIF recording.

And when recording audio-only, the following dependencies are also required ( to visualize the audio waveform):

• videojs-wavesurfer - Transforms video.js into an audio-player using wavesurfer.js.
• wavesurfer.js - Provides a navigable waveform for audio files. Comes with a microphone plugin used for real-time visualization of the microphone audio signal.

Optional dependencies when using other audio libraries (note that most of these audio codecs are already available in most modern browsers):

• vmsg - Converts PCM audio data to compressed MP3 audio. Uses WebAssembly version of LAME encoder.
• opus-recorder - Converts the output of Web Audio API nodes as Opus and exports it into an Ogg container.
• libvorbis.js - Converts PCM audio data to compressed Ogg Vorbis audio, resulting a smaller audio files with similar quality.
• lamejs - Converts PCM audio data to compressed MP3 audio. Written in JavaScript so not very fast.
• recorder.js - A plugin for recording the PCM output of Web Audio API nodes.

Optional dependencies when using other video libraries:

• webm-wasm - Creates WebM recordings using libwebm (compiled with WebAssembly).

Optional dependencies when using converter libraries:

• ts-ebml - Creates seekable WebM files, by injecting metadata like duration.
• ffmpeg.js - FFmpeg builds ported to JavaScript using Emscripten.

Usage

Start by including the video.js stylesheet and library:

<link href="video-js.min.css" rel="stylesheet">
<script src="video.min.js"></script>

If you're going to record audio and/or video you need to include RecordRTC as well:

<script src="RecordRTC.js"></script>

The videojs-record plugin automatically registers itself when the script is included on the page:

<script src="videojs.record.js"></script>

Add the extra stylesheet for the plugin that includes a custom font with additional icons:

<link href="videojs.record.css" rel="stylesheet">

Audio/video/image

When recording either audio/video, video-only, screen-only, audio/screen, animated GIF or a single image, include a video element:

<video id="myVideo" playsinline class="video-js vjs-default-skin"></video>

Audio-only

When recording audio-only, also include the wavesurfer.js library and the videojs-wavesurfer and microphone plugins. Make sure to place this before the videojs.record.js script.

<script src="wavesurfer.min.js"></script>
<script src="wavesurfer.microphone.min.js"></script>
<script src="videojs.wavesurfer.js"></script>

And define an audio element:

<audio id="myAudio" class="video-js vjs-default-skin"></audio>

There is also support for additional audio libraries that allows you to record audio with alternative codecs (that otherwise might not be supported in the browser) like Ogg Vorbis, MP3 and Opus.

Examples

• audio/video (demo / source)
• video-only (demo / source)
• audio-only example (demo / source)
• image (demo / source)
• animated GIF (demo / source)
• screen-only (demo / source)
• audio/screen (demo / source)

To try out the examples locally, download the zip-file and unpack it, or checkout the repository using Git:

git clone https://github.com/collab-project/videojs-record.git

And install the dependencies using npm:

cd videojs-record
npm install

Build the library and assets once:

npm run build

And start the local webserver:

npm run start

And open http://localhost:8080/examples/audio-video.html in a browser.

Options

Configure the player using the video.js options, and enable the plugin by adding a record configuration to plugins. For example:

var player = videojs('myVideo', {
    // video.js options
    controls: true,
    loop: false,
    fluid: false,
    width: 320,
    height: 240,
    plugins: {
        // videojs-record plugin options
        record: {
            image: false,
            audio: false,
            video: true,
            maxLength: 5,
            debug: true
        }
    }
});

The available options for this plugin are:

Option	Type	Default	Description
image	boolean or object	false	Create single snapshot image.
audio	boolean or object	false	Include audio in the recorded clip.
video	boolean or object	false	Include video in the recorded clip.
animation	boolean or object	false	Animated GIF without audio.
screen	boolean or object	false	Include screen capture in the recorded clip.
debug	boolean	false	Enables console log messages during recording for debugging purposes.
pip	boolean	false	Enables Picture-in-Picture support. Enable to add Picture-in-Picture button to controlbar.
maxLength	float	10	Maximum length of the recorded clip.
maxFileSize	float	0	Maximum file size of a recorded clip (in bytes). Recording will stop when the limit is reached. Default is 0 (no file size limit). Can only be used when timeSlice option is also enabled.
msDisplayMax	float	3	Indicates the number of seconds that is considered the boundary value for displaying milliseconds in the time controls. A clip with a total length of 2 seconds and a msDisplayMax of 3 will use the format M:SS:MMM. Clips with a duration that is longer than msDisplayMax will be displayed as M:SS or HH:MM:SS.
timeSlice	float	0	Accepts numbers in milliseconds; use this to force intervals-based blobs and receive timestamps during recording by listening for the timestamp event.
autoMuteDevice	boolean	false	Turns off the camera/microphone devices (and light) when audio and/or video recording stops, and turns them on again when recording resumes.
frameWidth	float	320	Width of the recorded video frames. Use media constraints to change the camera resolution width.
frameHeight	float	240	Height of the recorded video frames. Use media constraints to change the camera height.
videoEngine	string	'recordrtc'	Video recording library/plugin to use. Legal values are recordrtc and webm-wasm.
videoMimeType	string	'video/webm'	The mime type for the video recorder. Use video/mp4 (Firefox) or video/webm;codecs=H264 (Chrome 52 and newer) for MP4. A full list of supported mime-types in the Chrome browser is listed here.
videoRecorderType	string or function	'auto'	Video recorder type to use. This allows you to specify an alternative recorder class, e.g. WhammyRecorder. Defaults to auto which let's recordrtc specify the best available recorder type.
videoBitRate	float	1200	The video bitrate in kbps (only used in webm-wasm plugin).
videoFrameRate	float	30	The video frame rate in frames per second (only used in webm-wasm plugin).
videoWorkerURL	string	''	URL for the video worker, for example: ../node_modules/webm-wasm/dist/webm-worker.js. Currently only used for webm-wasm plugin. Use an empty string '' to disable (default).
videoWebAssemblyURL	string	''	URL for the video worker WebAssembly file. Use an empty string '' to disable (default). Currently only used for the webm-wasm plugin.
audioEngine	string	'recordrtc'	Audio recording library/plugin to use. Legal values are recordrtc, libvorbis.js, vmsg, opus-recorder, lamejs and recorder.js.
audioRecorderType	string or function	'auto'	Audio recorder type to use. This allows you to specify an alternative recorder class, e.g. StereoAudioRecorder. Defaults to auto which let's recordrtc specify the best available recorder type. Currently this setting is only used with the recordrtc audioEngine.
audioMimeType	string	'auto'	The mime type for the audio recorder. Defaults to auto which will pick the best option available in the browser (e.g. either audio/wav, audio/ogg or audio/webm). A full list of supported mime-types in the Chrome browser is listed here.
audioBufferSize	float	4096	The size of the audio buffer (in sample-frames per second). Legal values: 0, 256, 512, 1024, 2048, 4096, 8192 and 16384.
audioSampleRate	float	44100	The audio sample rate (in sample-frames per second) at which the AudioContext handles audio. Legal values are in the range of 22050 to 96000.
audioBitRate	float	128	The audio bitrate in kbps (only used in the lamejs plugin).
audioChannels	float	2	Number of audio channels. Using a single channel results in a smaller file size.
audioWorkerURL	string	''	URL for the audio worker, for example: /opus-recorder/build/encoderWorker.min.js. Currently only used for opus-recorder and lamejs plugins. Use an empty string '' to disable (default).
audioWebAssemblyURL	string	''	URL for the audio worker WebAssembly file. Use an empty string '' to disable (default). Currently only used for the vmsg plugin.
audioBufferUpdate	boolean	false	Enables the audioBufferUpdate event that provides real-time AudioBuffer instances from the input audio device.
animationFrameRate	float	200	Frame rate for animated GIF (in frames per second).
animationQuality	float	10	Sets quality of color quantization (conversion of images to the maximum 256 colors allowed by the GIF specification). Lower values (minimum = 1) produce better colors, but slow processing significantly. The default produces good color mapping at reasonable speeds. Values greater than 20 do not yield significant improvements in speed.
convertEngine	string	''	Media converter library to use. Legal values are ts-ebml and ffmpeg.js. Use an empty string '' to disable (default). Check the player.convertedData object for the converted data.
convertWorkerURL	string	''	URL for the converter worker, for example: /node_modules/ffmpeg.js/ffmpeg-worker-mp4.js. Currently only used for ffmpeg.js plugin. Use an empty string '' to disable (default).
convertOptions	array	[]	List of string options to pass to the convert engine.
hotKeys	boolean or function	false	Enable keyboard hotkeys. Disabled by default.
pluginLibraryOptions	object	{}	Use this object to specify additional settings for the library used by the plugin. Currently only used in the opus-recorder and vmsg plugins.

Methods

Methods for this plugin documented below are available using the record method of the video.js player instance. For example:

player.record().destroy();

Method	Description
isRecording	Returns a boolean indicating whether recording is active or not.
getRecordType	Get recorder type as string. Either image_only, animation, audio_only, video_only, audio_video, screen_only or audio_screen.
saveAs	Show save as dialog in browser so the user can store the recorded media locally.
destroy	Destroys the recorder instance and children (including the video.js player).
reset	Not as destructive as destroy: use this if you want to reset the player interface and recorder state.
stopDevice	Stop the recording and the active audio and/or video device(s).
getDevice	Start the audio and/or video device(s).
getDuration	Get the length of the recorded stream in seconds. Returns 0 if no recording is available (yet).
getCurrentTime	Get the current time of the recorded stream during playback. Returns 0 if no recording is available (yet).
enumerateDevices	Get async list of media input and output devices available on the system.
setAudioOutput(deviceId)	Change the audio output device using its deviceId.
setAudioInput(deviceId)	Change the audio input device using its deviceId.
setVideoInput(deviceId)	Change the video input device using its deviceId.
start	Start recording.
stop	Stop recording.
pause	Pause recording.
resume	Resume recording.

All public methods are documented in the online API documentation.

Events

Plugin events that are available on the video.js player instance. For example:

player.on('startRecord', function() {
    console.log('started recording!');
});

Event	Description
deviceReady	The webcam and/or microphone is ready to use.
deviceError	User doesn't allow the browser to access the webcam and/or microphone. Check player.deviceErrorCode for the specific error code.
startRecord	User pressed the record or camera button to start recording.
progressRecord	Fires continuously during recording (until recording is stopped or paused).
stopRecord	User pressed the stop button to stop recording.
timestamp	Fires continuously during recording whenever a new timestamp is available. Only fires if the timeSlice option is set.
finishRecord	The recorded stream or image is available. Check the player.recordedData object for the recorded data.
enumerateReady	enumerateDevices returned the devices successfully. The list of devices is stored in the player.record().devices array.
enumerateError	An error occurred after calling enumerateDevices. Check the player.enumerateErrorCode property for an description of the error.
audioOutputReady	Audio output was changed and is now active.
audioBufferUpdate	Get real-time AudioBuffer instances from microphone. Fires continuously during audio-only recording (until recording is stopped or paused) when the audioBufferUpdate option is enabled.
enterPIP	Entered Picture-in-Picture mode.
leavePIP	Left Picture-in-Picture mode.
startConvert	The convert plugin started processing the recorded data.
finishConvert	The converted data is available. Check the player.convertedData object for the converted data.

Media constraints

Media stream constraints allow you to specify the types of media to request, along with any requirements for each type.

The following example shows how to change the camera or screen resolution to 1280 by 720 pixels:

var player = videojs('myVideo', {
    controls: true,
    loop: false,
    // dimensions of video.js player
    fluid: false,
    width: 1280,
    height: 720,
    plugins: {
        record: {
            maxLength: 5,
            debug: true,
            audio: false,
            video: {
                // video constraints: set resolution of camera
                mandatory: {
                    minWidth: 1280,
                    minHeight: 720,
                },
            },
            // dimensions of captured video frames
            frameWidth: 1280,
            frameHeight: 720
        }
    }
});

Get recorded data

Listen for the finishRecord event and obtain the recorded data from the player.recordedData object for further processing:

// user completed recording and stream is available
player.on('finishRecord', function() {
    // the recordedData object contains the stream data that
    // can be downloaded by the user, stored on server etc.
    console.log('finished recording: ', player.recordedData);
});

Save data

Use the saveAs method to show a 'Save as' browser dialog where the user can choose the storage location for the recorded data. It accepts a name object that contains a mapping between the media type and the filename. For example:

player.on('finishRecord', function() {
    // show save as dialog
    player.record().saveAs({'video': 'my-video-file-name.webm'});
});

Convert data

It's possible to process and convert the recorded data in the browser. For example, adding metadata like duration to recorded WebM files, or using FFmpeg to convert the data with a different codec.

For example, enable the ts-ebml plugin with the convertEngine option:

record: {
    audio: false,
    video: true,
    maxLength: 5,
    debug: true,
    // use the ts-ebml convert plugin to inject metadata in webm files
    convertEngine: 'ts-ebml'
}

And listen for the finishConvert event. For example:

// converter ready and stream is available
player.on('finishConvert', function() {
    // the convertedData object contains the converted data that
    // can be downloaded by the user, stored on server etc.
    console.log('finished converting: ', player.convertedData);
});

Check the converter plugins documentation for more information.

Timestamps

It's also possible to get data during recording with specific time-intervals. This could be useful in scenarios where you're recording a long clip and planning to upload recorded blobs to a server periodically, where the clip is stitched together.

Enable the event with the timeSlice option:

record: {
    audio: false,
    video: true,
    maxLength: 5,
    debug: true,
    // fire the timestamp event every 2 seconds
    timeSlice: 2000
}

And listen for the timestamp event. For example:

// monitor stream data during recording
player.on('timestamp', function() {
    // timestamps
    console.log('current timestamp: ', player.currentTimestamp);
    console.log('all timestamps: ', player.allTimestamps);

    // stream data
    console.log('array of blobs: ', player.recordedData);
    // or construct a single blob:
    // var blob = new Blob(blobs, {
    //     type: 'video/webm'
    // });
});

Check the timeslice example.

Upload data

The example below shows how to upload each recording:

player.on('finishRecord', function() {
    // the blob object contains the recorded data that
    // can be downloaded by the user, stored on server etc.
    console.log('finished recording:', player.recordedData);

    var data = player.recordedData;
    var serverUrl = '/upload';
    var formData = new FormData();
    formData.append('file', data, data.name);

    console.log('uploading recording:', data.name);

    fetch(serverUrl, {
        method: 'POST',
        body: formData
    }).then(
        success => console.log('recording upload complete.')
    ).catch(
        error => console.error('an upload error occurred!')
    );
});

Check the simple upload example.

The example below shows how to 'stream' upload recorded data segments to a server using the jQuery library and the timestamp event:

var segmentNumber = 0;

player.on('timestamp', function() {
    if (player.recordedData && player.recordedData.length > 0) {
        var binaryData = player.recordedData[player.recordedData.length - 1];

        segmentNumber++;

        var formData = new FormData();
        formData.append('SegmentNumber', segmentNumber);
        formData.append('Data', binaryData);

        $.ajax({
            url: '/api/Test',
            method: 'POST',
            data: formData,
            cache: false,
            processData: false,
            contentType: false,
            success: function (res) {
                console.log("segment: " + segmentNumber);
            }
        });
    }
});

Check the jquery.fileupload or Fine Uploader examples on how to upload the data to a server using these libraries.

Controlling the input and output devices

Use enumerateDevices to get a list of the available input and output devices on the user's system, e.g. FaceTime HD-camera, default (Built-in microphone) etc.

Check out the enumerateDevices example (demo / source).

After you acquired the device id (called deviceId in the example below) specify it in the player configuration using constraints:

record: {
    maxLength: 20,
    debug: true,
    audio: true,
    video: {
        // video constraints: use preset device
        deviceId: {exact: deviceId}
    }
}

If your system has multiple audio output devices, use setAudioOutput(deviceId) to change the active audio output device, and listen for the audioOutputReady event to be notified when the new output device is active.

player.on('audioOutputReady', function() {
    console.log('Changed audio output to deviceId:', deviceId);
});

// change audio output device
player.record().setAudioOutput(deviceId);

See the full change-audio-output example (demo or source).

If your system has multiple audio input devices and you want to display these devices and allow the user to choose one, check out the the full change-audio-input example (demo or source).

Similarly, if your system has multiple video input devices and you want the user to choose one, check out the change-video-input example (demo or source).

Responsive layout

The fluid option for video.js will resize the player according to the size of the window.

Configure the player; enable the video.js fluid option:

fluid: true

Customizing controls

To disable and hide specific controls, use the video.js controlBar option:

controlBar: {
    // hide fullscreen and volume controls
    fullscreenToggle: false,
    volumePanel: false
},

Custom interface elements for this library that can be hidden are: deviceButton, recordIndicator, cameraButton, pipToggle and recordToggle.

Hotkeys

The hotKeys plugin option allows you to control this plugin using a keyboard (disabled by default). Note that this requires video.js 7.5.0 or newer.

The built-in hotkey handling is:

Key	Action	Description
x	toggle record	start/stop recording (or take snapshot in image-only mode)
c	toggle playback	start/stop playback
p	toggle picture-in-picture	enter/exit picture-in-picture mode (if enabled)

To enable the built-in handler, specify true for the hotKeys plugin option:

record: {
    maxLength: 20,
    debug: true,
    video: true,
    hotKeys: true
},

Or use your own handler by specifying a function:

record: {
    maxLength: 20,
    debug: true,
    video: true,
    hotKeys: function(event) {
        console.log('pressed key: ' + event.which);

        // check https://github.com/timoxley/keycode for codes
        if (event.which == 88) {
            // toggle record button when pressing 'x' key
            player.recordToggle.trigger('click');
        }
    }
},

Check out the hot-keys example (demo or source).

Picture-in-Picture

Picture-in-Picture (PiP) allows users to record and playback in a floating window (always on top of other windows) while interacting with other sites or applications.

Enable the PiP button with the pip option:

record: {
    pip: true
    debug: true,
    video: true,
    maxLength: 20
}

Check out the picture-in-picture example (demo or source).

Other audio libraries

RecordRTC is the default recording library but there is also support for other audio libraries. Check the audio plugins documentation for more information.

Other video libraries

RecordRTC is the default recording library but there is also support for other video libraries. Check the video plugins documentation for more information.

Localization

This plugin supports multiple languages. Each language has it's own file (found in the src/lang directory) that contains the translated text.

Using a different language, for example Dutch (nl), is done by including the plugin's language file and the Video.js language file:

<script src="videojs-record/dist/lang/nl.js"></script>
<script src="video.js/dist/lang/nl.js"></script>

And setting the Video.js player's language option:

language: "nl"

Adding support for an additional language is done by adding a new file with a filename that consists of the country code and the .json extension, eg. fr.json. The build script compiles the JSON into a usable language file, eg. fr.js. Check the Video.js lang directory for a list of supported languages. Pull requests to add more languages to this plugin are always welcome! You can also help out using the Transifex online translation tool.

Webpack

The Webpack wiki page shows how to configure webpack for videojs-record.

Using with React

The React wiki page wiki page shows how to get started with React and videojs-record using the create-react-app tool.

Alternatively, the react example shows how to integrate this plugin in a React component (demo or source).

Using with Angular

The Angular wiki page shows how to setup Angular and videojs-record.

More features using other plugins

The Video.js community created lots of plugins that can be used to enhance the player's functionality.

Development

Install dependencies using npm:

npm install

Build a minified version:

npm run build

Generated files are placed in the dist directory.

During development:

npm run start

This will watch the source directory and rebuild when any changes are detected. It will also serve the files on http://127.0.0.1:8080.

Generate the API documentation (placed in the docs directory):

npm run docs

All commands for development are listed in the package.json file and are run using:

npm run <command>

Font

Check the the font readme for more information.

License

This work is licensed under the MIT License.

Donate

Please consider donating if you like this project. Bitcoin is accepted and can be sent to 3PmXCqUggtq7KUWPbpN8WhMnb1Mfb1jbq8.