@webex/plugin-meetings 3.8.1-next.8 → 3.8.1

package/dist/types/controls-options-manager/enums.d.ts

@@ -12,8 +12,7 @@ declare enum Control {
     video = "video",
     viewTheParticipantList = "viewTheParticipantList",
     annotation = "annotation",
-    rdc = "rdc",
-    pollingQA = "pollingQA"
+    rdc = "rdc"
 }
 export { Control, Setting };
 export default Setting;

package/dist/types/controls-options-manager/types.d.ts

@@ -38,10 +38,7 @@ export interface AnnotationProperties {
 export interface RemoteDesktopControlProperties {
     enabled?: boolean;
 }
-export interface PollingQAProperties {
-    enabled?: boolean;
-}
-export type Properties = AudioProperties | RaiseHandProperties | ReactionsProperties | ShareControlProperties | VideoProperties | ViewTheParticipantListProperties | AnnotationProperties | RemoteDesktopControlProperties | PollingQAProperties;
+export type Properties = AudioProperties | RaiseHandProperties | ReactionsProperties | ShareControlProperties | VideoProperties | ViewTheParticipantListProperties | AnnotationProperties | RemoteDesktopControlProperties;
 export interface ControlConfig<Props = Properties> {
     /**
      * The scope of the control within this object.

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

@@ -103,8 +103,6 @@ interface IInMeetingActions {
     canEnableRemoteDesktopControl?: boolean;
     canDisableRemoteDesktopControl?: boolean;
     canMoveToLobby?: boolean;
-    canEnablePollingQA?: boolean;
-    canDisablePollingQA?: boolean;
 }
 /**
  * @class InMeetingActions
@@ -208,8 +206,6 @@ export default class InMeetingActions implements IInMeetingActions {
     canEnableRemoteDesktopControl: any;
     canDisableRemoteDesktopControl: any;
     canMoveToLobby: any;
-    canEnablePollingQA: any;
-    canDisablePollingQA: any;
     /**
      * Returns all meeting action options
      * @returns {Object}

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

@@ -69,7 +69,6 @@ declare const BEHAVIORAL_METRICS: {
     MEETING_INFO_POLICY_ERROR: string;
     LOCUS_DELTA_SYNC_FAILED: string;
     LOCUS_DELTA_OUT_OF_ORDER: string;
-    LOCUS_SYNC_HANDLING_FAILED: string;
     PERMISSION_TOKEN_REFRESH: string;
     PERMISSION_TOKEN_REFRESH_ERROR: string;
     TURN_DISCOVERY_LATENCY: string;

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

@@ -0,0 +1,70 @@
+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/reachability/index.d.ts

@@ -68,12 +68,12 @@ export default class Reachability extends EventsScope {
     }>;
     /**
      * Checks if the given subnet is reachable
-     * @param {string} selectedSubnetFirstOctet - selected subnet first octet, e.g. "10" for "10.X.X.X"
+     * @param {string} mediaServerIp - media server ip
      * @returns {boolean | null} true if reachable, false if not reachable, null if mediaServerIp is not provided
      * @public
      * @memberof Reachability
      */
-    isSubnetReachable(selectedSubnetFirstOctet: string): boolean | null;
+    isSubnetReachable(mediaServerIp?: string): boolean | null;
     /**
      * Gets a list of media clusters from the backend and performs reachability checks on all the clusters
      * @param {string} trigger - explains the reason for starting reachability

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

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

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

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

@@ -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;