Browse Source

Add jsdocs

dev1
Lyubomir Marinov 8 years ago
parent
commit
39488195d5
2 changed files with 12 additions and 5 deletions
  1. 1
    1
      modules/statistics/RTPStatsCollector.js
  2. 11
    4
      service/statistics/Events.js

+ 1
- 1
modules/statistics/RTPStatsCollector.js View File

@@ -727,9 +727,9 @@ StatsCollector.prototype.processStatsReport = function () {
727 727
             calculatePacketLoss(lostPackets.upload, totalPackets.upload)
728 728
     };
729 729
     this.eventEmitter.emit(StatisticsEvents.CONNECTION_STATS, {
730
+            "bandwidth": this.conferenceStats.bandwidth,
730 731
             "bitrate": this.conferenceStats.bitrate,
731 732
             "packetLoss": this.conferenceStats.packetLoss,
732
-            "bandwidth": this.conferenceStats.bandwidth,
733 733
             "resolution": resolutions,
734 734
             "transport": this.conferenceStats.transport
735 735
         });

+ 11
- 4
service/statistics/Events.js View File

@@ -12,15 +12,22 @@ export const AUDIO_LEVEL = "statistics.audioLevel";
12 12
 
13 13
 /**
14 14
  * Notifies about audio problem with remote participant.
15
+ *
16
+ * @param ssrc - The synchronization source identifier (SSRC) of the remote
17
+ * participant whose audio exhibits problems.
15 18
  */
16 19
 export const AUDIO_NOT_WORKING = "statistics.audio_not_working";
17 20
 
18 21
 /**
19
- * An event carrying connection statistics.
22
+ * An event carrying all statistics by ssrc.
20 23
  */
21
-export const CONNECTION_STATS = "statistics.connectionstats";
24
+export const BYTE_SENT_STATS = "statistics.byte_sent_stats";
22 25
 
23 26
 /**
24
- * An event carrying all statistics by ssrc.
27
+ * An event carrying connection statistics.
28
+ *
29
+ * @param {object} connectionStats - The connection statistics carried by the
30
+ * event such as <tt>bandwidth</tt>, <tt>bitrate</tt>, <tt>packetLoss</tt>,
31
+ * <tt>resolution</tt>, and <tt>transport</tt>.
25 32
  */
26
-export const BYTE_SENT_STATS = "statistics.byte_sent_stats";
33
+export const CONNECTION_STATS = "statistics.connectionstats";

Loading…
Cancel
Save