@webex/jsdoctrinetest 3.0.0-beta.8 → 3.0.0-bnr.0

package/dist/types/@webex/plugin-meetings/src/statsAnalyzer/index.d.ts

@@ -0,0 +1,195 @@
+/// <reference types="node" />
+import EventsScope from '../common/events/events-scope';
+export declare const EVENTS: {
+    MEDIA_QUALITY: string;
+    LOCAL_MEDIA_STARTED: string;
+    LOCAL_MEDIA_STOPPED: string;
+    REMOTE_MEDIA_STARTED: string;
+    REMOTE_MEDIA_STOPPED: string;
+};
+/**
+ * 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;
+    /**
+     * Creates a new instance of StatsAnalyzer
+     * @constructor
+     * @public
+     * @param {Object} config SDK Configuration Object
+     * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
+     * @param {Object} statsResults Default properties for stats
+     */
+    constructor(config: any, 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: object): 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Process Track results
+     *
+     * @private
+     * @param {*} result
+     * @param {*} mediaType
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    private processTrackResult;
+    /**
+     *
+     * @private
+     * @param {*} result
+     * @param {*} type
+     * @returns {void}
+     * @memberof StatsAnalyzer
+     */
+    compareSentAndReceived(result: any, type: any): void;
+}

package/dist/types/@webex/plugin-meetings/src/statsAnalyzer/mqaUtil.d.ts

@@ -0,0 +1,24 @@
+export declare const getAudioReceiverMqa: ({ audioReceiver, statsResults, lastMqaDataSent, mediaType }: {
+    audioReceiver: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;
+export declare const getAudioSenderMqa: ({ audioSender, statsResults, lastMqaDataSent, mediaType }: {
+    audioSender: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;
+export declare const getVideoReceiverMqa: ({ videoReceiver, statsResults, lastMqaDataSent, mediaType }: {
+    videoReceiver: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;
+export declare const getVideoSenderMqa: ({ videoSender, statsResults, lastMqaDataSent, mediaType }: {
+    videoSender: any;
+    statsResults: any;
+    lastMqaDataSent: any;
+    mediaType: any;
+}) => void;

package/dist/types/@webex/plugin-meetings/src/transcription/index.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @description Meeting Webex assistance transcription feature.
+ * @exports
+ * @class Transcription
+ */
+export default class Transcription {
+    webSocketUrl: any;
+    sessionID: any;
+    members: any;
+    memberCSIs: any;
+    webSocket: any;
+    /**
+     * @param {string} webSocketUrl
+     * @param {sessionID} sessionId
+     * @param {object} members
+     * @constructor
+     * @memberof Transcription
+     */
+    constructor(webSocketUrl: string, sessionId: any, members: object);
+    /**
+     * open the Low Latency Mercury connection
+     * An event parameter will be send to the callback.
+     *
+     * @param {string} token
+     * @param {string} sessionID
+     * @returns {void}
+     */
+    connect(token: string): void;
+    /**
+     * Sets callback to invoke when the web socket connection is closed.
+     *
+     * @param {Function} callback
+     * @returns {void}
+     */
+    onCloseSocket(callback: any): void;
+    /**
+     * Sets callback to invoke when a web socket connection error occurs.
+     * An event parameter will be send to the callback.
+     *
+     * @param {Function} callback
+     * @returns {void}
+     */
+    onErrorSocket(callback: any): void;
+    /**
+     * Get current speaker from the given csis payload and update the global csis map
+     *
+     * @private
+     * @param {object} csis
+     * @returns {object}
+     */
+    private getSpeaker;
+    /**
+     * Sends transcription data to given callback as it arrives.
+     *
+     * @param {Function} callback
+     * @returns {void}
+     */
+    subscribe(callback: any): void;
+    /**
+     * Close the LLM web socket connection
+     * @returns {void}
+     */
+    closeSocket(): void;
+}

package/dist/types/@webex/plugin-meetings/test/integration/spec/converged-space-meetings.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/integration/spec/journey.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/integration/spec/space-meeting.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/integration/spec/transcription.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/breakouts/breakout.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/breakouts/collection.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/breakouts/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/breakouts/request.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/breakouts/utils.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/common/browser-detection.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/common/queue.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/controls-options-manager/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/controls-options-manager/util.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/fixture/locus.d.ts

@@ -0,0 +1,332 @@
+declare namespace _default {
+    const url: string;
+    const created: string;
+    namespace info {
+        const topic: string;
+        const sipUri: string;
+        const maxParticipants: number;
+        const webExRosterSyncEnabled: boolean;
+        const webExMeetingId: string;
+        const globalMeetingId: string;
+        const webExSite: string;
+        const webExMeetingName: string;
+        const isPmr: boolean;
+        const webexServiceType: string;
+        const meetingAvatarUrl: string;
+        const owner: string;
+        const siteOrgId: string;
+        const callInTollNumber: string;
+        const callInNumbers: {
+            number: string;
+            tollfree: boolean;
+            label: string;
+        }[];
+        const isSparkPstnEnabled: boolean;
+        const isCallInEnabled: boolean;
+        const isGlobalCallInEnabled: boolean;
+        const isCallOutEnabled: boolean;
+        const isGlobalCallOutEnabled: boolean;
+        namespace displayHints {
+            const joined: string[];
+            const moderator: string[];
+            const coHost: string[];
+        }
+        const venueUrl: string;
+        const datachannelUrl: string;
+        const embeddedAppsListUrl: string;
+        const embeddedAppsLaunchUrl: string;
+        const meetingInstanceId: string;
+        const webexSiteUuid: string;
+    }
+    namespace host {
+        const id: string;
+        const name: string;
+        const isExternal: boolean;
+        const orgId: string;
+        const incomingCallProtocols: any[];
+    }
+    namespace fullState {
+        const active: boolean;
+        const count: number;
+        const locked: boolean;
+        const state: string;
+        const type: string;
+        const lastActive: string;
+        const sessionIds: any[];
+        const sessionId: string;
+    }
+    const meetings: any[];
+    namespace controls {
+        namespace lock {
+            const locked_1: boolean;
+            export { locked_1 as locked };
+            export const meta: {};
+        }
+        namespace record {
+            export const recording: boolean;
+            export namespace meta_1 {
+                const readOnly: boolean;
+            }
+            export { meta_1 as meta };
+        }
+        namespace transcribe {
+            export const transcribing: boolean;
+            export const postMeetingTranscribing: boolean;
+            export const caption: boolean;
+            const meta_2: {};
+            export { meta_2 as meta };
+        }
+        namespace meetingFull {
+            const meetingFull_1: boolean;
+            export { meetingFull_1 as meetingFull };
+            const meta_3: {};
+            export { meta_3 as meta };
+        }
+        namespace muteOnEntry {
+            export const enabled: boolean;
+            const meta_4: {};
+            export { meta_4 as meta };
+        }
+        namespace shareControl {
+            export const control: string;
+            const meta_5: {};
+            export { meta_5 as meta };
+        }
+        namespace disallowUnmute {
+            const enabled_1: boolean;
+            export { enabled_1 as enabled };
+            const meta_6: {};
+            export { meta_6 as meta };
+        }
+        namespace videoLayout {
+            namespace layoutName {
+                const defaultName: string;
+                const singleScreenDefaultName: string;
+            }
+        }
+        namespace reactions {
+            const enabled_2: boolean;
+            export { enabled_2 as enabled };
+            export namespace meta_7 {
+                const modifiedBy: string;
+                const lastModified: string;
+            }
+            export { meta_7 as meta };
+            export const reactionChannelUrl: string;
+            export const showDisplayNameWithReactions: boolean;
+        }
+        namespace viewTheParticipantList {
+            const enabled_3: boolean;
+            export { enabled_3 as enabled };
+            export namespace meta_8 {
+                const lastModified_1: string;
+                export { lastModified_1 as lastModified };
+            }
+            export { meta_8 as meta };
+        }
+    }
+    const participants: {
+        isCreator: boolean;
+        identity: string;
+        url: string;
+        state: string;
+        type: string;
+        isSiteInternal: boolean;
+        person: {
+            id: string;
+            name: string;
+            isExternal: boolean;
+            orgId: string;
+            incomingCallProtocols: any[];
+        };
+        devices: {
+            url: string;
+            deviceType: string;
+            state: string;
+            intents: any[];
+            correlationId: string;
+            isVideoCallback: boolean;
+            csis: any[];
+            replaces: any[];
+        }[];
+        status: {
+            audioStatus: string;
+            videoStatus: string;
+            csis: any[];
+        };
+        controls: {
+            audio: {
+                muted: boolean;
+                requestedToUnmute: boolean;
+                disallowUnmute: boolean;
+                meta: {};
+            };
+            video: {
+                muted: boolean;
+                meta: {};
+            };
+            role: {
+                roles: ({
+                    type: string;
+                    hasRole: boolean;
+                    meta: {
+                        lastModified: string;
+                        readOnly?: undefined;
+                    };
+                } | {
+                    type: string;
+                    hasRole: boolean;
+                    meta: {
+                        lastModified: string;
+                        readOnly: boolean;
+                    };
+                })[];
+            };
+        };
+        doesNotSupportBreakouts: boolean;
+        identityTrustLevel: string;
+        id: string;
+        guest: boolean;
+        resourceGuest: boolean;
+        moderator: boolean;
+        panelist: boolean;
+        moveToLobbyNotAllowed: boolean;
+        cmrHost: boolean;
+        deviceUrl: string;
+    }[];
+    namespace self {
+        export const deviceUrl: string;
+        export namespace alertHint {
+            const action: string;
+        }
+        export namespace alertType {
+            const action_1: string;
+            export { action_1 as action };
+        }
+        export namespace callbackInfo {
+            const callbackAddress: string;
+            const callbackType: string;
+        }
+        export namespace lookUpInfo {
+            export const lookupLink: string;
+            const type_1: string;
+            export { type_1 as type };
+        }
+        export const isCreator: boolean;
+        export const identity: string;
+        const url_1: string;
+        export { url_1 as url };
+        const state_1: string;
+        export { state_1 as state };
+        const type_2: string;
+        export { type_2 as type };
+        export namespace person {
+            const id_1: string;
+            export { id_1 as id };
+            const name_1: string;
+            export { name_1 as name };
+            const isExternal_1: boolean;
+            export { isExternal_1 as isExternal };
+            const orgId_1: string;
+            export { orgId_1 as orgId };
+            const incomingCallProtocols_1: any[];
+            export { incomingCallProtocols_1 as incomingCallProtocols };
+        }
+        export const devices: {
+            url: string;
+            deviceType: string;
+            state: string;
+            intents: any[];
+            keepAliveUrl: string;
+            keepAliveSecs: number;
+            callLegId: string;
+            correlationId: string;
+            isVideoCallback: boolean;
+            csis: any[];
+            serverTranscoded: boolean;
+            serverComposed: boolean;
+            replaces: any[];
+        }[];
+        export namespace status {
+            const audioStatus: string;
+            const videoStatus: string;
+            const csis: any[];
+        }
+        export const suggestedMedia: {
+            mediaType: string;
+            mediaContent: string;
+            direction: string;
+        }[];
+        export namespace controls_1 {
+            namespace audio {
+                export const muted: boolean;
+                export const requestedToUnmute: boolean;
+                const disallowUnmute_1: boolean;
+                export { disallowUnmute_1 as disallowUnmute };
+                const meta_9: {};
+                export { meta_9 as meta };
+            }
+            namespace video {
+                const muted_1: boolean;
+                export { muted_1 as muted };
+                const meta_10: {};
+                export { meta_10 as meta };
+            }
+            namespace role {
+                const roles: ({
+                    type: string;
+                    hasRole: boolean;
+                    meta: {
+                        lastModified: string;
+                        readOnly?: undefined;
+                    };
+                } | {
+                    type: string;
+                    hasRole: boolean;
+                    meta: {
+                        lastModified: string;
+                        readOnly: boolean;
+                    };
+                })[];
+            }
+        }
+        export { controls_1 as controls };
+        export const enableDTMF: boolean;
+        const id_2: string;
+        export { id_2 as id };
+        export const guest: boolean;
+        export const resourceGuest: boolean;
+        const moderator_1: boolean;
+        export { moderator_1 as moderator };
+        export const panelist: boolean;
+        export const moveToLobbyNotAllowed: boolean;
+        export const cmrHost: boolean;
+        export const mediaBaseUrl: string;
+    }
+    const mediaShares: {
+        name: string;
+        url: string;
+    }[];
+    const embeddedApps: any[];
+    const replaces: any[];
+    namespace sequence {
+        const entries: number[];
+        const rangeStart: number;
+        const rangeEnd: number;
+        const since: string;
+        const sequenceHash: number;
+        const dataCenter: string;
+        const totalParticipants: number;
+        const dirtyParticipants: number;
+    }
+    const syncUrl: string;
+    namespace links {
+        namespace services {
+            namespace breakout {
+                const url_2: string;
+                export { url_2 as url };
+            }
+        }
+    }
+}
+export default _default;

package/dist/types/@webex/plugin-meetings/test/unit/spec/locus-info/controlsUtils.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/locus-info/embeddedAppsUtils.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/locus-info/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/locus-info/infoUtils.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/@webex/plugin-meetings/test/unit/spec/locus-info/parser.d.ts

@@ -0,0 +1 @@
+export {};