@webex/plugin-meetings 3.8.1 → 3.9.0-next.2

package/dist/types/mediaQualityMetrics/config.d.ts

@@ -1,241 +0,0 @@
-export declare const emptyMqaInterval: {
-    audioReceive: any[];
-    audioTransmit: any[];
-    intervalMetadata: {
-        peerReflexiveIP: string;
-        peripherals: any[];
-        processAverageCPU: number;
-        processMaximumCPU: number;
-        systemAverageCPU: number;
-        systemMaximumCPU: number;
-    };
-    networkType: string;
-    intervalNumber: number;
-    videoReceive: any[];
-    videoTransmit: any[];
-};
-export declare const emptyAudioReceive: {
-    common: {
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        mediaHopByHopLost: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpHopByHopLost: number;
-        rtpPackets: number;
-        rtpRecovered: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        srtcpUnprotectErrors: number;
-        srtpUnprotectErrors: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: any[];
-};
-export declare const emptyAudioReceiveStream: {
-    common: {
-        codec: string;
-        concealedFrames: number;
-        csi: any[];
-        maxConcealRunLength: number;
-        optimalBitrate: number;
-        optimalFrameRate: number;
-        receivedBitrate: number;
-        receivedFrameRate: number;
-        renderedFrameRate: number;
-        requestedBitrate: number;
-        requestedFrameRate: number;
-        rtpEndToEndLost: number;
-        maxRtpJitter: number;
-        meanRtpJitter: number;
-        rtpPackets: number;
-        ssci: number;
-    };
-};
-export declare const emptyAudioTransmit: {
-    common: {
-        availableBitrate: number;
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        queueDelay: number;
-        remoteJitter: number;
-        remoteLossRate: number;
-        remoteReceiveRate: number;
-        roundTripTime: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpPackets: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: any[];
-};
-export declare const emptyAudioTransmitStream: {
-    common: {
-        codec: string;
-        csi: any[];
-        requestedBitrate: number;
-        requestedFrames: number;
-        rtpPackets: number;
-        ssci: number;
-        transmittedBitrate: number;
-        transmittedFrameRate: number;
-    };
-};
-export declare const emptyVideoReceive: {
-    common: {
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        mediaHopByHopLost: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpHopByHopLost: number;
-        rtpPackets: number;
-        rtpRecovered: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        srtcpUnprotectErrors: number;
-        srtpUnprotectErrors: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: any[];
-};
-export declare const emptyVideoReceiveStream: {
-    common: {
-        codec: string;
-        concealedFrames: number;
-        csi: any[];
-        maxConcealRunLength: number;
-        optimalBitrate: number;
-        optimalFrameRate: number;
-        receivedBitrate: number;
-        receivedFrameRate: number;
-        renderedFrameRate: number;
-        requestedBitrate: number;
-        requestedFrameRate: number;
-        rtpEndToEndLost: number;
-        rtpJitter: number;
-        rtpPackets: number;
-        ssci: number;
-    };
-    h264CodecProfile: string;
-    isActiveSpeaker: boolean;
-    optimalFrameSize: number;
-    receivedFrameSize: number;
-    receivedHeight: number;
-    receivedKeyFrames: number;
-    receivedKeyFramesForRequest: number;
-    receivedKeyFramesSourceChange: number;
-    receivedKeyFramesUnknown: number;
-    receivedWidth: number;
-    requestedFrameSize: number;
-    requestedKeyFrames: number;
-};
-export declare const emptyVideoTransmit: {
-    common: {
-        availableBitrate: number;
-        common: {
-            direction: string;
-            isMain: boolean;
-            mariFecEnabled: boolean;
-            mariQosEnabled: boolean;
-            multistreamEnabled: boolean;
-        };
-        dtlsBitrate: number;
-        dtlsPackets: number;
-        fecBitrate: number;
-        fecPackets: number;
-        maxBitrate: number;
-        queueDelay: number;
-        remoteJitter: number;
-        remoteLossRate: number;
-        remoteReceiveRate: number;
-        roundTripTime: number;
-        rtcpBitrate: number;
-        rtcpPackets: number;
-        rtpBitrate: number;
-        rtpPackets: number;
-        rtxBitrate: number;
-        rtxPackets: number;
-        stunBitrate: number;
-        stunPackets: number;
-        transportType: string;
-    };
-    streams: any[];
-};
-export declare const emptyVideoTransmitStream: {
-    common: {
-        codec: string;
-        csi: any[];
-        duplicateSsci: number;
-        requestedBitrate: number;
-        requestedFrames: number;
-        rtpPackets: number;
-        ssci: number;
-        transmittedBitrate: number;
-        transmittedFrameRate: number;
-    };
-    h264CodecProfile: string;
-    isAvatar: boolean;
-    isHardwareEncoded: boolean;
-    localConfigurationChanges: number;
-    maxFrameQp: number;
-    maxNoiseLevel: number;
-    minRegionQp: number;
-    remoteConfigurationChanges: number;
-    requestedFrameSize: number;
-    requestedKeyFrames: number;
-    transmittedFrameSize: number;
-    transmittedHeight: number;
-    transmittedKeyFrames: number;
-    transmittedKeyFramesClient: number;
-    transmittedKeyFramesConfigurationChange: number;
-    transmittedKeyFramesFeedback: number;
-    transmittedKeyFramesLocalDrop: number;
-    transmittedKeyFramesOtherLayer: number;
-    transmittedKeyFramesPeriodic: number;
-    transmittedKeyFramesSceneChange: number;
-    transmittedKeyFramesStartup: number;
-    transmittedKeyFramesUnknown: number;
-    transmittedWidth: number;
-};

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

@@ -1,70 +0,0 @@
-import EventsScope from '../common/events/events-scope';
-/**
- * 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
- *
- * @class NetworkQualityMonitor
- * @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
-     * @public
-     * @param {Object} config
-     * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
-     * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
-     * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
-     * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
-     * @property {string} mediaType - audio|video
-     */
-    constructor(config: any);
-    /**
-     * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
-     *
-     * @memberof NetworkQualityMonitor
-     * @returns {void}
-     */
-    emitNetworkQuality(): void;
-    /**
-     * invokes emitNetworkQuality method resets values back to default
-     * @returns {void}
-     * @memberof NetworkQualityMonitor
-     */
-    updateNetworkQualityStatus(): void;
-    /**
-     * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
-     * @param {Object} configObj
-     * @param {string} configObj.mediaType {audio|video}
-     * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
-     * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
-     * @returns {void}
-     * @public
-     * @memberof NetworkQualityMonitor
-     */
-    determineUplinkNetworkQuality({ mediaType, remoteRtpResults, statsAnalyzerCurrentStats, }: {
-        mediaType: string;
-        remoteRtpResults: any;
-        statsAnalyzerCurrentStats: object;
-    }): void;
-    /**
-     * Get the current status of network quaility object - networkQualityStatus
-     * @returns {Object}
-     * @public
-     */
-    get networkQualityStats(): any;
-}

package/dist/types/rtcMetrics/constants.d.ts

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

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

@@ -1,71 +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;
-    shouldSendMetricsOnNextStatsReport: boolean;
-    /**
-     * 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;
-    /**
-     * Forces sending metrics when we get the next stats-report
-     *
-     * This is useful for cases when something important happens that affects the media connection,
-     * for example when we move from lobby into the meeting.
-     *
-     * @returns {void}
-     */
-    sendNextMetrics(): 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 resetConnection;
-    /**
-     * Send metrics to the metrics service.
-     *
-     * @returns {void}
-     */
-    private sendMetrics;
-}

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

package/dist/webinar/collection.d.ts

@@ -1,16 +0,0 @@
-/*!
- * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
- */
-declare class WebinarCollection {
-    webinarInfo: any;
-    namespace: string;
-    mainIndex: string;
-    constructor();
-    set(id: any, info: any): void;
-    /**
-     * @param {String} id
-     * @returns {Member}
-     */
-    get(id: string): any;
-}
-export default WebinarCollection;