@webex/plugin-meetings 3.7.0-next.22 → 3.7.0-next.24

package/src/locus-info/selfUtils.ts

@@ -66,6 +66,7 @@ SelfUtils.parse = (self: any, deviceId: string) => {
       breakoutSessions: SelfUtils.getBreakoutSessions(self),
       breakout: SelfUtils.getBreakout(self),
       interpretation: SelfUtils.getInterpretation(self),
+      brb: SelfUtils.getBrb(self),
     };
   }
 
@@ -75,6 +76,7 @@ SelfUtils.parse = (self: any, deviceId: string) => {
 SelfUtils.getBreakoutSessions = (self) => self?.controls?.breakout?.sessions;
 SelfUtils.getBreakout = (self) => self?.controls?.breakout;
 SelfUtils.getInterpretation = (self) => self?.controls?.interpretation;
+SelfUtils.getBrb = (self) => self?.controls?.brb;
 
 SelfUtils.getLayout = (self) =>
   Array.isArray(self?.controls?.layouts) ? self.controls.layouts[0].type : undefined;
@@ -128,6 +130,7 @@ SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
   updates.isSharingBlockedChanged = previous?.isSharingBlocked !== current.isSharingBlocked;
   updates.breakoutsChanged = SelfUtils.breakoutsChanged(previous, current);
   updates.interpretationChanged = SelfUtils.interpretationChanged(previous, current);
+  updates.brbChanged = SelfUtils.brbChanged(previous, current);
 
   return {
     previous,
@@ -159,6 +162,9 @@ SelfUtils.breakoutsChanged = (previous, current) =>
 SelfUtils.interpretationChanged = (previous, current) =>
   !isEqual(previous?.interpretation, current?.interpretation) && !!current?.interpretation;
 
+SelfUtils.brbChanged = (previous, current) =>
+  !isEqual(previous?.brb, current?.brb) && current?.brb !== undefined;
+
 SelfUtils.isMediaInactive = (previous, current) => {
   if (
     previous &&

package/src/meeting/index.ts

@@ -3388,6 +3388,20 @@ export default class Meeting extends StatelessWebexPlugin {
       }
     });
 
+    this.locusInfo.on(LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED, (payload) => {
+      Trigger.trigger(
+        this,
+        {
+          file: 'meeting/index',
+          function: 'setUpLocusInfoSelfListener',
+        },
+        EVENT_TRIGGERS.MEETING_SELF_BRB_UPDATE,
+        {
+          payload,
+        }
+      );
+    });
+
     this.locusInfo.on(LOCUSINFO.EVENTS.SELF_ROLES_CHANGED, (payload) => {
       const isModeratorOrCohost =
         payload.newRoles?.includes(SELF_ROLES.MODERATOR) ||
@@ -3592,6 +3606,50 @@ export default class Meeting extends StatelessWebexPlugin {
     return this.members.admitMembers(memberIds, locusUrls);
   }
 
+  /**
+   * Manages be right back status updates for the current participant.
+   *
+   * @param {boolean} enabled - Indicates whether the user enabled brb or not.
+   * @returns {Promise<void>} resolves when the brb status is updated or does nothing if not in a multistream meeting.
+   * @throws {Error} - Throws an error if the request fails.
+   */
+  public async beRightBack(enabled: boolean): Promise<void> {
+    if (!this.isMultistream) {
+      const errorMessage = 'Meeting:index#beRightBack --> Not a multistream meeting';
+      const error = new Error(errorMessage);
+
+      LoggerProxy.logger.error(error);
+
+      return Promise.reject(error);
+    }
+
+    if (!this.mediaProperties.webrtcMediaConnection) {
+      const errorMessage = 'Meeting:index#beRightBack --> WebRTC media connection is not defined';
+      const error = new Error(errorMessage);
+
+      LoggerProxy.logger.error(error);
+
+      return Promise.reject(error);
+    }
+
+    // this logic should be applied only to multistream meetings
+    return this.meetingRequest
+      .setBrb({
+        enabled,
+        locusUrl: this.locusUrl,
+        deviceUrl: this.deviceUrl,
+        selfId: this.selfId,
+      })
+      .then(() => {
+        this.sendSlotManager.setSourceStateOverride(MediaType.VideoMain, enabled ? 'away' : null);
+      })
+      .catch((error) => {
+        LoggerProxy.logger.error('Meeting:index#beRightBack --> Error ', error);
+
+        return Promise.reject(error);
+      });
+  }
+
   /**
    * Remove the member from the meeting, boot them
    * @param {String} memberId

package/src/meeting/request.ts

@@ -27,7 +27,7 @@ import {
   _SLIDES_,
   ANNOTATION,
 } from '../constants';
-import {SendReactionOptions, ToggleReactionsOptions} from './request.type';
+import {SendReactionOptions, BrbOptions, ToggleReactionsOptions} from './request.type';
 import MeetingUtil from './util';
 import {AnnotationInfo} from '../annotation/annotation.types';
 import {ClientMediaPreferences} from '../reachability/reachability.types';
@@ -909,4 +909,29 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       uri: locusUrl,
     });
   }
+
+  /**
+   * Sends a request to set be right back status.
+   *
+   * @param {Object} options - The options for brb request.
+   * @param {boolean} options.enabled - Whether brb status is enabled.
+   * @param {string} options.locusUrl - The URL of the locus.
+   * @param {string} options.deviceUrl - The URL of the device.
+   * @param {string} options.selfId - The ID of the participant.
+   * @returns {Promise}
+   */
+  setBrb({enabled, locusUrl, deviceUrl, selfId}: BrbOptions) {
+    const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${CONTROLS}`;
+
+    return this.locusDeltaRequest({
+      method: HTTP_VERBS.PATCH,
+      uri,
+      body: {
+        brb: {
+          enabled,
+          deviceUrl,
+        },
+      },
+    });
+  }
 }

package/src/meeting/request.type.ts

@@ -11,3 +11,10 @@ export type ToggleReactionsOptions = {
   locusUrl: string;
   requestingParticipantId: string;
 };
+
+export type BrbOptions = {
+  enabled: boolean;
+  locusUrl: string;
+  deviceUrl: string;
+  selfId: string;
+};

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/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/test/unit/spec/locus-info/index.js

@@ -794,6 +794,75 @@ describe('plugin-meetings', () => {
     });
 
     describe('#updateSelf', () => {
+      it('should trigger SELF_MEETING_BRB_CHANGED when brb state changed', () => {
+        locusInfo.self = undefined;
+
+        const assertBrb = (enabled) => {
+          const selfWithBrbChanged = cloneDeep(self);
+          selfWithBrbChanged.controls.brb = enabled;
+
+          locusInfo.emitScoped = sinon.stub();
+          locusInfo.updateSelf(selfWithBrbChanged, []);
+
+          assert.calledWith(
+            locusInfo.emitScoped,
+            {file: 'locus-info', function: 'updateSelf'},
+            LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
+            {brb: enabled}
+          );
+        };
+
+        assertBrb(true);
+        assertBrb(false);
+      });
+
+      it('should not trigger SELF_MEETING_BRB_CHANGED when brb state did not change', () => {
+        const assertBrbUnchanged = (value) => {
+          locusInfo.self = undefined;
+
+          const selfWithBrbChanged = cloneDeep(self);
+          selfWithBrbChanged.controls.brb = value;
+          locusInfo.self = selfWithBrbChanged;
+
+          locusInfo.emitScoped = sinon.stub();
+
+          const newSelf = cloneDeep(self);
+          newSelf.controls.brb = value;
+
+          locusInfo.updateSelf(newSelf, []);
+
+          assert.neverCalledWith(
+            locusInfo.emitScoped,
+            {file: 'locus-info', function: 'updateSelf'},
+            LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
+            {brb: value}
+          );
+        };
+
+        assertBrbUnchanged(true);
+        assertBrbUnchanged(false);
+      });
+
+      it('should not trigger SELF_MEETING_BRB_CHANGED when brb state is undefined', () => {
+        const selfWithBrbChanged = cloneDeep(self);
+        selfWithBrbChanged.controls.brb = false;
+        locusInfo.self = selfWithBrbChanged;
+
+        locusInfo.emitScoped = sinon.stub();
+
+        const newSelf = cloneDeep(self);
+        newSelf.controls.brb = undefined;
+
+        locusInfo.updateSelf(newSelf, []);
+
+        assert.neverCalledWith(
+          locusInfo.emitScoped,
+          {file: 'locus-info', function: 'updateSelf'},
+          LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
+          {brb: undefined}
+        );
+      });
+
       it('should trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls change', () => {
         const layoutType = 'EXAMPLE TYPE';
 
@@ -1389,6 +1458,30 @@ describe('plugin-meetings', () => {
           }
         );
       });
+
+      it('should not trigger any events if controls is undefined', () => {
+        locusInfo.self = self;
+        locusInfo.emitScoped = sinon.stub();
+        const newSelf = cloneDeep(self);
+        newSelf.controls = undefined;
+
+        locusInfo.updateSelf(newSelf, []);
+
+        const eventsSet = new Set([
+          LOCUSINFO.EVENTS.CONTROLS_MEETING_LAYOUT_UPDATED,
+          LOCUSINFO.EVENTS.SELF_MEETING_BREAKOUTS_CHANGED,
+          LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
+          LOCUSINFO.EVENTS.SELF_MEETING_INTERPRETATION_CHANGED,
+          LOCUSINFO.EVENTS.LOCAL_UNMUTE_REQUIRED,
+          LOCUSINFO.EVENTS.SELF_REMOTE_MUTE_STATUS_UPDATED,
+        ]);
+
+        // check all events that contain logic on controls existence
+        locusInfo.emitScoped.getCalls().forEach((call) => {
+          const eventName = call.args[1];
+          assert.isFalse(eventsSet.has(eventName));
+        });
+      });
     });
 
     describe('#updateMeetingInfo', () => {

package/test/unit/spec/locus-info/selfConstant.js

@@ -304,6 +304,13 @@ export const selfWithInactivity = {
     localRecord: {
       recording: false,
     },
+    brb: {
+      enabled: true,
+      meta: {
+        lastModified: '2024-10-24T14:05:58.526Z',
+        modifiedBy: '70978427-8238-4ffc-9227-8baf4b80b831',
+      },
+    },
     layouts: [
       {
         type: 'activePresence',

package/test/unit/spec/locus-info/selfUtils.js

@@ -60,6 +60,14 @@ describe('plugin-meetings', () => {
         assert.calledWith(spy, self);
         assert.deepEqual(parsedSelf.layout, self.controls.layouts[0].type);
       });
+
+      it('calls getBrb and returns the resulting brb value', () => {
+        const spy = Sinon.spy(SelfUtils, 'getBrb');
+        const parsedSelf = SelfUtils.parse(self);
+
+        assert.calledWith(spy, self);
+        assert.deepEqual(parsedSelf.brb, self.controls.brb);
+      });
     });
 
     describe('getLayout', () => {
@@ -170,6 +178,37 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('brbChanged', () => {
+      it('should return true if brb have changed', () => {
+        const current = {
+          brb: {enabled: true}
+        };
+        const previous = {
+          brb: {enabled: false}
+        };
+
+        assert.isTrue(SelfUtils.brbChanged(previous, current));
+      });
+
+      it('should return false if brb have not changed', () => {
+        const current = {
+          brb: {enabled: true}
+        };
+        const previous = {
+          brb: {enabled: true}
+        };
+
+        assert.isFalse(SelfUtils.brbChanged(previous, current));
+      });
+
+      it('should return false if brb in current is undefined', () => {
+        const current = {};
+        const previous = {brb: {enabled: true}};
+
+        assert.isFalse(SelfUtils.brbChanged(previous, current));
+      });
+    });
+
     describe('canNotViewTheParticipantList', () => {
       it('should return the correct value', () => {
         assert.equal(