@webex/plugin-meetings 2.39.0 → 2.39.2

package/dist/roap/collection.d.ts

@@ -0,0 +1,10 @@
+declare const RoapCollection: {
+    sessions: {};
+    getSession(id: any): any;
+    deleteSession(id: any): void;
+    getSessionSequence(id: any, seqId: any): any;
+    deleteSessionSequence(id: any, seqId: any): void;
+    isBusy(id: any): boolean;
+    onSessionSequenceFinish(id: any, seqId: any): void;
+};
+export default RoapCollection;

package/dist/roap/handler.d.ts

@@ -0,0 +1,47 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import Meeting from '../meeting';
+/**
+ * @class RoapHandler
+ */
+export default class RoapHandler extends StatelessWebexPlugin {
+    attrs: any;
+    lastRoapMessage: any;
+    options: any;
+    roapAnswer: any;
+    roapFinished: any;
+    roapOk: any;
+    constructor(attrs: any, options: any, roapOk: any, roapAnswer: any, roapFinished: any);
+    /**
+     *
+     * @param {Object} session
+     * @param {Meeting} meeting
+     * @param {Object} action
+     * @returns {null}
+     */
+    perform(session: any, meeting: any, action: any): void;
+    /**
+     *
+     * @param {String} signal
+     * @param {Object} session
+     * @param {Object} action
+     * @param {Meeting} meeting
+     * @param {String} prefix
+     * @returns {null}
+     */
+    execute(signal: string, session: any, action: any, meeting: Meeting, prefix: string): void;
+    /**
+     *
+     * @param {Object} session
+     * @param {Object} action
+     * @param {Meeting} meeting
+     * @param {String} correlationId
+     * @returns {Boolean}
+     */
+    handleAction(session: object, action: any, meeting: Meeting, correlationId: string): boolean;
+    /**
+     *
+     * @param {Object} action
+     * @returns {Boolean}
+     */
+    submit(action: any): boolean;
+}

package/dist/roap/index.d.ts

@@ -0,0 +1,116 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import Meeting from '../meeting';
+/**
+ * Roap options
+ * @typedef {Object} RoapOptions
+ * @property {String} sdp
+ * @property {Meeting} meeting
+ * @property {Number} roapSeq
+ * @property {Boolean} reconnect
+ */
+/**
+ * @typedef {Object} SeqOptions
+ * @property {String} correlationId
+ * @property {String} mediaId
+ * @property {Number} seq
+ */
+/**
+ * @class Roap
+ * @export
+ * @private
+ */
+export default class Roap extends StatelessWebexPlugin {
+    attrs: any;
+    lastRoapOffer: any;
+    options: any;
+    roapHandler: any;
+    roapRequest: any;
+    turnDiscovery: any;
+    /**
+     *
+     * @param {Object} attrs
+     * @param {Object} options
+     */
+    constructor(attrs: any, options: any);
+    /**
+     * Starts listening to mercury events for Roap messages
+     * @param {object} data event object
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private roapEvent;
+    /**
+     *
+     * @param {String} correlationId correlation id of a meeting
+     * @param {Number} seq ROAP sequence number
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private stop;
+    /**
+     *
+     * @param {SeqOptions} options
+     * @returns {null}
+     * @private
+     * @memberof Roap
+     */
+    private sendRoapOK;
+    /**
+     * Sends a ROAP answer...
+     * @param {SeqOptions} options
+     * @param {Boolean} options.audioMuted
+     * @param {Boolean} options.videoMuted
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private sendRoapAnswer;
+    /**
+     * Sends a ROAP error...
+     * @param {Object} session
+     * @param {Object} locus
+     * @param {String} errorType
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private sendRoapError;
+    /**
+     * sends a roap media request
+     * @param {RoapOptions} options
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    sendRoapMediaRequest(options: any): any;
+    /**
+     * sends a roap media request
+     * @param {RoapOptions} options
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    sendRoapCallRequest: (options: any) => any;
+    /**
+     * Called when the roap sequence is finished (completed successfully or failed)
+     * @param {String} correlationId id of the meeting affected
+     * @param {String} sequenceId the id of the finished sequence
+     * @returns {undefined}
+     * @private
+     * @memberof Roap
+     */
+    private roapFinished;
+    /**
+     * Performs a TURN server discovery procedure, which involves exchanging
+     * some roap messages with the server. This exchange has to be done before
+     * any other roap messages are sent
+     *
+     * @param {Meeting} meeting
+     * @param {Boolean} isReconnecting should be set to true if this is a new
+     *                                 media connection just after a reconnection
+     * @returns {Promise}
+     */
+    doTurnDiscovery(meeting: Meeting, isReconnecting: boolean): any;
+}

package/dist/roap/request.d.ts

@@ -0,0 +1,35 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+/**
+ * @class RoapRequest
+ */
+export default class RoapRequest extends StatelessWebexPlugin {
+    /**
+     * Joins a meeting via ROAP
+     * @param {Object} options
+     * @returns {Promise} returns a promise that resolves/rejects whatever the request does
+     */
+    attachRechabilityData(localSdp: any): any;
+    joinMeetingWithRoap(options: any): Promise<any>;
+    /**
+     * Sends a ROAP message
+     * @param {Object} options
+     * @param {Object} options.roapMessage
+     * @param {String} options.locusSelfUrl
+     * @param {String} options.mediaId
+     * @param {String} options.correlationId
+     * @param {Boolean} options.audioMuted
+     * @param {Boolean} options.videoMuted
+     * @param {String} options.meetingId
+     * @returns {Promise} returns the response/failure of the request
+     */
+    sendRoap(options: {
+        roapMessage: any;
+        locusSelfUrl: string;
+        mediaId: string;
+        correlationId: string;
+        audioMuted: boolean;
+        videoMuted: boolean;
+        meetingId: string;
+        preferTranscoding?: boolean;
+    }): any;
+}

package/dist/roap/state.d.ts

@@ -0,0 +1,9 @@
+declare const RoapStateMachine: {
+    /**
+     * @param {Roap} roapRef
+     * initializes the state machine
+     * @returns {StateMachine} an instance of a state machine
+     */
+    createState(): any;
+};
+export default RoapStateMachine;

package/dist/roap/turnDiscovery.d.ts

@@ -0,0 +1,67 @@
+import RoapRequest from './request';
+import Meeting from '../meeting';
+/**
+ * Handles the process of finding out TURN server information from Linus.
+ * This is achieved by sending a TURN_DISCOVERY_REQUEST.
+ */
+export default class TurnDiscovery {
+    private roapRequest;
+    private defer?;
+    private turnInfo;
+    private responseTimer?;
+    /**
+     * Constructor
+     *
+     * @param {RoapRequest} roapRequest
+     */
+    constructor(roapRequest: RoapRequest);
+    /**
+     * waits for TURN_DISCOVERY_RESPONSE message to arrive
+     *
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private waitForTurnDiscoveryResponse;
+    /**
+     * handles TURN_DISCOVERY_RESPONSE roap message
+     *
+     * @param {Object} roapMessage
+     * @returns {void}
+     * @public
+     * @memberof Roap
+     */
+    handleTurnDiscoveryResponse(roapMessage: object): void;
+    /**
+     * sends the TURN_DISCOVERY_REQUEST roap request
+     *
+     * @param {Meeting} meeting
+     * @param {Boolean} isReconnecting
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private sendRoapTurnDiscoveryRequest;
+    /**
+     * Sends the OK message that server expects to receive
+     * after it sends us TURN_DISCOVERY_RESPONSE
+     *
+     * @param {Meeting} meeting
+     * @returns {Promise}
+     */
+    sendRoapOK(meeting: Meeting): any;
+    /**
+     * Retrieves TURN server information from the backend by doing
+     * a roap message exchange:
+     * client                             server
+     *  | -----TURN_DISCOVERY_REQUEST-----> |
+     *  | <----TURN_DISCOVERY_RESPONSE----- |
+     *  | --------------OK----------------> |
+     *
+     * @param {Meeting} meeting
+     * @param {Boolean} isReconnecting should be set to true if this is a new
+     *                                 media connection just after a reconnection
+     * @returns {Promise}
+     */
+    doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean): any;
+}

package/dist/roap/util.d.ts

@@ -0,0 +1,2 @@
+declare const RoapUtil: any;
+export default RoapUtil;

package/dist/statsAnalyzer/global.d.ts

@@ -0,0 +1,126 @@
+declare const STATS_DEFAULT: {
+    encryption: string;
+    audio: {
+        send: {
+            maxPacketLossRatio: number;
+            availableBandwidth: number;
+            bytesSent: number;
+            meanRemoteJitter: any[];
+            meanRoundTripTime: any[];
+        };
+        recv: {
+            availableBandwidth: number;
+            bytesReceived: number;
+            meanRtpJitter: any[];
+            meanRoundTripTime: any[];
+        };
+    };
+    video: {
+        send: {
+            maxPacketLossRatio: number;
+            availableBandwidth: number;
+            meanRemoteJitter: any[];
+            meanRoundTripTime: any[];
+        };
+        recv: {
+            availableBandwidth: number;
+            totalPacketsLost: number;
+            meanRtpJitter: any[];
+            meanRoundTripTime: any[];
+        };
+        latency: number;
+        packetsLost: number;
+    };
+    share: {
+        send: {
+            maxPacketLossRatio: number;
+            availableBandwidth: number;
+            totalPacketsLost: number;
+            meanRemoteJitter: any[];
+            meanRoundTripTime: any[];
+        };
+        recv: {
+            availableBandwidth: number;
+            meanRtpJitter: any[];
+            meanRoundTripTime: any[];
+        };
+        latency: number;
+        packetsLost: number;
+    };
+    bandwidth: {
+        systemBandwidth: number;
+        sentPerSecond: number;
+        encodedPerSecond: number;
+        helper: {
+            audioBytesSent: number;
+            videoBytestSent: number;
+        };
+        speed: number;
+    };
+    results: {};
+    connectionType: {
+        systemNetworkType: string;
+        systemIpAddress: string;
+        local: {
+            candidateType: any[];
+            transport: any[];
+            ipAddress: any[];
+            networkType: any[];
+        };
+        remote: {
+            candidateType: any[];
+            transport: any[];
+            ipAddress: any[];
+            networkType: any[];
+        };
+    };
+    resolutions: {
+        audio: {
+            send: {
+                width: number;
+                height: number;
+            };
+            recv: {
+                width: number;
+                height: number;
+            };
+        };
+        video: {
+            send: {
+                width: number;
+                height: number;
+            };
+            recv: {
+                width: number;
+                height: number;
+            };
+        };
+        share: {
+            send: {
+                width: number;
+                height: number;
+            };
+            recv: {
+                width: number;
+                height: number;
+            };
+        };
+    };
+    internal: {
+        audio: {
+            send: {};
+            recv: {};
+        };
+        video: {
+            send: {};
+            recv: {};
+        };
+        share: {
+            send: {};
+            recv: {};
+        };
+        remote: {};
+        candidates: {};
+    };
+};
+export default STATS_DEFAULT;

package/dist/statsAnalyzer/index.d.ts

@@ -0,0 +1,190 @@
+/// <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;
+    localMQEStats: any;
+    meetingMediaStatus: any;
+    mqaInterval: NodeJS.Timeout;
+    mqaSentCount: any;
+    networkQualityMonitor: any;
+    peerConnection: 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);
+    populateResults(lastMqa: any): 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 peerconnection
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    sendMqaData(): void;
+    /**
+     * updated the peerconnection when changed
+     *
+     * @private
+     * @memberof updatePeerconnection
+     * @param {PeerConnection} peerConnection
+     * @returns {void}
+     */
+    updatePeerconnection(peerConnection: any): void;
+    /**
+     * Starts the stats analyzer on interval
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @param {PeerConnection} peerConnection
+     * @returns {Promise}
+     */
+    startAnalyzer(peerConnection: any): Promise<void>;
+    /**
+     * Cleans up the analyzer when done
+     *
+     * @public
+     * @memberof StatsAnalyzer
+     * @returns {void}
+     */
+    stopAnalyzer(): Promise<void>;
+    /**
+     * 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} getStatsResults
+     * @param {String} type
+     * @param {boolean} isSender
+     * @returns {void}
+     */
+    private filterAndParseGetStatsResults;
+    /**
+     * 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 {*} type
+     * @returns {void}
+     */
+    private processOutboundRTPResult;
+    /**
+     * Processes InboundRTP stats result and stores
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @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
+     */
+    private compareSentAndReceived;
+}

package/dist/statsAnalyzer/mqaUtil.d.ts

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

package/dist/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;
+}