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

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/internal-README.md

@@ -48,7 +48,7 @@ Install tooling dependencies.
 npm install
 ```
 
-*Build issues?* See [BUILD-ISSUES.md](https://github.com/webex/webex-js-sdk/blob/master/BUILD-ISSUES.md) for help.
+_Build issues?_ See [BUILD-ISSUES.md](https://github.com/webex/webex-js-sdk/blob/master/BUILD-ISSUES.md) for help.
 
 ## Contribute to the `plugin-meetings` branch
 
@@ -93,12 +93,14 @@ yarn run build
 ```
 
 > Individual packages containing samples can usually be run this way:
+>
 > ```
 > yarn run serve:package --env.package @webex/plugin-meetings
+> ```
 
 > ```
 > However, `webex` does not get compiled properly for `plugin-meetings` using this method, so do the following instead.
-
+> ```
 
 ```bash
 # Run the "sample app" sample.
@@ -107,8 +109,8 @@ yarn run samples:meetings
 ```
 
 - Visit https://localhost:8000/
-- Copy/paste **Your Personal Access Token** from [Cisco Webex for Developers](https://developer.webex.com/docs/api/getting-started) and click *connect*.
-- Use the **Dialer** to *create* a Meeting object, *join* it, and *addMedia*, like video and audio.
+- Copy/paste **Your Personal Access Token** from [Cisco Webex for Developers](https://developer.webex.com/docs/api/getting-started) and click _connect_.
+- Use the **Dialer** to _create_ a Meeting object, _join_ it, and _addMedia_, like video and audio.
 
 > This sample does not join a meeting in one click on purpose. It is meant to demonstrate the different commands available, and their sequence, to developers. Other samples will be created in the future.
 >
@@ -124,7 +126,6 @@ yarn run samples:meetings
 
 Use `yarn run distsrc` to point each package's `main` entry at the raw src and let `babel` compile on the fly.
 
-
 ```bash
 # Point all package.json files to the src directory instead of the dist directory.
 yarn run distsrc
@@ -156,7 +157,7 @@ yarn run srcdist
 
 The SDK enforces relatively strict commit messages to version its packages and keep language similar.
 
-Here is an example committing a new feature. Notice the *package name* in parentheses.
+Here is an example committing a new feature. Notice the _package name_ in parentheses.
 
 ```bash
 git commit -a -m 'feat(plugin-meetings): add ability to join a meeting'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.4",
+  "version": "3.0.0-beta.40",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -12,6 +12,7 @@
     "Taymoor Khan <taykhan@cisco.com>"
   ],
   "main": "dist/index.js",
+  "types": "dist/types/index.d.ts",
   "devMain": "src/index.js",
   "repository": {
     "type": "git",
@@ -27,32 +28,37 @@
       "envify"
     ]
   },
+  "scripts": {
+    "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
+  },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.4",
-    "@webex/test-helper-chai": "3.0.0-beta.4",
-    "@webex/test-helper-mocha": "3.0.0-beta.4",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.4",
-    "@webex/test-helper-retry": "3.0.0-beta.4",
-    "@webex/test-helper-test-users": "3.0.0-beta.4",
+    "@webex/plugin-meetings": "3.0.0-beta.40",
+    "@webex/test-helper-chai": "3.0.0-beta.40",
+    "@webex/test-helper-mocha": "3.0.0-beta.40",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.40",
+    "@webex/test-helper-retry": "3.0.0-beta.40",
+    "@webex/test-helper-test-users": "3.0.0-beta.40",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
     "sinon": "^9.2.4",
-    "typed-emitter": "^2.1.0"
+    "typed-emitter": "^2.1.0",
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.4",
-    "@webex/internal-media-core": "^0.0.17-beta",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.4",
-    "@webex/internal-plugin-device": "3.0.0-beta.4",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.4",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.4",
-    "@webex/internal-plugin-support": "3.0.0-beta.4",
-    "@webex/internal-plugin-user": "3.0.0-beta.4",
-    "@webex/plugin-people": "3.0.0-beta.4",
-    "@webex/plugin-rooms": "3.0.0-beta.4",
-    "@webex/ts-sdp": "^1.0.1",
-    "@webex/webex-core": "3.0.0-beta.4",
+    "@webex/common": "3.0.0-beta.40",
+    "@webex/internal-media-core": "1.35.2",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.40",
+    "@webex/internal-plugin-device": "3.0.0-beta.40",
+    "@webex/internal-plugin-llm": "3.0.0-beta.40",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.40",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.40",
+    "@webex/internal-plugin-support": "3.0.0-beta.40",
+    "@webex/internal-plugin-user": "3.0.0-beta.40",
+    "@webex/plugin-people": "3.0.0-beta.40",
+    "@webex/plugin-rooms": "3.0.0-beta.40",
+    "@webex/webex-core": "3.0.0-beta.40",
+    "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
     "dotenv": "^4.0.0",
@@ -62,6 +68,6 @@
     "lodash": "^4.17.21",
     "sdp-transform": "^2.12.0",
     "uuid": "^3.3.2",
-    "webrtc-adapter": "^7.7.0"
+    "webrtc-adapter": "^8.1.2"
   }
 }

package/src/breakouts/README.md

@@ -0,0 +1,199 @@
+# Breakout Sessions
+
+Breakout sessions are like meetings within meetings. They have separate roster lists and titles. Participants can move between breakouts and the main session.
+
+### Enabling
+
+To enable breakouts the `breakoutsSupported` parameter must be passed to the meeting join method.
+
+### Structure
+
+The current breakout session is accessible as follows:
+
+```javascript
+breakouts.currentBreakoutSession;
+```
+
+Other breakout sessions are available in the breakouts collection. These are breakouts that you known about. If you are an attendee, you may not know about all the breakout sessions in the meeting.
+
+```javascript
+breakouts.breakouts;
+```
+
+note: The `currentBreakoutSession` is NOT a member of the `breakouts.breakouts` collection.
+
+Some information about the state of breakouts is available on the `meeting.breakouts` object itself
+
+```javascript
+// The number of seconds after ending breakouts before the participants are returned to the main session
+breakouts.delayCloseTime;
+
+// Whether the participant is allowed back to the main session
+breakouts.allowBackToMain;
+```
+
+### Attendee functionality
+
+The normal meeting members are updated when you move in and out of a breakout session.
+
+The following are methods available to attendees of a meeting:
+
+```javascript
+// Join a breakout
+// This can be used when the participant is in the main session or in a different breakout session
+breakout.join();
+
+// Leave a breakout
+// This will cause the participant to return to the main session
+breakouts.currentBreakoutSession.leave();
+
+// Ask for help when in a breakout session. 10 second cooldown.
+breakout.currentBreakoutSession.askForHelp();
+```
+
+#### Members
+
+Each breakout session has members. Members represent other entities within the meeting.
+The current breakout session members are accessed via the meeting object i.e. they will automatically
+be updated when the user moves between sessions.
+
+To see which members are in other sessions, you can access them via the breakout model. The Members
+class is the same as that of the main meeting.
+
+```javascript
+breakout = breakouts.breakouts.models[0];
+breakout.members;
+```
+
+#### breakouts events
+
+```javascript
+// When the breakouts in the breakouts collection changes. This includes updates to session members
+on('meeting:breakouts:update', (breakouts) => {});
+
+// When the breakout sessions end this event will be fired
+on('meeting:breakouts:closing', () => {});
+
+// When the host sends a message to the breakout this event will fire
+on('meeting:breakouts:message', {senderUserId, sentTime, message, sessionId});
+```
+
+When breakouts are started there are several possibilities:
+
+1. The attendee is forced to join a session
+2. The attendee is assigned to a session, but can join when they feel like it
+3. The attendee is not assigned to a session, and can choose which session they want to join
+
+```javascript
+breakout.assigned; // Assigned to a session, but not in it yet
+breakout.assignedCurrent; // Forced to join a session
+breakout.active; // The session exists
+breakout.allowed; // The user is allowed to join the session
+breakout.requested; // The user has been requested to join the session
+```
+
+The above attributes of the breakout sessions, combined with the `meeting:breakouts:update` event allow you to determine which situation you are in.
+
+A host can signal attendees to move to a particular session. In this case the following is available. Using the same event, and the `requested` attribute of the breakout you can determine which session is to be moved to. Requesting return to the main session is the current use case of this.
+
+### Host functionality
+
+The following are methods available to a hosts of a meeting.
+
+note: None of these are currently implemented
+
+```javascript
+
+// Move a participant to breakout
+breakout.move(participant)
+
+// Assign a particpant to a breakout
+// Not sure whether there is any difference from move
+breakout.assign(participant)
+
+// Remove someone from a breakout session
+// This returns them to the main session
+breakout.remove(participant)
+
+// Deletes a breakout session
+// This can only be done when breakouts are inactive
+breakout.delete()
+
+/*
+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)
+
+// Start breakout sessions with necessary params
+breakouts.start(params)
+
+// End breakout sessions with necessary params
+breakouts.end(params)
+
+// get breakout sessions with/without param editlock
+breakouts.getBreakout(editlock?)
+
+// Enable breakout sessions
+breakouts.enable()
+
+// Disable breakout sessions
+breakouts.disable()
+
+// Send message asking all participants to return to the main session
+breakouts.askAllToReturn()
+
+// Send a message to a breakout session
+// You can determine which participant types receive the message, if no type set, default is to all participants
+breakout.broadcast(message, {participants: boolean, cohosts: boolean, presenters: boolean})
+
+// Send a message to All breakout sessions
+// You can determine which participant types receive the message,  if no type set, default is to all participants
+breakouts.broadcast(message, {participants: boolean, cohosts: boolean, presenters: boolean})
+
+// When breakouts are active you can cancel the automatic end of all sessions by calling this
+// method. It cannot be restarted, only manually ending breakouts is possible after calling this
+breakouts.cancelAutomaticEnd()
+
+IBreakoutConfig {
+  /*
+  Number of sessions to count down before returning users to main session. Seconds. Default 60. 0 means off
+  */
+  countdownTimer: Number,
+  /*
+  Whether attendees are allowed to return to the main meeting
+  */
+  allowReturntoMainMeeting: Boolean,
+  /*
+  Whether attendees are allowed to join later
+  */
+  allowJoinLater: Boolean,
+  /*
+  The timeout after which breakouts are automatically ended. Seconds. Default 1800 (30 minutes) Miniumum 5 minutes.
+  */
+  automaticallyEndBreakoutsAfter: Number,
+  /*
+  How participants are assigned to breakouts.
+  auto -> participants are automatically placed in sessions
+  */
+  assignmentMethod: 'auto' | 'manual' | 'choose'
+}
+
+// Configure settings on breakouts
+breakouts.configure(config)
+
+// set whether anyone can join the breakout or whether it is just assigned participants that can join
+breakout.setOpen(isOpen)
+
+// When the members change for a given breakout
+on('meeting:breakout:members:update', ({sessionId, members}) => {
+
+})
+
+```