RecordRTC: WebRTC JavaScript Library for Audio+Video+Screen Recording
https://www.webrtc-experiment.com/RecordRTC/
Demo:Chrome-Extensions/screen-recording
Chrome Extension:RecordRTC Documentation / RecordRTC Wiki Pages / RecordRTC Demo / WebRTC Experiments
RecordRTC is a JavaScript-based media-recording library for modern web-browsers (supporting WebRTC getUserMedia API). It is optimized for different devices and browsers to bring all client-side (pluginfree) recording solutions in single place.
Check all releases:
Please check dev directory for development files.
- RecordRTC API Reference
- MediaStreamRecorder API Reference
- StereoAudioRecorder API Reference
- WhammyRecorder API Reference
- Whammy API Reference
- CanvasRecorder API Reference
- MultiStreamRecorder API Reference
- MRecordRTC API Reference
- RecordRTCPromisesHandler API Reference
- GifRecorder API Reference
- Global API Reference 12 RecordRTC and Upload to PHP Server
Browsers Support:
Browser | Support | Features |
---|---|---|
Firefox | Stable / Aurora / Nightly | Audio+Video (Both local/remote) |
Google Chrome | Stable / Canary / Beta / Dev | Audio+Video (Both local/remote) |
Opera | Stable / NEXT | Audio+Video (Both local/remote) |
Android | Chrome / Firefox / Opera | Audio+Video (Both local/remote) |
Microsoft Edge | Normal Build | Only Audio - No Video - No Canvas - No Screen |
Safari 11 | preview/beta (OSX/iOS11) | Only StereoAudioRecorder - No Video - No Canvas - No Screen |
Frameworks
- Angular2 - check article and demo github repository - via #186
- React.js - check this article and demo github repository
- Video.js - check this github repository
- meteor - check an old github repository
Want to add more? Please make a pull-request to update
README.md
Tests?
Tests source code:
Free?
It is MIT Licenced, which means that you can use it in any commercial/non-commercial product, free of cost.
RecordRTC Containers Format
RecordRTC supports vp9, vp8, h264, mkv, opus/vorbis, and pcm (mono/stereo).
vp9
var options = recorderType: MediaStreamRecorder mimeType: 'video/webm\;codecs=vp9';var recordRTC = ;
vp8
var options = recorderType: MediaStreamRecorder mimeType: 'video/webm\;codecs=vp8';var recordRTC = ;
h264
var options = recorderType: MediaStreamRecorder mimeType: 'video/webm\;codecs=h264';var recordRTC = ;
pcm
var options = recorderType: StereoAudioRecorder mimeType: 'audio/wav';var recordRTC = ;
opus
var options = recorderType: MediaStreamRecorder mimeType: 'audio/webm' // Firefox also supports: "audio/ogg";var recordRTC = ;
Media File | Bitrate/Framerate | encoders | Framesize | additional info |
---|---|---|---|---|
Audio File (WAV) | 1411 kbps | pcm_s16le | 44100 Hz | stereo, s16 |
Video File (WebM) | 60 kb/s | (whammy) vp8 codec yuv420p | -- | SAR 1:1 DAR 4:3, 1k tbr, 1k tbn, 1k tbc (default) |
RecordRTC Demos
- RecordRTC to Node.js
- RecordRTC to PHP
- RecordRTC to ASP.NET MVC
- RecordRTC & HTML-2-Canvas i.e. Canvas/HTML Recording!
- MRecordRTC i.e. Multi-RecordRTC!
- RecordRTC on Ruby!
- RecordRTC over Socket.io
- ffmpeg-asm.js and RecordRTC! Audio/Video Merging & Transcoding!
- RecordRTC / PHP / FFmpeg
- Record Audio and upload to Nodejs server
- ConcatenateBlobs.js - Concatenate multiple recordings in single Blob!
- Remote audio-stream recording or a real p2p demo
- Mp3 or Wav Recording
- Record entire DIV including video, image, textarea, input, drag/move/resize, everything
- Record canvas 2D drawings, lines, shapes, texts, images, drag/resize/enlarge/move via a huge drawing tool!
- Record Canvas2D Animation
- WebGL animation recording
- Plotly - WebGL animation recording
You can also try a chrome extension for screen recording:
How to link?
NPM install
npm install recordrtc
# you can use with "require" (browserify/nodejs)
var RecordRTC = require('recordrtc');
var recorder = RecordRTC({}, {
type: 'video',
recorderType: RecordRTC.WhammyRecorder
});
console.log('\n--------\nRecordRTC\n--------\n');
console.log(recorder);
console.log('\n--------\nstartRecording\n--------\n');
recorder.startRecording();
console.log('\n--------\nprocess.exit()\n--------\n');
process.exit()
Here is how to use require
:
var RecordRTC = ;var Whammy = RecordRTCWhammy;var WhammyRecorder = RecordRTCWhammyRecorder;var StereoAudioRecorder = RecordRTCStereoAudioRecorder;// and so on var video = 100;var recorder = stream options;
<!-- link npm package scripts -->
There are some other NPM packages regarding RecordRTC:
bower install
bower install recordrtc
<!-- link bower package scripts -->
CDN
<!-- CDN --> <!-- non-CDN -->
Otherwise check cdnjs below.
Releases
You can even link specific releases:
<!-- use 5.4.8 or any other version on cdnjs -->
Note: You can use RecordRTC.min.js
as well. (on webrtc-experiment or cdnjs)
How to capture stream?
Record audio+video
You'll be recording both audio/video in single WebM or Mp4 container.
var recordRTC; { // RecordRTC usage goes here var options = mimeType: 'video/webm' // or video/webm\;codecs=h264 or video/webm\;codecs=vp9 audioBitsPerSecond: 128000 videoBitsPerSecond: 128000 bitsPerSecond: 128000 // if this line is provided, skip above two ; recordRTC = ; recordRTC;} { // maybe another application is using the device} var mediaConstraints = video: true audio: true ; navigatormediaDevices; btnStopRecording { recordRTC;};
Record only Audio
var recordRTC = ;recordRTC;recordRTC;
options
RecordRTC requires a second parameter named as options
or configuration
or hints
or preferences
:
var options = recorderType: MediaStreamRecorder mimeType: 'video/webm\;codecs=vp9';var recordRTC = ;
You can pass options
object over startRecording
method as well:
var recordRTC = ; var options = recorderType: MediaStreamRecorder mimeType: 'video/webm\;codecs=vp9';recordRTC;
type
acceptsvideo
oraudio
orcanvas
orgif
mimeType
accepts all these valuesrecorderType
acceptsMediaStreamRecorder
orStereoAudioRecorder
orWhammyRecorder
orGifRecorder
or any recorder type from this pagetimeSlice
accepts numbers in milliseconds; use this to force intervals-based blobsondataavailable
pass this function along withtimeSlice
to get intervals based blobscheckForInactiveTracks
acceptstrue
orfalse
; use this to disable default inactive-stream-checker functionsonTimeStamp
it is a function that is called-back by the MediaStreamRecorder;timeSlice
parameter is required for this functionbitsPerSecond
accepts numbers in bits; applies both to audio and video tracksaudioBitsPerSecond
accepts numbers in bits; applies only to audio tracksvideoBitsPerSecond
accepts numbers in bits; applies only to video tracksdisableLogs
acceptstrue
orfalse
; use this to disable console logsframeInterval
accepts numbers in milliseconds; use this with MultiStreamRecorder, CanvasRecorder and WhammyRecorderpreviewStream
it is a function that is called-back by the MultiStreamRecordervideo
accepts object similar to this:{width: 320, height: 240}
; pass this parameter for MultiStreamRecorder, CanvasRecorder and WhammyRecordercanvas
accepts object similar to this:{width: 320, height: 240}
; pass this parameter for MultiStreamRecorder, CanvasRecorder and WhammyRecordersampleRate
used only by the StereoAudioRecorderbufferSize
used only by the StereoAudioRecordernumberOfAudioChannels
used only by the StereoAudioRecorder
Record Multiple Videos
Demos:
You can record many videos/streams in single WebM/Mp4 file (WebRTC Conference Recording):
var arrayOfStreams = localStream remoteStream1 remoteStream2 remoteStream3; var recordRTC = ;recordRTC;recordRTC;
Points:
- Instead of passing single
MediaStream
, you are passing array ofMediaStreams
- You will get single webm or mp4 according to your
mimeType
MultiStreamRecorder.js
supports two extra methods:
addStreams
resetVideoStreams
var msRecorder = recorder;if msRecorder instanceof MultiStreamRecorder msRecorder; msRecorder;
Usecases:
- You can add more audio and/or video streams during live recording (using
addStreams
method) - You can reset/remove/replace old videos using
resetVideoStreams
resetVideoStreams
can be used to recorded screenStream in full-screen mode e.g.
if yourScreenisScreen === true yourScreenfullcanvas = true; yourScreenwidth = windowscreenwidth; yourScreenheight = windowscreenheight; // now it will record all audios + only_this_screen internalRecorder;
As soon as screen is stopped:
;
getInternalRecorder
You can get access to internal recorders e.g. MultiStreamRecorder, MediaStreamRecorder, StereoAudioRecorder, WhammyRecorder etc.
Use
getInternalRecorder
only afterstartRecording
. It may returnNULL
according to RecordRTC current state.
// if RecordRTC recording in-progressif recorderstate === 'recording' // get MediaStreamRecorder var msRecorder = recorder; // always check for NULL or verify the recorder type if msRecorder instanceof MultiStreamRecorder // it is NOT NULL // also it is MultiStreamRecorder instance // now we can use these extra methods msRecorder; msRecorder;
Internal recorders can add extra methods. Same as MultiStreamRecorder which is supporting two extra methods:
addStreams
resetVideoStreams
onStateChanged
Use this method to detect status of the recording:
recorder = ; recorder;
state
Use this property to detect status of the recording:
recorder = ; ; recorder; ; recorder;
You can even use getState
method:
;
version
Detect current RecordRTC version:
recorder = ; ;
You can even use RecordRTC.version
:
;
Echo Issues
Simply set volume=0
or muted=true
over <audio>
or <video>
element:
videoElementmuted = true;audioElementmuted = true;
Otherwise, you can pass some media constraints:
{ // RecordRTC usage goes here} { // maybe another application is using the device} var mediaConstraints = audio: mandatory: echoCancellation: false googAutoGainControl: false googNoiseSuppression: false googHighpassFilter: false optional: googAudioMirroring: false ; navigatormediaDevices;
Record Video
Everything is optional except type:'video'
:
var options = type: 'video' frameInterval: 20 // minimum time between pushing frames to Whammy (in milliseconds);var recordRTC = ;recordRTC;recordRTC;
Record animated GIF image
Everything is optional except type:'gif'
:
// you must "manually" link:// https://cdn.webrtc-experiment.com/gif-recorder.js var options = type: 'gif' frameRate: 200 quality: 10;var recordRTC = ;recordRTC;recordRTC;
Record a Webpage
You can say it: "HTML/Canvas Recording using RecordRTC"!
See a demo: /Canvas-Recording/
<canvas>
Record You can even record Canvas2D drawings:
Live Demo:
Watch a video: https://vimeo.com/152119435
API Reference
initRecorder
It is a function that can be used to initiate recorder however skip getting recording outputs. It will provide maximum accuracy in the outputs after using startRecording
method. Here is how to use it:
var audioRecorder = ; var videoRecorder = ; videoRecorder;
After using stopRecording
, you'll see that both WAV/WebM blobs are having following charachteristics:
- Both are having same recording duration i.e. length
- Video recorder is having no blank frames
- Audio recorder is having no empty buffers
This method is really useful to sync audio/video outputs.
setRecordingDuration
You can ask RecordRTC to auto stop recording after specific duration. It accepts one mandatory and one optional argument:
recordRTC; // the easiest one:recordRTC;
Try a simple demo; paste in the chrome console:
navigatormediaDevices;
clearRecordedData
This method can be used to clear old recorded frames/buffers. Snippet:
recorder;
recorderType
If you're using recorderType
then you don't need to use type
. Second one will be redundant i.e. skipped.
You can force any Recorder by passing this object over RecordRTC constructor:
var audioRecorder =
It means that ALL_BROWSERS will be using StereoAudioRecorder i.e. WebAudio API for audio recording.
This feature brings remote audio recording support in Firefox, and local audio recording support in Microsoft Edge.
Note: Chrome >=50
supports remote audio+video recording.
You can even force WhammyRecorder
on Firefox however webp format isn't yet supported in standard Firefox builds. It simply means that, you're skipping MediaRecorder API in Firefox.
type
If you are NOT using recorderType
parameter then type
parameter can be used to ask RecordRTC choose best recorder-type for recording.
// if it is Firefox, then RecordRTC will be using MediaStreamRecorder.js// if it is Chrome or Opera, then RecordRTC will be using WhammyRecorder.jsvar recordVideo = ; // if it is Firefox, then RecordRTC will be using MediaStreamRecorder.js// if it is Chrome or Opera or Edge, then RecordRTC will be using StereoAudioRecorder.jsvar recordVideo = ;
frameInterval
Set minimum interval (in milliseconds) between each time we push a frame to Whammy recorder.
var whammyRecorder = ;
disableLogs
You can disable all the RecordRTC logs by passing this Boolean:
var recorder = ;
numberOfAudioChannels
You can force StereoAudioRecorder to record single-audio-channel only. It allows you reduce WAV file size to half.
var audioRecorder = ;
It will reduce WAV size to half!
This feature is useful only in Chrome and Microsoft Edge (WAV-recorders). It can work in Firefox as well.
How to set video width/height?
var options = type: 'video' video: width: 320 height: 240 canvas: width: 320 height: 240 ; var recordVideo = ;
pauseRecording
Note: Firefox seems has a bug. It is unable to pause the recording. Seems internal bug because they correctly changes
mediaRecorder.state
fromrecording
topaused
but they are unable to pause internal recorders.
RecordRTC pauses recording buffers/frames.
recordRTC;
resumeRecording
If you're using "initRecorder" then it asks RecordRTC that now its time to record buffers/frames. Otherwise, it asks RecordRTC to not only initialize recorder but also record buffers/frames.
recordRTC;
getDataURL
Optionally get "DataURL" object instead of "Blob".
recordRTC;
getBlob
Get "Blob" object. A blob object looks similar to input[type=file]
. Which means that you can append it to FormData
and upload to server using XMLHttpRequest object. Even socket.io nowadays supports blob-transmission.
blob = recordRTC;
toURL
A virtual URL. It can be used only inside the same browser. You can't share it. It is just providing a preview of the recording.
window;
save
Invoke save-as dialog. You can pass "fileName" as well; though fileName argument is optional.
recordRTC;
bufferSize
Here is how to customize Buffer-Size for audio recording?
// From the spec: This value controls how frequently the audioprocess event is// dispatched and how many sample-frames need to be processed each call.// Lower values for buffer size will result in a lower (better) latency.// Higher values will be necessary to avoid audio breakup and glitches// bug: how to minimize wav size?// workaround? obviously ffmpeg!// The size of the buffer (in sample-frames) which needs to// be processed each time onprocessaudio is called. // Legal values are (256, 512, 1024, 2048, 4096, 8192, 16384). var options = type: 'audio' recorderType: StereoAudioRecorder bufferSize: 16384;var recordRTC = ;
Following values are allowed for buffer-size:
// Legal values are (256, 512, 1024, 2048, 4096, 8192, 16384)
If you passed invalid value then you'll get blank audio.
sampleRate
Here is how to customize Sample-Rate for audio recording?
// The sample rate (in sample-frames per second) at which the// AudioContext handles audio. It is assumed that all AudioNodes// in the context run at this rate. In making this assumption,// sample-rate converters or "varispeed" processors are not supported// in real-time processing.// The sampleRate parameter describes the sample-rate of the// linear PCM audio data in the buffer in sample-frames per second. // An implementation must support sample-rates in at least// the range 22050 to 96000. var options = type: 'audio' recorderType: StereoAudioRecorder sampleRate: 96000;var recordRTC = ;
Values for sample-rate must be greater than or equal to 22050 and less than or equal to 96000.
If you passed invalid value then you'll get blank audio.
You can pass custom sample-rate values only on Mac (or additionally maybe on Windows 10).
desiredSampRate
Set sample rates such as 8K or 16K. Reference: http://stackoverflow.com/a/28977136/552182
// record 16khz audiovar options = type: 'audio' recorderType: StereoAudioRecorder desiredSampRate: 16 * 1000 // bits-per-sample * 1000;var recordRTC = ;
mimeType
This option allows you set MediaRecorder output format:
var options = mimeType: 'video/webm' // or video/webm\;codecs=h264 or video/webm\;codecs=vp9 bitsPerSecond: 128000;var recorder = ;
Note: For chrome, it will simply auto-set type:audio or video
parameters to keep supporting StereoAudioRecorder.js
and WhammyRecorder.js
.
That is, you can skip passing type:audio
parameter when you're using mimeType
parameter.
isMimeTypeSupported
{ // if (webrtcDetectedBrowser === 'edge') return false; if typeof MediaRecorderisTypeSupported !== 'function' return true; return MediaRecorder;}
Detect Audio Formats:
var mimeType = 'audio/mpeg';var recorderType = MediaStreamRecorder; if === false console; mimeType = 'audio/ogg'; if === false console; mimeType = 'audio/webm'; if === false console; // fallback to WebAudio solution mimeType = 'audio/wav'; recorderType = StereoAudioRecorder; var recorder = ;
Detect Video Formats:
var mimeType = 'video/x-matroska;codecs=avc1'; // MKVvar recorderType = MediaStreamRecorder; if === false console; mimeType = 'video/webm\;codecs=h264'; // H264 if === false console; mimeType = 'video/webm\;codecs=vp9'; // VP9 if === false console; mimeType = 'video/webm\;codecs=vp8'; // VP8 if === false console; mimeType = 'video/webm'; // do NOT pass any codecs (vp8 by default) if === false console; // fallback to Whammy (WebP+WebM) solution mimeType = 'video/webm'; recorderType = WhammyRecorder; var recorder = ;
bitsPerSecond
The chosen bitrate for the audio and video components of the media. If this is specified along with one or the other of the above properties, this will be used for the one that isn't specified.
var options = mimeType 'video/webm' // or video/mp4 or audio/ogg bitsPerSecond: 128000;var recorder = ;
audioBitsPerSecond
The chosen bitrate for the audio component of the media.
var options = mimeType 'audio/ogg' audioBitsPerSecond: 128000;var recorder = ;
videoBitsPerSecond
The chosen bitrate for the video component of the media.
var options = mimeType 'video/webm' // or video/mp4 videoBitsPerSecond: 128000;var recorder = ;
onAudioProcessStarted
Note: "initRecorder" is preferred over this old hack. Both works similarly.
Useful to recover audio/video sync issues inside the browser:
recordAudio = ; recordVideo = ; recordAudio;
onAudioProcessStarted
fixes shared/exclusive audio gap (a little bit). Because shared audio sometimes causes 100ms delay...
sometime about 400-to-500 ms delay.
Delay depends upon number of applications concurrently requesting same audio devices and CPU/Memory available.
Shared mode is the only mode currently available on 90% of windows systems especially on windows 7.
autoWriteToDisk
Using autoWriteToDisk
; you can suggest RecordRTC to auto-write to indexed-db as soon as you call stopRecording
method.
var recordRTC = ;
autoWriteToDisk
is helpful for single stream recording and writing to disk; however for MRecordRTC
; writeToDisk
is preferred one.
writeToDisk
You can write recorded blob to disk using writeToDisk
method:
recordRTC;recordRTC;
getFromDisk
You can get recorded blob from disk using getFromDisk
method:
// get all blobs from diskRecordRTC; // or get just single blobRecordRTC;
For MRecordRTC; you can use word MRecordRTC
instead of RecordRTC
!
Another possible situation!
var recordRTC = ;recordRTC;recordRTC; // "recordRTC" instance object to invoke "getFromDisk" method!recordRTC;
In the above example; you can see that recordRTC
instance object is used instead of global RecordRTC
object.
destroy
Destroy all internal recorders. Clear memory and ask RecordRTC to stop doing anything internally:
recorder;
Note: You can use this method anytime, anywhere; even during recording a stream.
Promises
Demo:
Credits
- Recorderjs for audio recording
- whammy for video recording
- jsGif for gif recording
Spec & Reference
RecordRTC.org domain
Contribute inThe domain https://RecordRTC.org is open-sourced here:
Issues/Questions?
- Stackoverflow: http://stackoverflow.com/questions/tagged/recordrtc
- Github: https://github.com/muaz-khan/RecordRTC/issues
- Disqus: https://www.webrtc-experiment.com/RecordRTC/#ask
- Email: muazkh@gmail.com
Travis Failed?
Steps to fix it (for your private projects only):
Modify package.json
and search this line:
Replace it with (i.e. ignore all "test"):
Why? Reason is this file: test/browserstack.config.js
'browserstack.user': processenvBROWSERSTACK_USERNAME'browserstack.key': processenvBROWSERSTACK_KEY
Your travis do NOT have these environment variables. That's why your travis builds fails.
More info: https://github.com/muaz-khan/RecordRTC/pull/283#issuecomment-308757116
Caution: NEVER make pull-request for modified
package.json
. Modify this file only for your own private projects.
Tests sponsored by
Check all tests here: https://travis-ci.org/muaz-khan/RecordRTC
Source code: https://github.com/muaz-khan/RecordRTC/tree/master/test
License
RecordRTC.js is released under MIT licence . Copyright (c) Muaz Khan.