Merge branch 'master' into RTC

Author: jallamsetty1

JitsiConference.ts

@@ -29,7 +29,7 @@ export interface IConnectionOptions {
     p2pStunServers: any[];
     serviceUrl: string;
     websocketKeepAlive?: number;
-    websocketKeepAliveUrl?: number;
+    websocketKeepAliveUrl?: string;
     xmppPing?: any;
 }
 
@@ -135,7 +135,7 @@ export default class JitsiConnection {
      * @param args - Optional arguments to be passed to XMPP.disconnect
      * @returns Promise that resolves when the disconnect process is finished or rejects with an error.
      */
-    disconnect(...args: [string?]): Promise<void> {
+    disconnect(...args: any): boolean | Promise<void> {
         // XXX Forward any arguments passed to JitsiConnection.disconnect to
         // XMPP.disconnect. For example, the caller of JitsiConnection.disconnect
         // may optionally pass the event which triggered the disconnect in order to

JitsiConnection.ts

@@ -11,14 +11,15 @@ const VIDEO_PERMISSION_NAME = 'camera' as PermissionName;
 
 /**
  * Media devices utilities for Jitsi.
+ * @noInheritDoc
  */
-class JitsiMediaDevices extends Listenable {
+export default class JitsiMediaDevices extends Listenable {
     private _initialized: boolean;
     private _permissions: { [key: string]: boolean; };
     private _permissionsApiSupported: Promise<boolean>;
 
     /**
-     * Initializes a {@code JitsiMediaDevices} object. There will be a single
+     * Initializes a `JitsiMediaDevices` object. There will be a single
      * instance of this class.
      */
     constructor() {
@@ -28,8 +29,55 @@ class JitsiMediaDevices extends Listenable {
         this._permissionsApiSupported = Promise.resolve(false);
     }
 
+    /**
+     * Parses a PermissionState object and returns true for granted and false otherwise.
+     *
+     * @param {PermissionState} permissionStatus - The PermissionState object retrieved from the Permissions API.
+     * @returns {boolean} - True for granted and false for denied.
+     * @throws {TypeError}
+     */
+    private _parsePermissionState(permissionStatus: PermissionStatus = {} as PermissionStatus): boolean {
+        const status = permissionStatus.state;
+
+        if (typeof status !== 'string') {
+            throw new TypeError();
+        }
+
+        return status === PERMISSION_GRANTED_STATUS;
+    }
+
+    /**
+     * Updates the local granted/denied permissions cache. A permissions might be
+     * granted, denied, or undefined. This is represented by having its media
+     * type key set to `true` or `false` respectively.
+     *
+     * @param {Object} permissions - Object with the permissions.
+     */
+    private _handlePermissionsChange(permissions: { [key: string]: boolean; }): void {
+        const hasPermissionsChanged
+            = [ MediaType.AUDIO, MediaType.VIDEO ]
+                .some(type => type in permissions && permissions[type] !== this._permissions[type]);
+
+        if (hasPermissionsChanged) {
+            this._permissions = {
+                ...this._permissions,
+                ...permissions
+            };
+            this.eventEmitter.emit(JitsiMediaDevicesEvents.PERMISSIONS_CHANGED, this._permissions);
+
+            if (this._permissions[MediaType.AUDIO] || this._permissions[MediaType.VIDEO]) {
+                // Triggering device list update when the permissions are granted in order to update
+                // the labels the devices.
+                this.enumerateDevices(() => {
+                    // Empty callback - device list update triggered
+                });
+            }
+        }
+    }
+
     /**
      * Initialize. Start listening for device changes and initialize permissions checks.
+     * @internal
      */
     init(): void {
         if (this._initialized) {
@@ -104,52 +152,6 @@ class JitsiMediaDevices extends Listenable {
         });
     }
 
-    /**
-     * Parses a PermissionState object and returns true for granted and false otherwise.
-     *
-     * @param {PermissionState} permissionStatus - The PermissionState object retrieved from the Permissions API.
-     * @returns {boolean} - True for granted and false for denied.
-     * @throws {TypeError}
-     */
-    _parsePermissionState(permissionStatus: PermissionStatus = {} as PermissionStatus): boolean {
-        const status = permissionStatus.state;
-
-        if (typeof status !== 'string') {
-            throw new TypeError();
-        }
-
-        return status === PERMISSION_GRANTED_STATUS;
-    }
-
-    /**
-     * Updates the local granted/denied permissions cache. A permissions might be
-     * granted, denied, or undefined. This is represented by having its media
-     * type key set to {@code true} or {@code false} respectively.
-     *
-     * @param {Object} permissions - Object with the permissions.
-     */
-    _handlePermissionsChange(permissions: { [key: string]: boolean; }): void {
-        const hasPermissionsChanged
-            = [ MediaType.AUDIO, MediaType.VIDEO ]
-                .some(type => type in permissions && permissions[type] !== this._permissions[type]);
-
-        if (hasPermissionsChanged) {
-            this._permissions = {
-                ...this._permissions,
-                ...permissions
-            };
-            this.eventEmitter.emit(JitsiMediaDevicesEvents.PERMISSIONS_CHANGED, this._permissions);
-
-            if (this._permissions[MediaType.AUDIO] || this._permissions[MediaType.VIDEO]) {
-                // Triggering device list update when the permissions are granted in order to update
-                // the labels the devices.
-                this.enumerateDevices(() => {
-                    // Empty callback - device list update triggered
-                });
-            }
-        }
-    }
-
     /**
      * Executes callback with list of media devices connected.
      * @param {function} callback
@@ -267,5 +269,3 @@ class JitsiMediaDevices extends Listenable {
         return RTC.setAudioOutputDevice(deviceId);
     }
 }
-
-export default new JitsiMediaDevices();

JitsiMediaDevices.ts

@@ -120,14 +120,16 @@ export interface IJoinConferenceOptions {
     tracks?: JitsiLocalTrack[];
 }
 
+const mediaDevices = new JitsiMediaDevices();
+
 /**
- * The public API of the Jitsi Meet library (a.k.a. {@code JitsiMeetJS}).
+ * The public API of the Jitsi Meet library (a.k.a. `JitsiMeetJS`).
  */
-export default {
+const JitsiMeetJS = {
     JitsiConnection,
 
     /**
-     * {@code ProxyConnectionService} is used to connect a remote peer to a local Jitsi participant without going
+     * `ProxyConnectionService` is used to connect a remote peer to a local Jitsi participant without going
      * through a Jitsi conference. It is currently used for room integration development, specifically wireless
      * screensharing. Its API is experimental and will likely change; usage of it is advised against.
      */
@@ -373,7 +375,7 @@ export default {
         // @ts-ignore
         logger.info(`This appears to be ${browser.getName()}, ver: ${browser.getVersion()}`);
 
-        JitsiMediaDevices.init();
+        mediaDevices.init();
         Settings.init(options.externalStorage);
         Statistics.init(options);
 
@@ -423,8 +425,8 @@ export default {
      * Returns whether the current execution environment supports WebRTC (for
      * use within this library).
      *
-     * @returns {boolean} {@code true} if WebRTC is supported in the current
-     * execution environment (for use within this library); {@code false},
+     * @returns {boolean} `true` if WebRTC is supported in the current
+     * execution environment (for use within this library); `false`,
      * otherwise.
      */
     isWebRtcSupported() {
@@ -521,7 +523,7 @@ export default {
     },
 
     logLevels: Logger.levels,
-    mediaDevices: JitsiMediaDevices as unknown,
+    mediaDevices,
 
     /**
      * Removes global logging transport from the library logging framework.
@@ -629,7 +631,7 @@ export default {
      * Informs lib-jitsi-meet about the current network status.
      *
      * @param {object} state - The network info state.
-     * @param {boolean} state.isOnline - {@code true} if the internet connectivity is online or {@code false}
+     * @param {boolean} state.isOnline - `true` if the internet connectivity is online or `false`
      * otherwise.
      */
     setNetworkInfo({ isOnline }) {
@@ -646,3 +648,5 @@ export default {
     },
     version: COMMIT_HASH
 };
+
+export default JitsiMeetJS;

JitsiMeetJS.ts

@@ -52,7 +52,6 @@ export default class JitsiParticipant {
     /**
      * Initializes a new JitsiParticipant instance.
      *
-     * @constructor
      * @param jid the conference XMPP jid
      * @param conference
      * @param displayName
@@ -391,8 +390,8 @@ export default class JitsiParticipant {
     /**
      * Sets the value of a property of this participant, and fires an event if
      * the value has changed.
-     * @name the name of the property.
-     * @value the value to set.
+     * @param {string} name the name of the property.
+     * @param {any} value the value to set.
      */
     setProperty(name: string, value: any): void {
         const oldValue = this._properties.get(name);

JitsiParticipant.ts

@@ -51,7 +51,6 @@ export default class JitsiTrackError extends Error {
     public gum?: IGum;
 
     /**
-     * @constructor
      * @param {IGumError|string} error - error object or error name
      * @param {IGumOptions|string} [options] - getUserMedia constraints object or error message
      * @param {DeviceType[]} [devices] - list of getUserMedia requested devices