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

package/dist/types/meeting/index.d.ts

@@ -0,0 +1,1471 @@
+/// <reference types="node" />
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { ClientEvent } from '@webex/internal-plugin-metrics';
+import { LocalTrack, LocalCameraTrack, LocalDisplayTrack, LocalSystemAudioTrack, LocalMicrophoneTrack, TrackMuteEvent } from '@webex/media-helpers';
+import { StatsAnalyzer } from '../statsAnalyzer';
+import NetworkQualityMonitor from '../networkQualityMonitor';
+import Roap from '../roap/index';
+import { type BundlePolicy } from '../media';
+import MediaProperties from '../media/properties';
+import ReconnectionManager from '../reconnection-manager';
+import MeetingRequest from './request';
+import Members from '../members/index';
+import Transcription from '../transcription';
+import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
+import { MediaRequestManager } from '../multistream/mediaRequestManager';
+import { Configuration as RemoteMediaManagerConfiguration, RemoteMediaManager } from '../multistream/remoteMediaManager';
+import { ReactionServerType, SkinToneType } from '../reactions/reactions.type';
+import InMeetingActions from './in-meeting-actions';
+import RecordingController from '../recording-controller';
+import ControlsOptionsManager from '../controls-options-manager';
+import { LocusMediaRequest } from './locusMediaRequest';
+import { AnnotationInfo } from '../annotation/annotation.types';
+export type LocalTracks = {
+    microphone?: LocalMicrophoneTrack;
+    camera?: LocalCameraTrack;
+    screenShare?: {
+        audio?: LocalSystemAudioTrack;
+        video?: LocalDisplayTrack;
+    };
+    annotationInfo?: AnnotationInfo;
+};
+export type AddMediaOptions = {
+    localTracks?: LocalTracks;
+    audioEnabled?: boolean;
+    videoEnabled?: boolean;
+    receiveShare?: boolean;
+    remoteMediaManagerConfig?: RemoteMediaManagerConfiguration;
+    bundlePolicy?: BundlePolicy;
+    allowMediaInLobby?: boolean;
+};
+export declare const MEDIA_UPDATE_TYPE: {
+    TRANSCODED_MEDIA_CONNECTION: string;
+    SHARE_FLOOR_REQUEST: string;
+    UPDATE_MEDIA: string;
+};
+export declare enum ScreenShareFloorStatus {
+    PENDING = "floor_request_pending",
+    GRANTED = "floor_request_granted",
+    RELEASED = "floor_released"
+}
+/**
+ * MediaDirection
+ * @typedef {Object} MediaDirection
+ * @property {boolean} sendAudio
+ * @property {boolean} receiveAudio
+ * @property {boolean} sendVideo
+ * @property {boolean} receiveVideo
+ * @property {boolean} sendShare
+ * @property {boolean} receiveShare
+ * @property {boolean} isSharing
+ */
+/**
+ * SharePreferences
+ * @typedef {Object} SharePreferences
+ * @property {Object} [shareConstraints]
+ * @property {Boolean} [highFrameRate]
+ */
+/**
+ * JoinOptions
+ * @typedef {Object} JoinOptions
+ * @property {String} [resourceId]
+ * @property {String} [pin]
+ * @property {Boolean} [moderator]
+ * @property {String|Object} [meetingQuality]
+ * @property {String} [meetingQuality.remote]
+ * @property {Boolean} [rejoin]
+ * @property {Boolean} [enableMultistream]
+ */
+/**
+ * Recording
+ * @typedef {Object} Recording
+ * @property {Object} state
+ * @property {String} modifiedBy
+ */
+/**
+ * Meeting State Change Event
+ * Emitted when ever there is a meeting state change
+ * @event meeting:stateChange
+ * @instance
+ * @type {Object}
+ * @property {String} currentState current state of the meeting
+ * @property {String} previousState previous state of the meeting
+ * @memberof Meeting
+ */
+/**
+ * Media Ready Event
+ * Emitted when a stream is ready to be rendered
+ * @event media:ready
+ * @instance
+ * @type {Object}
+ * @property {MediaStream} stream the media stream
+ * @property {String} type what type of stream, remote, local
+ * @memberof Meeting
+ */
+/**
+ * Media Stopped Event
+ * Emitted when a stream has stopped sending
+ * @event media:stopped
+ * @instance
+ * @type {Object}
+ * @property {String} type what type of stream, remote, local
+ * @memberof Meeting
+ */
+/**
+ * Meeting Ringing Event
+ * Emitted when this client should play a ringing sound, because this member is getting an incoming meeting
+ * or sending out an incoming meeting
+ * @event meeting:ringing
+ * @instance
+ * @type {Object}
+ * @property {String} type // INCOMING or JOIN
+ * @property {String} id
+ * @memberof Meeting
+ */
+/**
+ * Meeting Ringing Stop Event
+ * Emitted when this client should stop playing a ringing sound
+ * @event meeting:ringingStop
+ * @instance
+ * @type {Object}
+ * @property {Object} type
+ * @property {Boolean} type.remoteAnswered
+ * @property {Boolean} type.remoteDeclined
+ * @property {String} id
+ * @memberof Meeting
+ */
+/**
+ * Meeting Started Sharing Local Event
+ * Emitted when this member starts sharing
+ * @event meeting:startedSharingLocal
+ * @instance
+ * @type {Object}
+ * @memberof Meeting
+ */
+/**
+ * Meeting Stopped Sharing Local Event
+ * Emitted when this member stops sharing
+ * @event meeting:stoppedSharingLocal
+ * @instance
+ * @type {Object}
+ * @memberof Meeting
+ */
+/**
+ * Meeting Started Sharing Remote Event
+ * Emitted when remote sharing starts
+ * @event meeting:startedSharingRemote
+ * @instance
+ * @type {Object}
+ * @property {Boolean} memberId id of the meeting member that started screen share
+ * @property {String}  url of this content share
+ * @property {String}  shareInstanceId of this content share
+ * @property {Object}  annotation Info of this content share
+ * @memberof Meeting
+ *
+ */
+/**
+ * Meeting Stopped Sharing Remote Event
+ * Emitted when remote screen sharing ends
+ * @event meeting:stoppedSharingRemote
+ * @instance
+ * @type {Object}
+ * @memberof Meeting
+ */
+/**
+ * Meeting Locked Event
+ * Emitted when a meeting is locked
+ * @event meeting:locked
+ * @instance
+ * @type {Object}
+ * @property {Object} info
+ * @memberof Meeting
+ */
+/**
+ * Meeting Unlocked Event
+ * Emitted when a meeting is unlocked
+ * @event meeting:unlocked
+ * @instance
+ * @type {Object}
+ * @property {Object} info
+ * @memberof Meeting
+ */
+/**
+ * Meeting Actions Update Event
+ * Emitted when a user can take actions on a meeting such as lock, unlock, assign host
+ * @event meeting:actionsUpdate
+ * @instance
+ * @type {Object}
+ * @property {Boolean} canLock
+ * @property {Boolean} canUnlock
+ * @property {Boolean} canAssignHost
+ * @memberof Meeting
+ */
+/**
+ * Meeting Unmuted By Others Event
+ * Emitted when a member is unmuted by another member
+ * @event meeting:self:unmutedByOthers
+ * @instance
+ * @type {Object}
+ * @property {Object} payload
+ * @memberof Meeting
+ */
+/**
+ * Meeting Muted By Others Event
+ * Emitted when a member is muted by another member
+ * @event meeting:self:mutedByOthers
+ * @instance
+ * @type {Object}
+ * @property {Object} payload
+ * @property {Boolean} payload.unmuteAllowed - whether the user is allowed to unmute self
+ * @memberof Meeting
+ */
+/**
+ * Meeting Muted By Others Event
+ * Emitted when the host(moderator)/co-host requests a user to unmute
+ * @event meeting:self:requestedToUnmute
+ * @instance
+ * @type {Object}
+ * @property {Object} payload
+ * @memberof Meeting
+ */
+/**
+ * Meeting Self Guest Admitted Event
+ * Emitted when a joined user get admitted to the meeting by another member or host
+ * @event meeting:self:guestAdmitted
+ * @instance
+ * @type {Object}
+ * @property {Object} payload
+ * @memberof Meeting
+ */
+/**
+ * Meeting Self Lobby Waiting Event
+ * Emitted when joined user enters the lobby and is waiting for the webex meeting to begin
+ * @event meeting:self:lobbyWaiting
+ * @instance
+ * @type {Object}
+ * @property {Object} reason Reason why user left the meeting
+ * @memberof Meeting
+ */
+/**
+ * Meeting Self Left State
+ * Emitted when user is inactive for more then 40 seconds, User can rejoin the meeting again
+ * @event meeting:self:left
+ * @instance
+ * @type {Object}
+ * @property {Object} payload
+ * @memberof Meeting
+ */
+/**
+ * Reconnection Starting Event
+ * Emitted when reconnection of media to the active meeting was successful
+ * @event meeting:reconnectionStarting
+ * @instance
+ * @memberof Meeting
+ */
+/**
+ * Reconnection Success Event
+ * Emitted when reconnection of media to the active meeting was successful
+ * @event meeting:reconnectionSuccess
+ * @instance
+ * @type {Object}
+ * @property {Object} reconnect
+ * @memberof Meeting
+ */
+/**
+ * Reconnection Failure Event
+ * Emitted when reconnection of media to the active meeting was successful
+ * @event meeting:reconnectionFailure
+ * @instance
+ * @type {Object}
+ * @property {Error} error
+ * @memberof Meeting
+ */
+/**
+ * Meeting network quality event
+ * Emitted on each interval of retrieving stats Analyzer data
+ * @event network:quality
+ * @type {Object}
+ * @property {string} mediaType {video|audio}
+ * @property {number} networkQualityScore - {1|0} 1 indicates acceptable uplink 0 indicates unacceptable uplink based on threshold
+ * @memberof Meeting
+ */
+/**
+ * @description Meeting is the crux of the plugin
+ * @export
+ * @class Meeting
+ */
+export default class Meeting extends StatelessWebexPlugin {
+    attrs: any;
+    audio: any;
+    breakouts: any;
+    simultaneousInterpretation: any;
+    annotation: any;
+    conversationUrl: string;
+    correlationId: string;
+    destination: string;
+    destinationType: string;
+    deviceUrl: string;
+    hostId: string;
+    id: string;
+    isMultistream: boolean;
+    locusUrl: string;
+    mediaConnections: any[];
+    mediaId?: string;
+    meetingFiniteStateMachine: any;
+    meetingInfo: any;
+    meetingRequest: MeetingRequest;
+    members: Members;
+    options: object;
+    orgId: string;
+    owner: string;
+    partner: any;
+    policy: string;
+    reconnectionManager: ReconnectionManager;
+    resource: string;
+    roap: Roap;
+    roapSeq: number;
+    selfUrl?: string;
+    sipUri: string;
+    type: string;
+    userId: string;
+    video: any;
+    callEvents: any[];
+    deferJoin: Promise<any>;
+    dialInDeviceStatus: string;
+    dialInUrl: string;
+    dialOutDeviceStatus: string;
+    dialOutUrl: string;
+    fetchMeetingInfoTimeoutId: NodeJS.Timeout;
+    floorGrantPending: boolean;
+    hasJoinedOnce: boolean;
+    hasWebsocketConnected: boolean;
+    inMeetingActions: InMeetingActions;
+    isLocalShareLive: boolean;
+    isRoapInProgress: boolean;
+    keepAliveTimerId: NodeJS.Timeout;
+    lastVideoLayoutInfo: any;
+    locusInfo: any;
+    locusMediaRequest?: LocusMediaRequest;
+    mediaProperties: MediaProperties;
+    mediaRequestManagers: {
+        audio: MediaRequestManager;
+        video: MediaRequestManager;
+        screenShareAudio: MediaRequestManager;
+        screenShareVideo: MediaRequestManager;
+    };
+    meetingInfoFailureReason: string;
+    meetingInfoFailureCode?: number;
+    networkQualityMonitor: NetworkQualityMonitor;
+    networkStatus: string;
+    passwordStatus: string;
+    queuedMediaUpdates: any[];
+    recording: any;
+    remoteMediaManager: RemoteMediaManager | null;
+    recordingController: RecordingController;
+    controlsOptionsManager: ControlsOptionsManager;
+    requiredCaptcha: any;
+    receiveSlotManager: ReceiveSlotManager;
+    selfUserPolicies: any;
+    shareStatus: string;
+    screenShareFloorState: ScreenShareFloorStatus;
+    statsAnalyzer: StatsAnalyzer;
+    transcription: Transcription;
+    updateMediaConnections: (mediaConnections: any[]) => void;
+    endCallInitJoinReq: any;
+    endJoinReqResp: any;
+    endLocalSDPGenRemoteSDPRecvDelay: any;
+    joinedWith: any;
+    locusId: any;
+    startCallInitJoinReq: any;
+    startJoinReqResp: any;
+    startLocalSDPGenRemoteSDPRecvDelay: any;
+    wirelessShare: any;
+    guest: any;
+    meetingJoinUrl: any;
+    meetingNumber: any;
+    meetingState: any;
+    permissionToken: any;
+    resourceId: any;
+    resourceUrl: string;
+    selfId: string;
+    state: any;
+    localAudioTrackMuteStateHandler: (event: TrackMuteEvent) => void;
+    localVideoTrackMuteStateHandler: (event: TrackMuteEvent) => void;
+    underlyingLocalTrackChangeHandler: () => void;
+    roles: any[];
+    environment: string;
+    namespace: string;
+    annotationInfo: AnnotationInfo;
+    allowMediaInLobby: boolean;
+    /**
+     * @param {Object} attrs
+     * @param {Object} options
+     * @constructor
+     * @memberof Meeting
+     */
+    constructor(attrs: any, options: object);
+    /**
+     * returns meeting is joined
+     * @private
+     * @memberof Meeting
+     * @returns {Boolean}
+     */
+    private isJoined;
+    /**
+     * Returns whether this meeting is a Locus CALL
+     * @returns {Boolean}
+     */
+    isLocusCall(): boolean;
+    /**
+     * Fetches meeting information.
+     * @param {Object} options
+     * @param {String} [options.password] optional
+     * @param {String} [options.captchaCode] optional
+     * @public
+     * @memberof Meeting
+     * @returns {Promise}
+     */
+    fetchMeetingInfo({ password, captchaCode, extraParams, }: {
+        password?: string;
+        captchaCode?: string;
+        extraParams?: Record<string, any>;
+    }): Promise<void>;
+    /**
+     * Checks if the supplied password/host key is correct. It returns a promise with information whether the
+     * password and captcha code were correct or not.
+     * @param {String} password - this can be either a password or a host key, can be undefined if only captcha was required
+     * @param {String} captchaCode - can be undefined if captcha was not required by the server
+     * @public
+     * @memberof Meeting
+     * @returns {Promise<{isPasswordValid: boolean, requiredCaptcha: boolean, failureReason: MEETING_INFO_FAILURE_REASON}>}
+     */
+    verifyPassword(password: string, captchaCode: string): Promise<{
+        isPasswordValid: boolean;
+        requiredCaptcha: any;
+        failureReason: string;
+    } | {
+        isPasswordValid: boolean;
+        requiredCaptcha: any;
+        failureReason: string;
+    }>;
+    /**
+     * Refreshes the captcha. As a result the meeting will have new captcha id, image and audio.
+     * If the refresh operation fails, meeting remains with the old captcha properties.
+     * @public
+     * @memberof Meeting
+     * @returns {Promise}
+     */
+    refreshCaptcha(): any;
+    /**
+     * Posts metrics event for this meeting. Allows the app to send Call Analyzer events.
+     * @param {String} eventName - Call Analyzer event
+     * @public
+     * @memberof Meeting
+     * @returns {Promise}
+     */
+    postMetrics(eventName: ClientEvent['name']): void;
+    /**
+     * Proxy function for all the listener set ups
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusInfoListeners;
+    /**
+     * Set up the listeners for breakouts
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    setUpBreakoutsListener(): void;
+    /**
+     * Set up the listeners for interpretation
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpInterpretationListener;
+    /**
+     * Set up the locus info listener for meetings disconnected due to inactivity
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusInfoMediaInactiveListener;
+    /**
+     * Set up the locus info listener for assign host permissions on a meeting
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusInfoAssignHostListener;
+    /**
+     * Set up the internal locus info full state object listener
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusFullStateListener;
+    /**
+     * sets the network status on meeting object
+     * @param {String} networkStatus
+     * @private
+     * @returns {undefined}
+     * @memberof Meeting
+     */
+    private setNetworkStatus;
+    /**
+     * Set up the locus info self listener
+     * update self value for members and updates the member
+     * notifies consumer with members:self:update {activeSelfId endedSelfId}
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusSelfListener;
+    /**
+     * Notify any changes on the pstn devices
+     * @param {Object} payload
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private pstnUpdate;
+    /**
+     * Set up the locus info host listener
+     * update host value for members and updates the member
+     * notifies consumer with members:host:update: {activeHostId, endedHostId}
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusHostListener;
+    /**
+     * Set up the locus info participants update listener
+     * update members collection value for members
+     * notifies consumer with members:update
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusParticipantsListener;
+    /**
+     * Set up the locus info recording update listener
+     * update recording value for the meeting
+     * notifies consumer with:
+     *  meeting:recording:started
+     *  meeting:recording:stopped
+     *  meeting:recording:paused
+     *  meeting:recording:resumed
+     *
+     * Set up the locus info meeeting container listener
+     * update meetingContainerUrl value for the meeting
+     * notifies consumer with:
+     *  meeting:meetingContainer:update
+     *
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setupLocusControlsListener;
+    /**
+     * Trigger annotation info update event
+     @returns {undefined}
+     @param {object} contentShare
+     @param {object} previousContentShare
+     */
+    private triggerAnnotationInfoEvent;
+    /**
+     * Set up the locus info media shares listener
+     * update content and whiteboard sharing id value for members, and updates the member
+     * notifies consumer with members:content:update {activeContentSharingId, endedContentSharingId}
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusMediaSharesListener;
+    /**
+     * Set up the locus info url listener
+     * update locus_url value for members
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusUrlListener;
+    /**
+     * Set up the locus info service link listener
+     * update the locusInfo for recording controller
+     * does not currently re-emit the event as it's internal only
+     * payload is unused
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusServicesListener;
+    /**
+     * Set up the locus info meeting info listener
+     * @returns {undefined}
+     * @private
+     * @memberof meeting
+     */
+    private setUpLocusInfoMeetingInfoListener;
+    /**
+     * Handles a data channel URL change
+     * @param {String} datachannelUrl
+     * @returns {void}
+     */
+    handleDataChannelUrlChange(datachannelUrl: any): void;
+    /**
+     * Set up the locus info embedded apps listener
+     * @returns {undefined}
+     * @private
+     * @memberof meeting
+     */
+    private setUpLocusEmbeddedAppsListener;
+    /**
+     * Internal function to listen to the self object changes
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusInfoSelfListener;
+    /**
+     * Add LocusInfo nested object listeners (from child to parent)
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpLocusInfoMeetingListener;
+    /**
+     * Set meeting values rather than events
+     * @param {Object} object
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     * // TODO: is this function necessary?
+     */
+    private updateMeetingObject;
+    /**
+     * Invite a guest to the call that isn't normally part of this call
+     * @param {Object} invitee
+     * @param {String} invitee.emailAddress
+     * @param {String} invitee.email
+     * @param {String} invitee.phoneNumber
+     * @param {Boolean} [alertIfActive]
+     * @returns {Promise} see #members.addMember
+     * @public
+     * @memberof Meeting
+     */
+    invite(invitee: {
+        emailAddress: string;
+        email: string;
+        phoneNumber: string;
+    }, alertIfActive?: boolean): any;
+    /**
+     * Cancel an outgoing phone call invitation made during a meeting
+     * @param {Object} invitee
+     * @param {String} invitee.phoneNumber
+     * @returns {Promise} see #members.cancelPhoneInvite
+     * @public
+     * @memberof Meeting
+     */
+    cancelPhoneInvite(invitee: {
+        phoneNumber: string;
+    }): any;
+    /**
+     * Admit the guest(s) to the call once they are waiting.
+     * If the host/cohost is in a breakout session, the locus url
+     * of the session must be provided as the authorizingLocusUrl.
+     * Regardless of host/cohost location, the locus Id (lid) in
+     * the path should be the locus Id of the main, which means the
+     * locus url of the api call must be from the main session.
+     * If these loucs urls are not provided, the function will do the check.
+     * @param {Array} memberIds
+     * @param {Object} sessionLocusUrls: {authorizingLocusUrl, mainLocusUrl}
+     * @returns {Promise} see #members.admitMembers
+     * @public
+     * @memberof Meeting
+     */
+    admit(memberIds: Array<any>, sessionLocusUrls?: {
+        authorizingLocusUrl: string;
+        mainLocusUrl: string;
+    }): any;
+    /**
+     * Remove the member from the meeting, boot them
+     * @param {String} memberId
+     * @returns {Promise} see #members.removeMember
+     * @public
+     * @memberof Meeting
+     */
+    remove(memberId: string): any;
+    /**
+     * Mute another member from the meeting
+     * @param {String} memberId
+     * @param {Boolean} mute
+     * @returns {Promise} see #members.muteMember
+     * @public
+     * @memberof Meeting
+     */
+    mute(memberId: string, mute?: boolean): any;
+    /**
+     * Transfer the moderator role to another eligible member
+     * @param {String} memberId
+     * @param {Boolean} moderator
+     * @returns {Promise} see #members.transferHostToMember
+     * @public
+     * @memberof Meeting
+     */
+    transfer(memberId: string, moderator?: boolean): any;
+    /**
+     * Reference to the Members object
+     * @returns {Members}
+     * @public
+     * @memberof Meeting
+     */
+    getMembers(): Members;
+    /**
+     * Sets the meeting info on the class instance
+     * @param {Object} meetingInfo
+     * @param {Object} meetingInfo.body
+     * @param {String} meetingInfo.body.conversationUrl
+     * @param {String} meetingInfo.body.locusUrl
+     * @param {String} meetingInfo.body.sipUri
+     * @param {Object} meetingInfo.body.owner
+     * @param {Object | String} destination locus object with meeting data or destination string (sip url, meeting link, etc)
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    parseMeetingInfo(meetingInfo: {
+        body: {
+            conversationUrl: string;
+            locusUrl: string;
+            sipUri: string;
+            owner: object;
+        };
+    } | any, destination?: object | string | null): void;
+    /**
+     * Sets the self user policies based on the contents of the permission token
+     * @param {String} permissionToken
+     * @returns {void}
+     */
+    setSelfUserPolicies(permissionToken: string): void;
+    /**
+     * Sets the sip uri on the class instance
+     * uses meeting info as precedence
+     * @param {String} sipUri
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    setSipUri(sipUri: string): void;
+    /**
+     * Set the locus info the class instance
+     * @param {Object} locus
+     * @param {Array} locus.mediaConnections
+     * @param {String} locus.locusUrl
+     * @param {String} locus.locusId
+     * @param {String} locus.mediaId
+     * @param {Object} locus.host
+     * @todo change name to genertic parser
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    setLocus(locus: {
+        mediaConnections: Array<any>;
+        locusUrl: string;
+        locusId: string;
+        mediaId: string;
+        host: object;
+    } | any): void;
+    /**
+     * Upload logs for the current meeting
+     * @param {object} options file name and function name
+     * @returns {undefined}
+     * @public
+     * @memberof Meeting
+     */
+    uploadLogs(options?: object): void;
+    /**
+     * Removes remote audio, video and share tracks from class instance's mediaProperties
+     * @returns {undefined}
+     */
+    unsetRemoteTracks(): void;
+    /**
+     * Removes the remote stream on the class instance and triggers an event
+     * to developers
+     * @returns {undefined}
+     * @public
+     * @memberof Meeting
+     * @deprecated after v1.89.3
+     */
+    closeRemoteStream(): void;
+    /**
+     * Removes the remote tracks on the class instance and triggers an event
+     * to developers
+     * @returns {undefined}
+     * @memberof Meeting
+     */
+    closeRemoteTracks(): Promise<[any, any, any]>;
+    /**
+     * Stores the reference to a new microphone track, sets up the required event listeners
+     * on it, cleans up previous track, etc.
+     *
+     * @param {LocalMicrophoneTrack | null} localTrack local microphone track
+     * @returns {Promise<void>}
+     */
+    private setLocalAudioTrack;
+    /**
+     * Stores the reference to a new camera track, sets up the required event listeners
+     * on it, cleans up previous track, etc.
+     *
+     * @param {LocalCameraTrack | null} localTrack local camera track
+     * @returns {Promise<void>}
+     */
+    private setLocalVideoTrack;
+    /**
+     * Stores the reference to a new screen share video track, sets up the required event listeners
+     * on it, cleans up previous track, etc.
+     *
+     * @param {LocalDisplayTrack | undefined} localDisplayTrack local camera track
+     * @returns {Promise<void>}
+     */
+    private setLocalShareVideoTrack;
+    /**
+     * Stores the reference to a new screen share audio track, sets up the required event listeners
+     * on it, cleans up previous track, etc.
+     *
+     * @param {LocalSystemAudioTrack | undefined} localSystemAudioTrack local system audio track
+     * @returns {Promise<void>}
+     */
+    private setLocalShareAudioTrack;
+    /**
+     * sets up listner for mercury event
+     * @returns {undefined}
+     * @public
+     * @memberof Meeting
+     */
+    setMercuryListener(): void;
+    /**
+     * Close the peer connections and remove them from the class.
+     * Cleanup any media connection related things.
+     *
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    closePeerConnections(): Promise<void>;
+    /**
+     * Unsets the peer connections on the class
+     * warning DO NOT CALL WITHOUT CLOSING PEER CONNECTIONS FIRST
+     * @returns {undefined}
+     * @public
+     * @memberof Meeting
+     */
+    unsetPeerConnections(): void;
+    /**
+     * Convenience method to set the correlation id for the Meeting
+     * @param {String} id correlation id to set on the class
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setCorrelationId;
+    /**
+     * Enqueue request for screenshare floor and set the status to pending
+     * @returns {Promise}
+     * @private
+     * @memberof Meeting
+     */
+    private enqueueScreenShareFloorRequest;
+    /**
+     * Mute the audio for a meeting
+     * @returns {Promise} resolves the data from muting audio {mute, self} or rejects if there is no audio set
+     * @public
+     * @memberof Meeting
+     */
+    muteAudio(): any;
+    /**
+     * Unmute meeting audio
+     * @returns {Promise} resolves data from muting audio {mute, self} or rejects if there is no audio set
+     * @public
+     * @memberof Meeting
+     */
+    unmuteAudio(): any;
+    /**
+     * Mute the video for a meeting
+     * @returns {Promise} resolves data from muting video {mute, self} or rejects if there is no video set
+     * @public
+     * @memberof Meeting
+     */
+    muteVideo(): any;
+    /**
+     * Unmute meeting video
+     * @returns {Promise} resolves data from muting video {mute, self} or rejects if there is no video set
+     * @public
+     * @memberof Meeting
+     */
+    unmuteVideo(): any;
+    /**
+     * Shorthand function to join AND set up media
+     * @param {Object} options - options to join with media
+     * @param {JoinOptions} [options.joinOptions] - see #join()
+     * @param {AddMediaOptions} [options.mediaOptions] - see #addMedia()
+     * @returns {Promise} -- {join: see join(), media: see addMedia()}
+     * @public
+     * @memberof Meeting
+     * @example
+     * joinWithMedia({
+     *  joinOptions: {resourceId: 'resourceId' },
+     *  mediaOptions: {
+     *    localTracks: { microphone: microphoneTrack, camera: cameraTrack }
+     *   }
+     * })
+     */
+    joinWithMedia(options?: {
+        joinOptions?: any;
+        mediaOptions?: AddMediaOptions;
+    }): any;
+    /**
+     * Initiates the reconnection of the media in the meeting
+     *
+     * @param {object} options
+     * @returns {Promise} resolves with {reconnect} or errors with {error}
+     * @public
+     * @memberof Meeting
+     */
+    reconnect(options?: object): any;
+    /**
+     * Check if the meeting supports the Webex Assistant feature
+     * @returns {boolean}
+     * @throws TranscriptionNotSupportedError
+     */
+    isTranscriptionSupported(): boolean;
+    /**
+     * Check if the meeting supports the Reactions
+     * @returns {boolean}
+     */
+    isReactionsSupported(): boolean;
+    /**
+     * Monitor the Low-Latency Mercury (LLM) web socket connection on `onError` and `onClose` states
+     * @private
+     * @returns {void}
+     */
+    private monitorTranscriptionSocketConnection;
+    /**
+     * Request for a WebSocket Url, open and monitor the WebSocket connection
+     * @private
+     * @returns {Promise<void>} a promise to open the WebSocket connection
+     */
+    private receiveTranscription;
+    /**
+     * Callback called when a relay event is received from meeting LLM Connection
+     * @param {RelayEvent} e Event object coming from LLM Connection
+     * @private
+     * @returns {void}
+     */
+    private processRelayEvent;
+    /**
+     * stop recieving Transcription by closing
+     * the web socket connection properly
+     * @returns {void}
+     */
+    stopReceivingTranscription(): void;
+    /**
+     * triggers an event to notify that the user
+     * will not receive any more transcription
+     * @private
+     * @returns{void}
+     */
+    private triggerStopReceivingTranscriptionEvent;
+    /**
+     * Specify joining via audio (option: pstn), video, screenshare
+     * @param {JoinOptions} options A configurable options object for joining a meeting
+     * @returns {Promise} the join response
+     * @public
+     * @memberof Meeting
+     * Scenario A: Joining own claimed personal meeting room
+     * Scenario B: Joining other's claimed personal meeting room, do pass pin (if desired to join as host, or nullify), do pass moderator
+     * Scenario C: Joining an unclaimed personal meeting room, -do not- pass pin or moderator on first try, -do- pass pin and moderator
+     *             if joining as host on second loop, pass pin and pass moderator if joining as guest on second loop
+     * Scenario D: Joining any other way (sip, pstn, conversationUrl, link just need to specify resourceId)
+     */
+    join(options?: any): any;
+    /**
+     * Connects to low latency mercury and reconnects if the address has changed
+     * It will also disconnect if called when the meeting has ended
+     * @param {String} datachannelUrl
+     * @returns {Promise}
+     */
+    updateLLMConnection(): Promise<any>;
+    /**
+     * Use phone for meeting audio
+     * @param {String} phoneNumber If provided, it will dial-out using this number. If not provided, dial-in will be used
+     * @returns {Promise} Resolves once the dial-in or dial-out request has completed, or rejects if it failed
+     * @public
+     * @memberof Meeting
+     */
+    usePhoneAudio(phoneNumber: string): Promise<any>;
+    /**
+     * Determines if the given pstnStatus is in a state which implies the phone is provisioned
+     * @param {String} pstnStatus
+     * @returns {Boolean}
+     * @private
+     * @memberof Meeting
+     */
+    private isPhoneProvisioned;
+    /**
+     * Enable dial-in for audio
+     * @returns {Promise} Resolves once the dial-in request has completed, or rejects if it failed
+     * @private
+     * @memberof Meeting
+     */
+    private dialInPstn;
+    /**
+     * Enable dial-out for audio
+     * @param {String} phoneNumber Phone number to dial out to
+     * @returns {Promise} Resolves once the dial-out request has completed (it doesn't wait for the user to answer the phone), or rejects if it failed
+     * @private
+     * @memberof Meeting
+     */
+    private dialOutPstn;
+    /**
+     * Disconnect meeting audio via phone.
+     * @returns {Promise} Resolves once the phone audio disconnection has completed
+     * @public
+     * @memberof Meeting
+     * @returns {Promise}
+     */
+    disconnectPhoneAudio(): Promise<[any, any]>;
+    /**
+     * Moves the call to the specified resourceId
+     * @param {String} resourceId
+     * @returns {Promise} once the move has been completed
+     * @public
+     * @memberof Meeting
+     */
+    moveTo(resourceId: string): any;
+    /**
+     * Moves the call from the specified resourceId, back to computer
+     * @param {String} resourceId
+     * @returns {Promise} once the move has been completed
+     * @public
+     * @memberof Meeting
+     */
+    moveFrom(resourceId: string): any;
+    /**
+     * Handles ROAP_FAILURE event from the webrtc media connection
+     *
+     * @param {Error} error
+     * @returns {void}
+     */
+    handleRoapFailure: (error: any) => void;
+    setupMediaConnectionListeners: () => void;
+    /**
+     * Registers for all required StatsAnalyzer events
+     * @private
+     * @returns {void}
+     * @memberof Meetings
+     */
+    setupStatsAnalyzerEventHandlers: () => void;
+    getMediaConnectionDebugId(): string;
+    /**
+     * Creates a webrtc media connection and publishes tracks to it
+     *
+     * @param {Object} turnServerInfo TURN server information
+     * @param {BundlePolicy} [bundlePolicy] Bundle policy settings
+     * @returns {RoapMediaConnection | MultistreamRoapMediaConnection}
+     */
+    private createMediaConnection;
+    /**
+     * Listens for an event emitted by eventEmitter and emits it from the meeting object
+     *
+     * @private
+     * @param {*} eventEmitter object from which to forward the event
+     * @param {*} eventTypeToForward which event type to listen on and to forward
+     * @param {string} meetingEventType event type to be used in the event emitted from the meeting object
+     * @returns {void}
+     */
+    forwardEvent(eventEmitter: any, eventTypeToForward: any, meetingEventType: any): void;
+    /**
+     * Creates a media connection to the server. Media connection is required for sending or receiving any audio/video.
+     *
+     * @param {AddMediaOptions} options
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    addMedia(options?: AddMediaOptions): Promise<any>;
+    /**
+     * Informs if the peer connection is in a state that can be updated with updateMedia (audio/video/share)
+     * @returns {Boolean}
+     */
+    canUpdateMedia(): boolean;
+    /**
+     * Enqueues a media update operation.
+     * @param {String} mediaUpdateType one of MEDIA_UPDATE_TYPE values
+     * @param {Object} options
+     * @returns {Promise}
+     * @private
+     * @memberof Meeting
+     */
+    private enqueueMediaUpdate;
+    /**
+     * emits event when the negotation is completed
+     * @returns {void}
+     * @private
+     * @memberof Meeting
+     */
+    mediaNegotiatedEvent: () => void;
+    /**
+     * Checks if there are any queued media updates and runs the first one from
+     * the queue if we are in a state that allows doing that.
+     * @returns {undefined}
+     * @public
+     * @memberof Meeting
+     */
+    processNextQueuedMediaUpdate: () => void;
+    /**
+     * Updates the media connection - it allows to enable/disable all audio/video/share in the meeting.
+     * This does not affect the published tracks, so for example if a microphone track is published and
+     * updateMedia({audioEnabled: false}) is called, the audio will not be sent or received anymore,
+     * but the track's "published" state is not changed and when updateMedia({audioEnabled: true}) is called,
+     * the sending of the audio from the same track will resume.
+     *
+     * @param {Object} options
+     * @param {boolean} options.audioEnabled [optional] enables/disables receiving and sending of main audio in the meeting
+     * @param {boolean} options.videoEnabled [optional] enables/disables receiving and sending of main video in the meeting
+     * @param {boolean} options.shareEnabled [optional] enables/disables receiving and sending of screen share in the meeting
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    updateMedia(options: {
+        audioEnabled?: boolean;
+        videoEnabled?: boolean;
+        receiveShare?: boolean;
+    }): Promise<void>;
+    /**
+     * Acknowledge the meeting, outgoing or incoming
+     * @param {String} type
+     * @returns {Promise} resolve {message, ringing, response}
+     * @public
+     * @memberof Meeting
+     */
+    acknowledge(type: string): Promise<{
+        response: any;
+    }> | Promise<{
+        message: string;
+    }>;
+    /**
+     * Decline this meeting
+     * @param {String} reason
+     * @returns {undefined}
+     * @public
+     * @memberof Meeting
+     */
+    decline(reason: string): any;
+    /**
+     * Leave the current meeting
+     * @param {Object} options leave options
+     * @param {String} options.resourceId the device with which to leave from, empty if just the computer
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    leave(options?: {
+        resourceId?: string;
+        reason?: any;
+    }): any;
+    /**
+     * Start sharing whiteboard given channelUrl
+     * @param {string} channelUrl whiteboard url
+     * @param {String} resourceToken token created by authorize media injector
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    startWhiteboardShare(channelUrl: string, resourceToken: string): any;
+    /**
+     * Stop sharing whiteboard given channelUrl
+     * @param {string} channelUrl whiteboard url
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    stopWhiteboardShare(channelUrl: string): any;
+    /**
+     * Sends a request to Locus to obtain the screen share floor
+     * @returns {Promise} see #meetingRequest.changeMeetingFloor
+     * @private
+     * @memberof Meeting
+     */
+    private requestScreenShareFloor;
+    /**
+     * Requests screen share floor if such request is pending.
+     * It should be called whenever meeting state changes to JOINED
+     *
+     * @returns {void}
+     */
+    private requestScreenShareFloorIfPending;
+    /**
+     * Sends a request to Locus to release the screen share floor.
+     * @returns {Promise} see #meetingRequest.changeMeetingFloor
+     * @private
+     * @memberof Meeting
+     */
+    private releaseScreenShareFloor;
+    /**
+     * Intiate a recording of this meeting
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    startRecording(): Promise<any>;
+    /**
+     * set the mute on entry flag for participants if you're the host
+     * @returns {Promise}
+     * @param {boolean} enabled
+     * @public
+     * @memberof Meeting
+     */
+    setMuteOnEntry(enabled: boolean): Promise<any>;
+    /**
+     * set the disallow unmute flag for participants if you're the host
+     * @returns {Promise}
+     * @param {boolean} enabled
+     * @public
+     * @memberof Meeting
+     */
+    setDisallowUnmute(enabled: boolean): Promise<any>;
+    /**
+     * set the mute all flag for participants if you're the host
+     * @returns {Promise}
+     * @param {boolean} mutedEnabled
+     * @param {boolean} disallowUnmuteEnabled
+     * @param {boolean} muteOnEntryEnabled
+     * @public
+     * @memberof Meeting
+     */
+    setMuteAll(mutedEnabled: boolean, disallowUnmuteEnabled: boolean, muteOnEntryEnabled: boolean): Promise<any>;
+    /**
+     * End the recording of this meeting
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    stopRecording(): Promise<any>;
+    /**
+     * Pauses the recording of this meeting
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    pauseRecording(): Promise<any>;
+    /**
+     * Resumes the recording of this meeting
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    resumeRecording(): Promise<any>;
+    /**
+     * Locks the current meeting if possible
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    lockMeeting(): any;
+    /**
+     * Unlocks the current meeting if possible
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    unlockMeeting(): any;
+    /**
+     * Logs an error message and returns a rejected promise with same message
+     * @param {String} message
+     * @returns {Promise}
+     * @private
+     * @memberof Meeting
+     */
+    private rejectWithErrorLog;
+    /**
+     * Sends DTMF tones to the current meeting
+     * @param {String} tones a string of one or more DTMF tones to send
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    sendDTMF(tones: string): Promise<any>;
+    /**
+     * Sends request to change layout type for the current meeting for the specific participant/device only
+     * @param {String} [layoutType] a layout type that should be available in meeting constants {@link #layout_types}
+     * @param {Object} renderInfo preferred dimensions for the remote main and content streams (server can ignore it)
+     * @param {Object} renderInfo.main preferred dimensions for the remote main video stream
+     * @param {Number} renderInfo.main.width preferred width of main video stream
+     * @param {Number} renderInfo.main.height preferred height of main video stream
+     * @param {Object} renderInfo.content preferred dimensions for the remote content share stream
+     * @param {Number} renderInfo.content.width preferred width of content share stream
+     * @param {Number} renderInfo.content.height preferred height of content share stream
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    changeVideoLayout(layoutType?: string, renderInfo?: {
+        main: {
+            width: number;
+            height: number;
+        };
+        content: {
+            width: number;
+            height: number;
+        };
+    }): any;
+    /**
+     * Sets the quality level of the remote incoming media
+     * @param {String} level {LOW|MEDIUM|HIGH}
+     * @returns {Promise}
+     */
+    setRemoteQualityLevel(level: string): Promise<void>;
+    /**
+     * Functionality for when a share audio is ended.
+     * @private
+     * @memberof Meeting
+     * @returns {undefined}
+     */
+    private handleShareAudioTrackEnded;
+    /**
+     * Functionality for when a share video is ended.
+     * @private
+     * @memberof Meeting
+     * @returns {undefined}
+     */
+    private handleShareVideoTrackEnded;
+    /**
+     * Emits meeting:stoppedSharingLocal
+     * @private
+     * @returns {undefined}
+     * @memberof Meeting
+     */
+    private triggerStoppedSharing;
+    /**
+     * Emits the 'network:quality' event
+     * 1 indicates an acceptable uplink network.
+     * 0 indicates an unacceptable uplink network based on a predefined threshold
+     * @returns {undefined}
+     * @param {Object} res - payload of emitNetworkQuality
+     * @property {string} mediaType {video|audio}
+     * @property {number} networkQualityScore - {1|0}
+     * @private
+     * @memberof Meeting
+     */
+    private sendNetworkQualityEvent;
+    /**
+     * Handle logging the media
+     * @param {Object} mediaProperties
+     * @private
+     * @returns {undefined}
+     */
+    private handleMediaLogging;
+    /**
+     *
+     * @returns {string} one of 'attendee','host','cohost', returns the user type of the current user
+     */
+    getCurUserType(): "host" | "cohost" | "attendee";
+    /**
+     * End the current meeting for all
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    endMeetingForAll(): any;
+    /**
+     * clear the meeting data
+     * @returns {undefined}
+     * @public
+     * @memberof Meeting
+     */
+    clearMeetingData: () => void;
+    /**
+     * starts keepAlives being sent
+     * @returns {void}
+     * @private
+     * @memberof Meeting
+     */
+    startKeepAlive: () => void;
+    /**
+     * stops keepAlives being sent
+     * @returns {void}
+     * @private
+     * @memberof Meeting
+     */
+    stopKeepAlive: () => void;
+    /**
+     * Send a reaction inside the meeting.
+     *
+     * @param {ReactionServerType} reactionType - type of reaction to be sent. Example: "thumbs_up"
+     * @param {SkinToneType} skinToneType - skin tone for the reaction. Example: "medium_dark"
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    sendReaction(reactionType: ReactionServerType, skinToneType?: SkinToneType): any;
+    /**
+     * Method to enable or disable reactions inside the meeting.
+     *
+     * @param  {boolean} enable - enable or disable reactions
+     * @returns {Promise}
+     * @public
+     * @memberof Meeting
+     */
+    toggleReactions(enable: boolean): Promise<any>;
+    /**
+     * Throws if we don't have a media connection created
+     *
+     * @returns {void}
+     */
+    private checkMediaConnection;
+    /**
+     * Method to enable or disable the 'Music mode' effect on audio track
+     *
+     * @param {boolean} shouldEnableMusicMode
+     * @returns {Promise}
+     */
+    enableMusicMode(shouldEnableMusicMode: boolean): Promise<void>;
+    /** Updates the tracks being sent on the transcoded media connection
+     *
+     * @returns {Promise<void>}
+     */
+    private updateTranscodedMediaConnection;
+    /**
+     * Publishes a track.
+     *
+     * @param {LocalTrack} track to publish
+     * @returns {Promise}
+     */
+    private publishTrack;
+    /**
+     * Un-publishes a track.
+     *
+     * @param {LocalTrack} track to unpublish
+     * @returns {Promise}
+     */
+    private unpublishTrack;
+    /**
+     * Publishes specified local tracks in the meeting
+     *
+     * @param {Object} tracks
+     * @returns {Promise}
+     */
+    publishTracks(tracks: LocalTracks): Promise<void>;
+    /**
+     * Un-publishes specified local tracks in the meeting
+     *
+     * @param {Array<MediaStreamTrack>} tracks
+     * @returns {Promise}
+     */
+    unpublishTracks(tracks: LocalTrack[]): Promise<void>;
+}