@webex/internal-plugin-voicea 3.0.0-beta.4 → 3.0.0-beta.400

package/src/constants.ts

@@ -8,7 +8,7 @@ export const EVENT_TRIGGERS = {
 
   NEW_CAPTION: 'voicea:newCaption',
   EVA_COMMAND: 'voicea:wxa',
-  HIGHLIGHT_CREATED: 'voicea:highlightCreated'
+  HIGHLIGHT_CREATED: 'voicea:highlightCreated',
 };
 
 export const VOICEA_RELAY_TYPES = {
@@ -16,7 +16,7 @@ export const VOICEA_RELAY_TYPES = {
   CLIENT_ANNOUNCEMENT: 'client.annc',
   TRANSLATION_REQUEST: 'voicea.transl.req',
   TRANSLATION_RESPONSE: 'voicea.transl.rsp',
-  TRANSCRIPTION: 'voicea.transcription'
+  TRANSCRIPTION: 'voicea.transcription',
 };
 
 export const TRANSCRIPTION_TYPE = {
@@ -26,7 +26,19 @@ export const TRANSCRIPTION_TYPE = {
   EVA_CANCEL: 'eva_cancel',
   HIGHLIGHT_CREATED: 'highlight_created',
   TRANSCRIPT_INTERIM_RESULTS: 'transcript_interim_results',
-  TRANSCRIPT_FINAL_RESULT: 'transcript_final_result'
+  TRANSCRIPT_FINAL_RESULT: 'transcript_final_result',
 };
 
 export const VOICEA = 'voicea';
+
+export const ANNOUNCE_STATUS = {
+  IDLE: 'idle',
+  JOINED: 'joined',
+  JOINING: 'joining',
+};
+
+export const TURN_ON_CAPTION_STATUS = {
+  IDLE: 'idle',
+  ENABLED: 'enabled',
+  SENDING: 'sending',
+};

package/src/index.ts

@@ -5,3 +5,4 @@ import VoiceaChannel from './voicea';
 WebexCore.registerInternalPlugin('voicea', VoiceaChannel, {});
 
 export {default} from './voicea';
+export {EVENT_TRIGGERS, TURN_ON_CAPTION_STATUS} from './constants';

package/src/utils.ts

@@ -3,6 +3,5 @@ export const millisToMinutesAndSeconds = (millis: number) => {
   const minutes = Math.floor(millis / 60000);
   const seconds = ((millis % 60000) / 1000).toFixed(0);
 
-  return `${minutes}:${+(seconds) < 10 ? '0' : ''}${seconds}`;
+  return `${minutes}:${+seconds < 10 ? '0' : ''}${seconds}`;
 };
-

package/src/voicea.ts

@@ -2,7 +2,14 @@ import uuid from 'uuid';
 import {TriggerProxy as Trigger} from '@webex/plugin-meetings';
 import {WebexPlugin, config} from '@webex/webex-core';
 
-import {EVENT_TRIGGERS, VOICEA_RELAY_TYPES, TRANSCRIPTION_TYPE, VOICEA} from './constants';
+import {
+  EVENT_TRIGGERS,
+  VOICEA_RELAY_TYPES,
+  TRANSCRIPTION_TYPE,
+  VOICEA,
+  ANNOUNCE_STATUS,
+  TURN_ON_CAPTION_STATUS,
+} from './constants';
 // eslint-disable-next-line no-unused-vars
 import {
   AnnouncementPayload,
@@ -13,30 +20,36 @@ import {
 import {millisToMinutesAndSeconds} from './utils';
 
 /**
- * VoiceaChannel to hold single instance of LLM
+ * @description VoiceaChannel to hold single instance of LLM
+ * @export
+ * @class VoiceaChannel
  */
 export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
   namespace = VOICEA;
 
   private seqNum: number;
 
-  private hasVoiceaJoined: boolean;
-
   private areCaptionsEnabled: boolean;
 
-  private isTranscribingEnabled: boolean;
-
-  private hasSubscribedToEvents: boolean = false;
+  private hasSubscribedToEvents = false;
 
   private vmcDeviceId?: string;
 
+  private announceStatus: string;
+
+  private captionStatus: string;
+
+  /**
+   * @param {Object} e
+   * @returns {undefined}
+   */
+
   private eventProcessor = (e) => {
-    e;
     this.seqNum = e.sequenceNumber + 1;
     switch (e.data.relayType) {
       case VOICEA_RELAY_TYPES.ANNOUNCEMENT:
         this.vmcDeviceId = e.headers.from;
-        this.hasVoiceaJoined = true;
+        this.announceStatus = ANNOUNCE_STATUS.JOINED;
         this.processAnnouncementMessage(e.data.voiceaPayload);
         break;
       case VOICEA_RELAY_TYPES.TRANSLATION_RESPONSE:
@@ -49,23 +62,31 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
         break;
     }
   };
+
   /**
    * Listen to websocket messages
+   * @returns {undefined}
    */
   private listenToEvents() {
     if (!this.hasSubscribedToEvents) {
+      // @ts-ignore
       this.webex.internal.llm.on('event:relay.event', this.eventProcessor);
       this.hasSubscribedToEvents = true;
     }
   }
 
+  /**
+   * Listen to websocket messages
+   * @returns {void}
+   */
   public deregisterEvents() {
-    this.hasVoiceaJoined = false;
     this.areCaptionsEnabled = false;
-    this.isTranscribingEnabled = false;
     this.vmcDeviceId = undefined;
+    // @ts-ignore
     this.webex.internal.llm.off('event:relay.event', this.eventProcessor);
     this.hasSubscribedToEvents = false;
+    this.announceStatus = ANNOUNCE_STATUS.IDLE;
+    this.captionStatus = TURN_ON_CAPTION_STATUS.IDLE;
   }
 
   /**
@@ -75,10 +96,10 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
   constructor(...args) {
     super(...args);
     this.seqNum = 1;
-    this.hasVoiceaJoined = false;
     this.areCaptionsEnabled = false;
-    this.isTranscribingEnabled = false;
     this.vmcDeviceId = undefined;
+    this.announceStatus = ANNOUNCE_STATUS.IDLE;
+    this.captionStatus = TURN_ON_CAPTION_STATUS.IDLE;
   }
 
   /**
@@ -115,6 +136,7 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
           {
             isFinal: true,
             transcriptId: voiceaPayload.transcript_id,
+            translations: voiceaPayload.translations,
             transcript: {
               csis: voiceaPayload.csis,
               text: voiceaPayload.transcript.text,
@@ -236,14 +258,14 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
    * @returns {void}
    */
   private sendAnnouncement = (): void => {
-    if (this.hasVoiceaJoined || !this.webex.internal.llm.isConnected()) return;
-
+    this.announceStatus = ANNOUNCE_STATUS.JOINING;
     this.listenToEvents();
-
+    // @ts-ignore
     this.webex.internal.llm.socket.send({
       id: `${this.seqNum}`,
       type: 'publishRequest',
       recipients: {
+        // @ts-ignore
         route: this.webex.internal.llm.getBinding(),
       },
       headers: {},
@@ -265,11 +287,15 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
    * @returns {Promise}
    */
   public setSpokenLanguage = (languageCode: string): Promise<void> =>
+    // @ts-ignore
     this.request({
       method: 'PUT',
+      // @ts-ignore
       url: `${this.webex.internal.llm.getLocusUrl()}/controls/`,
       body: {
-        languageCode,
+        transcribe: {
+          spokenLanguage: languageCode,
+        },
       },
     }).then(() => {
       Trigger.trigger(
@@ -289,11 +315,14 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
    * @returns {void}
    */
   public requestLanguage = (languageCode: string): void => {
+    // @ts-ignore
     if (!this.webex.internal.llm.isConnected()) return;
+    // @ts-ignore
     this.webex.internal.llm.socket.send({
       id: `${this.seqNum}`,
       type: 'publishRequest',
       recipients: {
+        // @ts-ignore
         route: this.webex.internal.llm.getBinding(),
       },
       headers: {
@@ -313,59 +342,129 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
   };
 
   /**
-   * Turn on Captions
+   * request turn on Captions
+   * @param {string} [languageCode] - Optional Parameter for spoken language code. Defaults to English
    * @returns {Promise}
    */
-  public turnOnCaptions = async (): undefined | Promise<void> => {
-    if (this.hasVoiceaJoined && this.areCaptionsEnabled) return undefined;
+  private requestTurnOnCaptions = (languageCode?): undefined | Promise<void> => {
+    this.captionStatus = TURN_ON_CAPTION_STATUS.SENDING;
+
+    // only set the spoken language if it is provided
+    const body = {
+      transcribe: {caption: true},
+      languageCode,
+    };
 
+    // @ts-ignore
+    // eslint-disable-next-line newline-before-return
     return this.request({
       method: 'PUT',
+      // @ts-ignore
       url: `${this.webex.internal.llm.getLocusUrl()}/controls/`,
-      body: {
-        transcribe: {caption: true},
-      },
-    }).then(() => {
-      Trigger.trigger(
-        this,
-        {
-          file: 'voicea',
-          function: 'turnOnCaptions',
-        },
-        EVENT_TRIGGERS.CAPTIONS_TURNED_ON
-      );
-      this.areCaptionsEnabled = true;
-      this.sendAnnouncement();
-    });
+      body,
+    })
+      .then(() => {
+        Trigger.trigger(
+          this,
+          {
+            file: 'voicea',
+            function: 'turnOnCaptions',
+          },
+          EVENT_TRIGGERS.CAPTIONS_TURNED_ON
+        );
+        this.areCaptionsEnabled = true;
+        this.captionStatus = TURN_ON_CAPTION_STATUS.ENABLED;
+        this.announce();
+      })
+      .catch(() => {
+        this.captionStatus = TURN_ON_CAPTION_STATUS.IDLE;
+        throw new Error('turn on captions fail');
+      });
+  };
+
+  /**
+   * is announce processing
+   * @returns {boolean}
+   */
+  private isAnnounceProcessing = () =>
+    [ANNOUNCE_STATUS.JOINING, ANNOUNCE_STATUS.JOINED].includes(this.announceStatus);
+
+  /**
+   * announce to voicea data chanel
+   * @returns {void}
+   */
+  public announce = () => {
+    if (this.isAnnounceProcessing()) return;
+    // @ts-ignore
+    if (!this.webex.internal.llm.isConnected()) {
+      throw new Error('voicea can not announce before llm connected');
+    }
+    this.sendAnnouncement();
+  };
+
+  /**
+   * is turn on caption processing
+   * @returns {boolean}
+   */
+  private isCaptionProcessing = () =>
+    [TURN_ON_CAPTION_STATUS.SENDING, TURN_ON_CAPTION_STATUS.ENABLED].includes(this.captionStatus);
+
+  /**
+   * Turn on Captions
+   * @param {string} [spokenLanguage] - Optional Spoken language code
+   * @returns {Promise}
+   */
+  public turnOnCaptions = async (spokenLanguage?): undefined | Promise<void> => {
+    if (this.isCaptionProcessing()) return undefined;
+    // @ts-ignore
+    if (!this.webex.internal.llm.isConnected()) {
+      throw new Error('can not turn on captions before llm connected');
+    }
+
+    return this.requestTurnOnCaptions(spokenLanguage);
   };
 
   /**
    * Toggle transcribing for highlights
    * @param {bool} activate if true transcribing is turned on
+   * @param {string} spokenLanguage language code for spoken language
    * @returns {Promise}
    */
-  public toggleTranscribing = async (activate: boolean): undefined | Promise<void> => {
-    if (this.isTranscribingEnabled === activate) return undefined;
-
+  public toggleTranscribing = (
+    activate: boolean,
+    spokenLanguage?: string
+  ): undefined | Promise<void> => {
+    // @ts-ignore
     return this.request({
       method: 'PUT',
+      // @ts-ignore
       url: `${this.webex.internal.llm.getLocusUrl()}/controls/`,
       body: {
-        transcribe: {transcribing: activate},
-      },
-    }).then(() => {
-      Trigger.trigger(
-        this,
-        {
-          file: 'voicea',
-          function: 'toggleTranscribing',
+        transcribe: {
+          transcribing: activate,
         },
-        activate ? EVENT_TRIGGERS.TRANSCRIBING_ON : EVENT_TRIGGERS.TRANSCRIBING_OFF
-      );
-      this.isTranscribingEnabled = activate;
-      if (activate && !this.areCaptionsEnabled && !this.hasVoiceaJoined) this.turnOnCaptions();
+        spokenLanguage,
+      },
+    }).then((): undefined | Promise<void> => {
+      if (activate && !this.areCaptionsEnabled) {
+        return this.turnOnCaptions(spokenLanguage);
+      }
+
+      return undefined;
     });
   };
+
+  /**
+   * get caption status
+   * @returns {string}
+   */
+  public getCaptionStatus = () => this.captionStatus;
+
+  /**
+   * get announce status
+   * @returns {string}
+   */
+  public getAnnounceStatus = () => this.announceStatus;
 }
 
 export default VoiceaChannel;

package/src/voicea.types.ts

@@ -78,11 +78,11 @@ interface IVoiceaChannel {
   setSpokenLanguage: (languageCode: string) => Promise<void>;
   requestLanguage: (languageCode: string) => void;
   turnOnCaptions: () => undefined | Promise<void>;
-  toggleTranscribing: (activate: boolean) => undefined | Promise<void>;
-  deregisterEvents: () => undefined | Promise<void>;
+  toggleTranscribing: (activate: boolean, spokenLanguage: string) => undefined | Promise<void>;
+  deregisterEvents: () => void;
 }
 
-export {
+export type {
   AnnouncementPayload,
   CaptionLanguageResponse,
   TranscriptionResponse,