@webex/plugin-meetings 3.2.0 → 3.3.0

package/dist/roap/index.d.ts

@@ -1,86 +0,0 @@
-import { StatelessWebexPlugin } from '@webex/webex-core';
-import TurnDiscovery, { TurnDiscoveryResult } from './turnDiscovery';
-import Meeting from '../meeting';
-export { type TurnDiscoveryResult, type TurnServerInfo, type TurnDiscoverySkipReason, } from './turnDiscovery';
-/**
- * Roap options
- * @typedef {Object} RoapOptions
- * @property {String} sdp
- * @property {Meeting} meeting
- * @property {Number} seq
- * @property {Number} tieBreaker
- *  @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: TurnDiscovery;
-    /**
-     *
-     * @param {Object} attrs
-     * @param {Object} options
-     */
-    constructor(attrs: any, options: any);
-    /**
-     *
-     * @param {SeqOptions} options
-     * @returns {null}
-     * @memberof Roap
-     */
-    sendRoapOK(options: any): Promise<any>;
-    /**
-     * Sends a ROAP answer...
-     * @param {SeqOptions} options
-     * @param {Boolean} options.audioMuted
-     * @param {Boolean} options.videoMuted
-     * @returns {Promise}
-     * @memberof Roap
-     */
-    sendRoapAnswer(options: any): any;
-    /**
-     * Sends a ROAP error...
-     * @param {Object} options
-     * @returns {Promise}
-     * @memberof Roap
-     */
-    sendRoapError(options: any): any;
-    /**
-     * sends a roap media request
-     * @param {RoapOptions} options
-     * @returns {Promise}
-     * @memberof Roap
-     */
-    sendRoapMediaRequest(options: any): any;
-    /**
-     * 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
-     * @param {Boolean} [isForced]
-     * @returns {Promise}
-     */
-    doTurnDiscovery(meeting: Meeting, isReconnecting: boolean, isForced?: boolean): Promise<TurnDiscoveryResult>;
-    generateTurnDiscoveryRequestMessage(meeting: Meeting, isForced: boolean): Promise<{
-        roapMessage?: object;
-        turnDiscoverySkippedReason: string;
-    }>;
-    handleTurnDiscoveryHttpResponse(meeting: Meeting, httpResponse: object): Promise<TurnDiscoveryResult>;
-    abortTurnDiscovery(): void;
-}

package/dist/roap/request.d.ts

@@ -1,39 +0,0 @@
-import { StatelessWebexPlugin } from '@webex/webex-core';
-import { IP_VERSION } from '../constants';
-import { LocusMediaRequest } from '../meeting/locusMediaRequest';
-/**
- * @class RoapRequest
- */
-export default class RoapRequest extends StatelessWebexPlugin {
-    /**
-     * Returns reachability data.
-     * @param {Object} localSdp
-     * @returns {Object}
-     */
-    attachReachabilityData(localSdp: any): Promise<{
-        localSdp: any;
-        joinCookie: 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 {String} options.meetingId
-     * @param {IP_VERSION} options.ipVersion only required for offers
-     * @returns {Promise} returns the response/failure of the request
-     */
-    sendRoap(options: {
-        roapMessage: any;
-        locusSelfUrl: string;
-        mediaId: string;
-        meetingId: string;
-        ipVersion?: IP_VERSION;
-        locusMediaRequest?: LocusMediaRequest;
-    }): Promise<{
-        mediaConnections: any;
-        locus: any;
-    }>;
-}

package/dist/roap/turnDiscovery.d.ts

@@ -1,155 +0,0 @@
-import { Enum } from '../constants';
-import RoapRequest from './request';
-import Meeting from '../meeting';
-declare const TurnDiscoverySkipReason: {
-    readonly missingHttpResponse: "missing http response";
-    readonly reachability: "reachability";
-    readonly alreadyInProgress: "already in progress";
-};
-export type TurnDiscoverySkipReason = Enum<typeof TurnDiscoverySkipReason> | string | undefined;
-export type TurnServerInfo = {
-    url: string;
-    username: string;
-    password: string;
-};
-export type TurnDiscoveryResult = {
-    turnServerInfo?: TurnServerInfo;
-    turnDiscoverySkippedReason: TurnDiscoverySkipReason;
-};
-/**
- * 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. Use it if the roap message comes over the websocket,
-     * otherwise use handleTurnDiscoveryHttpResponse() if it comes in the http response.
-     *
-     * @param {Object} roapMessage
-     * @param {string} from string to indicate how we got the response (used just for logging)
-     * @returns {void}
-     * @public
-     * @memberof Roap
-     */
-    handleTurnDiscoveryResponse(roapMessage: any, from: string): void;
-    /**
-     * Generates TURN_DISCOVERY_REQUEST roap message. When this method returns a roapMessage, it means that a TURN discovery process has started.
-     * It needs be ended by calling handleTurnDiscoveryHttpResponse() once you get a response from the backend. If you don't get any response
-     * or want to abort, you need to call abort().
-     *
-     * @param {Meeting} meeting
-     * @param {boolean} isForced
-     * @returns {Object}
-     */
-    generateTurnDiscoveryRequestMessage(meeting: Meeting, isForced: boolean): Promise<{
-        roapMessage?: object;
-        turnDiscoverySkippedReason: TurnDiscoverySkipReason;
-    }>;
-    /**
-     * Handles any errors that occur during TURN discovery without re-throwing them.
-     *
-     * @param {Meeting} meeting
-     * @param {Error} error
-     * @returns {TurnDiscoveryResult}
-     */
-    private handleTurnDiscoveryFailure;
-    /**
-     * Handles TURN_DISCOVERY_RESPONSE roap message that came in http response. If the response is not valid,
-     * it returns an object with turnServerInfo set to undefined. In that case you need to call abort()
-     * to end the TURN discovery process.
-     *
-     * @param {Meeting} meeting
-     * @param {Object|undefined} httpResponse can be undefined to indicate that we didn't get the response
-     * @returns {Promise<TurnDiscoveryResult>}
-     * @memberof Roap
-     */
-    handleTurnDiscoveryHttpResponse(meeting: Meeting, httpResponse?: object): Promise<TurnDiscoveryResult>;
-    /**
-     * Aborts current TURN discovery. This method needs to be called if you called generateTurnDiscoveryRequestMessage(),
-     * but then never got any response from the server.
-     * @returns {void}
-     */
-    abort(): void;
-    /**
-     * Parses the TURN_DISCOVERY_RESPONSE roap message out of the http response
-     * and returns it.
-     *
-     * @param {Meeting} meeting
-     * @param {any} httpResponse
-     * @returns {any}
-     */
-    private parseHttpTurnDiscoveryResponse;
-    /**
-     * 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): Promise<{
-        mediaConnections: any;
-        locus: any;
-    }>;
-    /**
-     * Gets the reason why reachability is skipped.
-     *
-     * @param {Meeting} meeting
-     * @returns {Promise<string>} Promise with empty string if reachability is not skipped or a reason if it is skipped
-     */
-    private getSkipReason;
-    /**
-     * Checks if TURN discovery is skipped.
-     *
-     * @param {Meeting} meeting
-     * @returns {Boolean} true if TURN discovery is being skipped, false if it is being done
-     */
-    isSkipped(meeting: any): Promise<boolean>;
-    /**
-     * Retrieves TURN server information from the backend by doing
-     * a roap message exchange:
-     * client                             server
-     *  | -----TURN_DISCOVERY_REQUEST-----> |
-     *  | <----TURN_DISCOVERY_RESPONSE----- |
-     *  | --------------OK----------------> |
-     *
-     * This TURN discovery roap exchange is always done with seq=0.
-     * The RoapMediaConnection SDP exchange always starts with seq=1,
-     * so it works fine no matter if TURN discovery is done or not.
-     *
-     * @param {Meeting} meeting
-     * @param {Boolean} [isReconnecting] should be set to true if this is a new
-     *                                 media connection just after a reconnection
-     * @param {Boolean} [isForced]
-     * @returns {Promise}
-     */
-    doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean, isForced?: boolean): Promise<TurnDiscoveryResult>;
-}
-export {};

package/dist/rtcMetrics/constants.d.ts

@@ -1,4 +0,0 @@
-declare const RTC_METRICS: {
-    APP_ID: string;
-};
-export { RTC_METRICS as default };

package/dist/rtcMetrics/index.d.ts

@@ -1,61 +0,0 @@
-/**
- * Rtc Metrics
- */
-export default class RtcMetrics {
-    /**
-     * Array of MetricData items to be sent to the metrics service.
-     */
-    metricsQueue: any[];
-    intervalId: number;
-    webex: any;
-    meetingId: string;
-    correlationId: string;
-    connectionId: string;
-    /**
-     * Initialize the interval.
-     *
-     * @param {object} webex - The main `webex` object.
-     * @param {string} meetingId - The meeting id.
-     * @param {string} correlationId - The correlation id.
-     */
-    constructor(webex: any, meetingId: any, correlationId: any);
-    /**
-     * Check to see if the metrics queue has any items.
-     *
-     * @returns {void}
-     */
-    sendMetricsInQueue(): void;
-    /**
-     * Add metrics items to the metrics queue.
-     *
-     * @param {object} data - An object with a payload array of metrics items.
-     *
-     * @returns {void}
-     */
-    addMetrics(data: any): void;
-    /**
-     * Clear the metrics interval.
-     *
-     * @returns {void}
-     */
-    closeMetrics(): void;
-    /**
-     * Anonymize IP addresses.
-     *
-     * @param {array} stats - An RTCStatsReport organized into an array of strings.
-     * @returns {string}
-     */
-    anonymizeIp(stats: string): string;
-    /**
-     * Set a new connection id.
-     *
-     * @returns {void}
-     */
-    private setNewConnectionId;
-    /**
-     * Send metrics to the metrics service.
-     *
-     * @returns {void}
-     */
-    private sendMetrics;
-}

package/dist/statsAnalyzer/global.d.ts

@@ -1,36 +0,0 @@
-declare const STATS_DEFAULT: {
-    encryption: string;
-    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: {};
-    internal: {
-        remote: {};
-        candidates: {};
-    };
-};
-export default STATS_DEFAULT;

package/dist/statsAnalyzer/index.d.ts

@@ -1,217 +0,0 @@
-/// <reference types="node" />
-import EventsScope from '../common/events/events-scope';
-import { ReceiveSlot } from '../multistream/receiveSlot';
-export declare const EVENTS: {
-    MEDIA_QUALITY: string;
-    LOCAL_MEDIA_STARTED: string;
-    LOCAL_MEDIA_STOPPED: string;
-    REMOTE_MEDIA_STARTED: string;
-    REMOTE_MEDIA_STOPPED: string;
-};
-type ReceiveSlotCallback = (csi: number) => ReceiveSlot | undefined;
-type MediaStatus = {
-    actual?: any;
-    expected?: any;
-};
-/**
- * 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;
-    successfulCandidatePair: any;
-    localIpAddress: string;
-    receiveSlotCallback: ReceiveSlotCallback;
-    /**
-     * Creates a new instance of StatsAnalyzer
-     * @constructor
-     * @public
-     * @param {Object} config SDK Configuration Object
-     * @param {Function} receiveSlotCallback Callback used to access receive slots.
-     * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
-     * @param {Object} statsResults Default properties for stats
-     */
-    constructor(config: any, receiveSlotCallback?: ReceiveSlotCallback, 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: MediaStatus): 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;
-    /**
-     * Returns the local IP address for diagnostics.
-     * this is the local IP of the interface used for the current media connection
-     * a host can have many local Ip Addresses
-     * @returns {string | undefined} The local IP address.
-     */
-    getLocalIpAddress(): string;
-    /**
-     * 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;
-    /**
-     * extracts the local Ip address from the statsResult object by looking at stats results candidates
-     * and matches that ID with the successful candidate pair. It looks at the type of local candidate it is
-     * and then extracts the IP address from the relatedAddress or address property based on conditions known in webrtc
-     * note, there are known incompatibilities and it is possible for this to set undefined, or for the IP address to be the public IP address
-     * for example, firefox does not set the relayProtocol, and if the user is behind a NAT it might be the public IP
-     * @private
-     * @param {string} successfulCandidatePairId - The ID of the successful candidate pair.
-     * @param {Object} candidates - the stats result candidates
-     * @returns {void}
-     */
-    extractAndSetLocalIpAddressInfoForDiagnostics: (successfulCandidatePairId: string, candidates: {
-        [key: string]: Record<string, unknown>;
-    }) => void;
-    /**
-     * 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;
-    /**
-     *
-     * @private
-     * @param {*} result
-     * @param {*} type
-     * @returns {void}
-     * @memberof StatsAnalyzer
-     */
-    compareSentAndReceived(result: any, type: any): void;
-}
-export {};

package/dist/statsAnalyzer/mqaUtil.d.ts

@@ -1,48 +0,0 @@
-export declare const getAudioReceiverMqa: ({ audioReceiver, statsResults, lastMqaDataSent, baseMediaType, }: {
-    audioReceiver: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getAudioReceiverStreamMqa: ({ audioReceiverStream, statsResults, lastMqaDataSent, mediaType, }: {
-    audioReceiverStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getAudioSenderMqa: ({ audioSender, statsResults, lastMqaDataSent, baseMediaType }: {
-    audioSender: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getAudioSenderStreamMqa: ({ audioSenderStream, statsResults, lastMqaDataSent, mediaType, }: {
-    audioSenderStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getVideoReceiverMqa: ({ videoReceiver, statsResults, lastMqaDataSent, baseMediaType, }: {
-    videoReceiver: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getVideoReceiverStreamMqa: ({ videoReceiverStream, statsResults, lastMqaDataSent, mediaType, }: {
-    videoReceiverStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;
-export declare const getVideoSenderMqa: ({ videoSender, statsResults, lastMqaDataSent, baseMediaType }: {
-    videoSender: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    baseMediaType: any;
-}) => void;
-export declare const getVideoSenderStreamMqa: ({ videoSenderStream, statsResults, lastMqaDataSent, mediaType, }: {
-    videoSenderStream: any;
-    statsResults: any;
-    lastMqaDataSent: any;
-    mediaType: any;
-}) => void;