@webex/plugin-meetings 2.60.1-next.1 → 2.60.1-next.10

package/dist/meeting/index.d.ts

@@ -10,7 +10,6 @@ import MediaProperties from '../media/properties';
 import ReconnectionManager from '../reconnection-manager';
 import MeetingRequest from './request';
 import Members from '../members/index';
-import Transcription from '../transcription';
 import { NETWORK_STATUS } from '../constants';
 import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
 import { MediaRequestManager } from '../multistream/mediaRequestManager';
@@ -20,6 +19,35 @@ import InMeetingActions from './in-meeting-actions';
 import RecordingController from '../recording-controller';
 import ControlsOptionsManager from '../controls-options-manager';
 import { LocusMediaRequest } from './locusMediaRequest';
+export type CaptionData = {
+    id: string;
+    isFinal: boolean;
+    translations: Array<string>;
+    text: string;
+    currentCaptionLanguage: string;
+    timestamp: string;
+    speaker: string;
+};
+export type Transcription = {
+    languageOptions: {
+        captionLanguages?: string;
+        maxLanguages?: number;
+        spokenLanguages?: Array<string>;
+        currentCaptionLanguage?: string;
+        requestedCaptionLanguage?: string;
+        currentSpokenLanguage?: string;
+    };
+    status: string;
+    isListening: boolean;
+    commandText: string;
+    captions: Array<CaptionData>;
+    highlights: Array<any>;
+    showCaptionBox: boolean;
+    transcribingRequestStatus: string;
+    isCaptioning: boolean;
+    speakerProxy: Map<string, any>;
+    interimCaptions: Map<string, CaptionData>;
+};
 export type LocalStreams = {
     microphone?: LocalMicrophoneStream;
     camera?: LocalCameraStream;
@@ -53,6 +81,12 @@ export declare enum ScreenShareFloorStatus {
     GRANTED = "floor_request_granted",
     RELEASED = "floor_released"
 }
+type FetchMeetingInfoParams = {
+    password?: string;
+    captchaCode?: string;
+    extraParams?: Record<string, any>;
+    sendCAevents?: boolean;
+};
 /**
  * MediaDirection
  * @typedef {Object} MediaDirection
@@ -379,7 +413,6 @@ export default class Meeting extends StatelessWebexPlugin {
     screenShareFloorState: ScreenShareFloorStatus;
     statsAnalyzer: StatsAnalyzer;
     transcription: Transcription;
-    receiveTranscription: boolean;
     updateMediaConnections: (mediaConnections: any[]) => void;
     userDisplayHints: any;
     endCallInitJoinReq: any;
@@ -409,8 +442,12 @@ export default class Meeting extends StatelessWebexPlugin {
     environment: string;
     namespace: string;
     allowMediaInLobby: boolean;
+    localShareInstanceId: string;
+    remoteShareInstanceId: string;
     turnDiscoverySkippedReason: string;
     turnServerUsed: boolean;
+    areVoiceaEventsSetup: boolean;
+    voiceaListenerCallbacks: object;
     private retriedWithTurnServer;
     private sendSlotManager;
     private deferSDPAnswer?;
@@ -445,6 +482,34 @@ export default class Meeting extends StatelessWebexPlugin {
      * @param {string} correlationId
      */
     set correlationId(correlationId: string);
+    /**
+     * Set meeting info and trigger `MEETING_INFO_AVAILABLE` event
+     * @param {any} info
+     * @param {string} [meetingLookupUrl] Lookup url, defined when the meeting info fetched
+     * @returns {void}
+     */
+    private setMeetingInfo;
+    /**
+     * Add pre-fetched meeting info
+     *
+     * The passed meeting info should be be complete, e.g.: fetched after password or captcha provided
+     *
+     * @param {Object} meetingInfo - Complete meeting info
+     * @param {FetchMeetingInfoParams} fetchParams - Fetch parameters for validation
+     * @param {String|undefined} meetingLookupUrl - Lookup url, defined when the meeting info fetched
+     * @returns {Promise<void>}
+     */
+    injectMeetingInfo(meetingInfo: any, fetchParams: FetchMeetingInfoParams, meetingLookupUrl: string | undefined): Promise<void>;
+    /**
+     * Validate fetch parameters and clear the fetchMeetingInfoTimeout timeout
+     *
+     * @param {FetchMeetingInfoParams} fetchParams - fetch parameters for validation
+     * @param {String} caller - Name of the caller for logging
+     *
+     * @returns {Promise<void>}
+     * @private
+     */
+    private prepForFetchMeetingInfo;
     /**
      * Internal method for fetching meeting info
      *
@@ -468,12 +533,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      * @returns {Promise}
      */
-    fetchMeetingInfo({ password, captchaCode, extraParams, sendCAevents, }: {
-        password?: string;
-        captchaCode?: string;
-        extraParams?: Record<string, any>;
-        sendCAevents?: boolean;
-    }): Promise<void>;
+    fetchMeetingInfo(options: FetchMeetingInfoParams): 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.
@@ -530,6 +590,13 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     private setUpInterpretationListener;
+    /**
+     * Set up the listeners for captions
+     * @returns {undefined}
+     * @private
+     * @memberof Meeting
+     */
+    private setUpVoiceaListeners;
     /**
      * Set up the locus info listener for meetings disconnected due to inactivity
      * @returns {undefined}
@@ -771,24 +838,36 @@ export default class Meeting extends StatelessWebexPlugin {
     /**
      * 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 {String} meetingInfo.conversationUrl
+     * @param {String} meetingInfo.locusUrl
+     * @param {String} meetingInfo.sipUri
+     * @param {String} [meetingInfo.sipUrl]
+     * @param {String} [meetingInfo.sipMeetingUri]
+     * @param {String} [meetingInfo.meetingNumber]
+     * @param {String} [meetingInfo.meetingJoinUrl]
+     * @param {String} [meetingInfo.hostId]
+     * @param {String} [meetingInfo.permissionToken]
+     * @param {String} [meetingInfo.channel]
+     * @param {Object} meetingInfo.owner
      * @param {Object | String} destination locus object with meeting data or destination string (sip url, meeting link, etc)
+     * @param {Object | String} errors Meeting info request error
      * @returns {undefined}
      * @private
      * @memberof Meeting
      */
     parseMeetingInfo(meetingInfo: {
-        body: {
-            conversationUrl: string;
-            locusUrl: string;
-            sipUri: string;
-            owner: object;
-        };
-    } | any, destination?: object | string | null): void;
+        conversationUrl: string;
+        locusUrl: string;
+        sipUri: string;
+        owner: object;
+        sipUrl?: string;
+        sipMeetingUri?: string;
+        meetingNumber?: string;
+        meetingJoinUrl?: string;
+        hostId?: string;
+        permissionToken?: string;
+        channel?: string;
+    }, destination?: object | string | null, errors?: any): void;
     /**
      * Indicates whether policy can be applied
      * @returns {boolean}
@@ -1023,17 +1102,26 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     isReactionsSupported(): boolean;
     /**
-     * Monitor the Low-Latency Mercury (LLM) web socket connection on `onError` and `onClose` states
-     * @private
-     * @returns {void}
+     * sets Caption language for the meeting
+     * @param {string} language
+     * @returns {Promise}
      */
-    private monitorTranscriptionSocketConnection;
+    setCaptionLanguage(language: string): Promise<unknown>;
     /**
-     * Request for a WebSocket Url, open and monitor the WebSocket connection
-     * @private
+     * sets Spoken language for the meeting
+     * @param {string} language
+     * @returns {Promise}
+     */
+    setSpokenLanguage(language: string): Promise<unknown>;
+    /**
+     * This method will enable the transcription for the current meeting if the meeting has enabled/supports Webex Assistant
+     * @param {Object} options object with spokenlanguage setting
+     * @public
      * @returns {Promise<void>} a promise to open the WebSocket connection
      */
-    private startTranscription;
+    startTranscription(options?: {
+        spokenLanguage?: string;
+    }): Promise<void>;
     /**
      * Callback called when a relay event is received from meeting LLM Connection
      * @param {RelayEvent} e Event object coming from LLM Connection
@@ -1042,11 +1130,10 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     private processRelayEvent;
     /**
-     * stop recieving Transcription by closing
-     * the web socket connection properly
+     * This method stops receiving transcription for the current meeting
      * @returns {void}
      */
-    stopReceivingTranscription(): void;
+    stopTranscription(): void;
     /**
      * triggers an event to notify that the user
      * will not receive any more transcription
@@ -1597,7 +1684,7 @@ export default class Meeting extends StatelessWebexPlugin {
      *
      * @returns {string} one of 'attendee','host','cohost', returns the user type of the current user
      */
-    getCurUserType(): "host" | "cohost" | "attendee";
+    getCurUserType(): "host" | "cohost" | "presenter" | "attendee";
     /**
      * End the current meeting for all
      * @returns {Promise}
@@ -1717,3 +1804,4 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     checkAndRefreshPermissionToken(threshold: number, reason: string): Promise<void>;
 }
+export {};