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

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

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import { StatelessWebexPlugin } from '@webex/webex-core';
-import { LocalTrack, LocalCameraTrack, LocalDisplayTrack, LocalMicrophoneTrack, TrackMuteEvent } from '@webex/media-helpers';
+import { ClientEvent, ClientEventLeaveReason } from '@webex/internal-plugin-metrics';
+import { LocalStream, LocalCameraStream, LocalDisplayStream, LocalSystemAudioStream, LocalMicrophoneStream } from '@webex/media-helpers';
 import { StatsAnalyzer } from '../statsAnalyzer';
 import NetworkQualityMonitor from '../networkQualityMonitor';
 import Roap from '../roap/index';
@@ -18,29 +19,34 @@ 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;
+export type LocalStreams = {
+    microphone?: LocalMicrophoneStream;
+    camera?: LocalCameraStream;
     screenShare?: {
-        audio?: LocalTrack;
-        video?: LocalDisplayTrack;
+        audio?: LocalSystemAudioStream;
+        video?: LocalDisplayStream;
     };
-    annotationInfo?: AnnotationInfo;
 };
 export type AddMediaOptions = {
-    localTracks?: LocalTracks;
+    localStreams?: LocalStreams;
     audioEnabled?: boolean;
     videoEnabled?: boolean;
-    receiveShare?: boolean;
+    shareAudioEnabled?: boolean;
+    shareVideoEnabled?: 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
@@ -68,7 +74,6 @@ export declare const MEDIA_UPDATE_TYPE: {
  * @property {String} [meetingQuality.remote]
  * @property {Boolean} [rejoin]
  * @property {Boolean} [enableMultistream]
- * @property {String} [correlationId]
  */
 /**
  * Recording
@@ -151,7 +156,11 @@ export declare const MEDIA_UPDATE_TYPE: {
  * @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
@@ -320,6 +329,7 @@ export default class Meeting extends StatelessWebexPlugin {
     userId: string;
     video: any;
     callEvents: any[];
+    datachannelUrl: string;
     deferJoin: Promise<any>;
     dialInDeviceStatus: string;
     dialInUrl: string;
@@ -332,7 +342,6 @@ export default class Meeting extends StatelessWebexPlugin {
     inMeetingActions: InMeetingActions;
     isLocalShareLive: boolean;
     isRoapInProgress: boolean;
-    isSharing: boolean;
     keepAliveTimerId: NodeJS.Timeout;
     lastVideoLayoutInfo: any;
     locusInfo: any;
@@ -356,10 +365,13 @@ export default class Meeting extends StatelessWebexPlugin {
     controlsOptionsManager: ControlsOptionsManager;
     requiredCaptcha: any;
     receiveSlotManager: ReceiveSlotManager;
+    selfUserPolicies: any;
     shareStatus: string;
+    screenShareFloorState: ScreenShareFloorStatus;
     statsAnalyzer: StatsAnalyzer;
     transcription: Transcription;
     updateMediaConnections: (mediaConnections: any[]) => void;
+    userDisplayHints: any;
     endCallInitJoinReq: any;
     endJoinReqResp: any;
     endLocalSDPGenRemoteSDPRecvDelay: any;
@@ -378,13 +390,14 @@ export default class Meeting extends StatelessWebexPlugin {
     resourceUrl: string;
     selfId: string;
     state: any;
-    localAudioTrackMuteStateHandler: (event: TrackMuteEvent) => void;
-    localVideoTrackMuteStateHandler: (event: TrackMuteEvent) => void;
-    underlyingLocalTrackChangeHandler: () => void;
+    localAudioStreamMuteStateHandler: (muted: boolean) => void;
+    localVideoStreamMuteStateHandler: (muted: boolean) => void;
+    localOutputTrackChangeHandler: () => void;
     roles: any[];
     environment: string;
     namespace: string;
-    annotationInfo: AnnotationInfo;
+    allowMediaInLobby: boolean;
+    private sendSlotManager;
     /**
      * @param {Object} attrs
      * @param {Object} options
@@ -399,6 +412,11 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {Boolean}
      */
     private isJoined;
+    /**
+     * Returns whether this meeting is a Locus CALL
+     * @returns {Boolean}
+     */
+    isLocusCall(): boolean;
     /**
      * Fetches meeting information.
      * @param {Object} options
@@ -441,12 +459,12 @@ export default class Meeting extends StatelessWebexPlugin {
     refreshCaptcha(): any;
     /**
      * Posts metrics event for this meeting. Allows the app to send Call Analyzer events.
-     * @param {String} eventName - Call Analyzer event, see eventType in src/metrics/config.ts for possible values
+     * @param {String} eventName - Call Analyzer event
      * @public
      * @memberof Meeting
      * @returns {Promise}
      */
-    postMetrics(eventName: string): void;
+    postMetrics(eventName: ClientEvent['name']): void;
     /**
      * Proxy function for all the listener set ups
      * @returns {undefined}
@@ -489,52 +507,6 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     private setUpLocusFullStateListener;
-    /**
-     * get the metrics payload pre
-     * @param {Object} options
-     * @param {String} options.event
-     * @param {String} options.trackingId
-     * @param {Object} options.locus
-     * @param {Array} options.mediaConnections
-     * @param {Object} options.errors
-     * @returns {Object}
-     * @memberof Meeting
-     */
-    getAnalyzerMetricsPrePayload(options: {
-        type?: string;
-        event: string;
-        trackingId: string;
-        locus: object;
-        mediaConnections?: Array<any>;
-        errors?: object;
-        meetingLookupUrl?: string;
-        clientType?: any;
-        subClientType?: any;
-        [key: string]: any;
-    }): {};
-    /**
-     * Send the metrics to call-analyzer dashboard
-     * @param {Object} options
-     * @param {String} options.event
-     * @param {String} options.trackingId
-     * @param {Object} options.locus
-     * @param {Object} options.errors
-     * @returns {Promise}
-     * @private
-     * @memberof Meeting
-     */
-    private sendCallAnalyzerMetrics;
-    /**
-     * Send the metrics to Media Quality Analyzer dashboard
-     * @param {Object} options
-     * @param {String} options.event
-     * @param {String} options.trackingId
-     * @param {Object} options.locus
-     * @returns {Promise}
-     * @private
-     * @memberof Meeting
-     */
-    private sendMediaQualityAnalyzerMetrics;
     /**
      * sets the network status on meeting object
      * @param {String} networkStatus
@@ -773,6 +745,24 @@ export default class Meeting extends StatelessWebexPlugin {
             owner: object;
         };
     } | any, destination?: object | string | null): void;
+    /**
+     * Indicates whether policy can be applied
+     * @returns {boolean}
+     */
+    private arePolicyRestrictionsSupported;
+    /**
+     * Updates the meeting actions (display hints), depends on locus display hints, user policy and app api info
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private updateMeetingActions;
+    /**
+     * 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
@@ -811,10 +801,10 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     uploadLogs(options?: object): void;
     /**
-     * Removes remote audio, video and share tracks from class instance's mediaProperties
+     * Removes remote audio, video and share streams from class instance's mediaProperties
      * @returns {undefined}
      */
-    unsetRemoteTracks(): void;
+    unsetRemoteStreams(): void;
     /**
      * Removes the remote stream on the class instance and triggers an event
      * to developers
@@ -825,37 +815,45 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     closeRemoteStream(): void;
     /**
-     * Removes the remote tracks on the class instance and triggers an event
+     * Removes the remote streams on the class instance and triggers an event
      * to developers
      * @returns {undefined}
      * @memberof Meeting
      */
-    closeRemoteTracks(): Promise<[any, any, any]>;
+    closeRemoteStreams(): Promise<[any, any, any, any]>;
     /**
-     * Stores the reference to a new microphone track, sets up the required event listeners
-     * on it, cleans up previous track, etc.
+     * Stores the reference to a new microphone stream, sets up the required event listeners
+     * on it, cleans up previous stream, etc.
      *
-     * @param {LocalMicrophoneTrack | null} localTrack local microphone track
+     * @param {LocalMicrophoneStream | null} localStream local microphone stream
      * @returns {Promise<void>}
      */
-    private setLocalAudioTrack;
+    private setLocalAudioStream;
     /**
-     * Stores the reference to a new camera track, sets up the required event listeners
-     * on it, cleans up previous track, etc.
+     * Stores the reference to a new camera stream, sets up the required event listeners
+     * on it, cleans up previous stream, etc.
      *
-     * @param {LocalCameraTrack | null} localTrack local camera track
+     * @param {LocalCameraStream | null} localStream local camera stream
      * @returns {Promise<void>}
      */
-    private setLocalVideoTrack;
+    private setLocalVideoStream;
     /**
-     * Stores the reference to a new screen share track, sets up the required event listeners
-     * on it, cleans up previous track, etc.
+     * Stores the reference to a new screen share stream, sets up the required event listeners
+     * on it, cleans up previous stream, etc.
      * It also sends the floor grant/release request.
      *
-     * @param {LocalDisplayTrack | undefined} localDisplayTrack local camera track
+     * @param {LocalDisplayStream | undefined} localDisplayStream local display stream
+     * @returns {Promise<void>}
+     */
+    private setLocalShareVideoStream;
+    /**
+     * Stores the reference to a new screen share audio stream, sets up the required event listeners
+     * on it, cleans up previous stream, etc.
+     *
+     * @param {LocalSystemAudioStream | undefined} localSystemAudioStream local system audio stream
      * @returns {Promise<void>}
      */
-    private setLocalShareTrack;
+    private setLocalShareAudioStream;
     /**
      * sets up listner for mercury event
      * @returns {undefined}
@@ -888,11 +886,46 @@ export default class Meeting extends StatelessWebexPlugin {
      * @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 {MediaDirection} [options.mediaOptions] - see #addMedia()
+     * @param {AddMediaOptions} [options.mediaOptions] - see #addMedia()
      * @returns {Promise} -- {join: see join(), media: see addMedia()}
      * @public
      * @memberof Meeting
@@ -900,7 +933,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * joinWithMedia({
      *  joinOptions: {resourceId: 'resourceId' },
      *  mediaOptions: {
-     *    localTracks: { microphone: microphoneTrack, camera: cameraTrack }
+     *    localStreams: { microphone: microphoneStream, camera: cameraStream }
      *   }
      * })
      */
@@ -1052,10 +1085,11 @@ export default class Meeting extends StatelessWebexPlugin {
     setupStatsAnalyzerEventHandlers: () => void;
     getMediaConnectionDebugId(): string;
     /**
-     * Creates a webrtc media connection and publishes tracks to it
+     * Creates a webrtc media connection and publishes streams to it
      *
      * @param {Object} turnServerInfo TURN server information
      * @param {BundlePolicy} [bundlePolicy] Bundle policy settings
+     * @param {AddMediaOptions} [options] Options for enabling/disabling audio/video
      * @returns {RoapMediaConnection | MultistreamRoapMediaConnection}
      */
     private createMediaConnection;
@@ -1125,7 +1159,8 @@ export default class Meeting extends StatelessWebexPlugin {
     updateMedia(options: {
         audioEnabled?: boolean;
         videoEnabled?: boolean;
-        receiveShare?: boolean;
+        shareAudioEnabled?: boolean;
+        shareVideoEnabled?: boolean;
     }): Promise<void>;
     /**
      * Acknowledge the meeting, outgoing or incoming
@@ -1148,15 +1183,45 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     decline(reason: string): any;
     /**
-     * Leave the current meeting
+     * Returns a promise that will resolve to fetch options for leaving a meeting.
+     *
+     * This is to support quickly submitting a leave request when the browser/tab is closing.
+     * Calling meeting.leave will not work because there are some async steps that will
+     * not complete before the browser is closed.  Instead, we pre-gather all the
+     * information/options needed for the request(s), and then simply and quickly
+     * fire the fetch(es) when pagehide is triggered.
+     *
+     * We must use fetch instead of request because fetch has a keepalive option that
+     * allows the request it to outlive the page.
+     *
+     * Note: the $timings values will be wrong, but setRequestTimingsAndFetch() will
+     * properly adjust them before submitting.
+     *
+     * @public
      * @param {Object} options leave options
      * @param {String} options.resourceId the device with which to leave from, empty if just the computer
+     * @param {any} options.reason the reason for leaving
+     * @returns {Promise} resolves to options to be used with fetch
+     */
+    buildLeaveFetchRequestOptions(options?: {
+        resourceId?: string;
+        reason?: any;
+    }): 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
+     * @param {String} [options.clientEventLeaveReason] - the leaveReason to include in the Call Analyzer event.
+     *                 Must be one of: 'paired-leave' | 'one-to-one' | 'ended-by-locus' (defaults to no reason)
+     *                 https://sqbu-github.cisco.com/WebExSquared/event-dictionary/blob/main/diagnostic-events.raml#L796
+     * @param {String} [options.reason] - only used for logging
      * @returns {Promise}
      * @public
      * @memberof Meeting
      */
     leave(options?: {
         resourceId?: string;
+        clientEventLeaveReason?: ClientEventLeaveReason;
         reason?: any;
     }): any;
     /**
@@ -1312,13 +1377,26 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     setRemoteQualityLevel(level: string): Promise<void>;
     /**
-     * Functionality for when a share is ended.
+     * Functionality for when a share audio is ended.
      * @private
      * @memberof Meeting
-     * @param {MediaStream} localShare
      * @returns {undefined}
      */
-    private handleShareTrackEnded;
+    private handleShareAudioStreamEnded;
+    /**
+     * Functionality for when a share video is ended.
+     * @private
+     * @memberof Meeting
+     * @returns {undefined}
+     */
+    private handleShareVideoStreamEnded;
+    /**
+     * Emits meeting:stoppedSharingLocal
+     * @private
+     * @returns {undefined}
+     * @memberof Meeting
+     */
+    private triggerStoppedSharing;
     /**
      * Emits the 'network:quality' event
      * 1 indicates an acceptable uplink network.
@@ -1338,96 +1416,11 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {undefined}
      */
     private handleMediaLogging;
-    /**
-     * @param {string} typeMedia 'audio' or 'video'
-     * @returns {undefined}
-     */
-    setStartSetupDelay(typeMedia: string): void;
-    /**
-     * @param {string} typeMedia 'audio' or 'video'
-     * @returns {undefined}
-     */
-    setEndSetupDelay(typeMedia: string): void;
-    /**
-     * @param {string} typeMedia 'audio' or 'video'
-     * @returns {string} duration between start and end of setup
-     */
-    getSetupDelayDuration(typeMedia: string): number;
-    /**
-     * @param {string} typeMedia 'audio' or 'video'
-     * @returns {undefined}
-     */
-    setStartSendingMediaDelay(typeMedia: string): void;
-    /**
-     * @param {string} typeMedia 'audio' or 'video'
-     * @returns {undefined}
-     */
-    setEndSendingMediaDelay(typeMedia: string): void;
-    /**
-     * @param {string} typeMedia 'audio' or 'video'
-     * @returns {string} duration between join response and first media tx
-     */
-    getSendingMediaDelayDuration(typeMedia: string): number;
-    /**
-     *
-     * @returns {undefined}
-     */
-    setStartLocalSDPGenRemoteSDPRecvDelay(): void;
-    /**
-     *
-     * @returns {undefined}
-     */
-    setEndLocalSDPGenRemoteSDPRecvDelay(): void;
-    /**
-     *
-     * @returns {string} duration between local SDP generation and remote SDP reception
-     */
-    getLocalSDPGenRemoteSDPRecvDelay(): number;
-    /**
-     *
-     * @returns {undefined}
-     */
-    setStartCallInitJoinReq(): void;
-    /**
-     *
-     * @returns {undefined}
-     */
-    setEndCallInitJoinReq(): void;
-    /**
-     *
-     * @returns {string} duration between call initiate and sending join request to locus
-     */
-    getCallInitJoinReq(): number;
-    /**
-     *
-     * @returns {undefined}
-     */
-    setStartJoinReqResp(): void;
-    /**
-     *
-     * @returns {undefined}
-     */
-    setEndJoinReqResp(): void;
-    /**
-     *
-     * @returns {string} duration between sending locus join request and receiving join response
-     */
-    getJoinReqResp(): number;
-    /**
-     *
-     * @returns {string} duration between call initiate and successful locus join (even if it is in lobby)
-     */
-    getTotalJmt(): number;
     /**
      *
      * @returns {string} one of 'attendee','host','cohost', returns the user type of the current user
      */
     getCurUserType(): "host" | "cohost" | "attendee";
-    /**
-     *
-     * @returns {string} one of 'login-ci','unverified-guest', returns the login type of the current user
-     */
-    getCurLoginType(): "unverified-guest" | "login-ci";
     /**
      * End the current meeting for all
      * @returns {Promise}
@@ -1482,7 +1475,7 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     private checkMediaConnection;
     /**
-     * Method to enable or disable the 'Music mode' effect on audio track
+     * Method to enable or disable the 'Music mode' effect on audio stream
      *
      * @param {boolean} shouldEnableMusicMode
      * @returns {Promise}
@@ -1494,31 +1487,33 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     private updateTranscodedMediaConnection;
     /**
-     * Publishes a track.
+     * Publishes a stream.
      *
-     * @param {LocalTrack} track to publish
+     * @param {MediaType} mediaType of the stream
+     * @param {LocalStream} stream to publish
      * @returns {Promise}
      */
-    private publishTrack;
+    private publishStream;
     /**
-     * Un-publishes a track.
+     * Un-publishes a stream.
      *
-     * @param {LocalTrack} track to unpublish
+     * @param {MediaType} mediaType of the stream
+     * @param {LocalStream} stream to unpublish
      * @returns {Promise}
      */
-    private unpublishTrack;
+    private unpublishStream;
     /**
-     * Publishes specified local tracks in the meeting
+     * Publishes specified local streams in the meeting
      *
-     * @param {Object} tracks
+     * @param {Object} streams
      * @returns {Promise}
      */
-    publishTracks(tracks: LocalTracks): Promise<void>;
+    publishStreams(streams: LocalStreams): Promise<void>;
     /**
-     * Un-publishes specified local tracks in the meeting
+     * Un-publishes specified local streams in the meeting
      *
-     * @param {Array<MediaStreamTrack>} tracks
+     * @param {Array<LocalStream>} streams
      * @returns {Promise}
      */
-    unpublishTracks(tracks: LocalTrack[]): Promise<void>;
+    unpublishStreams(streams: LocalStream[]): Promise<void>;
 }

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

@@ -1,4 +1,5 @@
 import { WebexPlugin } from '@webex/webex-core';
+import { IP_VERSION } from '../constants';
 export type MediaRequestType = 'RoapMessage' | 'LocalMute';
 export type RequestResult = any;
 export type RoapRequest = {
@@ -9,6 +10,7 @@ export type RoapRequest = {
     reachability: any;
     sequence?: any;
     joinCookie: any;
+    ipVersion: IP_VERSION;
 };
 export type LocalMuteRequest = {
     type: 'LocalMute';
@@ -19,12 +21,15 @@ export type LocalMuteRequest = {
         audioMuted?: boolean;
         videoMuted?: boolean;
     };
+    ipVersion: IP_VERSION;
 };
 export type Request = RoapRequest | LocalMuteRequest;
 export type Config = {
     device: {
         url: string;
         deviceType: string;
+        countryCode?: string;
+        regionCode?: string;
     };
     correlationId: string;
     preferTranscoding: boolean;