@webex/plugin-meetings 3.5.0 → 3.6.0

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

@@ -0,0 +1,241 @@
+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/meeting/in-meeting-actions.d.ts

@@ -79,6 +79,7 @@ interface IInMeetingActions {
     supportHDV?: boolean;
     canShareWhiteBoard?: boolean;
     enforceVirtualBackground?: boolean;
+    canPollingAndQA?: boolean;
 }
 /**
  * @class InMeetingActions
@@ -158,6 +159,7 @@ export default class InMeetingActions implements IInMeetingActions {
     enforceVirtualBackground: any;
     supportHDV: any;
     canShareWhiteBoard: any;
+    canPollingAndQA: any;
     /**
      * Returns all meeting action options
      * @returns {Object}

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

@@ -67,6 +67,7 @@ export type AddMediaOptions = {
 };
 export type CallStateForMetrics = {
     correlationId?: string;
+    sessionCorrelationId?: string;
     joinTrigger?: string;
     loginType?: string;
 };
@@ -488,6 +489,16 @@ export default class Meeting extends StatelessWebexPlugin {
      * @param {string} correlationId
      */
     set correlationId(correlationId: string);
+    /**
+     * Getter - Returns callStateForMetrics.sessionCorrelationId
+     * @returns {string}
+     */
+    get sessionCorrelationId(): string;
+    /**
+     * Setter - sets callStateForMetrics.sessionCorrelationId
+     * @param {string} sessionCorrelationId
+     */
+    set sessionCorrelationId(sessionCorrelationId: string);
     /**
      * Getter - Returns isoLocalClientMeetingJoinTime
      * This will be set once on meeting join, and not updated again

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

@@ -2,6 +2,7 @@ import '@webex/internal-plugin-mercury';
 import '@webex/internal-plugin-conversation';
 import '@webex/internal-plugin-metrics';
 import { WebexPlugin } from '@webex/webex-core';
+import { DeviceRegistrationOptions } from '@webex/internal-plugin-device';
 import * as mediaHelpersModule from '@webex/media-helpers';
 import 'webrtc-adapter';
 import { DESTINATION_TYPE } from '../constants';
@@ -51,6 +52,26 @@ import { INoiseReductionEffect, IVirtualBackgroundEffect } from './meetings.type
  * @property {String} type what type of meeting it was
  * @memberof Meetings
  */
+/**
+ * Object containing only the most basic information about a meeting.
+ * This is the information that is kept even after the meeting is deleted from the MeetingCollection
+ */
+export type BasicMeetingInformation = {
+    allowMediaInLobby: boolean;
+    correlationId: string;
+    environment: string;
+    id: string;
+    locusUrl: string;
+    locusInfo: {
+        url: string;
+        fullState: {
+            lastActive: string;
+            sessionId: string;
+        };
+    };
+    meetingInfo: any;
+    sessionCorrelationId: string;
+};
 /**
  * Maintain a cache of meetings and sync with services.
  * @class
@@ -59,6 +80,7 @@ export default class Meetings extends WebexPlugin {
     loggerRequest: any;
     media: any;
     meetingCollection: any;
+    deletedMeetings: Map<string, BasicMeetingInformation>;
     personalMeetingRoom: any;
     preferredWebexSite: any;
     reachability: Reachability;
@@ -189,11 +211,12 @@ export default class Meetings extends WebexPlugin {
      * Explicitly sets up the meetings plugin by registering
      * the device, connecting to mercury, and listening for locus events.
      *
+     * @param {DeviceRegistrationOptions} [deviceRegistrationOptions] - The options for registering the device (optional)
      * @returns {Promise}
      * @public
      * @memberof Meetings
      */
-    register(): Promise<void>;
+    register(deviceRegistrationOptions?: DeviceRegistrationOptions): Promise<any>;
     /**
      * Explicitly tears down the meetings plugin by deregistering
      * the device, disconnecting from mercury, and stops listening to locus events
@@ -281,6 +304,14 @@ export default class Meetings extends WebexPlugin {
      * @memberof Meetings
      */
     getPersonalMeetingRoom(): any;
+    /**
+     * Returns basic information about a meeting that exists or
+     * used to exist in the MeetingCollection
+     *
+     * @param {string} meetingId
+     * @returns {BasicMeetingInformation|undefined}
+     */
+    getBasicMeetingInformation(meetingId: string): BasicMeetingInformation;
     /**
      * @param {Meeting} meeting
      * @param {Object} reason
@@ -304,11 +335,12 @@ export default class Meetings extends WebexPlugin {
      * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
      * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
      * @param {String} [meetingLookupUrl] - meeting info prefetch url
+     * @param {string} sessionCorrelationId - the optional specified sessionCorrelationId (callStateForMetrics.sessionCorrelationId) can be provided instead
      * @returns {Promise<Meeting>} A new Meeting.
      * @public
      * @memberof Meetings
      */
-    create(destination: string, type?: DESTINATION_TYPE, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics, meetingInfo?: any, meetingLookupUrl?: any): any;
+    create(destination: string, type?: DESTINATION_TYPE, useRandomDelayForInfo?: boolean, infoExtraParams?: {}, correlationId?: string, failOnMissingMeetingInfo?: boolean, callStateForMetrics?: CallStateForMetrics, meetingInfo?: any, meetingLookupUrl?: any, sessionCorrelationId?: string): any;
     /**
      * Create meeting
      *

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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,217 @@
+/// <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

@@ -0,0 +1,48 @@
+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

@@ -0,0 +1,16 @@
+/*!
+ * 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;

package/dist/webinar/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @class Webinar
+ */
+declare const Webinar: any;
+export default Webinar;

package/dist/webinar/index.js

@@ -62,7 +62,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
   updateCanManageWebcast: function updateCanManageWebcast(canManageWebcast) {
     this.set('canManageWebcast', canManageWebcast);
   },
-  version: "3.5.0"
+  version: "3.6.0"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map