@webex/plugin-meetings 3.0.0-stream-classes.1 → 3.0.0-stream-classes.2

package/dist/types/recording-controller/util.d.ts

@@ -1,9 +1,10 @@
+import { SELF_POLICY } from '../constants';
 import RecordingAction from './enums';
 declare const _default: {
-    canUserStart: (displayHints: string[]) => boolean;
-    canUserPause: (displayHints: string[]) => boolean;
-    canUserResume: (displayHints: string[]) => boolean;
-    canUserStop: (displayHints: string[]) => boolean;
+    canUserStart: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
+    canUserPause: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
+    canUserResume: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
+    canUserStop: (displayHints: string[], userPolicies: Record<SELF_POLICY, boolean>) => boolean;
     deriveRecordingStates: (action: RecordingAction) => {
         recording: boolean;
         paused: boolean;

package/dist/types/roap/request.d.ts

@@ -1,4 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
+import { IP_VERSION } from '../constants';
 import { LocusMediaRequest } from '../meeting/locusMediaRequest';
 /**
  * @class RoapRequest
@@ -28,6 +29,7 @@ export default class RoapRequest extends StatelessWebexPlugin {
         locusSelfUrl: string;
         mediaId: string;
         meetingId: string;
+        ipVersion: IP_VERSION;
         locusMediaRequest?: LocusMediaRequest;
     }): Promise<{
         mediaConnections: any;

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,47 @@
+/**
+ * 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;
+    /**
+     * 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}
+     */
+    private checkMetrics;
+    /**
+     * 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;
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+    private sendMetrics;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-stream-classes.01",
+  "version": "3.0.0-stream-classes.02",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [

package/dist/common/browser-detection.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="lodash" />
-declare const _default: ((agent?: any) => {
-    getOSName: () => any;
-    getOSVersion: () => any;
-    getBrowserName: () => any;
-    getBrowserVersion: () => any;
-    isBrowser: (name: any) => boolean;
-}) & import("lodash").MemoizedFunction;
-export default _default;

package/dist/common/collection.d.ts

@@ -1,48 +0,0 @@
-/**
- * @class Collection
- */
-export default class Collection {
-    namespace: string;
-    propertyName: string;
-    /**
-     * @param {String} property
-     * @memberof Collection
-     */
-    constructor(property: string);
-    /**
-     * @param {String} id ID of the thing stuffed into the collection at id location
-     * @returns {Any} returns whatever is being stuffed into the collection
-     * @public
-     * @memberof Collection
-     */
-    get(id: string): any;
-    /**
-     * @param {String} id the id of the meeting info instance to add to the collection
-     * @param {Any} value the thing to set in the collection
-     * @returns {Any} returns the thing just put in the collection
-     * @public
-     * @memberof Collection
-     */
-    set(id: string, value: any): any;
-    /**
-     * remove the thing at the id
-     * @param {String} id ID of the thing you wish to delete from the collection
-     * @returns {undefined}
-     * @public
-     * @memberof Collection
-     */
-    delete(id: string): void;
-    /**
-     * @returns {Object} returns an object map of things stuffed into the collection
-     * @public
-     * @memberof Collection
-     */
-    getAll(): any;
-    /**
-     * @param {Object} set the replacement object
-     * @returns {Object} returns an object map of things stuffed into the collection
-     * @public
-     * @memberof Collection
-     */
-    setAll(set: object): any;
-}

package/dist/common/config.d.ts

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

package/dist/common/errors/captcha-error.d.ts

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

package/dist/common/errors/intent-to-join.d.ts

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

package/dist/common/errors/join-meeting.d.ts

@@ -1,17 +0,0 @@
-/**
- * Extended Error object to signify a join meeting error
- */
-export default class JoinMeetingError extends Error {
-    code: any;
-    error: any;
-    joinOptions: any;
-    sdkMessage: any;
-    /**
-     *
-     * @constructor
-     * @param {Object} [options]
-     * @param {String} [message]
-     * @param {Object} [error]
-     */
-    constructor(options?: object, message?: string, error?: any);
-}

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

@@ -1,15 +0,0 @@
-/**
- * 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/common/errors/parameter.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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/common/errors/password-error.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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/common/errors/permission.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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/common/errors/reconnection-in-progress.d.ts

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

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

@@ -1,15 +0,0 @@
-/**
- * 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/common/errors/stats.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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/common/errors/webex-errors.d.ts

@@ -1,81 +0,0 @@
-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 - 'User has not established media yet'
- */
-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 InvalidSdpError
- * @classdesc Raised whenever SDP generated via browser is invalid.
- * @extends WebexMeetingsError
- * @property {number} code - 30201
- * @property {string} message - 'user is still in the lobby or not joined'
- */
-declare class InvalidSdpError extends WebexMeetingsError {
-    static CODE: number;
-    constructor(message: any);
-}
-export { InvalidSdpError };
-/**
- * @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/common/errors/webex-meetings-error.d.ts

@@ -1,20 +0,0 @@
-/**
- * @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/common/events/events-scope.d.ts

@@ -1,17 +0,0 @@
-/// <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/common/events/events.d.ts

@@ -1,12 +0,0 @@
-/// <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/common/events/trigger-proxy.d.ts

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

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

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

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

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

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

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

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

@@ -1,34 +0,0 @@
-/**
- * @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<string>;
-}

package/dist/common/queue.d.ts

@@ -1,32 +0,0 @@
-/**
- * Simple queue
- */
-export default class SimpleQueue {
-    queue: any[];
-    /**
-     * @constructs SimpleQueue
-     */
-    constructor();
-    /**
-     * 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: object): void;
-    /**
-     * Returns and removes the head of the queue.
-     * Returns null if the queue is empty.
-     * @returns {(object|null)} Queue item or null.
-     */
-    dequeue(): any;
-    /**
-     * Returns the number of items in queue.
-     * @returns {number}
-     */
-    size(): number;
-}

package/dist/config.d.ts

@@ -1,73 +0,0 @@
-declare const _default: {
-    meetings: {
-        deviceType: any;
-        mediaSettings: {
-            sendAudio: boolean;
-            sendVideo: boolean;
-            receiveAudio: boolean;
-            receiveVideo: boolean;
-            pstn: boolean;
-            sendShare: boolean;
-            receiveShare: 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;
-        experimental: {
-            enableMediaNegotiatedEvent: boolean;
-            enableUnifiedMeetings: boolean;
-            enableAdhocMeetings: boolean;
-            enableTurnDiscovery: boolean;
-        };
-    };
-};
-export default _default;