@webex/plugin-meetings 3.7.0-next.5 → 3.7.0-next.50

package/src/meeting/index.ts

@@ -31,7 +31,6 @@ import {
 } from '@webex/internal-media-core';
 
 import {
-  getDevices,
   LocalStream,
   LocalCameraStream,
   LocalDisplayStream,
@@ -122,6 +121,8 @@ import {
   MEETING_PERMISSION_TOKEN_REFRESH_REASON,
   ROAP_OFFER_ANSWER_EXCHANGE_TIMEOUT,
   NAMED_MEDIA_GROUP_TYPE_AUDIO,
+  WEBINAR_ERROR_WEBCAST,
+  WEBINAR_ERROR_REGISTRATIONID,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import ParameterError from '../common/errors/parameter';
@@ -129,7 +130,7 @@ import {
   MeetingInfoV2PasswordError,
   MeetingInfoV2CaptchaError,
   MeetingInfoV2PolicyError,
-  MeetingInfoV2WebinarRegistrationError,
+  MeetingInfoV2JoinWebinarError,
 } from '../meeting-info/meeting-info-v2';
 import {CSI, ReceiveSlotManager} from '../multistream/receiveSlotManager';
 import SendSlotManager from '../multistream/sendSlotManager';
@@ -158,7 +159,9 @@ import ControlsOptionsManager from '../controls-options-manager';
 import PermissionError from '../common/errors/permission';
 import {LocusMediaRequest} from './locusMediaRequest';
 import {ConnectionStateHandler, ConnectionStateEvent} from './connectionStateHandler';
-import WebinarRegistrationError from '../common/errors/webinar-registration-error';
+import JoinWebinarError from '../common/errors/join-webinar-error';
+import Member from '../member';
+import MultistreamNotSupportedError from '../common/errors/multistream-not-supported-error';
 
 // default callback so we don't call an undefined function, but in practice it should never be used
 const DEFAULT_ICE_PHASE_CALLBACK = () => 'JOIN_MEETING_FINAL';
@@ -848,7 +851,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     // @ts-ignore
-    this.webinar = new Webinar({}, {parent: this.webex});
+    this.webinar = new Webinar({meetingId: this.id}, {parent: this.webex});
     /**
      * helper class for managing receive slots (for multistream media connections)
      */
@@ -1767,15 +1770,20 @@ export default class Meeting extends StatelessWebexPlugin {
           this.meetingInfo = err.meetingInfo;
         }
         throw new PermissionError();
-      } else if (err instanceof MeetingInfoV2WebinarRegistrationError) {
+      } else if (err instanceof MeetingInfoV2JoinWebinarError) {
         this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WEBINAR_REGISTRATION;
+        if (WEBINAR_ERROR_WEBCAST.includes(err.wbxAppApiCode)) {
+          this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.NEED_JOIN_WITH_WEBCAST;
+        } else if (WEBINAR_ERROR_REGISTRATIONID.includes(err.wbxAppApiCode)) {
+          this.meetingInfoFailureReason = MEETING_INFO_FAILURE_REASON.WEBINAR_NEED_REGISTRATIONID;
+        }
         this.meetingInfoFailureCode = err.wbxAppApiCode;
 
         if (err.meetingInfo) {
           this.meetingInfo = err.meetingInfo;
         }
 
-        throw new WebinarRegistrationError();
+        throw new JoinWebinarError();
       } else if (err instanceof MeetingInfoV2PasswordError) {
         LoggerProxy.logger.info(
           // @ts-ignore
@@ -2734,6 +2742,7 @@ export default class Meeting extends StatelessWebexPlugin {
       this.triggerAnnotationInfoEvent(contentShare, previousContentShare);
 
       if (
+        !payload.forceUpdate &&
         contentShare.beneficiaryId === previousContentShare?.beneficiaryId &&
         contentShare.disposition === previousContentShare?.disposition &&
         contentShare.deviceUrlSharing === previousContentShare.deviceUrlSharing &&
@@ -2780,7 +2789,11 @@ export default class Meeting extends StatelessWebexPlugin {
       // 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;
+        // Webinar attendee should receive whiteboard as remote share
+        newShareStatus =
+          this.locusInfo?.info?.isWebinar && this.webinar?.selfIsAttendee
+            ? SHARE_STATUS.REMOTE_SHARE_ACTIVE
+            : 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 (
@@ -2795,6 +2808,7 @@ export default class Meeting extends StatelessWebexPlugin {
       LoggerProxy.logger.info(
         `Meeting:index#setUpLocusInfoMediaInactiveListener --> this.shareStatus=${this.shareStatus} newShareStatus=${newShareStatus}`
       );
+
       if (newShareStatus !== this.shareStatus) {
         const oldShareStatus = this.shareStatus;
 
@@ -3052,7 +3066,20 @@ export default class Meeting extends StatelessWebexPlugin {
    */
   private setUpLocusResourcesListener() {
     this.locusInfo.on(LOCUSINFO.EVENTS.LINKS_RESOURCES, (payload) => {
-      this.webinar.updateWebcastUrl(payload);
+      if (payload) {
+        this.webinar.updateWebcastUrl(payload);
+        Trigger.trigger(
+          this,
+          {
+            file: 'meeting/index',
+            function: 'setUpLocusInfoMeetingInfoListener',
+          },
+          EVENT_TRIGGERS.MEETING_RESOURCE_LINKS_UPDATE,
+          {
+            payload,
+          }
+        );
+      }
     });
   }
 
@@ -3362,6 +3389,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) ||
@@ -3371,6 +3412,7 @@ export default class Meeting extends StatelessWebexPlugin {
         payload.newRoles?.includes(SELF_ROLES.MODERATOR)
       );
       this.webinar.updateRoleChanged(payload);
+
       Trigger.trigger(
         this,
         {
@@ -3565,6 +3607,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
@@ -3774,6 +3860,10 @@ export default class Meeting extends StatelessWebexPlugin {
             this.userDisplayHints,
             this.selfUserPolicies
           ),
+          isPremiseRecordingEnabled: RecordingUtil.isPremiseRecordingEnabled(
+            this.userDisplayHints,
+            this.selfUserPolicies
+          ),
           canRaiseHand: MeetingUtil.canUserRaiseHand(this.userDisplayHints),
           canLowerAllHands: MeetingUtil.canUserLowerAllHands(this.userDisplayHints),
           canLowerSomeoneElsesHand: MeetingUtil.canUserLowerSomeoneElsesHand(this.userDisplayHints),
@@ -3800,6 +3890,7 @@ export default class Meeting extends StatelessWebexPlugin {
             this.userDisplayHints
           ),
           canManageBreakout: MeetingUtil.canManageBreakout(this.userDisplayHints),
+          canStartBreakout: MeetingUtil.canStartBreakout(this.userDisplayHints),
           canBroadcastMessageToBreakout: MeetingUtil.canBroadcastMessageToBreakout(
             this.userDisplayHints,
             this.selfUserPolicies
@@ -4095,10 +4186,11 @@ export default class Meeting extends StatelessWebexPlugin {
    */
   private setLogUploadTimer() {
     // start with short timeouts and increase them later on so in case users have very long multi-hour meetings we don't get too fragmented logs
-    const LOG_UPLOAD_INTERVALS = [0.1, 1, 15, 15, 30, 30, 30, 60];
+    const LOG_UPLOAD_INTERVALS = [0.1, 15, 30, 60]; // in minutes
 
     const delay =
       1000 *
+      60 *
       // @ts-ignore - config coming from registerPlugin
       this.config.logUploadIntervalMultiplicationFactor *
       LOG_UPLOAD_INTERVALS[this.logUploadIntervalIndex];
@@ -4537,11 +4629,12 @@ export default class Meeting extends StatelessWebexPlugin {
    * Close the peer connections and remove them from the class.
    * Cleanup any media connection related things.
    *
+   * @param {boolean} resetMuteStates whether to also reset the audio/video mute state information
    * @returns {Promise}
    * @public
    * @memberof Meeting
    */
-  public closePeerConnections() {
+  public closePeerConnections(resetMuteStates = true) {
     if (this.mediaProperties.webrtcMediaConnection) {
       if (this.remoteMediaManager) {
         this.remoteMediaManager.stop();
@@ -4554,12 +4647,15 @@ export default class Meeting extends StatelessWebexPlugin {
 
       this.receiveSlotManager.reset();
       this.mediaProperties.webrtcMediaConnection.close();
+      this.mediaProperties.unsetPeerConnection();
       this.sendSlotManager.reset();
       this.setNetworkStatus(undefined);
     }
 
-    this.audio = null;
-    this.video = null;
+    if (resetMuteStates) {
+      this.audio = null;
+      this.video = null;
+    }
 
     return Promise.resolve();
   }
@@ -4819,7 +4915,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @param {Object} options - options to join with media
    * @param {JoinOptions} [options.joinOptions] - see #join()
    * @param {AddMediaOptions} [options.mediaOptions] - see #addMedia()
-   * @returns {Promise} -- {join: see join(), media: see addMedia()}
+   * @returns {Promise} -- {join: see join(), media: see addMedia(), multistreamEnabled: flag to indicate if we managed to join in multistream mode}
    * @public
    * @memberof Meeting
    * @example
@@ -4909,6 +5005,7 @@ export default class Meeting extends StatelessWebexPlugin {
       return {
         join: joinResponse,
         media: mediaResponse,
+        multistreamEnabled: this.isMultistream,
       };
     } catch (error) {
       LoggerProxy.logger.error('Meeting:index#joinWithMedia --> ', error);
@@ -4917,7 +5014,17 @@ export default class Meeting extends StatelessWebexPlugin {
 
       this.roap.abortTurnDiscovery();
 
-      if (joined && isRetry) {
+      // if this was the first attempt, let's do a retry
+      let shouldRetry = !isRetry;
+
+      if (CallDiagnosticUtils.isSdpOfferCreationError(error)) {
+        // errors related to offer creation (for example missing H264 codec) will happen again no matter how many times we try,
+        // so there is no point doing a retry
+        shouldRetry = false;
+      }
+
+      // we only want to call leave if join was successful and this was a retry or we won't be doing any more retries
+      if (joined && (isRetry || !shouldRetry)) {
         try {
           await this.leave({resourceId: joinOptions?.resourceId, reason: 'joinWithMedia failure'});
         } catch (e) {
@@ -4941,15 +5048,6 @@ export default class Meeting extends StatelessWebexPlugin {
         }
       );
 
-      // if this was the first attempt, let's do a retry
-      let shouldRetry = !isRetry;
-
-      if (CallDiagnosticUtils.isSdpOfferCreationError(error)) {
-        // errors related to offer creation (for example missing H264 codec) will happen again no matter how many times we try,
-        // so there is no point doing a retry
-        shouldRetry = false;
-      }
-
       if (shouldRetry) {
         LoggerProxy.logger.warn('Meeting:index#joinWithMedia --> retrying call to joinWithMedia');
         this.joinWithMediaRetryInfo.isRetry = true;
@@ -5205,7 +5303,16 @@ export default class Meeting extends StatelessWebexPlugin {
           (this.config.receiveReactions || options.receiveReactions) &&
           this.isReactionsSupported()
         ) {
-          const {name} = this.members.membersCollection.get(e.data.sender.participantId);
+          const member = this.members.membersCollection.get(e.data.sender.participantId);
+          if (!member) {
+            // @ts-ignore -- fix type
+            LoggerProxy.logger.warn(
+              `Meeting:index#processRelayEvent --> Skipping handling of ${REACTION_RELAY_TYPES.REACTION} for ${this.id}. participantId ${e.data.sender.participantId} does not exist in membersCollection.`
+            );
+            break;
+          }
+
+          const {name} = member;
           const processedReaction: ProcessedReaction = {
             reaction: e.data.reaction,
             sender: {
@@ -5259,6 +5366,9 @@ export default class Meeting extends StatelessWebexPlugin {
         this.voiceaListenerCallbacks[VOICEAEVENTS.NEW_CAPTION]
       );
 
+      // @ts-ignore
+      this.webex.internal.voicea.deregisterEvents();
+
       this.areVoiceaEventsSetup = false;
       this.triggerStopReceivingTranscriptionEvent();
     }
@@ -5369,16 +5479,19 @@ export default class Meeting extends StatelessWebexPlugin {
       this.meetingFiniteStateMachine.reset();
     }
 
-    // @ts-ignore
-    this.webex.internal.newMetrics.submitClientEvent({
-      name: 'client.call.initiated',
-      payload: {
-        trigger: this.callStateForMetrics.joinTrigger || 'user-interaction',
-        isRoapCallEnabled: true,
-        pstnAudioType: options?.pstnAudioType,
-      },
-      options: {meetingId: this.id},
-    });
+    // send client.call.initiated unless told not to
+    if (options.sendCallInitiated !== false) {
+      // @ts-ignore
+      this.webex.internal.newMetrics.submitClientEvent({
+        name: 'client.call.initiated',
+        payload: {
+          trigger: this.callStateForMetrics.joinTrigger || 'user-interaction',
+          isRoapCallEnabled: true,
+          pstnAudioType: options?.pstnAudioType,
+        },
+        options: {meetingId: this.id},
+      });
+    }
 
     LoggerProxy.logger.log('Meeting:index#join --> Joining a meeting');
 
@@ -5566,17 +5679,23 @@ export default class Meeting extends StatelessWebexPlugin {
    */
   async updateLLMConnection() {
     // @ts-ignore - Fix type
-    const {url, info: {datachannelUrl} = {}} = this.locusInfo;
+    const {url, info: {datachannelUrl, practiceSessionDatachannelUrl} = {}} = this.locusInfo;
 
     const isJoined = this.isJoined();
 
+    // webinar panelist should use new data channel in practice session
+    const dataChannelUrl =
+      this.webinar.isJoinPracticeSessionDataChannel() && practiceSessionDatachannelUrl
+        ? practiceSessionDatachannelUrl
+        : datachannelUrl;
+
     // @ts-ignore - Fix type
     if (this.webex.internal.llm.isConnected()) {
       if (
         // @ts-ignore - Fix type
         url === this.webex.internal.llm.getLocusUrl() &&
         // @ts-ignore - Fix type
-        datachannelUrl === this.webex.internal.llm.getDatachannelUrl() &&
+        dataChannelUrl === this.webex.internal.llm.getDatachannelUrl() &&
         isJoined
       ) {
         return undefined;
@@ -5593,7 +5712,7 @@ export default class Meeting extends StatelessWebexPlugin {
 
     // @ts-ignore - Fix type
     return this.webex.internal.llm
-      .registerAndConnect(url, datachannelUrl)
+      .registerAndConnect(url, dataChannelUrl)
       .then((registerAndConnectResult) => {
         // @ts-ignore - Fix type
         this.webex.internal.llm.off('event:relay.event', this.processRelayEvent);
@@ -5965,6 +6084,11 @@ export default class Meeting extends StatelessWebexPlugin {
   public roapMessageReceived = (roapMessage: RoapMessage) => {
     const mediaServer = MeetingsUtil.getMediaServer(roapMessage.sdp);
 
+    if (this.isMultistream && mediaServer !== 'homer') {
+      throw new MultistreamNotSupportedError(
+        `Client asked for multistream backend (Homer), but got ${mediaServer} instead`
+      );
+    }
     this.mediaProperties.webrtcMediaConnection.roapMessageReceived(roapMessage);
 
     if (mediaServer) {
@@ -6087,16 +6211,20 @@ export default class Meeting extends StatelessWebexPlugin {
                 logText: `${LOG_HEADER} Roap Offer`,
               }
             ).catch((error) => {
+              const multistreamNotSupported = error instanceof MultistreamNotSupportedError;
+
               // @ts-ignore
               this.webex.internal.newMetrics.submitClientEvent({
                 name: 'client.media-engine.remote-sdp-received',
                 payload: {
-                  canProceed: false,
+                  canProceed: multistreamNotSupported,
                   errors: [
                     // @ts-ignore
                     this.webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode(
                       {
-                        clientErrorCode: CALL_DIAGNOSTIC_CONFIG.MISSING_ROAP_ANSWER_CLIENT_CODE,
+                        clientErrorCode: multistreamNotSupported
+                          ? CALL_DIAGNOSTIC_CONFIG.MULTISTREAM_NOT_AVAILABLE_CLIENT_CODE
+                          : CALL_DIAGNOSTIC_CONFIG.MISSING_ROAP_ANSWER_CLIENT_CODE,
                       }
                     ),
                   ],
@@ -6104,7 +6232,7 @@ export default class Meeting extends StatelessWebexPlugin {
                 options: {meetingId: this.id, rawError: error},
               });
 
-              this.deferSDPAnswer.reject(new Error('failed to send ROAP SDP offer'));
+              this.deferSDPAnswer.reject(error);
               clearTimeout(this.sdpResponseTimer);
               this.sdpResponseTimer = undefined;
             });
@@ -6432,6 +6560,14 @@ export default class Meeting extends StatelessWebexPlugin {
         this.webex.meetings.geoHintInfo?.clientAddress ||
         options.data.intervalMetadata.peerReflexiveIP ||
         MQA_STATS.DEFAULT_IP;
+
+      const {members} = this.getMembers().membersCollection;
+
+      // Count members that are in the meeting
+      options.data.intervalMetadata.meetingUserCount = Object.values(members).filter(
+        (member: Member) => member.isInMeeting
+      ).length;
+
       // @ts-ignore
       this.webex.internal.newMetrics.submitMQE({
         name: 'client.mediaquality.event',
@@ -6763,32 +6899,6 @@ export default class Meeting extends StatelessWebexPlugin {
     }
   }
 
-  /**
-   * Handles device logging
-   *
-   * @private
-   * @static
-   * @param {boolean} isAudioEnabled
-   * @param {boolean} isVideoEnabled
-   * @returns {Promise<void>}
-   */
-
-  private static async handleDeviceLogging(isAudioEnabled, isVideoEnabled): Promise<void> {
-    try {
-      let devices = [];
-      if (isVideoEnabled && isAudioEnabled) {
-        devices = await getDevices();
-      } else if (isVideoEnabled) {
-        devices = await getDevices(Media.DeviceKind.VIDEO_INPUT);
-      } else if (isAudioEnabled) {
-        devices = await getDevices(Media.DeviceKind.AUDIO_INPUT);
-      }
-      MeetingUtil.handleDeviceLogging(devices);
-    } catch {
-      // getDevices may fail if we don't have browser permissions, that's ok, we still can have a media connection
-    }
-  }
-
   /**
    * Returns a promise. This promise is created once the local sdp offer has been successfully created and is resolved
    * once the remote sdp answer has been received.
@@ -7012,7 +7122,9 @@ export default class Meeting extends StatelessWebexPlugin {
 
       const mc = await this.createMediaConnection(turnServerInfo, bundlePolicy);
 
-      LoggerProxy.logger.info(`${LOG_HEADER} media connection created`);
+      LoggerProxy.logger.info(
+        `${LOG_HEADER} media connection created this.isMultistream=${this.isMultistream}`
+      );
 
       if (this.isMultistream) {
         this.remoteMediaManager = new RemoteMediaManager(
@@ -7090,6 +7202,33 @@ export default class Meeting extends StatelessWebexPlugin {
     }
   }
 
+  /**
+   * Cleans up stats analyzer, peer connection and other things before
+   * we can create a new transcoded media connection
+   *
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async downgradeFromMultistreamToTranscoded(): Promise<void> {
+    if (this.statsAnalyzer) {
+      await this.statsAnalyzer.stopAnalyzer();
+    }
+    this.statsAnalyzer = null;
+
+    this.isMultistream = false;
+
+    if (this.mediaProperties.webrtcMediaConnection) {
+      // close peer connection, but don't reset mute state information, because we will want to use it on the retry
+      this.closePeerConnections(false);
+
+      this.mediaProperties.unsetPeerConnection();
+    }
+
+    this.locusMediaRequest?.downgradeFromMultistreamToTranscoded();
+
+    this.createStatsAnalyzer();
+  }
+
   /**
    * Sends stats report, closes peer connection and cleans up any media connection
    * related things before trying to establish media connection again with turn server
@@ -7284,19 +7423,33 @@ export default class Meeting extends StatelessWebexPlugin {
 
       this.createStatsAnalyzer();
 
-      await this.establishMediaConnection(
-        remoteMediaManagerConfig,
-        bundlePolicy,
-        forceTurnDiscovery,
-        turnServerInfo
-      );
+      try {
+        await this.establishMediaConnection(
+          remoteMediaManagerConfig,
+          bundlePolicy,
+          forceTurnDiscovery,
+          turnServerInfo
+        );
+      } catch (error) {
+        if (error instanceof MultistreamNotSupportedError) {
+          LoggerProxy.logger.warn(
+            `${LOG_HEADER} we asked for multistream backend (Homer), but got transcoded backend, recreating media connection...`
+          );
 
-      if (audioEnabled || videoEnabled) {
-        await Meeting.handleDeviceLogging(audioEnabled, videoEnabled);
-      } else {
-        LoggerProxy.logger.info(`${LOG_HEADER} device logging not required`);
-      }
+          await this.downgradeFromMultistreamToTranscoded();
 
+          // Establish new media connection with forced TURN discovery
+          // We need to do TURN discovery again, because backend will be creating a new confluence, so it might land on a different node or cluster
+          await this.establishMediaConnection(
+            remoteMediaManagerConfig,
+            bundlePolicy,
+            true,
+            undefined
+          );
+        } else {
+          throw error;
+        }
+      }
       if (this.mediaProperties.hasLocalShareStream()) {
         await this.enqueueScreenShareFloorRequest();
       }
@@ -8266,7 +8419,7 @@ export default class Meeting extends StatelessWebexPlugin {
     if (layoutType) {
       if (!LAYOUT_TYPES.includes(layoutType)) {
         return this.rejectWithErrorLog(
-          'Meeting:index#changeVideoLayout --> cannot change video layout, invalid layoutType received.'
+          `Meeting:index#changeVideoLayout --> cannot change video layout, invalid layoutType "${layoutType}" received.`
         );
       }
 
@@ -8422,6 +8575,12 @@ export default class Meeting extends StatelessWebexPlugin {
       correlationId: this.correlationId,
       muted,
       encoderImplementation: this.statsAnalyzer?.shareVideoEncoderImplementation,
+      // TypeScript 4 does not recognize the `displaySurface` property. Instead of upgrading the
+      // SDK to TypeScript 5, which may affect other packages, use bracket notation for now, since
+      // all we're doing here is adding metrics.
+      // eslint-disable-next-line dot-notation
+      displaySurface: this.mediaProperties?.shareVideoStream?.getSettings()['displaySurface'],
+      isMultistream: this.isMultistream,
     });
   };
 
@@ -8624,6 +8783,11 @@ export default class Meeting extends StatelessWebexPlugin {
       this.stopTranscription();
       this.transcription = undefined;
     }
+
+    this.annotation.deregisterEvents();
+
+    // @ts-ignore - fix types
+    this.webex.internal.llm.off('event:relay.event', this.processRelayEvent);
   };
 
   /**
@@ -8661,10 +8825,12 @@ export default class Meeting extends StatelessWebexPlugin {
 
       return;
     }
-    const {keepAliveUrl} = this.joinedWith;
+
     const keepAliveInterval = (this.joinedWith.keepAliveSecs - 1) * 750; // taken from UCF
 
     this.keepAliveTimerId = setInterval(() => {
+      const {keepAliveUrl} = this.joinedWith;
+
       this.meetingRequest.keepAlive({keepAliveUrl}).catch((error) => {
         LoggerProxy.logger.warn(
           `Meeting:index#startKeepAlive --> Stopping sending keepAlives to ${keepAliveUrl} after error ${error}`

package/src/meeting/locusMediaRequest.ts

@@ -342,4 +342,11 @@ export class LocusMediaRequest extends WebexPlugin {
   public isConfluenceCreated() {
     return this.confluenceState === 'created';
   }
+
+  /**
+   * This method needs to be called when we downgrade from multistream to transcoded connection.
+   */
+  public downgradeFromMultistreamToTranscoded() {
+    this.config.preferTranscoding = true;
+  }
 }

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;
+};