Add comments to waveConfig and onAmplitudeListener properties in Wave…

…Recorder class
squti · Nov 6, 2019 · 628c089 · 628c089
1 parent 0d6583a
commit 628c089
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/android-wave-recorder/src/main/java/com/github/squti/androidwaverecorder/WaveRecorder.kt b/android-wave-recorder/src/main/java/com/github/squti/androidwaverecorder/WaveRecorder.kt
@@ -41,7 +41,14 @@ import java.nio.ByteOrder
  * @property filePath the path of the file to be saved.
  */
 class WaveRecorder(private var filePath: String) {
+    /**
+     * Configuration for recording audio file.
+     */
     var waveConfig: WaveConfig = WaveConfig()
+    /**
+     * Register a callback to be invoked in every recorded chunk of audio data
+     * to get max amplitude of that chunk.
+     */
     var onAmplitudeListener: ((Int) -> Unit)? = null
     private var isRecording = false
     private lateinit var audioRecorder: AudioRecord