@webex/plugin-meetings 3.0.0-beta.4 → 3.0.0-beta.400

package/src/multistream/sendSlotManager.ts

@@ -0,0 +1,199 @@
+import {
+  SendSlot,
+  MediaType,
+  LocalStream,
+  MultistreamRoapMediaConnection,
+} from '@webex/internal-media-core';
+
+import {NamedMediaGroup} from '@webex/json-multistream';
+
+export default class SendSlotManager {
+  private readonly slots: Map<MediaType, SendSlot> = new Map();
+  private readonly LoggerProxy: any;
+
+  constructor(LoggerProxy: any) {
+    this.LoggerProxy = LoggerProxy;
+  }
+
+  /**
+   * This method is used to create a sendSlot for the given mediaType and returns the created sendSlot
+   * @param {MultistreamRoapMediaConnection} mediaConnection MultistreamRoapMediaConnection for which a sendSlot needs to be created
+   * @param {MediaType} mediaType MediaType for which a sendSlot needs to be created (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)
+   * @param {boolean} active This is optional boolean to set the active state of the sendSlot. Default is true
+   * @returns {SendSlot} slot The created sendSlot
+   */
+  public createSlot(
+    mediaConnection: MultistreamRoapMediaConnection,
+    mediaType: MediaType,
+    active = true
+  ): SendSlot {
+    if (this.slots.has(mediaType)) {
+      throw new Error(`Slot for ${mediaType} already exists`);
+    }
+
+    const slot: SendSlot = mediaConnection.createSendSlot(mediaType, active);
+
+    this.slots.set(mediaType, slot);
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->createSlot#Created slot for ${mediaType} with active ${active}`
+    );
+
+    return slot;
+  }
+
+  /**
+   * This method is used to retrieve the sendSlot for the given mediaType
+   * @param {MediaType} mediaType of which the slot needs to be retrieved
+   * @returns {SendSlot}
+   */
+  public getSlot(mediaType: MediaType): SendSlot {
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    return slot;
+  }
+
+  /**
+   * Allow users to specify 'namedMediaGroups' to indicate which named media group its audio should be sent to.
+   * @param {MediaType} mediaType MediaType of the sendSlot to which the audio stream needs to be send to the media group
+   * @param {[]}namedMediaGroups - Allow users to specify 'namedMediaGroups'.If the value of 'namedMediaGroups' is zero,
+   * named media group will be canceled and the audio stream will be sent to the floor.
+   * @returns {void}
+   */
+  public setNamedMediaGroups(mediaType: MediaType, namedMediaGroups: NamedMediaGroup[]) {
+    if (mediaType !== MediaType.AudioMain) {
+      throw new Error(
+        `sendSlotManager cannot set named media group which media type is ${mediaType}`
+      );
+    }
+
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    slot.setNamedMediaGroups(namedMediaGroups);
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->setNamedMediaGroups#set named media group ${namedMediaGroups}`
+    );
+  }
+
+  /**
+   * 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)
+   * @param {LocalStream} stream LocalStream to be published
+   * @returns {Promise<void>}
+   */
+  public async publishStream(mediaType: MediaType, stream: LocalStream): Promise<void> {
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    await slot.publishStream(stream);
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->publishStream#Published stream for ${mediaType} and stream with label ${stream.label} and muted ${stream.muted}`
+    );
+  }
+
+  /**
+   * This method unpublishes the stream from the sendSlot of the given mediaType
+   * @param {MediaType} mediaType MediaType of the sendSlot from which a stream needs to be unpublished (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)
+   * @returns {Promise<void>}
+   */
+  public async unpublishStream(mediaType: MediaType): Promise<void> {
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    await slot.unpublishStream();
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->unpublishStream#Unpublished stream for ${mediaType}`
+    );
+  }
+
+  /**
+   * This method is used to set the active state of the sendSlot for the given mediaType
+   * @param {MediaType} mediaType The MediaType of the sendSlot for which the active state needs to be set (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)
+   * @param {boolean} active The boolean to set the active state of the sendSlot. Default is true
+   * @returns {void}
+   */
+  public setActive(mediaType: MediaType, active = true): void {
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    slot.active = active;
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->setActive#Set active for ${mediaType} to ${active}`
+    );
+  }
+
+  /**
+   * This method is used to set the codec parameters for the sendSlot of the given mediaType
+   * @param {MediaType} mediaType MediaType of the sendSlot for which the codec parameters needs to be set (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)
+   * @param {Object} codecParameters
+   * @returns {Promise<void>}
+   */
+  public async setCodecParameters(
+    mediaType: MediaType,
+    codecParameters: {
+      [key: string]: string | undefined; // As per ts-sdp undefined is considered as a valid value to be used for codec parameters
+    }
+  ): Promise<void> {
+    // These codec parameter changes underneath are SDP value changes that are taken care by WCME automatically. So no need for any change in streams from the web sdk side
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    await slot.setCodecParameters(codecParameters);
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->setCodecParameters#Set codec parameters for ${mediaType} to ${codecParameters}`
+    );
+  }
+
+  /**
+   * This method is used to delete the codec parameters for the sendSlot of the given mediaType
+   * @param {MediaType} mediaType MediaType of the sendSlot for which the codec parameters needs to be deleted (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)
+   * @param {Array<String>} parameters Array of keys of the codec parameters to be deleted
+   * @returns {Promise<void>}
+   */
+  public async deleteCodecParameters(mediaType: MediaType, parameters: string[]): Promise<void> {
+    const slot = this.slots.get(mediaType);
+
+    if (!slot) {
+      throw new Error(`Slot for ${mediaType} does not exist`);
+    }
+
+    await slot.deleteCodecParameters(parameters);
+
+    this.LoggerProxy.logger.info(
+      `SendSlotsManager->deleteCodecParameters#Deleted the following codec parameters -> ${parameters} for ${mediaType}`
+    );
+  }
+
+  /**
+   * This method is used to reset the SendSlotsManager by deleting all the sendSlots
+   * @returns {undefined}
+   */
+  public reset(): void {
+    this.slots.clear();
+  }
+}

package/src/networkQualityMonitor/{index.js → index.ts}

@@ -1,16 +1,15 @@
 import EventsScope from '../common/events/events-scope';
-import {EVENT_TRIGGERS, STATS} from '../constants';
-
+import {EVENT_TRIGGERS} from '../constants';
 
 /**
-  * Meeting - network quality event
-  * Emitted on each interval of retrieving stats Analyzer data
-  * @event network:quality
-  * @type {Object}
-  * @property {string} mediaType {video|audio}
-  * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
-  * @memberof NetworkQualityMonitor
-  */
+ * Meeting - network quality event
+ * Emitted on each interval of retrieving stats Analyzer data
+ * @event network:quality
+ * @type {Object}
+ * @property {string} mediaType {video|audio}
+ * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
+ * @memberof NetworkQualityMonitor
+ */
 /**
  * NetworkQualityMonitor class that will emit events based on detected quality
  *
@@ -18,6 +17,13 @@ import {EVENT_TRIGGERS, STATS} from '../constants';
  * @extends {EventsScope}
  */
 export default class NetworkQualityMonitor extends EventsScope {
+  config: any;
+  frequencyTypes: any;
+  indicatorTypes: any;
+  mediaType: any;
+  networkQualityScore: any;
+  networkQualityStatus: any;
+
   /**
    * Creates a new instance of NetworkQualityMonitor
    * @constructor
@@ -29,25 +35,21 @@ export default class NetworkQualityMonitor extends EventsScope {
    * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
    * @property {string} mediaType - audio|video
    */
-  constructor(config) {
+  constructor(config: any) {
     super();
     this.config = config;
     this.indicatorTypes = Object.freeze({
       PACKETLOSS: 'packetLoss',
       LATENCY: 'latency',
-      JITTER: 'jitter'
+      JITTER: 'jitter',
     });
     this.frequencyTypes = Object.freeze({
       UPLINK: 'uplink',
-      DOWNLINK: 'downlink'
+      DOWNLINK: 'downlink',
     });
     this.networkQualityScore = 1;
     this.networkQualityStatus = {
-      [this.frequencyTypes.UPLINK]: {
-        [STATS.VIDEO_CORRELATE]: {},
-        [STATS.AUDIO_CORRELATE]: {},
-        [STATS.SHARE_CORRELATE]: {}
-      }
+      [this.frequencyTypes.UPLINK]: {},
     };
     this.mediaType = null;
   }
@@ -62,12 +64,12 @@ export default class NetworkQualityMonitor extends EventsScope {
     this.emit(
       {
         file: 'networkQualityMonitor',
-        function: 'emitNetworkQuality'
+        function: 'emitNetworkQuality',
       },
       EVENT_TRIGGERS.NETWORK_QUALITY,
       {
         mediaType: this.mediaType,
-        networkQualityScore: this.networkQualityScore
+        networkQualityScore: this.networkQualityScore,
       }
     );
   }
@@ -85,7 +87,6 @@ export default class NetworkQualityMonitor extends EventsScope {
     this.mediaType = null;
   }
 
-
   /**
    * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
    * @param {Object} configObj
@@ -96,7 +97,15 @@ export default class NetworkQualityMonitor extends EventsScope {
    * @public
    * @memberof NetworkQualityMonitor
    */
-  determineUplinkNetworkQuality({mediaType, remoteRtpResults, statsAnalyzerCurrentStats}) {
+  public determineUplinkNetworkQuality({
+    mediaType,
+    remoteRtpResults,
+    statsAnalyzerCurrentStats,
+  }: {
+    mediaType: string;
+    remoteRtpResults: any;
+    statsAnalyzerCurrentStats: object;
+  }) {
     const roundTripTimeInMilliseconds = remoteRtpResults.roundTripTime * 1000;
     const jitterInMilliseconds = remoteRtpResults.jitter * 1000;
     const {currentPacketLossRatio} = statsAnalyzerCurrentStats[mediaType].send;
@@ -112,8 +121,7 @@ export default class NetworkQualityMonitor extends EventsScope {
      * @returns {boolean}
      */
     const determinePacketLoss = () => {
-      if (currentPacketLossRatio >
-        this.config.videoPacketLossRatioThreshold) {
+      if (currentPacketLossRatio > this.config.videoPacketLossRatioThreshold) {
         this.networkQualityScore = 0;
 
         return false;
@@ -157,7 +165,12 @@ export default class NetworkQualityMonitor extends EventsScope {
      * @param {(number|undefined)} value
      * @returns {(number|null)}
      */
-    const determineIfUndefined = (value) => (typeof value === 'undefined' ? null : value);
+    const determineIfUndefined = (value: number | undefined) =>
+      typeof value === 'undefined' ? null : value;
+
+    if (!this.networkQualityStatus[UPLINK][mediaType]) {
+      this.networkQualityStatus[UPLINK][mediaType] = {};
+    }
 
     /**
      * Values for some browsers specifically Safari will be undefined we explicitly set to null
@@ -167,20 +180,19 @@ export default class NetworkQualityMonitor extends EventsScope {
     // PACKET LOSS
     this.networkQualityStatus[UPLINK][mediaType][PACKETLOSS] = {
       acceptable: determinePacketLoss(),
-      value: determineIfUndefined(currentPacketLossRatio)
+      value: determineIfUndefined(currentPacketLossRatio),
     };
 
-
     // LATENCY measured in Round trip time
     this.networkQualityStatus[UPLINK][mediaType][LATENCY] = {
       acceptable: determineLatency(),
-      value: determineIfUndefined(remoteRtpResults.roundTripTime)
+      value: determineIfUndefined(remoteRtpResults.roundTripTime),
     };
 
     // JITTER
     this.networkQualityStatus[UPLINK][mediaType][JITTER] = {
       acceptable: deterMineJitter(),
-      value: determineIfUndefined(remoteRtpResults.jitter)
+      value: determineIfUndefined(remoteRtpResults.jitter),
     };
 
     this.updateNetworkQualityStatus();

package/src/personal-meeting-room/{index.js → index.ts}

@@ -1,3 +1,4 @@
+// @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import {MEETINGS, _PERSONAL_ROOM_} from '../constants';
@@ -5,11 +6,20 @@ import ParameterError from '../common/errors/parameter';
 
 import PersonalMeetingRoomRequest from './request';
 
-
 /**
  * @class PersonalMeetingRoom
  */
 export default class PersonalMeetingRoom extends StatelessWebexPlugin {
+  link: any;
+  meetingInfo: any;
+  name: any;
+  personalMeetingRoomRequest: any;
+  pmr: any;
+  sipUri: any;
+  userId: any;
+  meetingLink: any;
+  number: any;
+
   namespace = MEETINGS;
 
   /**
@@ -17,7 +27,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    * @param {Object} attrs
    * @param {Object} options
    */
-  constructor(attrs, options) {
+  constructor(attrs: any, options: any) {
     super({}, options);
     /**
      * The pmr server object
@@ -25,7 +35,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {Object}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.pmr = null;
     /**
      * The pmr sip Uri
@@ -33,7 +43,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {String}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.sipUri = null;
     /**
      * The pmr link
@@ -41,7 +51,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {String}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.link = null;
     /**
      * The pmr server object
@@ -49,7 +59,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {Object}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.userId = null;
     /**
      * The pmr name
@@ -57,7 +67,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {String}
      * @public
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.name = null;
     /**
      * The meeting info request server interface
@@ -65,7 +75,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {MeetingInfo}
      * @private
      * @memberof PersonalMeetingRoom
-    */
+     */
     this.meetingInfo = attrs.meetingInfo;
     /**
      * The pmr server request interface
@@ -73,7 +83,8 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
      * @type {Object}
      * @private
      * @memberof PersonalMeetingRoom
-    */
+     */
+    // @ts-ignore
     this.personalMeetingRoomRequest = new PersonalMeetingRoomRequest({}, options);
   }
 
@@ -86,19 +97,19 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    * @public
    * @memberof PersonalMeetingRoom
    */
-  claim(link, pin, preferred = true) {
+  public claim(link: string, pin: string, preferred = true) {
     const options = {
+      // @ts-ignore
       userId: this.webex.internal.device.userId,
       passcode: pin,
       meetingAddress: link,
-      preferred
+      preferred,
     };
 
     return this.personalMeetingRoomRequest.claimPmr(options).then((pmr) => {
       if (pmr && pmr.body) {
         this.set(pmr.body);
-      }
-      else {
+      } else {
         return Promise.reject(new ParameterError('No PMR body provided. PMR values not updated.'));
       }
 
@@ -112,7 +123,7 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    * @private
    * @memberof PersonalMeetingRoom
    */
-  set(body) {
+  private set(body: any) {
     this.pmr = body;
     this.sipUri = body.sipMeetingUri;
     this.meetingLink = body.webExMeetingLink || body.meetingLink;
@@ -128,17 +139,15 @@ export default class PersonalMeetingRoom extends StatelessWebexPlugin {
    * @public
    * @memberof PersonalMeetingRoom
    */
-  get() {
+  public get() {
     const options = {
-      type: _PERSONAL_ROOM_
-
+      type: _PERSONAL_ROOM_,
     };
 
     return this.meetingInfo.fetchMeetingInfo(options).then((pmr) => {
       if (pmr && pmr.body && pmr.body.isPmr) {
         this.set(pmr.body);
-      }
-      else {
+      } else {
         return Promise.reject(new TypeError('The PMR requested is NOT a PMR. PMR values not set.'));
       }
 

package/src/personal-meeting-room/{request.js → request.ts}

@@ -1,3 +1,4 @@
+// @ts-ignore
 import {StatelessWebexPlugin} from '@webex/webex-core';
 
 import {MEETINGS} from '../constants';
@@ -5,7 +6,6 @@ import ParameterError from '../common/errors/parameter';
 
 import PersonalMeetingRoomUtil from './util';
 
-
 /**
  * @class MeetingInfoRequest
  */
@@ -18,9 +18,17 @@ export default class PersonalMeetingRoomRequest extends StatelessWebexPlugin {
    * @returns {Promise} returns a promise that resolves/rejects the result of the request
    * @memberof PersonalMeetingRoomRequest
    */
-  claimPmr(options) {
-    if (!options || !options.userId || !options.passcode || !options.meetingAddress || !options.preferred) {
-      throw new ParameterError('Claiming a PMR should be done with userId, passcode, preferred, and meetingAddress in options.');
+  claimPmr(options: any) {
+    if (
+      !options ||
+      !options.userId ||
+      !options.passcode ||
+      !options.meetingAddress ||
+      !options.preferred
+    ) {
+      throw new ParameterError(
+        'Claiming a PMR should be done with userId, passcode, preferred, and meetingAddress in options.'
+      );
     }
     const validPin = PersonalMeetingRoomUtil.getClaimPmrPin(options.passcode);
 
@@ -34,6 +42,7 @@ export default class PersonalMeetingRoomRequest extends StatelessWebexPlugin {
     }
     const request = PersonalMeetingRoomUtil.getClaimedRequestParams(validLink, validPin, options);
 
+    // @ts-ignore
     return this.request(request);
   }
 }

package/src/personal-meeting-room/{util.js → util.ts}

@@ -6,10 +6,10 @@ import {
   CMR_MEETINGS,
   CLAIM,
   HECATE,
-  WEBEX_DOT_COM
+  WEBEX_DOT_COM,
 } from '../constants';
 
-const PersonalMeetingRoomUtil = {};
+const PersonalMeetingRoomUtil: any = {};
 
 PersonalMeetingRoomUtil.getClaimPmrLink = (pmrLink) => {
   let validator = VALID_PMR_ADDRESS.test(pmrLink);
@@ -42,8 +42,8 @@ PersonalMeetingRoomUtil.getClaimedRequestParams = (link, pin, options) => ({
     userId: options.userId,
     passcode: pin,
     preferred: options.preferred,
-    meetingAddress: link
-  }
+    meetingAddress: link,
+  },
 });
 
 export default PersonalMeetingRoomUtil;