Add jsdocs

modules/statistics/RTPStatsCollector.js

 /* global require */
 /* jshint -W101 */
 
+var GlobalOnErrorHandler = require("../util/GlobalOnErrorHandler");
 var logger = require("jitsi-meet-logger").getLogger(__filename);
 var RTCBrowserType = require("../RTC/RTCBrowserType");
-var StatisticsEvents = require("../../service/statistics/Events");
-var GlobalOnErrorHandler = require("../util/GlobalOnErrorHandler");
+import * as StatisticsEvents from "../../service/statistics/Events";
 
 /* Whether we support the browser we are running into for logging statistics */
 var browserSupported = RTCBrowserType.isChrome() ||
         if (audioLevel) {
             const isLocal = !getStatValue(now, 'packetsReceived');
 
-            // TODO: can't find specs about what this value really is,
-            // but it seems to vary between 0 and around 32k.
+            // TODO: Can't find specs about what this value really is, but it
+            // seems to vary between 0 and around 32k.
             audioLevel = audioLevel / 32767;
             ssrcStats.setSsrcAudioLevel(audioLevel);
             this.eventEmitter.emit(

modules/statistics/statistics.js

 /* global require */
-var LocalStats = require("./LocalStatsCollector.js");
-var logger = require("jitsi-meet-logger").getLogger(__filename);
-var RTPStats = require("./RTPStatsCollector.js");
-var EventEmitter = require("events");
-var StatisticsEvents = require("../../service/statistics/Events");
 var AnalyticsAdapter = require("./AnalyticsAdapter");
 var CallStats = require("./CallStats");
-var ScriptUtil = require('../util/ScriptUtil');
+var EventEmitter = require("events");
 import JitsiTrackError from "../../JitsiTrackError";
+var logger = require("jitsi-meet-logger").getLogger(__filename);
+var LocalStats = require("./LocalStatsCollector.js");
+var RTPStats = require("./RTPStatsCollector.js");
+var ScriptUtil = require('../util/ScriptUtil');
+import * as StatisticsEvents from "../../service/statistics/Events";
 
 /**
  * True if callstats API is loaded

modules/talkmuted/TalkMutedDetection.js

          */
         this._callback = callback;
 
+        /**
+         * The indicator which determines whether <tt>callback</tt> has been
+         * invoked for the current local audio track of <tt>conference</tt> so
+         * that it is invoked once only.
+         *
+         * @private
+         */
+        this._eventFired = false;
+
+        // XXX I went back and forth on the subject of where to put the access
+        // to statistics. On the one had, (1) statistics is likely intended to
+        // be private to conference and (2) there is a desire to keep the
+        // dependencies of modules to the minimum (i.e. not have
+        // TalkMutedDetection depend on statistics). On the other hand, (1)
+        // statistics is technically not private because
+        // JitsiConferenceEventManager accesses it and (2) TalkMutedDetection
+        // works exactly because it knows that there are no audio levels for
+        // JitsiLocalTrack but there are audio levels for the local participant
+        // through statistics.
         conference.statistics.addAudioLevelListener(
-            this.audioLevelListener.bind(this));
+            this._audioLevel.bind(this));
+
         conference.on(
             JitsiConferenceEvents.TRACK_MUTE_CHANGED,
             this._trackMuteChanged.bind(this));
         conference.on(
             JitsiConferenceEvents.TRACK_ADDED,
             this._trackAdded.bind(this));
-
-        // we track firing the event, in order to avoid sending too many events
-        this.eventFired = false;
     }
 
     /**
-     * Receives audio level events for all send/receive streams.
-     * @param ssrc the ssrc of the stream
-     * @param level the current audio level
-     * @param isLocal whether this is local or remote stream (sent or received)
+     * Receives audio level events for all send and receive streams.
+     *
+     * @param ssrc - The synchronization source identifier (SSRC) of the
+     * endpoint/participant/stream being reported.
+     * @param {number} audioLevel - The audio level of <tt>ssrc</tt>.
+     * @param {boolean} isLocal - <tt>true</tt> if <tt>ssrc</tt> represents a
+     * local/send stream or <tt>false</tt> for a remote/receive stream.
      */
-    audioLevelListener(ssrc, level, isLocal) {
-        // we are interested only in local audio stream
-        // and if event is not already sent
-        if (!isLocal || !this.audioTrack || this.eventFired)
+    _audioLevel(ssrc, audioLevel, isLocal) {
+        // We are interested in the local audio stream only and if event is not
+        // sent yet.
+        if (!isLocal || !this.audioTrack || this._eventFired)
             return;
 
-        if (this.audioTrack.isMuted() && level > 0.6) {
-            this.eventFired = true;
+        if (this.audioTrack.isMuted() && audioLevel > 0.6) {
+            this._eventFired = true;
             this._callback();
         }
     }
 
     /**
-     * Adds local tracks. We are interested only in the audio one.
-     * @param track
+     * Determines whether a specific {@link JitsiTrack} represents a local audio
+     * track.
+     *
+     * @param {JitsiTrack} track - The <tt>JitsiTrack</tt> to be checked whether
+     * it represents a local audio track.
      * @private
+     * @return {boolean} - <tt>true</tt> if the specified <tt>track</tt>
+     * represents a local audio track; otherwise, <tt>false</tt>.
      */
-    _trackAdded(track) {
-        if (!track.isAudioTrack() || !track.isLocal())
-            return;
+    _isLocalAudioTrack(track) {
+        return track.isAudioTrack() && track.isLocal();
+    }
 
-        this.audioTrack = track;
+    /**
+     * Notifies this <tt>TalkMutedDetection</tt> that a {@link JitsiTrack} was
+     * added to the associated {@link JitsiConference}. Looks for the local
+     * audio track only.
+     *
+     * @param {JitsiTrack} track - The added <tt>JitsiTrack</tt>.
+     * @private
+     */
+    _trackAdded(track) {
+        if (this._isLocalAudioTrack(track))
+            this.audioTrack = track;
     }
 
     /**
-     * Mute changed for a track.
-     * @param track the track which mute state has changed.
+     * Notifies this <tt>TalkMutedDetection</tt> that the mute state of a
+     * {@link JitsiTrack} has changed. Looks for the local audio track only.
+     *
+     * @param {JitsiTrack} track - The <tt>JitsiTrack</tt> whose mute state has
+     * changed.
      * @private
      */
     _trackMuteChanged(track) {
-        if (track.isLocal() && track.isAudioTrack() && track.isMuted())
-            this.eventFired = false;
+        if (this._isLocalAudioTrack(track) && track.isMuted())
+            this._eventFired = false;
     }
 }

service/statistics/Events.js

-module.exports = {
-    /**
-     * Notifies for audio level in rtp statistics by ssrc.
-     */
-    AUDIO_LEVEL: "statistics.audioLevel",
-    /**
-     * Notifies about audio problem with remote participant.
-     */
-    AUDIO_NOT_WORKING: "statistics.audio_not_working",
-    /**
-     * An event carrying connection statistics.
-     */
-    CONNECTION_STATS: "statistics.connectionstats",
-    /**
-     * An event carrying all statistics by ssrc.
-     */
-    BYTE_SENT_STATS: "statistics.byte_sent_stats"
-};
+/**
+ * Notifies about audio level in RTP statistics by SSRC.
+ *
+ * @param ssrc - The synchronization source identifier (SSRC) of the
+ * endpoint/participant whose audio level is being reported.
+ * @param {number} audioLevel - The audio level of <tt>ssrc</tt> according to
+ * RTP statistics.
+ * @param {boolean} isLocal - <tt>true</tt> if <tt>ssrc</tt> identifies the
+ * local endpoint/participant; otherwise, <tt>false</tt>.
+ */
+export const AUDIO_LEVEL = "statistics.audioLevel";
+
+/**
+ * Notifies about audio problem with remote participant.
+ */
+export const AUDIO_NOT_WORKING = "statistics.audio_not_working";
+
+/**
+ * An event carrying connection statistics.
+ */
+export const CONNECTION_STATS = "statistics.connectionstats";
+
+/**
+ * An event carrying all statistics by ssrc.
+ */
+export const BYTE_SENT_STATS = "statistics.byte_sent_stats";