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

package/dist/types/@webex/plugin-meetings/src/media/properties.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @class MediaProperties
+ */
+export default class MediaProperties {
+    audioTrack: any;
+    localQualityLevel: any;
+    mediaDirection: any;
+    mediaSettings: any;
+    webrtcMediaConnection: any;
+    remoteAudioTrack: any;
+    remoteQualityLevel: any;
+    remoteShare: any;
+    remoteVideoTrack: any;
+    shareTrack: any;
+    videoDeviceId: any;
+    videoTrack: any;
+    namespace: string;
+    /**
+     * @param {Object} [options] -- to auto construct
+     * @returns {MediaProperties}
+     */
+    constructor(options?: any);
+    /**
+     * Retrieves the preferred video input device
+     * @returns {Object|null}
+     */
+    getVideoDeviceId(): any;
+    setMediaDirection(mediaDirection: any): void;
+    setMediaSettings(type: any, values: any): void;
+    setMediaPeerConnection(mediaPeerConnection: any): void;
+    setLocalVideoTrack(videoTrack: any): void;
+    setLocalAudioTrack(audioTrack: any): void;
+    setLocalQualityLevel(localQualityLevel: any): void;
+    setLocalShareTrack(shareTrack: any): void;
+    setRemoteQualityLevel(remoteQualityLevel: any): void;
+    setRemoteShare(remoteShare: any): void;
+    /**
+     * Sets the remote audio track
+     * @param {MediaTrack} remoteAudioTrack MediaTrack to save
+     * @returns {void}
+     */
+    setRemoteAudioTrack(remoteAudioTrack: any): void;
+    /**
+     * Sets the remote video track
+     * @param {MediaTrack} remoteVideoTrack MediaTrack to save
+     * @returns {void}
+     */
+    setRemoteVideoTrack(remoteVideoTrack: any): void;
+    /**
+     * Stores the preferred video input device
+     * @param {string} deviceId Preferred video input device
+     * @returns {void}
+     */
+    setVideoDeviceId(deviceId: string): void;
+    unsetPeerConnection(): void;
+    unsetLocalVideoTrack(): void;
+    unsetLocalShareTrack(): void;
+    unsetLocalAudioTrack(): void;
+    /**
+     * Removes remote stream from class instance
+     * @deprecated after v1.89.3
+     * @returns {void}
+     */
+    unsetRemoteStream(): void;
+    /**
+     * Removes both remote audio and video from class instance
+     * @returns {void}
+     */
+    unsetRemoteMedia(): void;
+    unsetRemoteShare(): void;
+    unsetLocalVideoTracks(): void;
+    /**
+     * Removes remote stream and remote share from class instance
+     * @deprecated after v1.89.3
+     * @returns {void}
+     */
+    unsetRemoteStreams(): void;
+    /**
+     * Unsets all remote tracks
+     * @returns {void}
+     */
+    unsetRemoteTracks(): void;
+    unsetShareStreams(): void;
+    /**
+     * Removes both local and remote video stream from class instance
+     * @deprecated after v1.89.3
+     * @returns {void}
+     */
+    unsetMediaStreams(): void;
+    /**
+     * Removes both local and remote video stream from class instance
+     * @returns {void}
+     */
+    unsetMediaTracks(): void;
+    /**
+     * Waits for the webrtc media connection to be connected.
+     *
+     * @returns {Promise<void>}
+     */
+    waitForMediaConnectionConnected(): Promise<void>;
+    /**
+     * Returns the type of a connection that has been established
+     *
+     * @returns {Promise<'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'>}
+     */
+    getCurrentConnectionType(): Promise<string>;
+}

package/dist/types/@webex/plugin-meetings/src/media/util.d.ts

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

package/dist/types/@webex/plugin-meetings/src/mediaQualityMetrics/config.d.ts

@@ -0,0 +1,365 @@
+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: {
+        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: {
+        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: {
+        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: {
+        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;
+    }[];
+};
+export declare const emptyVideoShareReceive: {
+    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: {
+        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 emptyVideoShareTransmit: {
+    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: {
+        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/@webex/plugin-meetings/src/meeting/effectsState.d.ts

@@ -0,0 +1,42 @@
+declare const createEffectsState: (type: any) => EffectsState;
+declare class EffectsState {
+    effectType: any;
+    pendingPromiseReject: any;
+    pendingPromiseResolve: any;
+    state: any;
+    constructor(type: any);
+    /**
+     * @memberof EffectsState
+     * @param {Boolean} [isEnable] true for enableBNR, false for disableBNR request
+     * @param {Object} [meeting] the meeting object
+     * @returns {Promise}
+     */
+    handleClientRequest(isEnable?: boolean, meeting?: object): Promise<unknown>;
+    /**
+     * Internal API to return status of BNR
+     * @memberof EffectsState
+     * @returns {Boolean}
+     * @public
+     * @memberof Meeting
+     */
+    isBnrEnabled(): boolean;
+    resolvePromise(): void;
+    rejectPromise(e: any): void;
+    /**
+     * enableBNR API
+     * @param {Object} meeting the meeting object
+     * @returns {Promise<Boolean>}
+     * @public
+     * @memberof EffectsState
+     */
+    enableBNR(meeting: any): Promise<void>;
+    /**
+     * disableBNR API
+     * @param {Object} meeting the meeting object
+     * @returns {Promise<Boolean>}
+     * @public
+     * @memberof EffectsState
+     */
+    disableBNR(meeting: any): Promise<void>;
+}
+export default createEffectsState;

package/dist/types/@webex/plugin-meetings/src/meeting/in-meeting-actions.d.ts

@@ -0,0 +1,83 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * IInMeetingActions
+ * Type for In-Meeting Actions
+ */
+interface IInMeetingActions {
+    canInviteNewParticipants?: boolean;
+    canAdmitParticipant?: boolean;
+    canLock?: boolean;
+    canUnlock?: boolean;
+    canSetMuteOnEntry?: boolean;
+    canUnsetMuteOnEntry?: boolean;
+    canSetDisallowUnmute?: boolean;
+    canUnsetDisallowUnmute?: boolean;
+    canAssignHost?: boolean;
+    canStartRecording?: boolean;
+    canPauseRecording?: boolean;
+    canResumeRecording?: boolean;
+    canStopRecording?: boolean;
+    canRaiseHand?: boolean;
+    canLowerAllHands?: boolean;
+    canLowerSomeoneElsesHand?: boolean;
+    bothLeaveAndEndMeetingAvailable?: boolean;
+    canEnableClosedCaption?: boolean;
+    canStartTranscribing?: boolean;
+    canStopTranscribing?: boolean;
+    isClosedCaptionActive?: boolean;
+    isWebexAssistantActive?: boolean;
+    canViewCaptionPanel?: boolean;
+    isRealTimeTranslationEnabled?: boolean;
+    canSelectSpokenLanguages?: boolean;
+    waitingForOthersToJoin?: boolean;
+    canEnableReactions?: boolean;
+    canSendReactions?: boolean;
+}
+/**
+ * @class InMeetingActions
+ */
+export default class InMeetingActions implements IInMeetingActions {
+    namespace: string;
+    canInviteNewParticipants: any;
+    canAdmitParticipant: any;
+    canLock: any;
+    canUnlock: any;
+    canAssignHost: any;
+    canStartRecording: any;
+    canPauseRecording: any;
+    canResumeRecording: any;
+    canStopRecording: any;
+    canSetMuteOnEntry: any;
+    canUnsetMuteOnEntry: any;
+    canSetDisallowUnmute: any;
+    canUnsetDisallowUnmute: any;
+    canRaiseHand: any;
+    canLowerAllHands: any;
+    canLowerSomeoneElsesHand: any;
+    bothLeaveAndEndMeetingAvailable: any;
+    canEnableClosedCaption: any;
+    canStartTranscribing: any;
+    canStopTranscribing: any;
+    isClosedCaptionActive: any;
+    isWebexAssistantActive: any;
+    canViewCaptionPanel: any;
+    isRealTimeTranslationEnabled: any;
+    canSelectSpokenLanguages: any;
+    waitingForOthersToJoin: any;
+    canEnableReactions: any;
+    canSendReactions: any;
+    /**
+     * Returns all meeting action options
+     * @returns {Object}
+     */
+    get: () => IInMeetingActions;
+    /**
+     *
+     * @param actions
+     * @returns
+     */
+    set: (actions: Partial<IInMeetingActions>) => boolean;
+}
+export {};