Explain startRecordingAt with a better description

closeio · Jul 7, 2017 · 4444ed3 · 4444ed3
1 parent e0c96e1
commit 4444ed3
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/dist/index.js b/dist/index.js
@@ -15816,7 +15816,11 @@ var MicRecorder = function () {
       // 128 or 160 kbit/s – mid-range bitrate quality
       bitRate: 128,
 
-      // Some browsers have a weird noise when starting the recording, this removes some milliseconds of the mp3 file
+      // There is a known issue with some macOS machines, where the recording
+      // will sometimes have a loud 'pop' or 'pop-click' sound. This flag
+      // prevents getting audio from the microphone a few milliseconds after
+      // the begining of the recording. It also helps to remove the mouse
+      // "click" sound from the output mp3 file.
       startRecordingAt: 300
     };
 

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/index.min.js.map b/dist/index.min.js.map
diff --git a/src/mic-recorder.js b/src/mic-recorder.js
@@ -6,7 +6,11 @@ class MicRecorder {
       // 128 or 160 kbit/s – mid-range bitrate quality
       bitRate: 128,
 
-      // Some browsers have a weird noise when starting the recording, this removes some milliseconds of the mp3 file
+      // There is a known issue with some macOS machines, where the recording
+      // will sometimes have a loud 'pop' or 'pop-click' sound. This flag
+      // prevents getting audio from the microphone a few milliseconds after
+      // the begining of the recording. It also helps to remove the mouse
+      // "click" sound from the output mp3 file.
       startRecordingAt: 300
     };