@webex/plugin-meetings 3.7.0-next.9 → 3.7.0-web-workers-keepalive.1

package/src/meeting/util.ts

@@ -140,7 +140,11 @@ const MeetingUtil = {
         meeting.isMultistream,
         MeetingUtil.getIpVersion(webex)
       );
-      reachability = await webex.meetings.reachability.getReachabilityReportToAttachToRoap();
+      if (options.roapMessage) {
+        // we only need to attach reachability if we are sending a roap message
+        // sending reachability on its own will cause Locus to reject our join request
+        reachability = await webex.meetings.reachability.getReachabilityReportToAttachToRoap();
+      }
     } catch (e) {
       LoggerProxy.logger.error(
         'Meeting:util#joinMeeting --> Error getting reachability or clientMediaPreferences:',
@@ -441,6 +445,9 @@ const MeetingUtil = {
     displayHints.includes(DISPLAY_HINTS.LEAVE_END_MEETING),
 
   canManageBreakout: (displayHints) => displayHints.includes(DISPLAY_HINTS.BREAKOUT_MANAGEMENT),
+
+  canStartBreakout: (displayHints) => !displayHints.includes(DISPLAY_HINTS.DISABLE_BREAKOUT_START),
+
   canBroadcastMessageToBreakout: (displayHints, policies = {}) =>
     displayHints.includes(DISPLAY_HINTS.BROADCAST_MESSAGE_TO_BREAKOUT) &&
     !!policies[SELF_POLICY.SUPPORT_BROADCAST_MESSAGE],
@@ -496,15 +503,6 @@ const MeetingUtil = {
     }
   },
 
-  handleDeviceLogging: (devices = []) => {
-    const LOG_HEADER = 'MeetingUtil#handleDeviceLogging -->';
-
-    devices.forEach((device) => {
-      LoggerProxy.logger.log(LOG_HEADER, `deviceId = ${device.deviceId}`);
-      LoggerProxy.logger.log(LOG_HEADER, 'settings', JSON.stringify(device));
-    });
-  },
-
   endMeetingForAll: (meeting) => {
     if (meeting.meetingState === FULL_STATE.INACTIVE) {
       return Promise.reject(new MeetingNotActiveError());

package/src/meeting-info/meeting-info-v2.ts

@@ -18,7 +18,19 @@ const ADHOC_MEETING_DEFAULT_ERROR =
   'Failed starting the adhoc meeting, Please contact support team ';
 const CAPTCHA_ERROR_REQUIRES_PASSWORD_CODES = [423005, 423006];
 const POLICY_ERROR_CODES = [403049, 403104, 403103, 403048, 403102, 403101];
-const WEBINAR_REGISTRATION_ERROR_CODES = [403021, 403022, 403024];
+/**
+ * 403021 - Meeting registration is required
+ * 403022 - Meeting registration is still pending
+ * 403024 - Meeting registration have been rejected
+ * 403137 - Registration ID verified failure
+ * 423007 - Registration ID input too many time,please input captcha code
+ * 403026 - Need to join meeting via webcast
+ * 403037 - Meeting join required registration ID
+ * 403137 - Registration ID verified failure
+ *
+ */
+const JOIN_WEBINAR_ERROR_CODES = [403021, 403022, 403024, 403137, 423007, 403026, 403037, 403137];
+
 /**
  * Error to indicate that wbxappapi requires a password
  */
@@ -126,9 +138,9 @@ export class MeetingInfoV2CaptchaError extends Error {
 }
 
 /**
- * Error preventing join because of a webinar registration error
+ * Error preventing join because of a webinar have some error
  */
-export class MeetingInfoV2WebinarRegistrationError extends Error {
+export class MeetingInfoV2JoinWebinarError extends Error {
   meetingInfo: any;
   sdkMessage: any;
   wbxAppApiCode: any;
@@ -142,7 +154,7 @@ export class MeetingInfoV2WebinarRegistrationError extends Error {
    */
   constructor(wbxAppApiErrorCode?: number, meetingInfo?: object, message?: string) {
     super(`${message}, code=${wbxAppApiErrorCode}`);
-    this.name = 'MeetingInfoV2WebinarRegistrationError';
+    this.name = 'MeetingInfoV2JoinWebinarError';
     this.sdkMessage = message;
     this.stack = new Error().stack;
     this.wbxAppApiCode = wbxAppApiErrorCode;
@@ -204,21 +216,21 @@ export default class MeetingInfoV2 {
   };
 
   /**
-   * Raises a handleWebinarRegistrationError for webinar registration error codes
+   * Raises a handleJoinWebinarError for join webinar error codes
    * @param {any} err the error from the request
    * @returns {void}
    */
-  handleWebinarRegistrationError = (err) => {
+  handleJoinWebinarError = (err) => {
     if (!err.body) {
       return;
     }
 
-    if (WEBINAR_REGISTRATION_ERROR_CODES.includes(err.body?.code)) {
-      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.WEBINAR_REGISTRATION_ERROR, {
+    if (JOIN_WEBINAR_ERROR_CODES.includes(err.body?.code)) {
+      Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.JOIN_WEBINAR_ERROR, {
         code: err.body?.code,
       });
 
-      throw new MeetingInfoV2WebinarRegistrationError(
+      throw new MeetingInfoV2JoinWebinarError(
         err.body?.code,
         err.body?.data?.meetingInfo,
         err.body?.message
@@ -286,7 +298,7 @@ export default class MeetingInfoV2 {
       })
       .catch((err) => {
         this.handlePolicyError(err);
-        this.handleWebinarRegistrationError(err);
+        this.handleJoinWebinarError(err);
 
         Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADHOC_MEETING_FAILURE, {
           reason: err.message,
@@ -441,7 +453,7 @@ export default class MeetingInfoV2 {
 
         if (err?.statusCode === 403) {
           this.handlePolicyError(err);
-          this.handleWebinarRegistrationError(err);
+          this.handleJoinWebinarError(err);
 
           Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.VERIFY_PASSWORD_ERROR, {
             reason: err.message,

package/src/meetings/index.ts

@@ -56,7 +56,7 @@ import MeetingCollection from './collection';
 import {MEETING_KEY, INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
-import WebinarRegistrationError from '../common/errors/webinar-registration-error';
+import JoinWebinarError from '../common/errors/join-webinar-error';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
 
@@ -1412,7 +1412,7 @@ export default class Meetings extends WebexPlugin {
         !(err instanceof CaptchaError) &&
         !(err instanceof PasswordError) &&
         !(err instanceof PermissionError) &&
-        !(err instanceof WebinarRegistrationError)
+        !(err instanceof JoinWebinarError)
       ) {
         LoggerProxy.logger.info(
           `Meetings:index#createMeeting --> Info Unable to fetch meeting info for ${destination}.`

package/src/meetings/util.ts

@@ -90,7 +90,8 @@ MeetingsUtil.getMediaServer = (sdp) => {
       .find((line) => line.startsWith('o='))
       .split(' ')
       .shift()
-      .replace('o=', '');
+      .replace('o=', '')
+      .toLowerCase();
   } catch {
     mediaServer = undefined;
   }

package/src/member/index.ts

@@ -28,6 +28,7 @@ export default class Member {
   isRecording: any;
   isRemovable: any;
   isSelf: any;
+  isBrb: boolean;
   isUser: any;
   isVideoMuted: any;
   roles: IExternalRoles;
@@ -227,6 +228,13 @@ export default class Member {
      * @memberof Member
      */
     this.isRemovable = null;
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.isBrb = false;
     /**
      * @instance
      * @type {String}
@@ -295,6 +303,7 @@ export default class Member {
       this.supportsInterpretation = MemberUtil.isInterpretationSupported(participant);
       this.supportLiveAnnotation = MemberUtil.isLiveAnnotationSupported(participant);
       this.isGuest = MemberUtil.isGuest(participant);
+      this.isBrb = MemberUtil.isBrb(participant);
       this.isUser = MemberUtil.isUser(participant);
       this.isDevice = MemberUtil.isDevice(participant);
       this.isModerator = MemberUtil.isModerator(participant);

package/src/member/types.ts

@@ -23,6 +23,14 @@ export type ParticipantWithRoles = {
   };
 };
 
+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

package/src/member/util.ts

@@ -4,6 +4,7 @@ import {
   ServerRoles,
   ServerRoleShape,
   IMediaStatus,
+  ParticipantWithBrb,
 } from './types';
 import {
   _USER_,
@@ -29,7 +30,7 @@ import ParameterError from '../common/errors/parameter';
 const MemberUtil: any = {};
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.canReclaimHost = (participant) => {
@@ -43,14 +44,23 @@ MemberUtil.canReclaimHost = (participant) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {[ServerRoleShape]}
  */
 MemberUtil.getControlsRoles = (participant: ParticipantWithRoles): Array<ServerRoleShape> =>
   participant?.controls?.role?.roles;
 
 /**
- * @param {Object} participant the locus participant
+ * Checks if the participant has the brb status enabled.
+ *
+ * @param {ParticipantWithBrb} participant - The locus participant object.
+ * @returns {boolean} - True if the participant has brb enabled, false otherwise.
+ */
+MemberUtil.isBrb = (participant: ParticipantWithBrb): boolean =>
+  participant.controls?.brb?.enabled || false;
+
+/**
+ * @param {Object} participant - The locus participant object.
  * @param {ServerRoles} controlRole the search role
  * @returns {Boolean}
  */
@@ -60,28 +70,28 @@ MemberUtil.hasRole = (participant: any, controlRole: ServerRoles): boolean =>
   );
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.hasCohost = (participant: ParticipantWithRoles): boolean =>
   MemberUtil.hasRole(participant, ServerRoles.Cohost) || false;
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.hasModerator = (participant: ParticipantWithRoles): boolean =>
   MemberUtil.hasRole(participant, ServerRoles.Moderator) || false;
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.hasPresenter = (participant: ParticipantWithRoles): boolean =>
   MemberUtil.hasRole(participant, ServerRoles.Presenter) || false;
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {IExternalRoles}
  */
 MemberUtil.extractControlRoles = (participant: ParticipantWithRoles): IExternalRoles => {
@@ -95,7 +105,7 @@ MemberUtil.extractControlRoles = (participant: ParticipantWithRoles): IExternalR
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isUser = (participant: any) => participant && participant.type === _USER_;
@@ -103,13 +113,13 @@ MemberUtil.isUser = (participant: any) => participant && participant.type === _U
 MemberUtil.isModerator = (participant) => participant && participant.moderator;
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isGuest = (participant: any) => participant && participant.guest;
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isDevice = (participant: any) => participant && participant.type === _RESOURCE_ROOM_;
@@ -120,7 +130,7 @@ MemberUtil.isModeratorAssignmentProhibited = (participant) =>
 /**
  * checks to see if the participant id is the same as the passed id
  * there are multiple ids that can be used
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @param {String} id
  * @returns {Boolean}
  */
@@ -130,7 +140,7 @@ MemberUtil.isSame = (participant: any, id: string) =>
 /**
  * checks to see if the participant id is the same as the passed id for associated devices
  * there are multiple ids that can be used
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @param {String} id
  * @returns {Boolean}
  */
@@ -142,7 +152,7 @@ MemberUtil.isAssociatedSame = (participant: any, id: string) =>
   );
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @param {Boolean} isGuest
  * @param {String} status
  * @returns {Boolean}
@@ -161,7 +171,7 @@ MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string):
     !status === _IN_MEETING_);
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isAudioMuted = (participant: any) => {
@@ -173,7 +183,7 @@ MemberUtil.isAudioMuted = (participant: any) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isVideoMuted = (participant: any): boolean => {
@@ -185,7 +195,7 @@ MemberUtil.isVideoMuted = (participant: any): boolean => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isHandRaised = (participant: any) => {
@@ -197,7 +207,7 @@ MemberUtil.isHandRaised = (participant: any) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isBreakoutsSupported = (participant) => {
@@ -209,7 +219,7 @@ MemberUtil.isBreakoutsSupported = (participant) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isInterpretationSupported = (participant) => {
@@ -223,7 +233,7 @@ MemberUtil.isInterpretationSupported = (participant) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isLiveAnnotationSupported = (participant) => {
@@ -279,7 +289,7 @@ MemberUtil.getRecordingMember = (controls: any) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Boolean}
  */
 MemberUtil.isRecording = (participant: any) => {
@@ -325,7 +335,7 @@ MemberUtil.isMutable = (isSelf, isDevice, isInMeeting, isMuted, type) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {String}
  */
 MemberUtil.extractStatus = (participant: any) => {
@@ -355,7 +365,7 @@ MemberUtil.extractStatus = (participant: any) => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {String}
  */
 MemberUtil.extractId = (participant: any) => {
@@ -368,7 +378,7 @@ MemberUtil.extractId = (participant: any) => {
 
 /**
  * extracts the media status from nested participant object
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {Object}
  */
 MemberUtil.extractMediaStatus = (participant: any): IMediaStatus => {
@@ -383,7 +393,7 @@ MemberUtil.extractMediaStatus = (participant: any): IMediaStatus => {
 };
 
 /**
- * @param {Object} participant the locus participant
+ * @param {Object} participant - The locus participant object.
  * @returns {String}
  */
 MemberUtil.extractName = (participant: any) => {

package/src/metrics/constants.ts

@@ -70,7 +70,7 @@ const BEHAVIORAL_METRICS = {
   ROAP_HTTP_RESPONSE_MISSING: 'js_sdk_roap_http_response_missing',
   TURN_DISCOVERY_REQUIRES_OK: 'js_sdk_turn_discovery_requires_ok',
   REACHABILITY_COMPLETED: 'js_sdk_reachability_completed',
-  WEBINAR_REGISTRATION_ERROR: 'js_sdk_webinar_registration_error',
+  JOIN_WEBINAR_ERROR: 'js_sdk_join_webinar_error',
   GUEST_ENTERED_LOBBY: 'js_sdk_guest_entered_lobby',
   GUEST_EXITED_LOBBY: 'js_sdk_guest_exited_lobby',
 };

package/src/multistream/remoteMedia.ts

@@ -19,6 +19,14 @@ export type RemoteVideoResolution =
   | 'large' // 1080p or less
   | 'best'; // highest possible resolution
 
+const MAX_FS_VALUES = {
+  '90p': 60,
+  '180p': 240,
+  '360p': 920,
+  '720p': 3600,
+  '1080p': 8192,
+};
+
 /**
  * Converts pane size into h264 maxFs
  * @param {PaneSize} paneSize
@@ -29,28 +37,28 @@ export function getMaxFs(paneSize: RemoteVideoResolution): number {
 
   switch (paneSize) {
     case 'thumbnail':
-      maxFs = 60;
+      maxFs = MAX_FS_VALUES['90p'];
       break;
     case 'very small':
-      maxFs = 240;
+      maxFs = MAX_FS_VALUES['180p'];
       break;
     case 'small':
-      maxFs = 920;
+      maxFs = MAX_FS_VALUES['360p'];
       break;
     case 'medium':
-      maxFs = 3600;
+      maxFs = MAX_FS_VALUES['720p'];
       break;
     case 'large':
-      maxFs = 8192;
+      maxFs = MAX_FS_VALUES['1080p'];
       break;
     case 'best':
-      maxFs = 8192; // for now 'best' is 1080p, so same as 'large'
+      maxFs = MAX_FS_VALUES['1080p']; // for now 'best' is 1080p, so same as 'large'
       break;
     default:
       LoggerProxy.logger.warn(
         `RemoteMedia#getMaxFs --> unsupported paneSize: ${paneSize}, using "medium" instead`
       );
-      maxFs = 3600;
+      maxFs = MAX_FS_VALUES['720p'];
   }
 
   return maxFs;
@@ -117,16 +125,21 @@ export class RemoteMedia extends EventsScope {
       return;
     }
 
-    if (height < 135) {
-      fs = 60;
-    } else if (height < 270) {
-      fs = 240;
-    } else if (height < 540) {
-      fs = 920;
+    // we switch to the next resolution level when the height is 10% more than the current resolution height
+    // except for 1080p - we switch to it immediately when the height is more than 720p
+    const threshold = 1.1;
+    const getThresholdHeight = (h: number) => Math.round(h * threshold);
+
+    if (height < getThresholdHeight(90)) {
+      fs = MAX_FS_VALUES['90p'];
+    } else if (height < getThresholdHeight(180)) {
+      fs = MAX_FS_VALUES['180p'];
+    } else if (height < getThresholdHeight(360)) {
+      fs = MAX_FS_VALUES['360p'];
     } else if (height <= 720) {
-      fs = 3600;
+      fs = MAX_FS_VALUES['720p'];
     } else {
-      fs = 8192;
+      fs = MAX_FS_VALUES['1080p'];
     }
 
     this.receiveSlot?.setMaxFs(fs);

package/src/multistream/sendSlotManager.ts

@@ -4,6 +4,7 @@ import {
   LocalStream,
   MultistreamRoapMediaConnection,
   NamedMediaGroup,
+  StreamState,
 } from '@webex/internal-media-core';
 
 export default class SendSlotManager {
@@ -83,6 +84,36 @@ export default class SendSlotManager {
     );
   }
 
+  /**
+   * Sets the source state override for the given media type.
+   * @param {MediaType} mediaType - The type of media (must be MediaType.VideoMain to apply source state changes).
+   * @param {StreamState | null} state - The state to set or null to clear the override value.
+   * @returns {void}
+   */
+  public setSourceStateOverride(mediaType: MediaType, state: StreamState | null) {
+    if (mediaType !== MediaType.VideoMain) {
+      throw new Error(
+        `sendSlotManager cannot set source state override which media type is ${mediaType}`
+      );
+    }
+
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    if (state) {
+      slot.setSourceStateOverride(state);
+    } else {
+      slot.clearSourceStateOverride();
+    }
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->setSourceStateOverride#set source state override for ${mediaType} to ${state}`
+    );
+  }
+
   /**
    * This method publishes the given stream to the sendSlot for the given mediaType
    * @param {MediaType} mediaType MediaType of the sendSlot to which a stream needs to be published (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)

package/src/roap/index.ts

@@ -231,14 +231,16 @@ export default class Roap extends StatelessWebexPlugin {
               headers,
             } = remoteSdp.roapMessage;
 
-            roapAnswer = {
-              seq: answerSeq,
-              messageType,
-              sdp: sdps[0],
-              errorType,
-              errorCause,
-              headers,
-            };
+            if (messageType === ROAP.ROAP_TYPES.ANSWER) {
+              roapAnswer = {
+                seq: answerSeq,
+                messageType,
+                sdp: sdps[0],
+                errorType,
+                errorCause,
+                headers,
+              };
+            }
           }
         }