Additional description of audioLevel (#288)

* Additional description of audioLevel Fixes #239 (by answering "yes"). * Added def for outgoing audo tracks
w3c · Jan 17, 2018 · 8584b7d · 8584b7d
1 parent 1ec24b3
commit 8584b7d
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/webrtc-stats.html b/webrtc-stats.html
@@ -2225,6 +2225,27 @@ <h2>
                   level = -round(log10(audioLevel) * 20), with audioLevel 0.0 and values above 127
                   mapped to 127.
                 </p>
+                <p>
+                  The <a>audioLevel</a> represents the output audio
+                  level of the track; thus, if the track is sourced
+                  from an <a>RTCReceiver</a>, does no audio
+                  processing, has a constant level, and has
+                  a <a>volume</a> setting of 1.0, the audio level is
+                  expected to be the same as the audio level of the
+                  source SSRC, while if the <a>volume</a> setting is
+                  0.5, the audioLevel is expected to be half that
+                  value.
+                </p>
+                <p>
+                  For outgoing audio tracks, the audioLevel is the
+                  level of the audio being sent.
+                </p>
+                <p>
+                  The audioLevel is averaged over some small
+                  interval, using the algortihm described
+                  under <a>totalAudioEnergy</a>. The interval used is
+                  implementation dependent.
+                </p>
               </dd>
               <dt>
                 <dfn><code>totalAudioEnergy</code></dfn> of type <span class=