@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.200

package/dist/types/common/errors/media.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for media errors
+ */
+export default class MediaError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/common/errors/parameter.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class ParameterError extends Error {
+    sdkMessage: string;
+    error: null;
+    code: number;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/common/errors/password-error.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify password related errors
+ */
+export default class PasswordError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/common/errors/permission.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class PermissionError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/common/errors/reconnection-in-progress.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ *
+ * @export
+ * @class ReconnectInProgress
+ * @extends {Error}
+ */
+export default class ReconnectInProgress extends Error {
+}

package/dist/types/common/errors/reconnection.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify the intent to join for unclaimed PMR scenarios
+ */
+export default class ReconnectionError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/common/errors/stats.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for Stats Errors
+ */
+export default class StatsError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/types/common/errors/webex-errors.d.ts

@@ -0,0 +1,69 @@
+import WebexMeetingsError from './webex-meetings-error';
+/**
+ * Create a {@link WebexMeetingsError} for a given code and message.
+ * @private
+ * @param {number} [code] - Error code
+ * @param {string} [message] - Error message
+ * @returns {WebexMeetingsError}
+ */
+export declare function createMeetingsError(code?: number, message?: string): any;
+/**
+ * @class MeetingNotActiveError
+ * @classdesc Raised whenever Meeting has already ended and user tries to do a action.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30101
+ * @property {string} message - 'Meeting has already Ended or not Active'
+ */
+declare class MeetingNotActiveError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { MeetingNotActiveError };
+/**
+ * @class UserNotJoinedError
+ * @classdesc Raised whenever the user has already left the meeting and user tries to do a action.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30102
+ * @property {string} message - 'User has already left the meeting'
+ */
+declare class UserNotJoinedError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { UserNotJoinedError };
+/**
+ * @class NoMediaEstablishedYetError
+ * @classdesc Raised whenever the user has not established media yet.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30103
+ * @property {string} message - error message
+ */
+declare class NoMediaEstablishedYetError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { NoMediaEstablishedYetError };
+/**
+ * @class UserInLobbyError
+ * @classdesc Raised whenever the user is in lobby and not joined yet.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30104
+ * @property {string} message - 'user is still in the lobby or not joined'
+ */
+declare class UserInLobbyError extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { UserInLobbyError };
+/**
+ * @class IceGatheringFailed
+ * @classdesc Raised whenever ice gathering fails.
+ * @extends WebexMeetingsError
+ * @property {number} code - 30202
+ * @property {string} message - 'user failed ice gathering check network/firewall'
+ */
+declare class IceGatheringFailed extends WebexMeetingsError {
+    static CODE: number;
+    constructor();
+}
+export { IceGatheringFailed };

package/dist/types/common/errors/webex-meetings-error.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @extends Error
+ * @property {number} code - Error code
+ */
+export default class WebexMeetingsError extends Error {
+    code: any;
+    /**
+     * Creates a new {@link WebexMeetingsError}
+     * @param {number} code - Error code
+     * @param {string} [message] - Error message
+     * @param {string} [fileName] - Name of the script file where error was generated
+     * @param {number} [lineNumber] - Line number of the script file where error was generated
+     */
+    constructor(code: number, ...args: any[]);
+    /**
+     * Returns human readable string describing the error.
+     * @returns {string}
+     */
+    toString(): string;
+}

package/dist/types/common/events/events-scope.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+import ChildEmitter from 'events';
+/**
+ * Events
+ * plugin-meetings local
+ * Used to emit events internally between modules specific to an object
+ */
+export default class EventsScope extends ChildEmitter {
+    /**
+     * Emits and logs an event
+     * @param {*} scope
+     * @param {*} eventName
+     * @param {*} args
+     * @returns {Function}
+     */
+    emit(scope: any, eventName: any, args: any): boolean;
+}

package/dist/types/common/events/events.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+/**
+ * Events
+ * plugin-meetings global
+ * Used to emit events internally between modules
+ */
+declare class Events extends EventEmitter {
+    emit(scope: any, eventName: any, args: any): boolean;
+}
+declare const _default: Events;
+export default _default;

package/dist/types/common/events/trigger-proxy.d.ts

@@ -0,0 +1,2 @@
+declare const TriggerProxy: any;
+export default TriggerProxy;

package/dist/types/common/events/util.d.ts

@@ -0,0 +1,2 @@
+declare const EventsUtil: any;
+export default EventsUtil;

package/dist/types/common/logs/logger-config.d.ts

@@ -0,0 +1,2 @@
+declare const LoggerConfig: any;
+export default LoggerConfig;

package/dist/types/common/logs/logger-proxy.d.ts

@@ -0,0 +1,2 @@
+declare const LoggerProxy: any;
+export default LoggerProxy;

package/dist/types/common/logs/request.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @class LogsRequest
+ */
+export default class LogsRequest {
+    webex: any;
+    /**
+     *
+     * @param {Object} options
+     * @param {Object} options.webex Webex SDK instance
+     * @param {ClientMetrics} metrics
+     */
+    constructor(options: {
+        webex: object;
+    });
+    /**
+     * Uploads logs to the support server
+     *
+     * @param {Object} [options={}]
+     * @param {String} [options.feedbackId=uuid.v4] ID used for tracking
+     * @param {String} [options.locusId]
+     * @param {String} [options.correlationId]
+     * @param {String} [options.callStart] Call Start Time
+     * @param {String} [options.meetingId] webex meeting ID
+     * @returns {Promise.<String>} Feedback ID
+     * @memberof LogsRequest
+     */
+    uploadLogs(options?: {
+        feedbackId?: string;
+        locusId?: string;
+        correlationId?: string;
+        callStart?: string;
+        meetingId?: string;
+    }): Promise<any>;
+}

package/dist/types/common/queue.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Simple queue in which the elements are always sorted
+ */
+export default class SortedQueue<ItemType> {
+    queue: ItemType[];
+    compareFunc: (left: ItemType, right: ItemType) => number;
+    /**
+     * @constructs SortedQueue
+     * @param {Function} compareFunc comparison function used for sorting the elements of the queue
+     */
+    constructor(compareFunc: (left: ItemType, right: ItemType) => number);
+    /**
+     * Removes all of the elements from queue.
+     * @returns {undefined}
+     */
+    clear(): void;
+    /**
+     * Inserts the specified element into the queue.
+     * @param {object} item
+     * @returns {undefined}
+     */
+    enqueue(item: ItemType): void;
+    /**
+     * Returns and removes the head of the queue.
+     * Returns null if the queue is empty.
+     * @returns {(object|null)} Queue item or null.
+     */
+    dequeue(): ItemType;
+    /**
+     * Returns the number of items in queue.
+     * @returns {number}
+     */
+    size(): number;
+}

package/dist/types/config.d.ts

@@ -0,0 +1,72 @@
+declare const _default: {
+    meetings: {
+        deviceType: any;
+        mediaSettings: {
+            pstn: boolean;
+        };
+        reconnection: {
+            enabled: boolean;
+            autoRejoin: boolean;
+            detection: boolean;
+            iceReconnectionTimeout: number;
+            maxRejoinAttempts: number;
+        };
+        stats: {
+            enableStatsAnalyzer: boolean;
+            autoDowngradeEnabled: boolean;
+            interval: number;
+            analyzerInterval: number;
+            historyMax: number;
+            videoPacketLossRatioThreshold: number;
+            rttThreshold: number;
+            jitterThreshold: number;
+        };
+        metrics: {
+            clientName: string;
+            clientType: string;
+            subClientType: string;
+            mqaMetricsInterval: number;
+            autoSendMQA: boolean;
+        };
+        logging: {
+            enable: boolean;
+            verboseEvents: boolean;
+        };
+        resolution: {
+            maxWidth: number;
+            maxHeight: number;
+            idealWidth: number;
+            idealHeight: number;
+        };
+        screenResolution: {
+            maxWidth: number;
+            maxHeight: number;
+            idealWidth: number;
+            idealHeight: number;
+        };
+        bandwidth: {
+            audio: number;
+            video: number;
+            startBitrate: number;
+        };
+        screenFrameRate: number;
+        videoShareFrameRate: number;
+        aspectRatio: number;
+        autoUploadLogs: boolean;
+        enableRtx: boolean;
+        receiveTranscription: boolean;
+        enableExtmap: boolean;
+        enableAutomaticLLM: boolean;
+        installedOrgID: any;
+        experimental: {
+            enableMediaNegotiatedEvent: boolean;
+            enableUnifiedMeetings: boolean;
+            enableAdhocMeetings: boolean;
+            enableTurnDiscovery: boolean;
+        };
+        degradationPreferences: {
+            maxMacroblocksLimit: number;
+        };
+    };
+};
+export default _default;