浏览代码

Add, expand, fix jsdocs, comments

tags/v0.0.2
Lyubomir Marinov 9 年前
父节点
当前提交
c779d7a958
共有 4 个文件被更改,包括 13 次插入5 次删除
  1. 8
    2
      JitsiConferenceEvents.js
  2. 2
    1
      modules/RTC/JitsiLocalTrack.js
  3. 2
    1
      modules/RTC/JitsiRemoteTrack.js
  4. 1
    1
      modules/RTC/RTCUtils.js

+ 8
- 2
JitsiConferenceEvents.js 查看文件

@@ -4,11 +4,17 @@
4 4
  */
5 5
 var JitsiConferenceEvents = {
6 6
     /**
7
-     * A new media track was added to the conference.
7
+     * A new media track was added to the conference. The event provides the
8
+     * following parameters to its listeners:
9
+     *
10
+     * @param {JitsiTrack} track the added JitsiTrack
8 11
      */
9 12
     TRACK_ADDED: "conference.trackAdded",
10 13
     /**
11
-     * The media track was removed from the conference.
14
+     * The media track was removed from the conference. The event provides the
15
+     * following parameters to its listeners:
16
+     *
17
+     * @param {JitsiTrack} track the removed JitsiTrack
12 18
      */
13 19
     TRACK_REMOVED: "conference.trackRemoved",
14 20
     /**

+ 2
- 1
modules/RTC/JitsiLocalTrack.js 查看文件

@@ -296,7 +296,8 @@ JitsiLocalTrack.prototype.getSSRC = function () {
296 296
 };
297 297
 
298 298
 /**
299
- * Return true;
299
+ * Returns <tt>true</tt>.
300
+ * @returns {boolean} <tt>true</tt>
300 301
  */
301 302
 JitsiLocalTrack.prototype.isLocal = function () {
302 303
     return true;

+ 2
- 1
modules/RTC/JitsiRemoteTrack.js 查看文件

@@ -67,7 +67,8 @@ JitsiRemoteTrack.prototype.isLocal = function () {
67 67
 };
68 68
 
69 69
 /**
70
- * Return false;
70
+ * Returns the synchronization source identifier (SSRC) of this remote track.
71
+ * @returns {string} the SSRC of this remote track
71 72
  */
72 73
 JitsiRemoteTrack.prototype.getSSRC = function () {
73 74
     return this.ssrc;

+ 1
- 1
modules/RTC/RTCUtils.js 查看文件

@@ -637,7 +637,7 @@ var RTCUtils = {
637 637
                     return element;
638 638
                 });
639 639
                 this.getStreamID = function (stream) {
640
-                    // streams from FF endpoints have the characters '{' and '}'
640
+                    // Streams from FF endpoints have the characters '{' and '}'
641 641
                     // that make jQuery choke.
642 642
                     return SDPUtil.filter_special_chars(stream.id);
643 643
                 };

正在加载...
取消
保存