@webex/plugin-meetings 3.0.0-beta.17 → 3.0.0-beta.18

package/src/meeting/request.ts

@@ -9,6 +9,7 @@ import LoggerProxy from '../common/logs/logger-proxy';
 import {
   ALERT,
   ALTERNATE_REDIRECT_TRUE,
+  BREAKOUTS,
   CALL,
   CONTROLS,
   DECLINE,
@@ -55,6 +56,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    * @param {boolean} options.pin
    * @param {boolean} options.moveToResource
    * @param {Object} options.roapMessage
+   * @param {boolean} options.breakoutsSupported
    * @returns {Promise}
    */
   async joinMeeting(options: {
@@ -73,6 +75,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     meetingNumber: any;
     permissionToken: any;
     preferTranscoding: any;
+    breakoutsSupported: boolean;
   }) {
     const {
       asResourceOccupant,
@@ -89,6 +92,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       moveToResource,
       roapMessage,
       preferTranscoding,
+      breakoutsSupported,
     } = options;
 
     LoggerProxy.logger.info('Meeting:request#joinMeeting --> Joining a meeting', correlationId);
@@ -114,6 +118,10 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       },
     };
 
+    if (breakoutsSupported) {
+      body.deviceCapabilities = [BREAKOUTS.BREAKOUTS_SUPPORTED];
+    }
+
     // @ts-ignore
     if (this.webex.meetings.clientRegion) {
       // @ts-ignore
@@ -497,37 +505,6 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     });
   }
 
-  /**
-   * Make a network request to acknowledge a meeting
-   * @param {Object} options
-   * @param {String} options.locusUrl
-   * @param {String} options.deviceUrl
-   * @param {String} options.id
-   * @returns {Promise}
-   */
-  recordMeeting(options: {
-    locusUrl: string;
-    deviceUrl: string;
-    id: string;
-    recording: any;
-    paused: any;
-  }) {
-    const uri = `${options.locusUrl}/${CONTROLS}`;
-    const body = {
-      record: {
-        recording: options.recording,
-        paused: options.paused,
-      },
-    };
-
-    // @ts-ignore
-    return this.request({
-      method: HTTP_VERBS.PATCH,
-      uri,
-      body,
-    });
-  }
-
   lockMeeting(options) {
     const uri = `${options.locusUrl}/${CONTROLS}`;
     const body = {
@@ -842,6 +819,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   toggleReactions({enable, locusUrl, requestingParticipantId}: ToggleReactionsOptions) {
     const uri = `${locusUrl}/${CONTROLS}`;
 
+    // @ts-ignore
     return this.request({
       method: HTTP_VERBS.PUT,
       uri,

package/src/meeting/request.type.ts

@@ -1,3 +1,5 @@
+import {Reaction} from '../reactions/reactions.type';
+
 export type SendReactionOptions = {
   reactionChannelUrl: string;
   reaction: Reaction;

package/src/meeting/util.ts

@@ -105,6 +105,7 @@ MeetingUtil.joinMeeting = (meeting, options) => {
       moveToResource: options.moveToResource,
       preferTranscoding: !meeting.isMultistream,
       asResourceOccupant: options.asResourceOccupant,
+      breakoutsSupported: options.breakoutsSupported,
     })
     .then((res) => {
       Metrics.postEvent({
@@ -123,6 +124,8 @@ MeetingUtil.joinMeeting = (meeting, options) => {
 };
 
 MeetingUtil.cleanUp = (meeting) => {
+  meeting.breakouts.cleanUp();
+
   // make sure we send last metrics before we close the peerconnection
   const stopStatsAnalyzer = meeting.statsAnalyzer
     ? meeting.statsAnalyzer.stopAnalyzer()
@@ -359,66 +362,6 @@ MeetingUtil.canUserUnlock = (displayHints) =>
   displayHints.includes(DISPLAY_HINTS.LOCK_CONTROL_UNLOCK) &&
   displayHints.includes(DISPLAY_HINTS.LOCK_STATUS_LOCKED);
 
-MeetingUtil.canUserRecord = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_START);
-
-MeetingUtil.canUserPause = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_PAUSE);
-
-MeetingUtil.canUserResume = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_RESUME);
-
-MeetingUtil.canUserStop = (displayHints) =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_STOP);
-
-MeetingUtil.startRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserRecord(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: true, paused: false});
-  }
-
-  return Promise.reject(
-    new PermissionError('Start recording not allowed, due to moderator property.')
-  );
-};
-
-MeetingUtil.pauseRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserPause(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: true, paused: true});
-  }
-
-  return Promise.reject(
-    new PermissionError('Pause recording not allowed, due to moderator property.')
-  );
-};
-
-MeetingUtil.resumeRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserResume(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: true, paused: false});
-  }
-
-  return Promise.reject(
-    new PermissionError('Resume recording not allowed, due to moderator property.')
-  );
-};
-
-MeetingUtil.stopRecording = (request, locusUrl, locusInfo) => {
-  const displayHints = MeetingUtil.getUserDisplayHintsFromLocusInfo(locusInfo);
-
-  if (MeetingUtil.canUserStop(displayHints)) {
-    return request.recordMeeting({locusUrl, recording: false, paused: false});
-  }
-
-  return Promise.reject(
-    new PermissionError('Stop recording not allowed, due to moderator property.')
-  );
-};
-
 MeetingUtil.canUserRaiseHand = (displayHints) => displayHints.includes(DISPLAY_HINTS.RAISE_HAND);
 
 MeetingUtil.canUserLowerAllHands = (displayHints) =>

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

@@ -19,6 +19,7 @@ export class MeetingInfoV2PasswordError extends Error {
   meetingInfo: any;
   sdkMessage: any;
   wbxAppApiCode: any;
+  body: any;
 
   /**
    *
@@ -70,6 +71,7 @@ export class MeetingInfoV2CaptchaError extends Error {
   isPasswordRequired: any;
   sdkMessage: any;
   wbxAppApiCode: any;
+  body: any;
   /**
    *
    * @constructor

package/src/meetings/index.ts

@@ -4,7 +4,7 @@ import '@webex/internal-plugin-mercury';
 import '@webex/internal-plugin-conversation';
 // @ts-ignore
 import {WebexPlugin} from '@webex/webex-core';
-import {MediaConnection as MC} from '@webex/internal-media-core';
+import {setLogger} from '@webex/internal-media-core';
 
 import 'webrtc-adapter';
 
@@ -249,6 +249,7 @@ export default class Meetings extends WebexPlugin {
       // @ts-ignore
       this.meetingCollection.getByKey(
         CORRELATION_ID,
+        // @ts-ignore
         MeetingsUtil.checkForCorrelationId(this.webex.internal.device.url, data.locus)
       ) ||
       this.meetingCollection.getByKey(
@@ -460,7 +461,7 @@ export default class Meetings extends WebexPlugin {
       LoggerProxy.set(this.webex.logger);
 
       mediaLogger = new MediaLogger();
-      MC.setLogger(mediaLogger);
+      setLogger(mediaLogger);
 
       /**
        * The MeetingInfo object to interact with server
@@ -471,11 +472,14 @@ export default class Meetings extends WebexPlugin {
        */
       // @ts-ignore
       this.meetingInfo = this.config.experimental.enableUnifiedMeetings
-        ? new MeetingInfoV2(this.webex)
-        : new MeetingInfo(this.webex);
+        ? // @ts-ignore
+          new MeetingInfoV2(this.webex)
+        : // @ts-ignore
+          new MeetingInfo(this.webex);
       // @ts-ignore
       this.personalMeetingRoom = new PersonalMeetingRoom(
         {meetingInfo: this.meetingInfo},
+        // @ts-ignore
         {parent: this.webex}
       );
 
@@ -585,6 +589,7 @@ export default class Meetings extends WebexPlugin {
         // @ts-ignore
         .then(() =>
           LoggerProxy.logger.info(
+            // @ts-ignore
             `Meetings:index#register --> INFO, Device registered ${this.webex.internal.device.url}`
           )
         )
@@ -638,8 +643,8 @@ export default class Meetings extends WebexPlugin {
 
     this.stopListeningForEvents();
 
-    // @ts-ignore
     return (
+      // @ts-ignore
       this.webex.internal.mercury
         .disconnect()
         // @ts-ignore

package/src/meetings/request.ts

@@ -53,9 +53,9 @@ export default class MeetingRequest extends StatelessWebexPlugin {
    */
   determineRedirections(responseBody: any) {
     if (responseBody.remoteLocusClusterUrls && responseBody.remoteLocusClusterUrls.length) {
-      // @ts-ignore
       return Promise.all(
         responseBody.remoteLocusClusterUrls.map((url) =>
+          // @ts-ignore
           this.request({
             method: HTTP_VERBS.GET,
             url,

package/src/member/index.ts

@@ -31,6 +31,7 @@ export default class Member {
   name: any;
   participant: any;
   status: any;
+  supportsBreakouts: boolean;
   type: any;
   namespace = MEETINGS;
 
@@ -100,6 +101,13 @@ export default class Member {
      * @memberof Member
      */
     this.isHandRaised = null;
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.supportsBreakouts = null;
     /**
      * @instance
      * @type {Boolean}
@@ -242,6 +250,7 @@ export default class Member {
       this.isAudioMuted = MemberUtil.isAudioMuted(participant);
       this.isVideoMuted = MemberUtil.isVideoMuted(participant);
       this.isHandRaised = MemberUtil.isHandRaised(participant);
+      this.supportsBreakouts = MemberUtil.isBreakoutsSupported(participant);
       this.isGuest = MemberUtil.isGuest(participant);
       this.isUser = MemberUtil.isUser(participant);
       this.isDevice = MemberUtil.isDevice(participant);

package/src/member/util.ts

@@ -72,7 +72,7 @@ MemberUtil.isAssociatedSame = (participant: any, id: string) =>
  * @param {String} status
  * @returns {Boolean}
  */
-MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string) =>
+MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string): boolean =>
   participant &&
   participant.guest &&
   ((participant.devices &&
@@ -82,6 +82,7 @@ MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string)
     // @ts-ignore
     isGuest &&
     status === _IN_LOBBY_) ||
+    // @ts-ignore
     !status === _IN_MEETING_);
 
 /**
@@ -130,6 +131,18 @@ MemberUtil.isHandRaised = (participant: any) => {
   return participant.controls?.hand?.raised || false;
 };
 
+/**
+ * @param {Object} participant the locus participant
+ * @returns {Boolean}
+ */
+MemberUtil.isBreakoutsSupported = (participant) => {
+  if (!participant) {
+    throw new ParameterError('Breakout support could not be processed, participant is undefined.');
+  }
+
+  return !participant.doesNotSupportBreakouts;
+};
+
 /**
  * utility method for audio/video muted status
  * @param {String} status

package/src/members/index.ts

@@ -925,6 +925,7 @@ export default class Members extends StatelessWebexPlugin {
    */
   findMemberByCsi(csi) {
     return Object.values(this.membersCollection.getAll()).find((member) =>
+      // @ts-ignore
       member.participant?.devices?.find((device) =>
         device.csis?.find((memberCsi) => memberCsi === csi)
       )

package/src/members/request.ts

@@ -140,6 +140,7 @@ export default class MembersRequest extends StatelessWebexPlugin {
       !options.locusUrl ||
       !options.memberId ||
       !options.url ||
+      // @ts-ignore
       (!options.tones && options.tones !== 0)
     ) {
       throw new ParameterError(

package/src/multistream/mediaRequestManager.ts

@@ -1,9 +1,18 @@
 /* eslint-disable require-jsdoc */
-import {MediaConnection as MC} from '@webex/internal-media-core';
+import {
+  MediaRequest as WcmeMediaRequest,
+  Policy,
+  ActiveSpeakerInfo,
+  ReceiverSelectedInfo,
+  CodecInfo as WcmeCodecInfo,
+  H264Codec,
+} from '@webex/internal-media-core';
+import {cloneDeep} from 'lodash';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 
 import {ReceiveSlot, ReceiveSlotId} from './receiveSlot';
+import {getMaxFs} from './remoteMedia';
 
 export interface ActiveSpeakerPolicyInfo {
   policy: 'active-speaker';
@@ -47,22 +56,32 @@ const CODEC_DEFAULTS = {
   },
 };
 
-type SendMediaRequestsCallback = (mediaRequests: MC.MediaRequest[]) => void;
+type DegradationPreferences = {
+  maxMacroblocksLimit: number;
+};
+
+type SendMediaRequestsCallback = (mediaRequests: WcmeMediaRequest[]) => void;
 
 export class MediaRequestManager {
   private sendMediaRequestsCallback: SendMediaRequestsCallback;
 
-  private counter;
+  private counter: number;
 
   private clientRequests: {[key: MediaRequestId]: MediaRequest};
 
   private slotsActiveInLastMediaRequest: {[key: ReceiveSlotId]: ReceiveSlot};
 
-  constructor(sendMediaRequestsCallback: SendMediaRequestsCallback) {
+  private degradationPreferences: DegradationPreferences;
+
+  constructor(
+    degradationPreferences: DegradationPreferences,
+    sendMediaRequestsCallback: SendMediaRequestsCallback
+  ) {
     this.sendMediaRequestsCallback = sendMediaRequestsCallback;
     this.counter = 0;
     this.clientRequests = {};
     this.slotsActiveInLastMediaRequest = {};
+    this.degradationPreferences = degradationPreferences;
   }
 
   private resetInactiveReceiveSlots() {
@@ -90,34 +109,79 @@ export class MediaRequestManager {
     this.slotsActiveInLastMediaRequest = activeSlots;
   }
 
+  public setDegradationPreferences(degradationPreferences: DegradationPreferences) {
+    this.degradationPreferences = degradationPreferences;
+    this.sendRequests(); // re-send requests after preferences are set
+  }
+
+  private getDegradedClientRequests() {
+    const clientRequests = cloneDeep(this.clientRequests);
+    const maxFsLimits = [
+      getMaxFs('best'),
+      getMaxFs('large'),
+      getMaxFs('medium'),
+      getMaxFs('small'),
+      getMaxFs('very small'),
+      getMaxFs('thumbnail'),
+    ];
+
+    // reduce max-fs until total macroblocks is below limit
+    for (let i = 0; i < maxFsLimits.length; i += 1) {
+      let totalMacroblocksRequested = 0;
+      Object.values(clientRequests).forEach((mr) => {
+        if (mr.codecInfo) {
+          mr.codecInfo.maxFs = Math.min(
+            mr.codecInfo.maxFs || CODEC_DEFAULTS.h264.maxFs,
+            maxFsLimits[i]
+          );
+          totalMacroblocksRequested += mr.codecInfo.maxFs * mr.receiveSlots.length;
+        }
+      });
+      if (totalMacroblocksRequested <= this.degradationPreferences.maxMacroblocksLimit) {
+        if (i !== 0) {
+          LoggerProxy.logger.warn(
+            `multistream:mediaRequestManager --> too many requests with high max-fs, frame size will be limited to ${maxFsLimits[i]}`
+          );
+        }
+        break;
+      } else if (i === maxFsLimits.length - 1) {
+        LoggerProxy.logger.warn(
+          `multistream:mediaRequestManager --> even with frame size limited to ${maxFsLimits[i]} you are still requesting too many streams, consider reducing the number of requests`
+        );
+      }
+    }
+
+    return clientRequests;
+  }
+
   private sendRequests() {
-    const wcmeMediaRequests: MC.MediaRequest[] = [];
+    const wcmeMediaRequests: WcmeMediaRequest[] = [];
 
-    // todo: check how many streams we're asking for and what resolution and introduce some limits (spark-377701)
+    const clientRequests = this.getDegradedClientRequests();
     const maxPayloadBitsPerSecond = 10 * 1000 * 1000;
 
     // map all the client media requests to wcme media requests
-    Object.values(this.clientRequests).forEach((mr) => {
+    Object.values(clientRequests).forEach((mr) => {
       wcmeMediaRequests.push(
-        new MC.MediaRequest(
+        new WcmeMediaRequest(
           mr.policyInfo.policy === 'active-speaker'
-            ? MC.Policy.ActiveSpeaker
-            : MC.Policy.ReceiverSelected,
+            ? Policy.ActiveSpeaker
+            : Policy.ReceiverSelected,
           mr.policyInfo.policy === 'active-speaker'
-            ? new MC.ActiveSpeakerInfo(
+            ? new ActiveSpeakerInfo(
                 mr.policyInfo.priority,
                 mr.policyInfo.crossPriorityDuplication,
                 mr.policyInfo.crossPolicyDuplication,
                 mr.policyInfo.preferLiveVideo
               )
-            : new MC.ReceiverSelectedInfo(mr.policyInfo.csi),
+            : new ReceiverSelectedInfo(mr.policyInfo.csi),
           mr.receiveSlots.map((receiveSlot) => receiveSlot.wcmeReceiveSlot),
           maxPayloadBitsPerSecond,
           mr.codecInfo && [
-            new MC.CodecInfo(
+            new WcmeCodecInfo(
               0x80,
-              new MC.H264Codec(
-                mr.codecInfo.maxFs || CODEC_DEFAULTS.h264.maxFs,
+              new H264Codec(
+                mr.codecInfo.maxFs,
                 mr.codecInfo.maxFps || CODEC_DEFAULTS.h264.maxFps,
                 mr.codecInfo.maxMbps || CODEC_DEFAULTS.h264.maxMbps,
                 mr.codecInfo.maxWidth,

package/src/multistream/multistreamMedia.ts

@@ -48,6 +48,7 @@ export class MultistreamMedia {
     // todo: depending on how muting is done with Local tracks, this code here might need to change...
 
     if (track.kind === 'audio') {
+      // @ts-ignore
       this.meeting.setLocalAudioTrack(track);
       this.meeting.mediaProperties.mediaDirection.sendAudio = true;
 
@@ -56,6 +57,7 @@ export class MultistreamMedia {
         this.meeting.audio ||
         createMuteState(AUDIO, this.meeting, this.meeting.mediaProperties.mediaDirection);
     } else if (track.kind === 'video') {
+      // @ts-ignore
       this.meeting.setLocalVideoTrack(track);
       this.meeting.mediaProperties.mediaDirection.sendVideo = true;
 
@@ -80,9 +82,11 @@ export class MultistreamMedia {
     // muting etc
 
     if (track.kind === 'audio') {
+      // @ts-ignore
       this.meeting.setLocalVideoTrack(null);
       this.meeting.mediaProperties.mediaDirection.sendAudio = false;
     } else if (track.kind === 'video') {
+      // @ts-ignore
       this.meeting.setLocalAudioTrack(null);
       this.meeting.mediaProperties.mediaDirection.sendVideo = false;
     }

package/src/multistream/receiveSlot.ts

@@ -1,5 +1,10 @@
 /* eslint-disable valid-jsdoc */
-import {MediaConnection as MC} from '@webex/internal-media-core';
+import {
+  MediaType,
+  ReceiveSlot as WcmeReceiveSlot,
+  ReceiveSlotEvents as WcmeReceiveSlotEvents,
+  SourceState,
+} from '@webex/internal-media-core';
 
 import LoggerProxy from '../common/logs/logger-proxy';
 import EventsScope from '../common/events/events-scope';
@@ -8,7 +13,7 @@ export const ReceiveSlotEvents = {
   SourceUpdate: 'sourceUpdate',
 };
 
-export type SourceState = MC.SourceState;
+export type {SourceState} from '@webex/internal-media-core';
 export type CSI = number;
 export type MemberId = string;
 export type ReceiveSlotId = string;
@@ -22,31 +27,31 @@ export type FindMemberIdCallback = (csi: CSI) => MemberId | undefined;
  * for example some participant's main video or audio
  */
 export class ReceiveSlot extends EventsScope {
-  private readonly mcReceiveSlot: MC.ReceiveSlot;
+  private readonly mcReceiveSlot: WcmeReceiveSlot;
 
   private readonly findMemberIdCallback: FindMemberIdCallback;
 
   public readonly id: ReceiveSlotId;
 
-  public readonly mediaType: MC.MediaType;
+  public readonly mediaType: MediaType;
 
   #memberId?: MemberId;
 
   #csi?: CSI;
 
-  #sourceState: MC.SourceState;
+  #sourceState: SourceState;
 
   /**
    * constructor - don't use it directly, you should always use meeting.receiveSlotManager.allocateSlot()
    * to create any receive slots
    *
-   * @param {MC.MediaType} mediaType
-   * @param {MC.ReceiveSlot} mcReceiveSlot
+   * @param {MediaType} mediaType
+   * @param {ReceiveSlot} mcReceiveSlot
    * @param {FindMemberIdCallback} findMemberIdCallback callback for finding memberId for given CSI
    */
   constructor(
-    mediaType: MC.MediaType,
-    mcReceiveSlot: MC.ReceiveSlot,
+    mediaType: MediaType,
+    mcReceiveSlot: WcmeReceiveSlot,
     findMemberIdCallback: FindMemberIdCallback
   ) {
     super();
@@ -93,8 +98,8 @@ export class ReceiveSlot extends EventsScope {
     };
 
     this.mcReceiveSlot.on(
-      MC.ReceiveSlotEvents.SourceUpdate,
-      (state: MC.SourceState, csi?: number) => {
+      WcmeReceiveSlotEvents.SourceUpdate,
+      (state: SourceState, csi?: number) => {
         LoggerProxy.logger.log(
           `ReceiveSlot#setupEventListeners --> got source update on receive slot ${this.id}, mediaType=${this.mediaType}, csi=${csi}, state=${state}`
         );
@@ -123,7 +128,7 @@ export class ReceiveSlot extends EventsScope {
   /**
    * The underlying WCME receive slot
    */
-  get wcmeReceiveSlot(): MC.ReceiveSlot {
+  get wcmeReceiveSlot(): WcmeReceiveSlot {
     return this.mcReceiveSlot;
   }