@eatsjobs/audio-recorder-polyfill-es
v0.1.1Audio Recorder Polyfill
MediaRecorder polyfill to record audio in Edge and Safari 11. Try it in online demo.
- Spec compatible. In the future when all browsers will support MediaRecorder, you will just remove polyfill.
- Small. Less than 1 KB (minified and gzipped). No dependencies. It uses Size Limit to control size.
- One file. In contrast to other recorders, this polyfill uses “inline worker” and don’t need a separated file for Web Worker.
navigator.mediaDevices.getUserMedia({ audio: true }).then(stream => {
recorder = new MediaRecorder(stream)
recorder.addEventListener('dataavailable', e => {
audio.src = URL.createObjectURL(e.data)
})
recorder.start()
})
Install
Install package:
npm install --save audio-recorder-polyfill
If you bundle your app with "Webpack", "Roll up" or "Parcel", you can dynamic import the polyfill before you application loads
if (!window.MediaRecorder || isIE || isSafari) {
import('audio-recorder-polyfill').then((MediaRecorderPolyfill) => {
window.MediaRecorder = MediaRecorderPolyfill.default || MediaRecorderPolyfill;
}).then(() => {
// start the app
});
}
Or you can load the "UMD" bundle
function loadScript(url, callback) {
var script = document.createElement("script")
script.type = "text/javascript";
if(script.readyState) { // only required for IE <9
script.onreadystatechange = function() {
if ( script.readyState === "loaded" || script.readyState === "complete" ) {
script.onreadystatechange = null;
callback();
}
};
} else { //Others
script.onload = function() {
callback();
};
}
script.src = url;
document.getElementsByTagName("head")[0].appendChild(script);
}
if (!window.MediaRecorder || isIE || isSafari) {
var umdURL = 'https://unpkg.com/audio-recorder-polyfill/dist/audio-polyfill.umd.js';
loadScript(umdURL, function() {
window.MediaRecorder = window.MediaRecorderPolyfill;
// startApplication()
});
}
You can also use the ".mjs" module right in the browser that supports new script type=module tags
<script type='module'>
import MediaRecorderPolyfill from 'https://unpkg.com/audio-recorder-polyfill/dist/audio-polyfill.mjs'
</script>
Usage
In the begging, we need to show a warning in browsers without Web Audio API:
if (MediaRecorder.notSupported) {
noSupport.style.display = 'block'
dictaphone.style.display = 'none'
}
Then you can use standard MediaRecorder API:
let recorder
recordButton.addEventListener('click', () => {
// Request permissions to record audio
navigator.mediaDevices.getUserMedia({ audio: true }).then(stream => {
recorder = new MediaRecorder(stream)
// Set record to <audio> when recording will be finished
recorder.addEventListener('dataavailable', e => {
audio.src = URL.createObjectURL(e.data)
})
// Start recording
recorder.start()
})
})
stopButton.addEventListener('click', () => {
// Stop recording
recorder.stop()
// Remove “recording” icon from browser tab
recorder.stream.getTracks().forEach(i => i.stop())
})
If you need to upload record to the server, we recommend using timeslice
.
MediaRecorder will send recorded data every specified millisecond.
So you will start uploading before recording would finish.
// Will be executed every second with next part of audio file
recorder.addEventListener('dataavailable', e => {
sendNextPiece(e.data)
})
// Dump audio data every second
recorder.start(1000)
Audio Formats
Chrome records natively only to .webm
files. Firefox to .ogg
.
This polyfill saves records to .wav
files. Compression
is not very good, but encoding is fast and simple.
You can get used file format in e.data.type
:
recorder.addEventListener('dataavailable', e => {
e.data.type //=> 'audio/wav' with polyfill
// 'audio/webm' in Chrome
// 'audio/ogg' in Firefox
})
Limitations
This polyfill tries to be MediaRecorder API compatible. But it still has small differences.
- WAV format contains duration in the file header. As result, with
timeslice
orrequestData()
call,dataavailable
will receive a separated file with header on every call. In contrast, MediaRecorder sends header only to firstdataavailable
. Other events receive addition bytes to the same file. - Constructor options are not supported.
- Polyfill ignores method call in the wrong state (like
stop()
duringinactive
state) instead of throwing an error. BlobEvent.timecode
is not supported.
Custom Encoder
If you need audio format with better compression, you can change polyfill encoder:
window.MediaRecorder = require('audio-recorder-polyfill')
+ MediaRecorder.encoder = require('./ogg-opus-encoder')
+ MediaRecorder.mimeType = 'audio/ogg'
The encoder should be a function with Web Worker in the body. Polyfill converts function to the string to make Web Worker.
module.exports = function () {
function encode (input) {
…
}
function dump (sampleRate) {
…
postMessage(output)
}
onmessage = function (e) {
if (e.data[0] === 'encode') {
encode(e.data[1])
} else {
dump(e.data[1])
}
}
}
Metadata
- MIT
- Whatever
- Andrey Sitnik
- released 2/4/2019