@webex/plugin-meetings 3.7.0-wxcc.1 → 3.8.0

package/dist/types/constants.d.ts

@@ -139,7 +139,7 @@ export declare const RETRY_TIMEOUT = 3000;
 export declare const ICE_AND_DTLS_CONNECTION_TIMEOUT = 20000;
 export declare const ROAP_OFFER_ANSWER_EXCHANGE_TIMEOUT = 35000;
 export declare const WEBINAR_ERROR_WEBCAST: number[];
-export declare const WEBINAR_ERROR_REGISTRATIONID: number[];
+export declare const WEBINAR_ERROR_REGISTRATION_ID: number[];
 export declare const JOIN_BEFORE_HOST = 403003;
 export declare const DIALER_REGEX: {
     SIP_ADDRESS: RegExp;
@@ -1110,14 +1110,21 @@ export declare const PASSWORD_STATUS: {
     UNKNOWN: string;
     VERIFIED: string;
 };
+export declare const REGISTRATION_ID_STATUS: {
+    NOT_REQUIRED: string;
+    REQUIRED: string;
+    UNKNOWN: string;
+    VERIFIED: string;
+};
 export declare const MEETING_INFO_FAILURE_REASON: {
     NONE: string;
     WRONG_PASSWORD: string;
     WRONG_CAPTCHA: string;
+    WRONG_REGISTRATION_ID: string;
     POLICY: string;
     WEBINAR_REGISTRATION: string;
     NEED_JOIN_WITH_WEBCAST: string;
-    WEBINAR_NEED_REGISTRATIONID: string;
+    WEBINAR_NEED_REGISTRATION_ID: string;
     NOT_REACH_JBH: string;
     JOIN_FORBIDDEN: string;
     OTHER: string;

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/brbState.d.ts

@@ -0,0 +1,54 @@
+import type Meeting from '.';
+import SendSlotManager from '../multistream/sendSlotManager';
+export declare const createBrbState: (meeting: Meeting, enabled: boolean) => BrbState;
+/** The purpose of this class is to manage the local and remote brb state
+ * and make sure that the server state always matches the last requested state by the client.
+ */
+export declare class BrbState {
+    state: {
+        client: {
+            enabled: boolean;
+        };
+        server: {
+            enabled: boolean;
+        };
+        syncToServerInProgress: boolean;
+    };
+    meeting: Meeting;
+    /**
+     * Constructor
+     *
+     * @param {Meeting} meeting - the meeting object
+     * @param {boolean} enabled - whether the client audio/video is enabled at all
+     */
+    constructor(meeting: Meeting, enabled: boolean);
+    /**
+     * Enables/disables brb
+     *
+     * @param {boolean} enabled
+     * @param {SendSlotManager} sendSlotManager
+     * @returns {Promise}
+     */
+    enable(enabled: boolean, sendSlotManager: SendSlotManager): Promise<void>;
+    /**
+     * Updates the server local and remote brb values so that they match the current client desired state.
+     *
+     * @param {SendSlotManager} sendSlotManager
+     * @returns {Promise}
+     */
+    private applyClientStateToServer;
+    /**
+     * Send the local brb state to the server
+     *
+     * @param {SendSlotManager} sendSlotManager
+     * @returns {Promise}
+     */
+    private sendLocalBrbStateToServer;
+    /**
+     * This method should be called whenever the server brb state is changed
+     *
+     * @param {Boolean} [enabled] true if user has brb enabled, false otherwise
+     * @returns {undefined}
+     */
+    handleServerBrbUpdate(enabled?: boolean): void;
+}

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

@@ -19,6 +19,7 @@ import InMeetingActions from './in-meeting-actions';
 import RecordingController from '../recording-controller';
 import ControlsOptionsManager from '../controls-options-manager';
 import { LocusMediaRequest } from './locusMediaRequest';
+import { BrbState } from './brbState';
 export type CaptionData = {
     id: string;
     isFinal: boolean;
@@ -83,6 +84,7 @@ export declare enum ScreenShareFloorStatus {
 }
 type FetchMeetingInfoParams = {
     password?: string;
+    registrationId?: string;
     captchaCode?: string;
     extraParams?: Record<string, any>;
     sendCAevents?: boolean;
@@ -449,6 +451,8 @@ export default class Meeting extends StatelessWebexPlugin {
     turnServerUsed: boolean;
     areVoiceaEventsSetup: boolean;
     isMoveToInProgress: boolean;
+    registrationIdStatus: string;
+    brbState: BrbState;
     voiceaListenerCallbacks: object;
     private addMediaData;
     private sendSlotManager;
@@ -578,6 +582,25 @@ export default class Meeting extends StatelessWebexPlugin {
         requiredCaptcha: any;
         failureReason: string;
     }>;
+    /**
+     * Checks if the supplied registrationId is correct. It returns a promise with information whether the
+     * registrationId and captcha code were correct or not.
+     * @param {String | undefined} registrationId - can be undefined if only captcha was required
+     * @param {String | undefined} captchaCode - can be undefined if captcha was not required by the server
+     * @param {Boolean} sendCAevents - whether Call Analyzer events should be sent when fetching meeting information
+     * @public
+     * @memberof Meeting
+     * @returns {Promise<{isRegistrationIdValid: boolean, requiredCaptcha: boolean, failureReason: MEETING_INFO_FAILURE_REASON}>}
+     */
+    verifyRegistrationId(registrationId: string, captchaCode: string, sendCAevents?: boolean): Promise<{
+        isRegistrationIdValid: boolean;
+        requiredCaptcha: any;
+        failureReason: string;
+    } | {
+        isRegistrationIdValid: boolean;
+        requiredCaptcha: any;
+        failureReason: string;
+    }>;
     /**
      * Refreshes the captcha. As a result the meeting will have new captcha id, image and audio.
      * If the refresh operation fails, meeting remains with the old captcha properties.

package/dist/types/meeting-info/meeting-info-v2.d.ts

@@ -52,6 +52,7 @@ export declare class MeetingInfoV2PolicyError extends Error {
 export declare class MeetingInfoV2CaptchaError extends Error {
     captchaInfo: any;
     isPasswordRequired: any;
+    isRegistrationIdRequired: any;
     sdkMessage: any;
     wbxAppApiCode: any;
     body: any;
@@ -156,6 +157,7 @@ export default class MeetingInfoV2 {
      * @param {String} locusId
      * @param {Object} extraParams
      * @param {Object} options
+     * @param {String} registrationId
      * @returns {Promise} returns a meeting info object
      * @public
      * @memberof MeetingInfo
@@ -166,5 +168,5 @@ export default class MeetingInfoV2 {
     }, installedOrgID?: any, locusId?: any, extraParams?: object, options?: {
         meetingId?: string;
         sendCAevents?: boolean;
-    }): Promise<any>;
+    }, registrationId?: string): Promise<any>;
 }

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

@@ -70,6 +70,8 @@ declare const BEHAVIORAL_METRICS: {
     JOIN_WEBINAR_ERROR: string;
     GUEST_ENTERED_LOBBY: string;
     GUEST_EXITED_LOBBY: string;
+    VERIFY_REGISTRATION_ID_SUCCESS: string;
+    VERIFY_REGISTRATION_ID_ERROR: string;
     JOIN_FORBIDDEN_ERROR: string;
 };
 export { BEHAVIORAL_METRICS as default };

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

@@ -99,6 +99,13 @@ export default class Reachability extends EventsScope {
      * @memberof Reachability
      */
     gatherReachabilityFallback(): Promise<void>;
+    /**
+     * Stops all reachability checks that are in progress
+     * @public
+     * @memberof Reachability
+     * @returns {void}
+     */
+    stopReachability(): void;
     /**
      * Returns statistics about last reachability results. The returned value is an object
      * with a flat list of properties so that it can be easily sent with metrics
@@ -201,9 +208,10 @@ export default class Reachability extends EventsScope {
     /**
      * Sends a metric with all the statistics about how long reachability took
      *
+     * @param {boolean} aborted true if the reachability checks were aborted
      * @returns {void}
      */
-    protected sendMetric(): Promise<void>;
+    protected sendMetric(aborted?: boolean): Promise<void>;
     /**
      * Starts all the timers used for various timeouts
      *

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;