@webex/internal-plugin-voicea 3.11.0 → 3.12.0-metrics-init-fix-2.1

package/src/constants.ts

@@ -1,3 +1,5 @@
+export {LLM_PRACTICE_SESSION} from '@webex/internal-plugin-llm';
+
 export const EVENT_TRIGGERS = {
   VOICEA_ANNOUNCEMENT: 'voicea:announcement',
   CAPTION_LANGUAGE_UPDATE: 'voicea:captionLanguageUpdate',

package/src/voicea.ts

@@ -6,6 +6,7 @@ import {
   AIBRIDGE_RELAY_TYPES,
   TRANSCRIPTION_TYPE,
   VOICEA,
+  LLM_PRACTICE_SESSION,
   ANNOUNCE_STATUS,
   TURN_ON_CAPTION_STATUS,
   TOGGLE_MANUAL_CAPTION_STATUS,
@@ -41,6 +42,8 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
 
   private captionStatus: string;
 
+  private keepTranscriptionSubscribed: boolean;
+
   private toggleManualCaptionStatus: string;
 
   private currentSpokenLanguage?: string;
@@ -89,6 +92,8 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
     if (!this.hasSubscribedToEvents) {
       // @ts-ignore
       this.webex.internal.llm.on('event:relay.event', this.eventProcessor);
+      // @ts-ignore
+      this.webex.internal.llm.on(`event:relay.event:${LLM_PRACTICE_SESSION}`, this.eventProcessor);
       this.hasSubscribedToEvents = true;
     }
   }
@@ -99,9 +104,12 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
    */
   public deregisterEvents() {
     this.areCaptionsEnabled = false;
+    this.keepTranscriptionSubscribed = false;
     this.captionServiceId = undefined;
     // @ts-ignore
     this.webex.internal.llm.off('event:relay.event', this.eventProcessor);
+    // @ts-ignore
+    this.webex.internal.llm.off(`event:relay.event:${LLM_PRACTICE_SESSION}`, this.eventProcessor);
     this.hasSubscribedToEvents = false;
     this.announceStatus = ANNOUNCE_STATUS.IDLE;
     this.captionStatus = TURN_ON_CAPTION_STATUS.IDLE;
@@ -118,6 +126,7 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
     super(...args);
     this.seqNum = 1;
     this.areCaptionsEnabled = false;
+    this.keepTranscriptionSubscribed = false;
     this.captionServiceId = undefined;
     this.announceStatus = ANNOUNCE_STATUS.IDLE;
     this.captionStatus = TURN_ON_CAPTION_STATUS.IDLE;
@@ -257,6 +266,38 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
     this.trigger(EVENT_TRIGGERS.VOICEA_ANNOUNCEMENT, voiceaLanguageOptions);
   };
 
+  /**
+   * Indicates whether the default or practice-session LLM connection is active.
+   * @returns {boolean}
+   */
+  private isLLMConnected = (): boolean =>
+    // @ts-ignore
+    this.webex.internal.llm.isConnected() ||
+    // @ts-ignore
+    this.webex.internal.llm.isConnected(LLM_PRACTICE_SESSION);
+
+  public getKeepTranscriptionSubscribed = (): boolean => this.keepTranscriptionSubscribed;
+
+  /**
+   * Resolves the active LLM publish transport, preferring the practice-session
+   * connection only when that session is fully connected.
+   * @returns {Object}
+   */
+  private getPublishTransport = () => {
+    // @ts-ignore
+    const {llm} = this.webex.internal;
+    const isPracticeSessionConnected = llm.isConnected(LLM_PRACTICE_SESSION);
+
+    return {
+      socket: (isPracticeSessionConnected && llm.getSocket(LLM_PRACTICE_SESSION)) || llm.socket,
+      binding:
+        (isPracticeSessionConnected && llm.getBinding(LLM_PRACTICE_SESSION)) || llm.getBinding(),
+      datachannelUrl:
+        (isPracticeSessionConnected && llm.getDatachannelUrl(LLM_PRACTICE_SESSION)) ||
+        llm.getDatachannelUrl(),
+    };
+  };
+
   /**
    * Sends Announcement to add voicea to the meeting
    * @returns {void}
@@ -264,14 +305,15 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
   private sendAnnouncement = (): void => {
     this.announceStatus = ANNOUNCE_STATUS.JOINING;
     this.listenToEvents();
-    // @ts-ignore
-    this.webex.internal.llm.socket.send({
+    const {socket, binding} = this.getPublishTransport();
+    socket.send({
       id: `${this.seqNum}`,
       type: 'publishRequest',
-      recipients: {
-        // @ts-ignore
-        route: this.webex.internal.llm.getBinding(),
-      },
+      recipients: [
+        {
+          route: binding,
+        },
+      ],
       // If captionServiceId exists, send it as the 'to' header; otherwise keep headers empty.
       headers: this.captionServiceId ? {to: this.captionServiceId} : {},
       data: {
@@ -318,16 +360,19 @@ 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({
+    if (!this.isLLMConnected()) {
+      return;
+    }
+
+    const {socket, binding} = this.getPublishTransport();
+    socket.send({
       id: `${this.seqNum}`,
       type: 'publishRequest',
-      recipients: {
-        // @ts-ignore
-        route: this.webex.internal.llm.getBinding(),
-      },
+      recipients: [
+        {
+          route: binding,
+        },
+      ],
       headers: {
         to: this.captionServiceId,
       },
@@ -360,17 +405,20 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
     csis: number[],
     isFinal: boolean
   ): void => {
-    // @ts-ignore
-    if (!this.webex.internal.llm.isConnected()) return;
+    if (!this.isLLMConnected()) {
+      return;
+    }
 
-    // @ts-ignore
-    this.webex.internal.llm.socket.send({
+    const {socket, binding} = this.getPublishTransport();
+
+    socket?.send({
       id: `${this.seqNum}`,
       type: 'publishRequest',
-      recipients: {
-        // @ts-ignore
-        route: this.webex.internal.llm.getBinding(),
-      },
+      recipients: [
+        {
+          route: binding,
+        },
+      ],
       headers: {},
       data: {
         eventType: 'relay.event',
@@ -425,6 +473,7 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
         this.areCaptionsEnabled = true;
         this.captionStatus = TURN_ON_CAPTION_STATUS.ENABLED;
         this.announce();
+        this.updateSubchannelSubscriptionsAndSyncCaptionState({subscribe: ['transcription']}, true);
       })
       .catch(() => {
         this.captionStatus = TURN_ON_CAPTION_STATUS.IDLE;
@@ -439,14 +488,21 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
   private isAnnounceProcessing = () =>
     [ANNOUNCE_STATUS.JOINING, ANNOUNCE_STATUS.JOINED].includes(this.announceStatus);
 
+  /**
+   * is announce processed
+   * @returns {boolean}
+   */
+  private isAnnounceProcessed = () => this.announceStatus === ANNOUNCE_STATUS.JOINED;
+
   /**
    * announce to voicea data chanel
    * @returns {void}
    */
   public announce = () => {
-    if (this.isAnnounceProcessing()) return;
-    // @ts-ignore
-    if (!this.webex.internal.llm.isConnected()) {
+    if (this.isAnnounceProcessed()) {
+      return;
+    }
+    if (!this.isLLMConnected()) {
       throw new Error('voicea can not announce before llm connected');
     }
     this.sendAnnouncement();
@@ -466,8 +522,8 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
    */
   public turnOnCaptions = async (spokenLanguage?): undefined | Promise<void> => {
     if (this.captionStatus === TURN_ON_CAPTION_STATUS.SENDING) return undefined;
-    // @ts-ignore
-    if (!this.webex.internal.llm.isConnected()) {
+
+    if (!this.isLLMConnected()) {
       throw new Error('can not turn on captions before llm connected');
     }
 
@@ -577,6 +633,69 @@ export class VoiceaChannel extends WebexPlugin implements IVoiceaChannel {
    * @returns {string}
    */
   public getAnnounceStatus = () => this.announceStatus;
+  /**
+   * update LLM sub‑channel subscriptions.
+   *
+   * sends a single `subchannelSubscriptionRequest` to LLM,
+   * allowing subscribe and unsubscribe subchannel.
+   *
+   * @param {string[]} options.subscribe   Sub‑channels to subscribe to.
+   * @param {string[]} options.unsubscribe Sub‑channels to unsubscribe from.
+   * @returns {Promise}
+   */
+  public updateSubchannelSubscriptions = async ({
+    subscribe = [],
+    unsubscribe = [],
+  }: {
+    subscribe?: string[];
+    unsubscribe?: string[];
+  } = {}): Promise<void> => {
+    // @ts-ignore
+    const isDataChannelTokenEnabled = await this.webex.internal.llm.isDataChannelTokenEnabled();
+    // @ts-ignore
+    if (!this.isLLMConnected() || !isDataChannelTokenEnabled) return;
+
+    const {socket, datachannelUrl} = this.getPublishTransport();
+
+    // @ts-ignore
+    socket.send({
+      id: `${this.seqNum}`,
+      type: 'subchannelSubscriptionRequest',
+      data: {
+        // @ts-ignore
+        datachannelUri: datachannelUrl,
+        subscribe,
+        unsubscribe,
+      },
+      trackingId: `${config.trackingIdPrefix}_${uuid.v4().toString()}`,
+    });
+
+    this.seqNum += 1;
+  };
+
+  /**
+   * Updates transcription subchannel subscriptions and records whether the
+   * transcription subscription should be kept (and restored on reconnect).
+   *
+   * @param {Object} [options] - Subscription options.
+   * @param {string[]} [options.subscribe] - Subchannels to subscribe to.
+   * @param {string[]} [options.unsubscribe] - Subchannels to unsubscribe from.
+   * @param {boolean} [keepSubscribed=false] - Whether the transcription
+   * subscription should be kept and restored on reconnect.
+   *
+   * @returns {Promise<void>}
+   */
+  public updateSubchannelSubscriptionsAndSyncCaptionState = (
+    options: {
+      subscribe?: string[];
+      unsubscribe?: string[];
+    } = {},
+    keepSubscribed = false
+  ): Promise<void> => {
+    this.keepTranscriptionSubscribed = keepSubscribed;
+
+    return this.updateSubchannelSubscriptions(options);
+  };
 }
 
 export default VoiceaChannel;