@webex/plugin-meetings 1.148.0 → 1.150.0

package/src/locus-info/mediaSharesUtils.js

@@ -1,4 +1,4 @@
-import {CONTENT} from '../constants';
+import {CONTENT, WHITEBOARD} from '../constants';
 
 const MediaSharesUtils = {};
 
@@ -10,8 +10,15 @@ const MediaSharesUtils = {};
 MediaSharesUtils.parse = (mediaShares) => {
   if (mediaShares) {
     return {
-      contentId: MediaSharesUtils.getContentId(mediaShares),
-      disposition: MediaSharesUtils.getDisposition(mediaShares)
+      content: {
+        beneficiaryId: MediaSharesUtils.getContentBeneficiaryId(mediaShares),
+        disposition: MediaSharesUtils.getContentDisposition(mediaShares)
+      },
+      whiteboard: {
+        beneficiaryId: MediaSharesUtils.getWhiteboardBeneficiaryId(mediaShares),
+        disposition: MediaSharesUtils.getWhiteboardDisposition(mediaShares),
+        resourceUrl: MediaSharesUtils.getWhiteboardResourceUrl(mediaShares)
+      }
     };
   }
 
@@ -36,16 +43,27 @@ MediaSharesUtils.getMediaShares = (oldShare, newShare) => {
 };
 
 /**
- * get the floor disposition (released, granted)
+ * get the content floor disposition (released, granted)
  * @param {Object} mediaShares
  * @returns {Boolean} disposition
  */
-MediaSharesUtils.getDisposition = (mediaShares) => {
+MediaSharesUtils.getContentDisposition = (mediaShares) => {
   const contentFloor = MediaSharesUtils.extractContentFloor(mediaShares);
 
   return contentFloor ? contentFloor.disposition : null;
 };
 
+/**
+ * get the whiteboard floor disposition (released, granted)
+ * @param {Object} mediaShares
+ * @returns {Boolean} disposition
+ */
+MediaSharesUtils.getWhiteboardDisposition = (mediaShares) => {
+  const whiteboardFloor = MediaSharesUtils.extractWhiteboardFloor(mediaShares);
+
+  return whiteboardFloor ? whiteboardFloor.disposition : null;
+};
+
 /**
  * extract the content property from media shares
  * @param {Object} mediaShares
@@ -60,16 +78,29 @@ MediaSharesUtils.extractContent = (mediaShares) => {
 };
 
 /**
- * extract the floor property from content object
- * @param {Object} content
+ * extract the whiteboard property from media shares
+ * @param {Object} mediaShares
+ * @returns {Object}
+ */
+MediaSharesUtils.extractWhiteboard = (mediaShares) => {
+  if (!mediaShares || !mediaShares.length) {
+    return null;
+  }
+
+  return mediaShares.find((share) => share.name === WHITEBOARD) || null;
+};
+
+/**
+ * extract the media stream floor property from content object
+ * @param {Object} mediaStream
  * @returns {Object}
  */
-MediaSharesUtils.extractFloor = (content) => {
-  if (!content) {
+MediaSharesUtils.extractFloor = (mediaStream) => {
+  if (!mediaStream) {
     return null;
   }
 
-  return content.floor;
+  return mediaStream.floor;
 };
 
 /**
@@ -84,11 +115,22 @@ MediaSharesUtils.extractContentFloor = (mediaShares) => {
 };
 
 /**
- * get who is sharing from media shares
+ * extract the whiteboard's floor from media shares
+ * @param {Object} mediaShares
+ * @returns {Object}
+ */
+MediaSharesUtils.extractWhiteboardFloor = (mediaShares) => {
+  const whiteboard = MediaSharesUtils.extractWhiteboard(mediaShares);
+
+  return MediaSharesUtils.extractFloor(whiteboard);
+};
+
+/**
+ * get who is sharing from media shares (content)
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.getContentId = (mediaShares) => {
+MediaSharesUtils.getContentBeneficiaryId = (mediaShares) => {
   const contentFloor = MediaSharesUtils.extractContentFloor(mediaShares);
 
   if (!contentFloor || !contentFloor.beneficiary) {
@@ -98,4 +140,34 @@ MediaSharesUtils.getContentId = (mediaShares) => {
   return contentFloor.beneficiary.id;
 };
 
+/**
+ * get who is sharing from media shares (whiteboard)
+ * @param {Object} mediaShares
+ * @returns {Object}
+ */
+MediaSharesUtils.getWhiteboardBeneficiaryId = (mediaShares) => {
+  const whiteboardFloor = MediaSharesUtils.extractWhiteboardFloor(mediaShares);
+
+  if (!whiteboardFloor || !whiteboardFloor.beneficiary) {
+    return null;
+  }
+
+  return whiteboardFloor.beneficiary.id;
+};
+
+/**
+ * get the which whiteboard is being shared via resource url
+ * @param {Object} mediaShares
+ * @returns {Object}
+ */
+MediaSharesUtils.getWhiteboardResourceUrl = (mediaShares) => {
+  const whiteboard = MediaSharesUtils.extractWhiteboard(mediaShares);
+
+  if (!whiteboard || !whiteboard.resourceUrl) {
+    return null;
+  }
+
+  return whiteboard.resourceUrl;
+};
+
 export default MediaSharesUtils;

package/src/meeting/index.js

@@ -1047,6 +1047,24 @@ export default class Meeting extends StatelessWebexPlugin {
         };
       }
 
+      const joinRespTxStartAudio = this.getSendingMediaDelayDuration('audio');
+
+      if (joinRespTxStartAudio) {
+        options.audioSetupDelay = {
+          ...options.audioSetupDelay,
+          joinRespTxStart: joinRespTxStartAudio
+        };
+      }
+
+      const joinRespTxStartVideo = this.getSendingMediaDelayDuration('video');
+
+      if (joinRespTxStartVideo) {
+        options.videoSetupDelay = {
+          ...options.videoSetupDelay,
+          joinRespTxStart: joinRespTxStartVideo
+        };
+      }
+
       if (options.type === MQA_STATS.CA_TYPE) {
         payload = Metrics.initMediaPayload(options.event, identifiers, options);
       }
@@ -1292,7 +1310,7 @@ export default class Meeting extends StatelessWebexPlugin {
 
   /**
    * Set up the locus info media shares listener
-   * update content sharing id value for members, and updates the member
+   * update content and whiteboard sharing id value for members, and updates the member
    * notifies consumer with members:content:update {activeContentSharingId, endedContentSharingId}
    * @returns {undefined}
    * @private
@@ -1301,11 +1319,16 @@ export default class Meeting extends StatelessWebexPlugin {
   setUpLocusMediaSharesListener() {
     // Will get triggered on local and remote share
     this.locusInfo.on(EVENTS.LOCUS_INFO_UPDATE_MEDIA_SHARES, (payload) => {
-      const {contentId, disposition} = payload.current;
+      const {content: contentShare, whiteboard: whiteboardShare} = payload.current;
+      const previousContentShare = payload.previous?.content;
+      const previousWhiteboardShare = payload.previous?.whiteboard;
 
       if (
-        contentId === payload.previous?.contentId &&
-        disposition === payload.previous?.disposition
+        (contentShare.beneficiaryId === previousContentShare?.beneficiaryId &&
+          contentShare.disposition === previousContentShare?.disposition) &&
+        (whiteboardShare.beneficiaryId === previousWhiteboardShare?.beneficiaryId &&
+          whiteboardShare.disposition === previousWhiteboardShare?.disposition &&
+          whiteboardShare.resourceUrl === previousWhiteboardShare?.resourceUrl)
       ) {
         // nothing changed, so ignore
         // (this happens when we steal presentation from remote)
@@ -1316,15 +1339,16 @@ export default class Meeting extends StatelessWebexPlugin {
 
       // REMOTE - check if remote started sharing
       if (
-        this.selfId !== contentId &&
-        disposition === FLOOR_ACTION.GRANTED
+        this.selfId !== contentShare.beneficiaryId &&
+        contentShare.disposition === FLOOR_ACTION.GRANTED
       ) {
+        // CONTENT - sharing content remote
         newShareStatus = SHARE_STATUS.REMOTE_SHARE_ACTIVE;
       }
-      // LOCAL - check if we started sharing
+      // LOCAL - check if we started sharing content
       else if (
-        this.selfId === contentId &&
-        disposition === FLOOR_ACTION.GRANTED
+        this.selfId === contentShare.beneficiaryId &&
+        contentShare.disposition === FLOOR_ACTION.GRANTED
       ) {
         if (this.mediaProperties.shareTrack?.readyState === 'ended') {
           this.stopShare({
@@ -1335,13 +1359,23 @@ export default class Meeting extends StatelessWebexPlugin {
             });
         }
         else {
+          // CONTENT - sharing content local
           newShareStatus = SHARE_STATUS.LOCAL_SHARE_ACTIVE;
         }
       }
-      // or if sharing has been stopped
+      // If we did not hit the cases above, no one is sharng content, so we check if we are sharing whiteboard
+      // There is no concept of local/remote share for whiteboard
+      // It does not matter who requested to share the whiteboard, everyone gets the same view
+      else if (whiteboardShare.disposition === FLOOR_ACTION.GRANTED) {
+        // WHITEBOARD - sharing whiteboard
+        newShareStatus = SHARE_STATUS.WHITEBOARD_SHARE_ACTIVE;
+      }
+      // or if content share is either released or null and whiteboard share is either released or null, no one is sharing
       else if (
-        payload.previous &&
-        disposition === FLOOR_ACTION.RELEASED
+        (previousContentShare &&
+          (contentShare.disposition === FLOOR_ACTION.RELEASED) || (contentShare.disposition === null)) &&
+        (previousWhiteboardShare &&
+          (whiteboardShare.disposition === FLOOR_ACTION.RELEASED) || (whiteboardShare.disposition === null))
       ) {
         newShareStatus = SHARE_STATUS.NO_SHARE;
       }
@@ -1379,6 +1413,17 @@ export default class Meeting extends StatelessWebexPlugin {
             );
             break;
 
+          case SHARE_STATUS.WHITEBOARD_SHARE_ACTIVE:
+            Trigger.trigger(
+              this,
+              {
+                file: 'meeting/index',
+                function: 'stopWhiteboardShare'
+              },
+              EVENT_TRIGGERS.MEETING_STOPPED_SHARING_WHITEBOARD
+            );
+            break;
+
           case SHARE_STATUS.NO_SHARE:
             // nothing to do
             break;
@@ -1399,13 +1444,16 @@ export default class Meeting extends StatelessWebexPlugin {
                 },
                 EVENT_TRIGGERS.MEETING_STARTED_SHARING_REMOTE,
                 {
-                  memberId: contentId
+                  memberId: contentShare.beneficiaryId
                 }
               );
             };
 
             // if a remote participant is stealing the presentation from us
-            if (this.mediaProperties.mediaDirection?.sendShare) {
+            if (!this.mediaProperties.mediaDirection?.sendShare || oldShareStatus === SHARE_STATUS.WHITEBOARD_SHARE_ACTIVE) {
+              sendStartedSharingRemote();
+            }
+            else {
               this.updateShare({
                 sendShare: false,
                 receiveShare: this.mediaProperties.mediaDirection.receiveShare
@@ -1414,9 +1462,6 @@ export default class Meeting extends StatelessWebexPlugin {
                   sendStartedSharingRemote();
                 });
             }
-            else {
-              sendStartedSharingRemote();
-            }
             break;
           }
 
@@ -1432,6 +1477,22 @@ export default class Meeting extends StatelessWebexPlugin {
             Metrics.postEvent({event: eventType.LOCAL_SHARE_FLOOR_GRANTED, meeting: this});
             break;
 
+          case SHARE_STATUS.WHITEBOARD_SHARE_ACTIVE:
+            Trigger.trigger(
+              this,
+              {
+                file: 'meeting/index',
+                function: 'startWhiteboardShare'
+              },
+              EVENT_TRIGGERS.MEETING_STARTED_SHARING_WHITEBOARD,
+              {
+                resourceUrl: whiteboardShare.resourceUrl,
+                memberId: whiteboardShare.beneficiaryId
+              }
+            );
+            Metrics.postEvent({event: eventType.WHITEBOARD_SHARE_FLOOR_GRANTED, meeting: this});
+            break;
+
           case SHARE_STATUS.NO_SHARE:
           // nothing to do
             break;
@@ -1453,11 +1514,29 @@ export default class Meeting extends StatelessWebexPlugin {
           },
           EVENT_TRIGGERS.MEETING_STARTED_SHARING_REMOTE,
           {
-            memberId: contentId
+            memberId: contentShare.beneficiaryId
           }
         );
         this.members.locusMediaSharesUpdate(payload);
       }
+      else if (newShareStatus === SHARE_STATUS.WHITEBOARD_SHARE_ACTIVE) {
+        // if we got here, then some remote participant has stolen
+        // the presentation from another remote participant
+        Trigger.trigger(
+          this,
+          {
+            file: 'meeting/index',
+            function: 'startWhiteboardShare'
+          },
+          EVENT_TRIGGERS.MEETING_STARTED_SHARING_WHITEBOARD,
+          {
+            resourceUrl: whiteboardShare.resourceUrl,
+            memberId: whiteboardShare.beneficiaryId
+          }
+        );
+        Metrics.postEvent({event: eventType.WHITEBOARD_SHARE_FLOOR_GRANTED, meeting: this});
+        this.members.locusMediaSharesUpdate(payload);
+      }
     });
   }
 
@@ -4473,6 +4552,105 @@ export default class Meeting extends StatelessWebexPlugin {
       });
   }
 
+  /**
+   * Start sharing whiteboard given channelUrl
+   * @param {string} channelUrl whiteboard url
+   * @param {String} resourceToken token created by authorize media injector
+   * @returns {Promise}
+   * @public
+   * @memberof Meeting
+   */
+  startWhiteboardShare(channelUrl, resourceToken) {
+    const whiteboard = this.locusInfo.mediaShares.find((element) => element.name === 'whiteboard');
+
+    if (!channelUrl) {
+      return Promise.reject(new ParameterError('Cannot share without channelUrl.'));
+    }
+
+    if (whiteboard) {
+      Metrics.postEvent({event: eventType.WHITEBOARD_SHARE_INITIATED, meeting: this});
+
+      const body = {
+        disposition: FLOOR_ACTION.GRANTED,
+        personUrl: this.locusInfo.self.url,
+        deviceUrl: this.deviceUrl,
+        uri: whiteboard.url,
+        resourceUrl: channelUrl
+      };
+
+      if (resourceToken) {
+        body.resourceToken = resourceToken;
+      }
+
+      return this.meetingRequest.changeMeetingFloor(body)
+        .then(() => {
+          this.isSharing = false;
+
+          return Promise.resolve();
+        })
+        .catch((error) => {
+          LoggerProxy.logger.error('Meeting:index#startWhiteboardShare --> Error ', error);
+
+          Metrics.sendOperationalMetric(
+            METRICS_OPERATIONAL_MEASURES.MEETING_START_WHITEBOARD_SHARE_FAILURE,
+            {
+              correlation_id: this.correlationId,
+              locus_id: this.locusUrl.split('/').pop(),
+              reason: error.message,
+              stack: error.stack,
+              board: {channelUrl}
+            }
+          );
+
+          return Promise.reject(error);
+        });
+    }
+
+    return Promise.reject(new ParameterError('Cannot share without whiteboard.'));
+  }
+
+  /**
+   * Stop sharing whiteboard given channelUrl
+   * @param {string} channelUrl whiteboard url
+   * @returns {Promise}
+   * @public
+   * @memberof Meeting
+   */
+  stopWhiteboardShare(channelUrl) {
+    const whiteboard = this.locusInfo.mediaShares.find((element) => element.name === 'whiteboard');
+
+    if (whiteboard) {
+      Metrics.postEvent({event: eventType.WHITEBOARD_SHARE_STOPPED, meeting: this});
+
+      return this.meetingRequest.changeMeetingFloor({
+        disposition: FLOOR_ACTION.RELEASED,
+        personUrl: this.locusInfo.self.url,
+        deviceUrl: this.deviceUrl,
+        uri: whiteboard.url
+      })
+        .catch((error) => {
+          LoggerProxy.logger.error('Meeting:index#stopWhiteboardShare --> Error ', error);
+
+          Metrics.sendOperationalMetric(
+            METRICS_OPERATIONAL_MEASURES.STOP_WHITEBOARD_SHARE_FAILURE,
+            {
+              correlation_id: this.correlationId,
+              locus_id: this.locusUrl.split('/').pop(),
+              reason: error.message,
+              stack: error.stack,
+              board: {channelUrl}
+            }
+          );
+
+          return Promise.reject(error);
+        })
+        .finally(() => {
+        });
+    }
+
+    return Promise.reject(new ParameterError('Cannot stop share without whiteboard.'));
+  }
+
   /**
    * Start sharing content with server
    * @returns {Promise} see #meetingRequest.changeMeetingFloor
@@ -4546,7 +4724,7 @@ export default class Meeting extends StatelessWebexPlugin {
       Metrics.postEvent({event: eventType.SHARE_STOPPED, meeting: this});
       Media.stopTracks(this.mediaProperties.shareTrack);
 
-      if (this.contentId !== this.selfId) {
+      if (content.floor.beneficiary.id !== this.selfId) {
         // remote participant started sharing and caused our sharing to stop, we don't want to send any floor action request in that case
         this.isSharing = false;
 
@@ -5049,4 +5227,32 @@ export default class Meeting extends StatelessWebexPlugin {
 
     return (start && end) ? end - start : undefined;
   }
+
+  /**
+   * @param {string} typeMedia 'audio' or 'video'
+   * @returns {undefined}
+   */
+  setStartSendingMediaDelay(typeMedia) {
+    this[`startSendingMediaDelay${typeMedia}`] = performance.now();
+    this[`endSendingMediaDelay${typeMedia}`] = undefined;
+  }
+
+  /**
+ * @param {string} typeMedia 'audio' or 'video'
+ * @returns {undefined}
+ */
+  setEndSendingMediaDelay(typeMedia) {
+    this[`endSendingMediaDelay${typeMedia}`] = performance.now();
+  }
+
+  /**
+   * @param {string} typeMedia 'audio' or 'video'
+   * @returns {string} duration between join response and first media tx
+   */
+  getSendingMediaDelayDuration(typeMedia) {
+    const start = this[`startSendingMediaDelay${typeMedia}`];
+    const end = this[`endSendingMediaDelay${typeMedia}`];
+
+    return (start && end) ? end - start : undefined;
+  }
 }

package/src/meeting/request.js

@@ -1,9 +1,7 @@
 import uuid from 'uuid';
 import {debounce} from 'lodash';
 import {StatelessWebexPlugin} from '@webex/webex-core';
-import {
-  deviceType
-} from '@webex/common';
+import {deviceType} from '@webex/common';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import {
@@ -51,7 +49,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    */
   async joinMeeting(options) {
     const {
-      asResourceOccupant, sipUri, meetingNumber, deviceUrl, locusUrl, resourceId, correlationId, ensureConversation, moderator, pin, moveToResource, roapMessage, preferTranscoding
+      asResourceOccupant,
+      sipUri,
+      meetingNumber,
+      deviceUrl,
+      locusUrl,
+      resourceId,
+      correlationId,
+      ensureConversation,
+      moderator,
+      pin,
+      moveToResource,
+      roapMessage,
+      preferTranscoding
     } = options;
 
     LoggerProxy.logger.info(
@@ -95,29 +105,16 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     if (locusUrl) {
       url = `${locusUrl}/${PARTICIPANT}`;
     }
-    else if (meetingNumber) {
+    else if (sipUri || meetingNumber) {
       try {
         await this.webex.internal.services.waitForCatalog('postauth');
         url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
         body.invitee = {
-          address: `wbxmn:${meetingNumber}`
+          address: sipUri || `wbxmn:${meetingNumber}`
         };
       }
       catch (e) {
-        LoggerProxy.logger.error(`Meeting:request#joinMeeting  webex meeting id--> ${e}`);
-        throw (e);
-      }
-    }
-    else if (sipUri) {
-      try {
-        await this.webex.internal.services.waitForCatalog('postauth');
-        url = `${this.webex.internal.services.get('locus')}/${LOCI}/${CALL}`;
-        body.invitee = {
-          address: sipUri
-        };
-      }
-      catch (e) {
-        LoggerProxy.logger.error(`Meeting:request#joinMeeting sipUrl --> ${e}`);
+        LoggerProxy.logger.error(`Meeting:request#joinMeeting ${sipUri ? 'sipUri' : 'meetingNumber'} --> ${e}`);
         throw (e);
       }
     }
@@ -154,7 +151,10 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @private
    */
   dialIn({
-    locusUrl, dialInUrl, clientUrl, correlationId
+    locusUrl,
+    dialInUrl,
+    clientUrl,
+    correlationId
   }) {
     LoggerProxy.logger.info(
       'Meeting:request#dialIn --> Provisioning a dial in device',
@@ -195,7 +195,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @private
    */
   dialOut({
-    locusUrl, dialOutUrl, phoneNumber, clientUrl, correlationId
+    locusUrl,
+    dialOutUrl,
+    phoneNumber,
+    clientUrl,
+    correlationId
   }) {
     LoggerProxy.logger.info(
       'Meeting:request#dialOut --> Provisioning a dial out device',
@@ -294,7 +298,10 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @private
    */
   disconnectPhoneAudio({
-    locusUrl, phoneUrl, correlationId, selfId
+    locusUrl,
+    phoneUrl,
+    correlationId,
+    selfId
   }) {
     LoggerProxy.logger.info(
       `Meeting:request#disconnectPhoneAudio --> request phone ${phoneUrl} to leave`,
@@ -334,7 +341,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @returns {Promise}
    */
   leaveMeeting({
-    locusUrl, selfId, deviceUrl: url, resourceId, correlationId
+    locusUrl,
+    selfId,
+    deviceUrl: url,
+    resourceId,
+    correlationId
   }) {
     LoggerProxy.logger.info(
       'Meeting:request#leaveMeeting --> Leaving a meeting',
@@ -512,13 +523,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       };
     }
 
+    const body = {
+      floor: floorReq,
+      resourceUrl: options.resourceUrl
+    };
+
+    if (options?.resourceToken) {
+      body.resourceToken = options?.resourceToken;
+    }
+
     return this.request({
       uri: options.uri,
       method: HTTP_VERBS.PUT,
-      body: {
-        floor: floorReq,
-        resourceUrl: options.resourceUrl
-      }
+      body
     });
   }
 
@@ -559,7 +576,11 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @returns {Promise}
    */
   changeVideoLayout({
-    locusUrl, deviceUrl, layoutType, main, content
+    locusUrl,
+    deviceUrl,
+    layoutType,
+    main,
+    content
   }) {
     // send main/content renderInfo only if both width and height are specified
     if (main && (!main.width || !main.height)) {

package/src/meeting-info/index.js

@@ -108,7 +108,10 @@ export default class MeetingInfo {
    * @memberof MeetingInfo
    */
   fetchMeetingInfo(destination, type = null) {
-    return this.fetchInfoOptions(destination, type).then((options) =>
+    return this.fetchInfoOptions(
+      MeetingInfoUtil.extractDestination(destination, type),
+      type
+    ).then((options) =>
     // fetch meeting info
       this.requestFetchInfo(options).catch((error) => {
       // if it failed the first time as meeting link

package/src/meeting-info/util.js

@@ -35,6 +35,19 @@ import {
 
 const MeetingInfoUtil = {};
 
+MeetingInfoUtil.extractDestination = (destination, type) => {
+  let dest = destination;
+
+  if (type === _LOCUS_ID_) {
+    if (!(destination && destination.url)) {
+      throw new ParameterError('You cannot create a meeting by locus without a locus.url defined');
+    }
+    dest = destination.url;
+  }
+
+  return dest;
+};
+
 MeetingInfoUtil.getParsedUrl = (link) => {
   try {
     let parsedUrl = url.parse(link);