@webex/plugin-meetings 3.0.0-beta.145 → 3.0.0-beta.147

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

@@ -4,6 +4,7 @@ import { LocalTrack, LocalCameraTrack, LocalDisplayTrack, LocalMicrophoneTrack,
 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';
@@ -11,18 +12,34 @@ import Members from '../members/index';
 import Transcription from '../transcription';
 import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
 import { MediaRequestManager } from '../multistream/mediaRequestManager';
-import { RemoteMediaManager } from '../multistream/remoteMediaManager';
+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?: LocalTrack;
+        video?: LocalDisplayTrack;
+    };
+    annotationInfo?: AnnotationInfo;
+};
+export type AddMediaOptions = {
+    localTracks?: LocalTracks;
+    audioEnabled?: boolean;
+    videoEnabled?: boolean;
+    receiveShare?: boolean;
+    remoteMediaManagerConfig?: RemoteMediaManagerConfiguration;
+    bundlePolicy?: BundlePolicy;
+};
 export declare const MEDIA_UPDATE_TYPE: {
-    ALL: string;
-    AUDIO: string;
-    VIDEO: string;
-    SHARE: string;
+    TRANSCODED_MEDIA_CONNECTION: string;
     LAMBDA: string;
+    UPDATE_MEDIA: string;
 };
 /**
  * MediaDirection
@@ -35,15 +52,6 @@ export declare const MEDIA_UPDATE_TYPE: {
  * @property {boolean} receiveShare
  * @property {boolean} isSharing
  */
-/**
- * AudioVideo
- * @typedef {Object} AudioVideo
- * @property {Object} audio
- * @property {String} audio.deviceId
- * @property {Object} video
- * @property {String} video.deviceId
- * @property {String} video.localVideoQuality // [240p, 360p, 480p, 720p, 1080p]
- */
 /**
  * SharePreferences
  * @typedef {Object} SharePreferences
@@ -57,19 +65,11 @@ export declare const MEDIA_UPDATE_TYPE: {
  * @property {String} [pin]
  * @property {Boolean} [moderator]
  * @property {String|Object} [meetingQuality]
- * @property {String} [meetingQuality.local]
  * @property {String} [meetingQuality.remote]
  * @property {Boolean} [rejoin]
  * @property {Boolean} [enableMultistream]
  * @property {String} [correlationId]
  */
-/**
- * SendOptions
- * @typedef {Object} SendOptions
- * @property {Boolean} sendAudio
- * @property {Boolean} sendVideo
- * @property {Boolean} sendShare
- */
 /**
  * Recording
  * @typedef {Object} Recording
@@ -379,9 +379,11 @@ export default class Meeting extends StatelessWebexPlugin {
     state: any;
     localAudioTrackMuteStateHandler: (event: TrackMuteEvent) => void;
     localVideoTrackMuteStateHandler: (event: TrackMuteEvent) => void;
+    underlyingLocalTrackChangeHandler: () => void;
     roles: any[];
     environment: string;
     namespace: string;
+    annotationInfo: AnnotationInfo;
     /**
      * @param {Object} attrs
      * @param {Object} options
@@ -728,48 +730,6 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     getMembers(): Members;
-    /**
-     * Truthy when a meeting has an audio connection established
-     * @returns {Boolean}  true if meeting audio is connected otherwise false
-     * @public
-     * @memberof Meeting
-     */
-    isAudioConnected(): boolean;
-    /**
-     * Convenience function to tell whether a meeting is muted
-     * @returns {Boolean} if meeting audio muted or not
-     * @public
-     * @memberof Meeting
-     */
-    isAudioMuted(): any;
-    /**
-     * Convenience function to tell if the end user last changed the audio state
-     * @returns {Boolean} if audio was manipulated by the end user
-     * @public
-     * @memberof Meeting
-     */
-    isAudioSelf(): any;
-    /**
-     * Truthy when a meeting has a video connection established
-     * @returns {Boolean} true if meeting video connected otherwise false
-     * @public
-     * @memberof Meeting
-     */
-    isVideoConnected(): boolean;
-    /**
-     * Convenience function to tell whether video is muted
-     * @returns {Boolean} if meeting video is muted or not
-     * @public
-     * @memberof Meeting
-     */
-    isVideoMuted(): any;
-    /**
-     * Convenience function to tell whether the end user changed the video state
-     * @returns {Boolean} if meeting video is muted or not
-     * @public
-     * @memberof Meeting
-     */
-    isVideoSelf(): any;
     /**
      * Sets the meeting info on the class instance
      * @param {Object} meetingInfo
@@ -828,15 +788,6 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     uploadLogs(options?: object): void;
-    /**
-     * Removes remote audio and video stream on the class instance and triggers an event
-     * to developers
-     * @returns {undefined}
-     * @public
-     * @memberof Meeting
-     * @deprecated after v1.89.3
-     */
-    unsetRemoteStream(): void;
     /**
      * Removes remote audio, video and share tracks from class instance's mediaProperties
      * @returns {undefined}
@@ -859,76 +810,30 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     closeRemoteTracks(): Promise<[any, any, any]>;
     /**
-     * Emits the 'media:ready' event with a local stream that consists of 1 local audio and 1 local video track
-     * @returns {undefined}
-     * @private
-     * @memberof Meeting
-     */
-    private sendLocalMediaReadyEvent;
-    /**
-     * Sets the local audio track on the class and emits an event to the developer
-     * @param {MediaStreamTrack} rawAudioTrack
-     * @param {Boolean} emitEvent if true, a media ready event is emitted to the developer
-     * @returns {undefined}
-     * @private
-     * @memberof Meeting
+     * 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;
     /**
-     * Sets the local video track on the class and emits an event to the developer
-     * @param {MediaStreamTrack} rawVideoTrack
-     * @param {Boolean} emitEvent if true, a media ready event is emitted to the developer
-     * @returns {undefined}
-     * @private
-     * @memberof Meeting
+     * 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;
     /**
-     * Sets the local media stream on the class and emits an event to the developer
-     * @param {Stream} localStream the local media stream
-     * @returns {undefined}
-     * @public
-     * @memberof Meeting
-     */
-    setLocalTracks(localStream: any): void;
-    /**
-     * Sets the local media stream on the class and emits an event to the developer
-     * @param {MediaStreamTrack} rawLocalShareTrack the local share media track
-     * @returns {undefined}
-     * @public
-     * @memberof Meeting
-     */
-    setLocalShareTrack(rawLocalShareTrack: MediaStreamTrack | null): void;
-    /**
-     * Closes the local stream from the class and emits an event to the developer
-     * @returns {undefined}
-     * @event media:stopped
-     * @public
-     * @memberof Meeting
-     */
-    closeLocalStream(): any;
-    /**
-     * Closes the local stream from the class and emits an event to the developer
-     * @returns {undefined}
-     * @event media:stopped
-     * @public
-     * @memberof Meeting
-     */
-    closeLocalShare(): any;
-    /**
-     * Removes the local stream from the class and emits an event to the developer
-     * @returns {undefined}
-     * @public
-     * @memberof Meeting
-     */
-    unsetLocalVideoTrack(): void;
-    /**
-     * Removes the local share from the class and emits an event to the developer
-     * @returns {undefined}
-     * @public
-     * @memberof Meeting
+     * Stores the reference to a new screen share track, sets up the required event listeners
+     * on it, cleans up previous track, etc.
+     * It also sends the floor grant/release request.
+     *
+     * @param {LocalDisplayTrack | undefined} localDisplayTrack local camera track
+     * @returns {Promise<void>}
      */
-    unsetLocalShareTrack(): void;
+    private setLocalShareTrack;
     /**
      * sets up listner for mercury event
      * @returns {undefined}
@@ -961,63 +866,25 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     private setCorrelationId;
-    /**
-     * 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 {MediaDirection} options.mediaSettings - see #addMedia()
-     * @param {AudioVideo} [options.audioVideoOptions] - see #getMediaStreams()
-     * @returns {Promise} -- {join: see join(), media: see addMedia(), local: see getMediaStreams()}
+     * @param {MediaDirection} [options.mediaOptions] - see #addMedia()
+     * @returns {Promise} -- {join: see join(), media: see addMedia()}
      * @public
      * @memberof Meeting
      * @example
      * joinWithMedia({
      *  joinOptions: {resourceId: 'resourceId' },
-     *  mediaSettings: {
-     *   sendAudio: true,
-     *   sendVideo: true,
-     *   sendShare: false,
-     *   receiveVideo:true,
-     *   receiveAudio: true,
-     *   receiveShare: true
-     * }
-     * audioVideoOptions: {
-     *   audio: 'audioDeviceId',
-     *   video: 'videoDeviceId'
-     * }})
+     *  mediaOptions: {
+     *    localTracks: { microphone: microphoneTrack, camera: cameraTrack }
+     *   }
+     * })
      */
     joinWithMedia(options?: {
         joinOptions?: any;
-        mediaSettings: any;
-        audioVideoOptions?: any;
+        mediaOptions?: AddMediaOptions;
     }): any;
     /**
      * Initiates the reconnection of the media in the meeting
@@ -1146,38 +1013,6 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     moveFrom(resourceId: string): any;
-    /**
-     * Get local media streams based on options passed
-     *
-     * NOTE: this method can only be used with transcoded meetings, not with multistream meetings
-     *
-     * @param {MediaDirection} mediaDirection A configurable options object for joining a meeting
-     * @param {AudioVideo} [audioVideo] audio/video object to set audioinput and videoinput devices, see #Media.getUserMedia
-     * @param {SharePreferences} [sharePreferences] audio/video object to set audioinput and videoinput devices, see #Media.getUserMedia
-     * @returns {Promise} see #Media.getUserMedia
-     * @public
-     * @todo should be static, or moved so can be called outside of a meeting
-     * @memberof Meeting
-     */
-    getMediaStreams: (mediaDirection: any, audioVideo?: any, sharePreferences?: any) => any;
-    /**
-     * Checks if the machine has at least one audio or video device
-     * @param {Object} options
-     * @param {Boolean} options.sendAudio
-     * @param {Boolean} options.sendVideo
-     * @returns {Object}
-     * @memberof Meetings
-     */
-    getSupportedDevices: ({ sendAudio, sendVideo, }: {
-        sendAudio: boolean;
-        sendVideo: boolean;
-    }) => any;
-    /**
-     * Get the devices from the Media module
-     * @returns {Promise} resolves to an array of DeviceInfo
-     * @memberof Meetings
-     */
-    getDevices: () => any;
     /**
      * Handles ROAP_FAILURE event from the webrtc media connection
      *
@@ -1195,13 +1030,13 @@ export default class Meeting extends StatelessWebexPlugin {
     setupStatsAnalyzerEventHandlers: () => void;
     getMediaConnectionDebugId(): string;
     /**
-     * Creates a webrtc media connection
+     * 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}
      */
-    createMediaConnection(turnServerInfo: any, bundlePolicy: any): any;
+    private createMediaConnection;
     /**
      * Listens for an event emitted by eventEmitter and emits it from the meeting object
      *
@@ -1213,19 +1048,14 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     forwardEvent(eventEmitter: any, eventTypeToForward: any, meetingEventType: any): void;
     /**
-     * Specify joining via audio (option: pstn), video, screenshare
-     * @param {Object} options A configurable options object for joining a meeting
-     * @param {Object} options.resourceId pass the deviceId
-     * @param {MediaDirection} options.mediaSettings pass media options
-     * @param {MediaStream} options.localStream
-     * @param {MediaStream} options.localShare
-     * @param {BundlePolicy} options.bundlePolicy bundle policy for multistream meetings
-     * @param {RemoteMediaManagerConfig} options.remoteMediaManagerConfig only applies if multistream is enabled
+     * 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?: any): Promise<any>;
+    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}
@@ -1256,94 +1086,25 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     processNextQueuedMediaUpdate: () => void;
     /**
-     * A confluence of updateAudio, updateVideo, and updateShare
-     * this function re-establishes all of the media streams with new options
-     * @param {Object} options
-     * @param {MediaStream} options.localStream
-     * @param {MediaStream} options.localShare
-     * @param {MediaDirection} options.mediaSettings
-     * @returns {Promise}
-     * @public
-     * @memberof Meeting
-     */
-    updateMedia(options?: {
-        localStream?: MediaStream;
-        localShare?: MediaStream;
-        mediaSettings?: any;
-    }): any;
-    /**
-     * Update the main audio track with new parameters
-     *
-     * NOTE: this method can only be used with transcoded meetings, for multistream meetings use publishTrack()
-     *
-     * @param {Object} options
-     * @param {boolean} options.sendAudio
-     * @param {boolean} options.receiveAudio
-     * @param {MediaStream} options.stream Stream that contains the audio track to update
-     * @returns {Promise}
-     * @public
-     * @memberof Meeting
-     */
-    updateAudio(options: {
-        sendAudio: boolean;
-        receiveAudio: boolean;
-        stream: MediaStream;
-    }): Promise<unknown>;
-    /**
-     * Update the main video track with new parameters
-     *
-     * NOTE: this method can only be used with transcoded meetings, for multistream meetings use publishTrack()
+     * 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.sendVideo
-     * @param {boolean} options.receiveVideo
-     * @param {MediaStream} options.stream Stream that contains the video track to update
+     * @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
      */
-    updateVideo(options: {
-        sendVideo: boolean;
-        receiveVideo: boolean;
-        stream: MediaStream;
-    }): Promise<unknown>;
-    /**
-     * Internal function when stopping a share stream, cleanup
-     * @param {boolean} sendShare
-     * @param {boolean} previousShareStatus
-     * @returns {Promise}
-     * @private
-     * @memberof Meeting
-     */
-    private checkForStopShare;
-    /**
-     * Update the share streams, can be used to start sharing
-     *
-     * NOTE: this method can only be used with transcoded meetings, for multistream meetings use publishTrack()
-     *
-     * @param {Object} options
-     * @param {boolean} options.sendShare
-     * @param {boolean} options.receiveShare
-     * @returns {Promise}
-     * @public
-     * @memberof Meeting
-     */
-    updateShare(options: {
-        sendShare?: boolean;
+    updateMedia(options: {
+        audioEnabled?: boolean;
+        videoEnabled?: boolean;
         receiveShare?: boolean;
-        stream?: any;
-        skipSignalingCheck?: boolean;
-    }): Promise<unknown>;
-    /**
-     * Do all the attach media pre set up before executing the actual attach
-     * @param {MediaStream} localStream
-     * @param {MediaStream} localShare
-     * @param {MediaDirection} mediaSettings
-     * @returns {undefined}
-     * @private
-     * @memberof Meeting
-     */
-    private preMedia;
+    }): Promise<void>;
     /**
      * Acknowledge the meeting, outgoing or incoming
      * @param {String} type
@@ -1401,12 +1162,12 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     private requestScreenShareFloor;
     /**
-     * Stops the screen share
-     * @returns {Promise} see #updateShare
-     * @public
-     * @memberof Meeting
+     * Requests screen share floor if such request is pending.
+     * It should be called whenever meeting state changes to JOINED
+     *
+     * @returns {void}
      */
-    stopShare(options?: {}): Promise<unknown>;
+    private requestScreenShareFloorIfPending;
     /**
      * Sends a request to Locus to release the screen share floor.
      * @returns {Promise} see #meetingRequest.changeMeetingFloor
@@ -1522,45 +1283,12 @@ export default class Meeting extends StatelessWebexPlugin {
             height: number;
         };
     }): any;
-    /**
-     * Sets the quality of the local video stream
-     * @param {String} level {LOW|MEDIUM|HIGH}
-     * @returns {Promise<MediaStream>} localStream
-     */
-    setLocalVideoQuality(level: string): any;
     /**
      * Sets the quality level of the remote incoming media
      * @param {String} level {LOW|MEDIUM|HIGH}
      * @returns {Promise}
      */
-    setRemoteQualityLevel(level: string): any;
-    /**
-     * This is deprecated, please use setLocalVideoQuality for setting local and setRemoteQualityLevel for remote
-     * @param {String} level {LOW|MEDIUM|HIGH}
-     * @returns {Promise}
-     * @deprecated After FHD support
-     */
-    setMeetingQuality(level: string): any;
-    /**
-     *
-     * NOTE: this method can only be used with transcoded meetings, for multistream use publishTrack()
-     *
-     * @param {Object} options parameter
-     * @param {Boolean} options.sendAudio send audio from the display share
-     * @param {Boolean} options.sendShare send video from the display share
-     * @param {Object} options.sharePreferences
-     * @param {MediaTrackConstraints} options.sharePreferences.shareConstraints constraints to apply to video
-     *   @see {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackConstraints}
-     * @param {Boolean} options.sharePreferences.highFrameRate if shareConstraints isn't provided, set default values based off of this boolean
-     * @returns {Promise}
-     */
-    shareScreen(options?: {
-        sendAudio: boolean;
-        sendShare: boolean;
-        sharePreferences: {
-            shareConstraints: MediaTrackConstraints;
-        };
-    }): any;
+    setRemoteQualityLevel(level: string): Promise<void>;
     /**
      * Functionality for when a share is ended.
      * @private
@@ -1738,20 +1466,32 @@ export default class Meeting extends StatelessWebexPlugin {
      * @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: {
-        microphone?: LocalMicrophoneTrack;
-        camera?: LocalCameraTrack;
-        screenShare: {
-            audio?: LocalTrack;
-            video?: LocalDisplayTrack;
-        };
-    }): Promise<void>;
+    publishTracks(tracks: LocalTracks): Promise<void>;
     /**
      * Un-publishes specified local tracks in the meeting
      *