feat(JitsiLocalTrack): expose source id for desktop sharing tracks

modules/RTC/JitsiLocalTrack.js

@@ -46,20 +46,25 @@ function createMuteUnmutePromise(track, mute) {
  * One <tt>JitsiLocalTrack</tt> corresponds to one WebRTC MediaStreamTrack.
  */
 export default class JitsiLocalTrack extends JitsiTrack {
-    /* eslint-disable max-params */
     /**
      * Constructs new JitsiLocalTrack instanse.
-     * @param {number} rtcId the ID assigned by the RTC module
-     * @param stream WebRTC MediaStream, parent of the track
-     * @param track underlying WebRTC MediaStreamTrack for new JitsiRemoteTrack
-     * @param mediaType the MediaType of the JitsiRemoteTrack
-     * @param videoType the VideoType of the JitsiRemoteTrack
-     * @param resolution the video resolution if it's a video track
-     * @param deviceId the ID of the local device for this track
-     * @param facingMode the camera facing mode used in getUserMedia call
+     * @param {Object} trackInfo
+     * @param {number} trackInfo.rtcId the ID assigned by the RTC module
+     * @param trackInfo.stream WebRTC MediaStream, parent of the track
+     * @param trackInfo.track underlying WebRTC MediaStreamTrack for new
+     * JitsiRemoteTrack
+     * @param trackInfo.mediaType the MediaType of the JitsiRemoteTrack
+     * @param trackInfo.videoType the VideoType of the JitsiRemoteTrack
+     * @param trackInfo.resolution the video resolution if it's a video track
+     * @param trackInfo.deviceId the ID of the local device for this track
+     * @param trackInfo.facingMode the camera facing mode used in getUserMedia
+     * call
+     * @param {sourceId} trackInfo.sourceId - The id of the desktop sharing
+     * source. NOTE: defined for desktop sharing tracks only.
      * @constructor
      */
-    constructor(
+    constructor(trackInfo) {
+        const {
             rtcId,
             stream,
             track,
@@ -67,7 +72,10 @@ export default class JitsiLocalTrack extends JitsiTrack {
             videoType,
             resolution,
             deviceId,
-            facingMode) {
+            facingMode,
+            sourceId
+        } = trackInfo;
+
         super(
             null /* RTC */,
             stream,
@@ -88,6 +96,7 @@ export default class JitsiLocalTrack extends JitsiTrack {
         this.rtcId = rtcId;
         this.dontFireRemoveEvent = false;
         this.resolution = resolution;
+        this.sourceId = sourceId;
 
         // FIXME: currently firefox is ignoring our constraints about
         // resolutions so we do not store it, to avoid wrong reporting of local
@@ -177,8 +186,6 @@ export default class JitsiLocalTrack extends JitsiTrack {
         this._initNoDataFromSourceHandlers();
     }
 
-    /* eslint-enable max-params */
-
     /**
      * Returns if associated MediaStreamTrack is in the 'ended' state
      * @returns {boolean}

modules/RTC/RTC.js

@@ -35,16 +35,12 @@ function createLocalTracks(tracksInfo, options) {
             deviceId = options.cameraDeviceId;
         }
         rtcTrackIdCounter += 1;
-        const localTrack
-            = new JitsiLocalTrack(
-                rtcTrackIdCounter,
-                trackInfo.stream,
-                trackInfo.track,
-                trackInfo.mediaType,
-                trackInfo.videoType,
-                trackInfo.resolution,
-                deviceId,
-                options.facingMode);
+        const localTrack = new JitsiLocalTrack({
+            ...trackInfo,
+            deviceId,
+            facingMode: options.facingMode,
+            rtcId: rtcTrackIdCounter
+        });
 
         newTracks.push(localTrack);
     });

modules/RTC/RTCUtils.js

@@ -628,14 +628,16 @@ function handleLocalStream(streams, resolution) {
             videoStream = streams.video;
         }
 
-        // Again, different choices on different types of browser.
-        desktopStream = streams.desktopStream || streams.desktop;
+        desktopStream = streams.desktop;
     }
 
     if (desktopStream) {
+        const { stream, sourceId } = desktopStream;
+
         res.push({
-            stream: desktopStream,
-            track: desktopStream.getVideoTracks()[0],
+            stream,
+            sourceId,
+            track: stream.getVideoTracks()[0],
             mediaType: MediaType.VIDEO,
             videoType: VideoType.DESKTOP
         });
@@ -1186,9 +1188,9 @@ class RTCUtils extends Listenable {
                             if (hasDesktop) {
                                 screenObtainer.obtainStream(
                                     dsOptions,
-                                    desktopStream => {
+                                    desktop => {
                                         successCallback({ audioVideo: stream,
-                                            desktopStream });
+                                            desktop });
                                     }, error => {
                                         self.stopMediaStream(stream);
 
@@ -1203,7 +1205,7 @@ class RTCUtils extends Listenable {
                 } else if (hasDesktop) {
                     screenObtainer.obtainStream(
                         dsOptions,
-                        stream => successCallback({ desktopStream: stream }),
+                        desktop => successCallback({ desktop }),
                         error => reject(error));
                 }
             }

modules/RTC/ScreenObtainer.js

@@ -121,10 +121,11 @@ const ScreenObtainer = {
                     && window.JitsiMeetScreenObtainer.openDesktopPicker) {
                     window.JitsiMeetScreenObtainer.openDesktopPicker(
                         streamId =>
-                            onGetStreamResponse({ streamId },
-                            onSuccess,
-                            onFailure
-                        ),
+                            onGetStreamResponse(
+                                { streamId },
+                                onSuccess,
+                                onFailure
+                            ),
                         err => onFailure(new JitsiTrackError(
                             JitsiTrackErrors.ELECTRON_DESKTOP_PICKER_ERROR,
                             err
@@ -565,18 +566,21 @@ function waitForExtensionAfterInstall(options, waitInterval, retries) {
  * @param {Function} onSuccess - callback for success.
  * @param {Function} onFailure - callback for failure.
  */
-function onGetStreamResponse(response, onSuccess, onFailure) {
-    if (response.streamId) {
+function onGetStreamResponse({ streamId, error }, onSuccess, onFailure) {
+    if (streamId) {
         gumFunction(
             [ 'desktop' ],
-            stream => onSuccess(stream),
+            stream => onSuccess({
+                stream,
+                sourceId: streamId
+            }),
             onFailure,
-            { desktopStream: response.streamId });
+            { desktopStream: streamId });
     } else {
         // As noted in Chrome Desktop Capture API:
         // If user didn't select any source (i.e. canceled the prompt)
         // then the callback is called with an empty streamId.
-        if (response.streamId === '') {
+        if (streamId === '') {
             onFailure(new JitsiTrackError(
                 JitsiTrackErrors.CHROME_EXTENSION_USER_CANCELED));
 
@@ -585,7 +589,7 @@ function onGetStreamResponse(response, onSuccess, onFailure) {
 
         onFailure(new JitsiTrackError(
             JitsiTrackErrors.CHROME_EXTENSION_GENERIC_ERROR,
-            response.error));
+            error));
     }
 }