@webex/plugin-meetings 3.0.0-beta.35 → 3.0.0-beta.36

package/dist/types/media/properties.d.ts

@@ -1,8 +1,9 @@
+import { LocalCameraTrack, LocalMicrophoneTrack, LocalDisplayTrack } from '@webex/internal-media-core';
 /**
  * @class MediaProperties
  */
 export default class MediaProperties {
-    audioTrack: any;
+    audioTrack: LocalMicrophoneTrack | null;
     localQualityLevel: any;
     mediaDirection: any;
     mediaSettings: any;
@@ -11,9 +12,9 @@ export default class MediaProperties {
     remoteQualityLevel: any;
     remoteShare: any;
     remoteVideoTrack: any;
-    shareTrack: any;
+    shareTrack: LocalDisplayTrack | null;
     videoDeviceId: any;
-    videoTrack: any;
+    videoTrack: LocalCameraTrack | null;
     namespace: string;
     /**
      * @param {Object} [options] -- to auto construct
@@ -28,10 +29,10 @@ export default class MediaProperties {
     setMediaDirection(mediaDirection: any): void;
     setMediaSettings(type: any, values: any): void;
     setMediaPeerConnection(mediaPeerConnection: any): void;
-    setLocalVideoTrack(videoTrack: any): void;
-    setLocalAudioTrack(audioTrack: any): void;
+    setLocalVideoTrack(videoTrack: LocalCameraTrack | null): void;
+    setLocalAudioTrack(audioTrack: LocalMicrophoneTrack | null): void;
     setLocalQualityLevel(localQualityLevel: any): void;
-    setLocalShareTrack(shareTrack: any): void;
+    setLocalShareTrack(shareTrack: LocalDisplayTrack | null): void;
     setRemoteQualityLevel(remoteQualityLevel: any): void;
     setRemoteShare(remoteShare: any): void;
     /**

package/dist/types/meeting/index.d.ts

@@ -290,7 +290,6 @@ export default class Meeting extends StatelessWebexPlugin {
     destination: string;
     destinationType: string;
     deviceUrl: string;
-    effects: any;
     hostId: string;
     id: string;
     isMultistream: boolean;
@@ -838,7 +837,7 @@ export default class Meeting extends StatelessWebexPlugin {
     private sendLocalMediaReadyEvent;
     /**
      * Sets the local audio track on the class and emits an event to the developer
-     * @param {MediaStreamTrack} audioTrack
+     * @param {MediaStreamTrack} rawAudioTrack
      * @param {Boolean} emitEvent if true, a media ready event is emitted to the developer
      * @returns {undefined}
      * @private
@@ -847,7 +846,7 @@ export default class Meeting extends StatelessWebexPlugin {
     private setLocalAudioTrack;
     /**
      * Sets the local video track on the class and emits an event to the developer
-     * @param {MediaStreamTrack} videoTrack
+     * @param {MediaStreamTrack} rawVideoTrack
      * @param {Boolean} emitEvent if true, a media ready event is emitted to the developer
      * @returns {undefined}
      * @private
@@ -864,12 +863,12 @@ export default class Meeting extends StatelessWebexPlugin {
     setLocalTracks(localStream: any): void;
     /**
      * Sets the local media stream on the class and emits an event to the developer
-     * @param {MediaStreamTrack} localShareTrack the local media stream
+     * @param {MediaStreamTrack} rawLocalShareTrack the local share media track
      * @returns {undefined}
      * @public
      * @memberof Meeting
      */
-    setLocalShareTrack(localShareTrack: MediaStreamTrack): void;
+    setLocalShareTrack(rawLocalShareTrack: MediaStreamTrack | null): void;
     /**
      * Closes the local stream from the class and emits an event to the developer
      * @returns {undefined}
@@ -1165,6 +1164,12 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     setupStatsAnalyzerEventHandlers: () => void;
     getMediaConnectionDebugId(): string;
+    /**
+     * Creates a webrtc media connection
+     *
+     * @param {Object} turnServerInfo TURN server information
+     * @returns {RoapMediaConnection | MultistreamRoapMediaConnection}
+     */
     createMediaConnection(turnServerInfo: any): any;
     /**
      * Listens for an event emitted by eventEmitter and emits it from the meeting object
@@ -1532,8 +1537,7 @@ export default class Meeting extends StatelessWebexPlugin {
     private sendNetworkQualityEvent;
     /**
      * Handle logging the media
-     * @param {Object} audioTrack The audio track
-     * @param {Object} videoTrack The video track
+     * @param {Object} mediaProperties
      * @private
      * @returns {undefined}
      */
@@ -1632,35 +1636,6 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     clearMeetingData: () => void;
-    /**
-     * Internal API to return status of BNR
-     * @returns {Boolean}
-     * @public
-     * @memberof Meeting
-     */
-    isBnrEnabled(): any;
-    /**
-     * Internal API to obtain BNR enabled MediaStream
-     * @returns {Promise<MediaStreamTrack>}
-     * @private
-     * @param {MedaiStreamTrack} audioTrack from updateAudio
-     * @memberof Meeting
-     */
-    private internal_enableBNR;
-    /**
-     * Enable the audio track with BNR for a meeting
-     * @returns {Promise} resolves the data from enable bnr or rejects if there is no audio or audio is muted
-     * @public
-     * @memberof Meeting
-     */
-    enableBNR(): any;
-    /**
-     * Disable the BNR for an audio track
-     * @returns {Promise} resolves the data from disable bnr or rejects if there is no audio set
-     * @public
-     * @memberof Meeting
-     */
-    disableBNR(): any;
     /**
      * starts keepAlives being sent
      * @returns {void}

package/dist/types/metrics/constants.d.ts

@@ -37,10 +37,6 @@ declare const BEHAVIORAL_METRICS: {
     INVALID_ICE_CANDIDATE: string;
     UPLOAD_LOGS_FAILURE: string;
     RECEIVE_TRANSCRIPTION_FAILURE: string;
-    ENABLE_BNR_SUCCESS: string;
-    ENABLE_BNR_FAILURE: string;
-    DISABLE_BNR_SUCCESS: string;
-    DISABLE_BNR_FAILURE: string;
     FETCH_MEETING_INFO_V1_SUCCESS: string;
     FETCH_MEETING_INFO_V1_FAILURE: string;
     ADHOC_MEETING_SUCCESS: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.35",
+  "version": "3.0.0-beta.36",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.35",
-    "@webex/test-helper-chai": "3.0.0-beta.35",
-    "@webex/test-helper-mocha": "3.0.0-beta.35",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.35",
-    "@webex/test-helper-retry": "3.0.0-beta.35",
-    "@webex/test-helper-test-users": "3.0.0-beta.35",
+    "@webex/plugin-meetings": "3.0.0-beta.36",
+    "@webex/test-helper-chai": "3.0.0-beta.36",
+    "@webex/test-helper-mocha": "3.0.0-beta.36",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.36",
+    "@webex/test-helper-retry": "3.0.0-beta.36",
+    "@webex/test-helper-test-users": "3.0.0-beta.36",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,18 +46,18 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.35",
-    "@webex/internal-media-core": "1.35.0",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.35",
-    "@webex/internal-plugin-device": "3.0.0-beta.35",
-    "@webex/internal-plugin-llm": "3.0.0-beta.35",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.35",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.35",
-    "@webex/internal-plugin-support": "3.0.0-beta.35",
-    "@webex/internal-plugin-user": "3.0.0-beta.35",
-    "@webex/plugin-people": "3.0.0-beta.35",
-    "@webex/plugin-rooms": "3.0.0-beta.35",
-    "@webex/webex-core": "3.0.0-beta.35",
+    "@webex/common": "3.0.0-beta.36",
+    "@webex/internal-media-core": "1.35.1",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.36",
+    "@webex/internal-plugin-device": "3.0.0-beta.36",
+    "@webex/internal-plugin-llm": "3.0.0-beta.36",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.36",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.36",
+    "@webex/internal-plugin-support": "3.0.0-beta.36",
+    "@webex/internal-plugin-user": "3.0.0-beta.36",
+    "@webex/plugin-people": "3.0.0-beta.36",
+    "@webex/plugin-rooms": "3.0.0-beta.36",
+    "@webex/webex-core": "3.0.0-beta.36",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/breakouts/README.md

@@ -119,8 +119,14 @@ breakout.remove(participant)
 // This can only be done when breakouts are inactive
 breakout.delete()
 
-// Create a breakout session
-breakouts.create(sessionName)
+/* 
+Create breakout sessions, Type is array
+Format: [{'name':'session1', "anyoneCanJoin" : true}]
+*/
+breakouts.create(sessions)
+
+// Delete all breakout sessions
+breakouts.clearSessions()
 
 // Rename an existing breakout session
 breakout.rename(newSessionName)

package/src/breakouts/edit-lock-error.ts

@@ -0,0 +1,25 @@
+import {ERROR_DICTIONARY} from '../constants';
+
+/**
+ * Extended Error object to signify breakout related errors
+ */
+export default class BreakoutEditLockedError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
+  /**
+   *
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(message: string = ERROR_DICTIONARY.BREAKOUT_EDIT.MESSAGE, error: any = null) {
+    super(message);
+    this.name = ERROR_DICTIONARY.BREAKOUT_EDIT.NAME;
+    this.sdkMessage = ERROR_DICTIONARY.BREAKOUT_EDIT.MESSAGE;
+    this.error = error;
+    this.stack = error ? error.stack : new Error().stack;
+    this.code = ERROR_DICTIONARY.BREAKOUT_EDIT.CODE;
+  }
+}

package/src/breakouts/index.ts

@@ -10,6 +10,7 @@ import {BREAKOUTS, HTTP_VERBS, MEETINGS} from '../constants';
 import Breakout from './breakout';
 import BreakoutCollection from './collection';
 import BreakoutRequest from './request';
+import BreakoutEditLockedError from './edit-lock-error';
 
 /**
  * @class Breakouts
@@ -34,6 +35,7 @@ const Breakouts = WebexPlugin.extend({
     url: 'string', // appears from the moment you enable breakouts
     locusUrl: 'string', // the current locus url
     breakoutServiceUrl: 'string', // the current breakout resouce url
+    groups: 'array', // appears when create breakouts
   },
 
   children: {
@@ -348,6 +350,77 @@ const Breakouts = WebexPlugin.extend({
       },
     });
   },
+
+  /**
+   * Create new breakout sessions
+   * @param {object} sessions -- breakout session group
+   * @returns {Promise}
+   */
+  async create(sessions) {
+    // @ts-ignore
+    const breakInfo = await this.webex
+      .request({
+        method: HTTP_VERBS.PUT,
+        uri: this.url,
+        body: {
+          groups: [
+            {
+              sessions,
+            },
+          ],
+        },
+      })
+      .catch((error) => {
+        if (error.body && error.body.errorCode === BREAKOUTS.ERROR_CODE.EDIT_LOCK_TOKEN_MISMATCH) {
+          LoggerProxy.logger.info(`Breakouts#create --> Edit lock token mismatch`);
+
+          return Promise.reject(new BreakoutEditLockedError('Edit lock token mismatch', error));
+        }
+
+        return Promise.reject(error);
+      });
+
+    if (breakInfo.body && breakInfo.body.groups && breakInfo.body.groups) {
+      this.set('groups', breakInfo.body.groups);
+    }
+
+    return Promise.resolve(breakInfo);
+  },
+
+  /**
+   * Delete all breakout sessions
+   * @returns {Promise}
+   */
+  async clearSessions() {
+    // @ts-ignore
+    const breakInfo = await this.webex
+      .request({
+        method: HTTP_VERBS.PUT,
+        uri: this.url,
+        body: {
+          groups: [
+            {
+              action: BREAKOUTS.ACTION_TYPES.DELETE,
+            },
+          ],
+        },
+      })
+      .catch((error) => {
+        if (error.body && error.body.errorCode === BREAKOUTS.ERROR_CODE.EDIT_LOCK_TOKEN_MISMATCH) {
+          LoggerProxy.logger.info(`Breakouts#clearSessions --> Edit lock token mismatch`);
+
+          return Promise.reject(new BreakoutEditLockedError('Edit lock token mismatch', error));
+        }
+
+        return Promise.reject(error);
+      });
+
+    if (breakInfo.body && breakInfo.body.groups && breakInfo.body.groups) {
+      this.set('groups', breakInfo.body.groups);
+    }
+
+    return Promise.resolve(breakInfo);
+  },
 });
 
 export default Breakouts;

package/src/constants.ts

@@ -452,6 +452,11 @@ export const ERROR_DICTIONARY = {
     MESSAGE: 'Captcha is required.',
     CODE: 8,
   },
+  BREAKOUT_EDIT: {
+    NAME: 'BreakoutEditLockedError',
+    MESSAGE: 'Edit lock token mismatch',
+    CODE: 9,
+  },
 };
 
 export const FLOOR_ACTION = {
@@ -538,6 +543,12 @@ export const BREAKOUTS = {
     REQUESTED: 'requested',
   },
   BREAKOUTS_SUPPORTED: 'BREAKOUTS_SUPPORTED',
+  ACTION_TYPES: {
+    DELETE: 'DELETE',
+  },
+  ERROR_CODE: {
+    EDIT_LOCK_TOKEN_MISMATCH: 201409024,
+  },
 };
 
 export const LOCUSINFO = {

package/src/media/index.ts

@@ -3,7 +3,13 @@
  */
 /* globals navigator */
 
-import {RoapMediaConnection, MultistreamRoapMediaConnection} from '@webex/internal-media-core';
+import {
+  LocalCameraTrack,
+  LocalDisplayTrack,
+  LocalMicrophoneTrack,
+  RoapMediaConnection,
+  MultistreamRoapMediaConnection,
+} from '@webex/internal-media-core';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {AUDIO_INPUT, VIDEO_INPUT, MEDIA_TRACK_CONSTRAINT} from '../constants';
 import Config from '../config';
@@ -43,22 +49,6 @@ const {isBrowser} = BrowserDetection();
  */
 const Media: any = {};
 
-/**
- * @param {boolean} enabled
- * @param {MediaStreamTrack} track
- * @returns {Boolean}
- * @public
- */
-Media.setLocalTrack = (enabled: boolean, track: MediaStreamTrack) => {
-  if (track) {
-    track.enabled = enabled;
-
-    return true;
-  }
-
-  return false;
-};
-
 /**
  * format the media array for send
  * @param {String} mediaId
@@ -121,7 +111,7 @@ Media.getLocalMedia = (options: any, config: object) => {
  * @param {boolean} [options.enableRtx] applicable only to non-multistream connections
  * @param {boolean} [options.enableExtmap] applicable only to non-multistream connections
  * @param {Object} [options.turnServerInfo]
- * @returns {RoapMediaConnection}
+ * @returns {RoapMediaConnection | MultistreamRoapMediaConnection}
  */
 Media.createMediaConnection = (
   isMultistream: boolean,
@@ -133,9 +123,9 @@ Media.createMediaConnection = (
         receiveVideo: boolean;
         receiveShare: boolean;
       };
-      audioTrack?: MediaStreamTrack;
-      videoTrack?: MediaStreamTrack;
-      shareTrack?: MediaStreamTrack;
+      audioTrack?: LocalMicrophoneTrack;
+      videoTrack?: LocalCameraTrack;
+      shareTrack?: LocalDisplayTrack;
     };
     remoteQualityLevel?: 'LOW' | 'MEDIUM' | 'HIGH';
     enableRtx?: boolean;
@@ -194,9 +184,9 @@ Media.createMediaConnection = (
     },
     {
       send: {
-        audio: audioTrack,
-        video: videoTrack,
-        screenShareVideo: shareTrack,
+        audio: audioTrack?.underlyingTrack,
+        video: videoTrack?.underlyingTrack,
+        screenShareVideo: shareTrack?.underlyingTrack,
       },
       receive: {
         audio: mediaDirection.receiveAudio,

package/src/media/properties.ts

@@ -1,4 +1,10 @@
-import {ConnectionState, Event} from '@webex/internal-media-core';
+import {
+  ConnectionState,
+  Event,
+  LocalCameraTrack,
+  LocalMicrophoneTrack,
+  LocalDisplayTrack,
+} from '@webex/internal-media-core';
 
 import {MEETINGS, PC_BAIL_TIMEOUT, QUALITY_LEVELS} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
@@ -7,7 +13,7 @@ import LoggerProxy from '../common/logs/logger-proxy';
  * @class MediaProperties
  */
 export default class MediaProperties {
-  audioTrack: any;
+  audioTrack: LocalMicrophoneTrack | null;
   localQualityLevel: any;
   mediaDirection: any;
   mediaSettings: any;
@@ -16,9 +22,9 @@ export default class MediaProperties {
   remoteQualityLevel: any;
   remoteShare: any;
   remoteVideoTrack: any;
-  shareTrack: any;
+  shareTrack: LocalDisplayTrack | null;
   videoDeviceId: any;
-  videoTrack: any;
+  videoTrack: LocalCameraTrack | null;
   namespace = MEETINGS;
 
   /**
@@ -28,9 +34,9 @@ export default class MediaProperties {
   constructor(options: any = {}) {
     this.webrtcMediaConnection = null;
     this.mediaDirection = options.mediaDirection;
-    this.videoTrack = options.videoTrack;
-    this.audioTrack = options.audioTrack;
-    this.shareTrack = options.shareTrack;
+    this.videoTrack = options.videoTrack || null;
+    this.audioTrack = options.audioTrack || null;
+    this.shareTrack = options.shareTrack || null;
     this.remoteShare = options.remoteShare;
     this.remoteAudioTrack = options.remoteAudioTrack;
     this.remoteVideoTrack = options.remoteVideoTrack;
@@ -60,11 +66,11 @@ export default class MediaProperties {
     this.webrtcMediaConnection = mediaPeerConnection;
   }
 
-  setLocalVideoTrack(videoTrack) {
+  setLocalVideoTrack(videoTrack: LocalCameraTrack | null) {
     this.videoTrack = videoTrack;
   }
 
-  setLocalAudioTrack(audioTrack) {
+  setLocalAudioTrack(audioTrack: LocalMicrophoneTrack | null) {
     this.audioTrack = audioTrack;
   }
 
@@ -72,7 +78,7 @@ export default class MediaProperties {
     this.localQualityLevel = localQualityLevel;
   }
 
-  setLocalShareTrack(shareTrack) {
+  setLocalShareTrack(shareTrack: LocalDisplayTrack | null) {
     this.shareTrack = shareTrack;
   }