@webex/plugin-meetings 3.0.0-beta.22 → 3.0.0-beta.24

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

@@ -0,0 +1,195 @@
+/// <reference types="node" />
+import EventsScope from '../common/events/events-scope';
+export declare const EVENTS: {
+    MEDIA_QUALITY: string;
+    LOCAL_MEDIA_STARTED: string;
+    LOCAL_MEDIA_STOPPED: string;
+    REMOTE_MEDIA_STARTED: string;
+    REMOTE_MEDIA_STOPPED: string;
+};
+/**
+ * Stats Analyzer class that will emit events based on detected quality
+ *
+ * @export
+ * @class StatsAnalyzer
+ * @extends {EventsScope}
+ */
+export declare class StatsAnalyzer extends EventsScope {
+    config: any;
+    correlationId: any;
+    lastEmittedStartStopEvent: any;
+    lastMqaDataSent: any;
+    lastStatsResults: any;
+    meetingMediaStatus: any;
+    mqaInterval: NodeJS.Timeout;
+    mqaSentCount: any;
+    networkQualityMonitor: any;
+    mediaConnection: any;
+    statsInterval: NodeJS.Timeout;
+    statsResults: any;
+    statsStarted: any;
+    /**
+     * Creates a new instance of StatsAnalyzer
+     * @constructor
+     * @public
+     * @param {Object} config SDK Configuration Object
+     * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
+     * @param {Object} statsResults Default properties for stats
+     */
+    constructor(config: any, networkQualityMonitor?: object, statsResults?: object);
+    /**
+     * Resets cumulative stats arrays.
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    resetStatsResults(): void;
+    /**
+     * sets mediaStatus status for analyzing metrics
+     *
+     * @public
+     * @param {Object} status for the audio and video
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    updateMediaStatus(status: object): void;
+    /**
+     * captures MQA data from media connection
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    sendMqaData(): void;
+    /**
+     * updated the media connection when changed
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @param {RoapMediaConnection} mediaConnection
+     * @returns {void}
+     */
+    updateMediaConnection(mediaConnection: any): void;
+    /**
+     * Starts the stats analyzer on interval
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @param {RoapMediaConnection} mediaConnection
+     * @returns {Promise}
+     */
+    startAnalyzer(mediaConnection: any): any;
+    /**
+     * Cleans up the analyzer when done
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    stopAnalyzer(): any;
+    /**
+     * Parse a single result of get stats
+     *
+     * @private
+     * @param {*} getStatsResult
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    private parseGetStatsResult;
+    /**
+     * Filters the get stats results for types
+     * @private
+     * @param {Array} statsItem
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
+     */
+    filterAndParseGetStatsResults(statsItem: any, type: string, isSender: boolean): void;
+    /**
+     * parse the audio
+     * @param {String} result
+     * @param {boolean} type
+     * @returns {void}
+     */
+    parseAudioSource(result: any, type: any): void;
+    /**
+     * emits started/stopped events for local/remote media by checking
+     * if given values are increasing or not. The previousValue, currentValue
+     * params can be any numerical value like number of receive packets or
+     * decoded frames, etc.
+     *
+     * @private
+     * @param {string} mediaType
+     * @param {number} previousValue - value to compare
+     * @param {number} currentValue - value to compare (must be same type of value as previousValue)
+     * @param {boolean} isLocal - true if stats are for local media being sent out, false for remote media being received
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    emitStartStopEvents: (mediaType: string, previousValue: number, currentValue: number, isLocal: boolean) => void;
+    /**
+     * compares current and previous stats to check if packets are not sent
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    private compareLastStatsResult;
+    /**
+     * Does a `getStats` on all the transceivers and parses the results
+     *
+     * @private
+     * @memberof StatsAnalyzer
+     * @returns {Promise}
+     */
+    private getStatsAndParse;
+    /**
+     * Processes OutboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @returns {void}
+     */
+    private processOutboundRTPResult;
+    /**
+     * Processes InboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @returns {void}
+     */
+    private processInboundRTPResult;
+    /**
+     * Processes remote and local candidate result and stores
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @param {boolean} isSender
+     * @param {boolean} isRemote
+     *
+     * @returns {void}
+     */
+    parseCandidate: (result: any, type: any, isSender: boolean, isRemote: boolean) => void;
+    /**
+     * Process Track results
+     *
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    private processTrackResult;
+    /**
+     *
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    compareSentAndReceived(result: any, type: any): void;
+}

package/dist/types/statsAnalyzer/mqaUtil.d.ts

@@ -0,0 +1,24 @@
+export declare const getAudioReceiverMqa: ({ audioReceiver, statsResults, lastMqaDataSent, mediaType }: {
+    audioReceiver: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;
+export declare const getAudioSenderMqa: ({ audioSender, statsResults, lastMqaDataSent, mediaType }: {
+    audioSender: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;
+export declare const getVideoReceiverMqa: ({ videoReceiver, statsResults, lastMqaDataSent, mediaType }: {
+    videoReceiver: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;
+export declare const getVideoSenderMqa: ({ videoSender, statsResults, lastMqaDataSent, mediaType }: {
+    videoSender: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;

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

@@ -0,0 +1,64 @@
+/**
+ * @description Meeting Webex assistance transcription feature.
+ * @exports
+ * @class Transcription
+ */
+export default class Transcription {
+    webSocketUrl: any;
+    sessionID: any;
+    members: any;
+    memberCSIs: any;
+    webSocket: any;
+    /**
+     * @param {string} webSocketUrl
+     * @param {sessionID} sessionId
+     * @param {object} members
+     * @constructor
+     * @memberof Transcription
+     */
+    constructor(webSocketUrl: string, sessionId: any, members: object);
+    /**
+     * open the Low Latency Mercury connection
+     * An event parameter will be send to the callback.
+     *
+     * @param {string} token
+     * @param {string} sessionID
+     * @returns {void}
+     */
+    connect(token: string): void;
+    /**
+     * Sets callback to invoke when the web socket connection is closed.
+     *
+     * @param {Function} callback
+     * @returns {void}
+     */
+    onCloseSocket(callback: any): void;
+    /**
+     * Sets callback to invoke when a web socket connection error occurs.
+     * An event parameter will be send to the callback.
+     *
+     * @param {Function} callback
+     * @returns {void}
+     */
+    onErrorSocket(callback: any): void;
+    /**
+     * Get current speaker from the given csis payload and update the global csis map
+     *
+     * @private
+     * @param {object} csis
+     * @returns {object}
+     */
+    private getSpeaker;
+    /**
+     * Sends transcription data to given callback as it arrives.
+     *
+     * @param {Function} callback
+     * @returns {void}
+     */
+    subscribe(callback: any): void;
+    /**
+     * Close the LLM web socket connection
+     * @returns {void}
+     */
+    closeSocket(): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.22",
+  "version": "3.0.0-beta.24",
   "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.22",
-    "@webex/test-helper-chai": "3.0.0-beta.22",
-    "@webex/test-helper-mocha": "3.0.0-beta.22",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.22",
-    "@webex/test-helper-retry": "3.0.0-beta.22",
-    "@webex/test-helper-test-users": "3.0.0-beta.22",
+    "@webex/plugin-meetings": "3.0.0-beta.24",
+    "@webex/test-helper-chai": "3.0.0-beta.24",
+    "@webex/test-helper-mocha": "3.0.0-beta.24",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.24",
+    "@webex/test-helper-retry": "3.0.0-beta.24",
+    "@webex/test-helper-test-users": "3.0.0-beta.24",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -45,18 +45,18 @@
     "typed-emitter": "^2.1.0"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.22",
-    "@webex/internal-media-core": "1.33.0",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.22",
-    "@webex/internal-plugin-device": "3.0.0-beta.22",
-    "@webex/internal-plugin-llm": "3.0.0-beta.22",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.22",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.22",
-    "@webex/internal-plugin-support": "3.0.0-beta.22",
-    "@webex/internal-plugin-user": "3.0.0-beta.22",
-    "@webex/plugin-people": "3.0.0-beta.22",
-    "@webex/plugin-rooms": "3.0.0-beta.22",
-    "@webex/webex-core": "3.0.0-beta.22",
+    "@webex/common": "3.0.0-beta.24",
+    "@webex/internal-media-core": "1.33.1",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.24",
+    "@webex/internal-plugin-device": "3.0.0-beta.24",
+    "@webex/internal-plugin-llm": "3.0.0-beta.24",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.24",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.24",
+    "@webex/internal-plugin-support": "3.0.0-beta.24",
+    "@webex/internal-plugin-user": "3.0.0-beta.24",
+    "@webex/plugin-people": "3.0.0-beta.24",
+    "@webex/plugin-rooms": "3.0.0-beta.24",
+    "@webex/webex-core": "3.0.0-beta.24",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/constants.ts

@@ -886,9 +886,6 @@ export const NETWORK_TYPE = {
 };
 
 export const STATS = {
-  AUDIO_CORRELATE: 'audio',
-  VIDEO_CORRELATE: 'video',
-  SHARE_CORRELATE: 'share',
   SEND_DIRECTION: 'send',
   RECEIVE_DIRECTION: 'recv',
   REMOTE: 'remote',

package/src/media/properties.ts

@@ -212,7 +212,7 @@ export default class MediaProperties {
    *
    * @returns {Promise<void>}
    */
-  waitForMediaConnectionConnected() {
+  waitForMediaConnectionConnected(): Promise<void> {
     const isConnected = () =>
       this.webrtcMediaConnection.getConnectionState() === ConnectionState.Connected;
 
@@ -256,9 +256,7 @@ export default class MediaProperties {
     const allStatsReports = [];
 
     try {
-      // eslint-disable-next-line no-await-in-loop
       const statsResult = await this.webrtcMediaConnection.getStats();
-
       statsResult.forEach((report) => allStatsReports.push(report));
     } catch (error) {
       LoggerProxy.logger.warn(