@webex/plugin-meetings 3.8.0 → 3.8.1-next.10

package/src/meetings/index.ts

@@ -807,6 +807,67 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * API to toggle usage of audio main DTX, needs to be called before webex.meetings.register()
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleDisableAudioMainDtx(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+
+    // @ts-ignore
+    if (this.config.experimental.disableAudioMainDtx !== newValue) {
+      // @ts-ignore
+      this.config.experimental.disableAudioMainDtx = newValue;
+    }
+  }
+
+  /**
+   * API to toggle usage of audio twcc support
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleEnableAudioTwccForMultistream(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+
+    // @ts-ignore
+    if (this.config.enableAudioTwccForMultistream !== newValue) {
+      // @ts-ignore
+      this.config.enableAudioTwccForMultistream = newValue;
+    }
+  }
+
+  /**
+   * API to toggle stopping ICE Candidates Gathering after first relay candidate,
+   * needs to be called before webex.meetings.joinWithMedia()
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleStopIceGatheringAfterFirstRelayCandidate(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+
+    // @ts-ignore
+    if (this.config.stopIceGatheringAfterFirstRelayCandidate !== newValue) {
+      // @ts-ignore
+      this.config.stopIceGatheringAfterFirstRelayCandidate = newValue;
+    }
+  }
+
   /**
    * Executes a registration step and updates the registration status.
    * @param {Function} step - The registration step to execute.
@@ -854,7 +915,7 @@ export default class Meetings extends WebexPlugin {
       this.executeRegistrationStep(
         () =>
           this.startReachability('registration').catch((error) => {
-            LoggerProxy.logger.error(`Meetings:index#register --> GDM error, ${error.message}`);
+            LoggerProxy.logger.warn(`Meetings:index#register --> startReachability failed:`, error);
           }),
         'startReachability'
       ),
@@ -935,6 +996,21 @@ export default class Meetings extends WebexPlugin {
         .disconnect()
         // @ts-ignore
         .then(() => this.webex.internal.device.unregister())
+        .catch((error) => {
+          // If error status code is 404, continue the chain
+          if (error.statusCode === 404) {
+            LoggerProxy.logger.info(
+              'Meetings:index#unregister --> 404 error during device unregister, proceeding normally'
+            );
+
+            return; // returning undefined allows the chain to continue
+          }
+          // For any other status code, break the chain by rethrowing
+          LoggerProxy.logger.error(
+            `Meetings:index#unregister --> Failed to unregister device: ${error.message}`
+          );
+          throw error; // rethrow to break the promise chain
+        })
         .then(() => {
           Trigger.trigger(
             this,
@@ -1217,6 +1293,29 @@ export default class Meetings extends WebexPlugin {
     );
   }
 
+  /**
+   * Fetch static meeting link for given conversation url.
+   *
+   * @param {string} conversationUrl - url for conversation
+   * @returns {Promise}
+   * @public
+   * @memberof Meetings
+   */
+  public fetchStaticMeetingLink(conversationUrl: string): Promise<any> {
+    return (
+      this.meetingInfo
+        .fetchStaticMeetingLink(conversationUrl)
+        // Catch a failure to fetch static meeting link.
+        .catch((error) => {
+          LoggerProxy.logger.error(
+            `Meetings:index#fetchStaticMeetingLink --> ERROR, unable to fetch persistent meeting link: ${error.message}`
+          );
+
+          return Promise.reject(error);
+        })
+    );
+  }
+
   /**
    * Create a meeting or return an existing meeting.
    *
@@ -1369,6 +1468,54 @@ export default class Meetings extends WebexPlugin {
     );
   }
 
+  /**
+   * Enable static meeting links for given conversation url.
+   *
+   *
+   * @param {string} conversationUrl - url for conversation
+   * @returns {Promise}
+   * @public
+   * @memberof Meetings
+   */
+  public enableStaticMeetingLink(conversationUrl: string): Promise<any> {
+    return (
+      this.meetingInfo
+        .enableStaticMeetingLink(conversationUrl)
+        // Catch a failure to enable static meeting link.
+        .catch((error) => {
+          LoggerProxy.logger.error(
+            `Meetings:index#enableStaticMeetingLink --> ERROR, unable to enable static meeting link: ${error.message}`
+          );
+
+          return Promise.reject(error);
+        })
+    );
+  }
+
+  /**
+   * Disable static meeting links for given conversation url.
+   *
+   *
+   * @param {string} conversationUrl - url for conversation
+   * @returns {Promise}
+   * @public
+   * @memberof Meetings
+   */
+  public disableStaticMeetingLink(conversationUrl: string): Promise<any> {
+    return (
+      this.meetingInfo
+        .disableStaticMeetingLink(conversationUrl)
+        // Catch a failure to disable static meeting link.
+        .catch((error) => {
+          LoggerProxy.logger.error(
+            `Meetings:index#disableStaticMeetingLink --> ERROR, unable to disable static meeting link: ${error.message}`
+          );
+
+          return Promise.reject(error);
+        })
+    );
+  }
+
   /**
    * Create meeting
    *

package/src/meetings/util.ts

@@ -99,6 +99,24 @@ MeetingsUtil.getMediaServer = (sdp) => {
   return mediaServer;
 };
 
+MeetingsUtil.getMediaServerIp = (sdp) => {
+  let mediaServerIp;
+
+  // Attempt to collect the media server from the roap message.
+  try {
+    mediaServerIp = sdp
+      .split('\r\n')
+      .find((line) => line.startsWith('o='))
+      .match(/o=\S+ \d+ \d+ IN IP4 ([\d.]+)/)?.[1]
+      .toLowerCase()
+      .trim();
+  } catch {
+    mediaServerIp = undefined;
+  }
+
+  return mediaServerIp;
+};
+
 MeetingsUtil.checkForCorrelationId = (deviceUrl, locus) => {
   let devices = [];
 

package/src/member/index.ts

@@ -1,18 +1,20 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_} from '../constants';
-import {IExternalRoles, IMediaStatus, ParticipantWithRoles} from './types';
+import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_, _OBSERVE_} from '../constants';
+import {IExternalRoles, IMediaStatus, Participant, ParticipantUrl} from './types';
 
 import MemberUtil from './util';
 
+export type MemberId = string;
 /**
  * @class Member
  */
 export default class Member {
-  associatedUser: any;
+  associatedUser: MemberId | null; // deprecated, use associatedUsers instead
+  associatedUsers: Set<MemberId>; // users associated with this device, empty if this member is not a device
   canReclaimHost: boolean;
-  id: any;
+  id: MemberId;
   isAudioMuted: any;
   isContentSharing: any;
   isDevice: any;
@@ -23,11 +25,13 @@ export default class Member {
   isInMeeting: any;
   isModerator: any;
   isModeratorAssignmentProhibited: any;
+  isPresenterAssignmentProhibited: any;
   isMutable: any;
   isNotAdmitted: any;
   isRecording: any;
   isRemovable: any;
   isSelf: any;
+  isPairedWithSelf: boolean; // true for a device that we are paired with
   isBrb: boolean;
   isUser: any;
   isVideoMuted: any;
@@ -41,6 +45,10 @@ export default class Member {
   supportLiveAnnotation: boolean;
   type: any;
   namespace = MEETINGS;
+  pairedWith: {
+    participantUrl?: ParticipantUrl;
+    memberId?: MemberId;
+  };
 
   /**
    * @param {Object} participant - the locus participant
@@ -53,7 +61,7 @@ export default class Member {
    * @memberof Member
    */
   constructor(
-    participant: object,
+    participant: Participant,
     options:
       | {
           selfId: string;
@@ -200,13 +208,23 @@ export default class Member {
      */
     this.isUser = null;
     /**
+     * Deprecated: use associatedUsers instead
      * Is this member associated to another user by way of pairing (typical of devices)
      * @instance
-     * @type {String}
+     * @type {MemberId|null}
+     * @deprecated
      * @public
      * @memberof Member
      */
     this.associatedUser = null;
+    /**
+     * Is this member associated to another user by way of pairing (typical of devices)
+     * @instance
+     * @type {String}
+     * @public
+     * @memberof Member
+     */
+    this.associatedUsers = new Set<MemberId>();
     /**
      * @instance
      * @type {Boolean}
@@ -257,6 +275,22 @@ export default class Member {
      */
     this.isModeratorAssignmentProhibited = null;
 
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.isPresenterAssignmentProhibited = null;
+
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.isPairedWithSelf = false;
+
     /**
      * @instance
      * @type {IExternalRoles}
@@ -265,6 +299,10 @@ export default class Member {
      */
     this.roles = null;
 
+    this.pairedWith = {
+      participantUrl: undefined,
+      memberId: undefined,
+    };
     /**
      * @instance
      * @type {IMediaStatus}
@@ -290,9 +328,10 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processParticipant(participant: object) {
+  private processParticipant(participant: Participant) {
     this.participant = participant;
     if (participant) {
+      this.processPairedDevice(participant);
       this.canReclaimHost = MemberUtil.canReclaimHost(participant);
       this.id = MemberUtil.extractId(participant);
       this.name = MemberUtil.extractName(participant);
@@ -309,13 +348,27 @@ export default class Member {
       this.isModerator = MemberUtil.isModerator(participant);
       this.isModeratorAssignmentProhibited =
         MemberUtil.isModeratorAssignmentProhibited(participant);
+      this.isPresenterAssignmentProhibited =
+        MemberUtil.isPresenterAssignmentProhibited(participant);
       this.processStatus(participant);
-      this.processRoles(participant as ParticipantWithRoles);
+      this.processRoles(participant);
       // must be done last
       this.isNotAdmitted = MemberUtil.isNotAdmitted(participant, this.isGuest, this.status);
     }
   }
 
+  /**
+   * Checks if the participant is paired with another device
+   *
+   * @param {any} participant the locus participant object
+   * @returns {void}
+   */
+  processPairedDevice(participant: Participant) {
+    // we can't populate this.pairedWith.memberId here because the member for that device might not yet exist
+    // so only populating the participantUrl and memberId will be set later
+    this.pairedWith.participantUrl = MemberUtil.extractPairedWithParticipantUrl(participant);
+  }
+
   /**
    * Use the members options and participant values to set on the member
    * @param {Object} participant the locus participant object
@@ -324,7 +377,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processParticipantOptions(participant: object, options: any) {
+  private processParticipantOptions(participant: Participant, options: any) {
     if (participant && options) {
       this.processIsSelf(participant, options.selfId);
       this.processIsHost(participant, options.hostId);
@@ -367,7 +420,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processStatus(participant: object) {
+  private processStatus(participant: Participant) {
     this.status = MemberUtil.extractStatus(participant);
     switch (this.status) {
       case _IN_LOBBY_:
@@ -429,11 +482,9 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  public processIsContentSharing(participant: object, sharingId: string) {
+  public processIsContentSharing(participant: Participant, sharingId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isContentSharing = MemberUtil.isSame(participant, sharingId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isContentSharing = MemberUtil.isAssociatedSame(participant, sharingId);
     }
   }
 
@@ -445,7 +496,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  public processIsRecording(participant: object, recordingId: string) {
+  public processIsRecording(participant: Participant, recordingId: string) {
     this.isRecording = MemberUtil.isSame(participant, recordingId);
   }
 
@@ -457,12 +508,9 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processIsSelf(participant: object, selfId: string) {
+  private processIsSelf(participant: Participant, selfId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isSelf = MemberUtil.isSame(participant, selfId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isSelf = MemberUtil.isAssociatedSame(participant, selfId);
-      this.associatedUser = selfId;
     }
   }
 
@@ -474,11 +522,9 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processIsHost(participant: object, hostId: string) {
+  private processIsHost(participant: Participant, hostId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isHost = MemberUtil.isSame(participant, hostId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isHost = MemberUtil.isAssociatedSame(participant, hostId);
     }
   }
 
@@ -489,7 +535,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processRoles(participant: ParticipantWithRoles) {
+  private processRoles(participant: Participant) {
     this.roles = MemberUtil.extractControlRoles(participant);
   }
 

package/src/member/types.ts

@@ -15,22 +15,6 @@ export type ServerRoleShape = {
   hasRole: boolean;
 };
 
-export type ParticipantWithRoles = {
-  controls: {
-    role: {
-      roles: Array<ServerRoleShape>;
-    };
-  };
-};
-
-export type ParticipantWithBrb = {
-  controls: {
-    brb?: {
-      enabled: boolean;
-    };
-  };
-};
-
 // values are inherited from locus so don't update these
 export enum MediaStatus {
   RECVONLY = 'RECVONLY', // participant only receiving and not sending
@@ -44,3 +28,85 @@ export interface IMediaStatus {
   audio: MediaStatus;
   video: MediaStatus;
 }
+
+export type Csi = number;
+export type Direction = 'inactive' | 'sendrecv' | 'sendonly' | 'recvonly';
+export type ParticipantUrl = string;
+export interface MediaSession {
+  csi: Csi;
+  direction: Direction;
+  mediaContent: 'main' | 'slides';
+  mediaType: 'audio' | 'video';
+  state: string;
+}
+
+export interface Intent {
+  associatedWith: ParticipantUrl;
+  id: string;
+  type: string; // could be "WAIT" or "OBSERVE" or other....
+}
+export interface ParticipantDevice {
+  correlationId: string;
+  csis: Csi[];
+  deviceType: string; // WDM device type, could be "WEB", "TP_ENDPOINT", "MAC" or other things, don't know the full list, so keeping it as string
+  intent?: Intent;
+  intents: Array<Intent | null>;
+  isVideoCallback: boolean;
+  mediaSessions: Array<MediaSession>;
+  mediaSessionsExternal: boolean;
+  state: string; // probably one of MEETING_STATE.STATES
+}
+
+// this is not a complete type, Locus may send more fields
+export interface ParticipantPerson {
+  id: string;
+  isExternal: boolean;
+  name: string;
+  orgId: string;
+}
+
+export interface ParticipantMediaStatus {
+  audioStatus: MediaStatus;
+  videoStatus: MediaStatus;
+  audioSlidesStatus?: MediaStatus;
+  videoSlidesStatus?: MediaStatus;
+  csis: Csi[];
+}
+
+// this is not a complete type, Locus may send more fields
+export interface ParticipantControls {
+  role: {
+    roles: Array<ServerRoleShape>;
+  };
+  brb?: {
+    enabled: boolean;
+  };
+  hand: {
+    raised: boolean;
+  };
+  localRecord: {
+    recording: boolean;
+  };
+}
+
+// this is not a complete type, Locus may send more fields
+export interface Participant {
+  canBeController: boolean;
+  controls: ParticipantControls;
+  deviceUrl: string;
+  devices: Array<ParticipantDevice>;
+  guest: boolean;
+  id: string;
+  identity: string;
+  identityTrustLevel: string; // could be 'INTERNAL', 'EXTERNAL' or other....
+  isCreator: boolean;
+  moderator: boolean; // Locus docs say this is deprecated and role control should be used instead
+  moderatorAssignmentNotAllowed: boolean;
+  presenterAssignmentNotAllowed: boolean;
+  person: ParticipantPerson;
+  resourceGuest: boolean;
+  state: string; // probably one of MEETING_STATE.STATES
+  status: ParticipantMediaStatus;
+  type: string;
+  url: ParticipantUrl;
+}