@webex/plugin-meetings 3.7.0 → 3.8.0

package/dist/types/common/errors/{webinar-registration-error.d.ts → join-webinar-error.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Error occurred while the webinar required registration
+ * Error occurred while join the webinar
  */
-export default class WebinarRegistrationError extends Error {
+export default class JoinWebinarError extends Error {
     code: number;
     error: any;
     sdkMessage: string;

package/dist/types/common/errors/multistream-not-supported-error.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Error thrown when we try to do multistream, but fail. This error
+ * is not exported outside of plugin-meetings, because it's handled
+ * internally.
+ */
+export default class MultistreamNotSupportedError 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/config.d.ts

@@ -71,6 +71,7 @@ declare const _default: {
         iceCandidatesGatheringTimeout: any;
         backendIpv6NativeSupport: boolean;
         reachabilityGetClusterTimeout: number;
+        logUploadIntervalMultiplicationFactor: number;
     };
 };
 export default _default;

package/dist/types/constants.d.ts

@@ -24,6 +24,7 @@ export declare const ENDED = "ended";
 export declare const HECATE = "hecate";
 export declare const HOST = "host";
 export declare const JOIN = "join";
+export declare const JOIN_LINK_MTID = "MTID";
 export declare const LEAVE = "leave";
 export declare const LIVE = "live";
 export declare const LOCAL = "local";
@@ -75,6 +76,7 @@ export declare const _ON_HOLD_LOBBY_ = "ON_HOLD_LOBBY";
 export declare const _MEETING_LINK_ = "MEETING_LINK";
 export declare const _MEETING_UUID_ = "MEETING_UUID";
 export declare const _MEETING_ = "MEETING";
+export declare const _SPACE_SHARE_ = "SPACE_SHARE";
 export declare const _MEETING_CENTER_ = "MEETING_CENTER";
 export declare const _MEETING_ID_ = "MEETING_ID";
 export declare const _NOT_IN_MEETING_ = "NOT_IN_MEETING";
@@ -136,6 +138,9 @@ export declare const ICE_FAIL_TIMEOUT = 3000;
 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_REGISTRATION_ID: number[];
+export declare const JOIN_BEFORE_HOST = 403003;
 export declare const DIALER_REGEX: {
     SIP_ADDRESS: RegExp;
     PHONE_NUMBER: RegExp;
@@ -214,6 +219,7 @@ export declare const EVENT_TRIGGERS: {
     MEETING_SELF_CANNOT_VIEW_PARTICIPANT_LIST: string;
     MEETING_SELF_IS_SHARING_BLOCKED: string;
     MEETING_SELF_ROLES_CHANGED: string;
+    MEETING_SELF_BRB_UPDATE: string;
     MEETING_CONTROLS_LAYOUT_UPDATE: string;
     MEETING_ENTRY_EXIT_TONE_UPDATE: string;
     MEETING_BREAKOUTS_UPDATE: string;
@@ -236,6 +242,7 @@ export declare const EVENT_TRIGGERS: {
     MEETING_RECONNECTION_FAILURE: string;
     MEETING_UNLOCKED: string;
     MEETING_LOCKED: string;
+    MEETING_RESOURCE_LINKS_UPDATE: string;
     MEETING_INFO_AVAILABLE: string;
     MEETING_INFO_UPDATED: string;
     MEETING_LOG_UPLOAD_SUCCESS: string;
@@ -286,6 +293,12 @@ export declare const EVENT_TYPES: {
     REMOTE_SHARE_AUDIO: string;
     ERROR: string;
 };
+export declare const HEADERS: {
+    CONTENT_TYPE: string;
+    CONTENT_TYPE_VALUE: {
+        APPLICATION_JSON: string;
+    };
+};
 export declare const MEETING_REMOVED_REASON: {
     SELF_REMOVED: string;
     FULLSTATE_REMOVED: string;
@@ -410,7 +423,17 @@ export declare const ERROR_DICTIONARY: {
         MESSAGE: string;
         CODE: number;
     };
-    WebinarRegistrationError: {
+    JoinWebinarError: {
+        NAME: string;
+        MESSAGE: string;
+        CODE: number;
+    };
+    MULTISTREAM_NOT_SUPPORTED: {
+        NAME: string;
+        MESSAGE: string;
+        CODE: number;
+    };
+    JoinForbiddenError: {
         NAME: string;
         MESSAGE: string;
         CODE: number;
@@ -578,6 +601,7 @@ export declare const LOCUSINFO: {
         SELF_IS_SHARING_BLOCKED_CHANGE: string;
         SELF_MEETING_BREAKOUTS_CHANGED: string;
         SELF_MEETING_INTERPRETATION_CHANGED: string;
+        SELF_MEETING_BRB_CHANGED: string;
         MEDIA_INACTIVITY: string;
         LINKS_SERVICES: string;
         LINKS_RESOURCES: string;
@@ -738,6 +762,10 @@ export declare const DISPLAY_HINTS: {
     RECORDING_CONTROL_PAUSE: string;
     RECORDING_CONTROL_STOP: string;
     RECORDING_CONTROL_RESUME: string;
+    PREMISE_RECORDING_CONTROL_START: string;
+    PREMISE_RECORDING_CONTROL_PAUSE: string;
+    PREMISE_RECORDING_CONTROL_STOP: string;
+    PREMISE_RECORDING_CONTROL_RESUME: string;
     LOCK_CONTROL_UNLOCK: string;
     LOCK_CONTROL_LOCK: string;
     LOCK_STATUS_LOCKED: string;
@@ -782,6 +810,7 @@ export declare const DISPLAY_HINTS: {
     DISABLE_ASK_FOR_HELP: string;
     DISABLE_BREAKOUT_PREASSIGNMENTS: string;
     DISABLE_LOBBY_TO_BREAKOUT: string;
+    DISABLE_BREAKOUT_START: string;
     DISABLE_VIEW_THE_PARTICIPANT_LIST: string;
     ENABLE_VIEW_THE_PARTICIPANT_LIST: string;
     DISABLE_VIEW_THE_PARTICIPANT_LIST_PANELIST: string;
@@ -805,6 +834,10 @@ export declare const DISPLAY_HINTS: {
     STAGE_VIEW_INACTIVE: string;
     ENABLE_STAGE_VIEW: string;
     DISABLE_STAGE_VIEW: string;
+    PRACTICE_SESSION_ON: string;
+    PRACTICE_SESSION_OFF: string;
+    SHOW_PRACTICE_SESSION_START: string;
+    SHOW_PRACTICE_SESSION_STOP: string;
 };
 export declare const INTERSTITIAL_DISPLAY_HINTS: string[];
 export declare const SELF_ROLES: {
@@ -1077,12 +1110,23 @@ 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_REGISTRATION_ID: string;
+    NOT_REACH_JBH: string;
+    JOIN_FORBIDDEN: string;
     OTHER: string;
 };
 export declare const BNR_STATUS: {
@@ -1130,3 +1174,11 @@ export declare const DESTINATION_TYPE: {
     readonly MEETING_UUID: "MEETING_UUID";
 };
 export type DESTINATION_TYPE = Enum<typeof DESTINATION_TYPE>;
+export declare const INITIAL_REGISTRATION_STATUS: {
+    fetchWebexSite: boolean;
+    getGeoHint: boolean;
+    startReachability: boolean;
+    deviceRegister: boolean;
+    mercuryConnect: boolean;
+    checkH264Support: boolean;
+};

package/dist/types/index.d.ts

@@ -3,18 +3,18 @@ import CaptchaError from './common/errors/captcha-error';
 import IntentToJoinError from './common/errors/intent-to-join';
 import PasswordError from './common/errors/password-error';
 import PermissionError from './common/errors/permission';
-import WebinarRegistrationError from './common/errors/webinar-registration-error';
+import JoinWebinarError from './common/errors/join-webinar-error';
 import { ReclaimHostEmptyWrongKeyError, ReclaimHostIsHostAlreadyError, ReclaimHostNotAllowedError, ReclaimHostNotSupportedError } from './common/errors/reclaim-host-role-errors';
 import Meeting from './meeting';
 import MeetingInfoUtil from './meeting-info/utilv2';
 import JoinMeetingError from './common/errors/join-meeting';
-export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, RemoteStreamEventNames, type ServerMuteReason, LocalMicrophoneStreamEventNames, LocalCameraStreamEventNames, LocalMicrophoneStream, LocalCameraStream, createMicrophoneStream, createCameraStream, createDisplayStream, createDisplayStreamWithAudio, FacingMode, DisplaySurface, PresetCameraConstraints, type VideoContentHint, } from '@webex/media-helpers';
+export { LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, RemoteStreamEventNames, type ServerMuteReason, LocalMicrophoneStreamEventNames, LocalCameraStreamEventNames, LocalMicrophoneStream, LocalCameraStream, createMicrophoneStream, createCameraStream, createCameraAndMicrophoneStreams, createDisplayStream, createDisplayStreamWithAudio, createDisplayMedia, FacingMode, DisplaySurface, PresetCameraConstraints, type VideoContentHint, type StreamState, } from '@webex/media-helpers';
 export default Meetings;
 export * as CONSTANTS from './constants';
 export * as REACTIONS from './reactions/reactions';
 export * as sdkAnnotationTypes from './annotation/annotation.types';
 export * as MeetingInfoV2 from './meeting-info/meeting-info-v2';
 export { type Reaction } from './reactions/reactions.type';
-export { CaptchaError, IntentToJoinError, JoinMeetingError, PasswordError, PermissionError, ReclaimHostIsHostAlreadyError, ReclaimHostNotAllowedError, ReclaimHostNotSupportedError, ReclaimHostEmptyWrongKeyError, Meeting, MeetingInfoUtil, WebinarRegistrationError, };
+export { CaptchaError, IntentToJoinError, JoinMeetingError, PasswordError, PermissionError, ReclaimHostIsHostAlreadyError, ReclaimHostNotAllowedError, ReclaimHostNotSupportedError, ReclaimHostEmptyWrongKeyError, Meeting, MeetingInfoUtil, JoinWebinarError, };
 export { RemoteMedia } from './multistream/remoteMedia';
 export { default as TriggerProxy } from './common/events/trigger-proxy';

package/dist/types/locus-info/index.d.ts

@@ -229,11 +229,12 @@ export default class LocusInfo extends EventsScope {
     /**
      * handles when the locus.mediaShares is updated
      * @param {Object} mediaShares the locus.mediaShares property
+     * @param {boolean} forceUpdate force to update the mediaShares
      * @returns {undefined}
      * @memberof LocusInfo
      * emits internal event locus_info_update_media_shares
      */
-    updateMediaShares(mediaShares: object): void;
+    updateMediaShares(mediaShares: object, forceUpdate?: boolean): void;
     /**
      * @param {String} participantsUrl
      * @returns {undefined}

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/in-meeting-actions.d.ts

@@ -22,6 +22,7 @@ interface IInMeetingActions {
     canStartRecording?: boolean;
     canPauseRecording?: boolean;
     canResumeRecording?: boolean;
+    isPremiseRecordingEnabled?: boolean;
     canStopRecording?: boolean;
     canRaiseHand?: boolean;
     canLowerAllHands?: boolean;
@@ -42,6 +43,7 @@ interface IInMeetingActions {
     waitingForOthersToJoin?: boolean;
     canSendReactions?: boolean;
     canManageBreakout?: boolean;
+    canStartBreakout?: boolean;
     canBroadcastMessageToBreakout?: boolean;
     canAdmitLobbyToBreakout?: boolean;
     isBreakoutPreassignmentsEnabled?: boolean;
@@ -89,6 +91,10 @@ interface IInMeetingActions {
     canShowStageView?: boolean;
     canEnableStageView?: boolean;
     canDisableStageView?: boolean;
+    isPracticeSessionOn?: boolean;
+    isPracticeSessionOff?: boolean;
+    canStartPracticeSession?: boolean;
+    canStopPracticeSession?: boolean;
 }
 /**
  * @class InMeetingActions
@@ -103,6 +109,7 @@ export default class InMeetingActions implements IInMeetingActions {
     canStartRecording: any;
     canPauseRecording: any;
     canResumeRecording: any;
+    isPremiseRecordingEnabled: any;
     canStopRecording: any;
     canSetMuteOnEntry: any;
     canSetPresenter: any;
@@ -131,6 +138,7 @@ export default class InMeetingActions implements IInMeetingActions {
     waitingForOthersToJoin: any;
     canSendReactions: any;
     canManageBreakout: any;
+    canStartBreakout: any;
     canBroadcastMessageToBreakout: any;
     canAdmitLobbyToBreakout: any;
     isBreakoutPreassignmentsEnabled: any;
@@ -178,6 +186,10 @@ export default class InMeetingActions implements IInMeetingActions {
     canShowStageView: any;
     canEnableStageView: any;
     canDisableStageView: any;
+    isPracticeSessionOn: any;
+    isPracticeSessionOff: any;
+    canStartPracticeSession: any;
+    canStopPracticeSession: any;
     /**
      * Returns all meeting action options
      * @returns {Object}