@kaltura-sdk/avatars 1.18.0 → 1.20.0

package/README.md

@@ -34,7 +34,7 @@ manager.stop(); // full teardown, unsubscribes everything
 - **Pause/resume**: `pause()`, `resume()`, `pauseAfterSpeaking()`, `isPaused`
 - **Chat & content**: `askViaText()`, `chatLog`, `content`, `setLocalContent()`, `clearContent()`, `agentData`
 - **Screen share**: `startScreenShare()`, `stopScreenShare()`, `screenShareInfo`
-- **Tap-to-talk**: `tapToTalkStart()`, `tapToTalkEnd()`, `toggleTapToTalkMode()`, `tapToTalkInfo`
+- **Tap-to-talk**: `tapToTalkStart(options?)` (`options.enrichAudio` asks the server to analyze the recording; `options.referenceText` is the text being read, sent with `enrichAudio`), `tapToTalkEnd()`, `toggleTapToTalkMode()`, `tapToTalkInfo`
 - **Captions**: `captions` (state + `toggle`/`setReplacements`/`setFilter`)
 - **Kaltura context**: `kalturaContext`, `toggleKalturaContext()`, `updateDynamicVariables()`
 - **Client tools**: `registerClientTools()`, `unregisterClientTools()`, `registeredClientTools`, `clientToolCallLog`

package/index.esm.js

@@ -23103,13 +23103,30 @@ const isTapToTalkEnabled = ({
 };
 
 const sendTapToTalkStart = ({
-  context
+  context,
+  event
 }) => {
+  var _a;
+  assertEvent(event, AvatarConnectionMachineEventTypes.RequestTapToTalkStart);
   const client = websocketClientManager.getClient(context.externalInfo.serverUrl);
   if (!client) {
     throw new Error('WebSocket client not found');
   }
-  client.emit('tapToTalkStart');
+  const {
+    enrichAudio,
+    referenceText
+  } = (_a = event.options) !== null && _a !== void 0 ? _a : {};
+  // No payload without options keeps the event identical for servers that predate the flag
+  if (enrichAudio === undefined) {
+    client.emit('tapToTalkStart');
+    return;
+  }
+  client.emit('tapToTalkStart', referenceText === undefined ? {
+    enrichAudio
+  } : {
+    enrichAudio,
+    referenceText
+  });
 };
 
 const sendTapToTalkEnd = ({
@@ -24238,7 +24255,7 @@ class AvatarClientManager extends ActorManager {
       pauseAvatar: () => this.pause(),
       resumeAvatar: () => this.resume(),
       pauseAvatarAfterSpeaking: () => this.pauseAfterSpeaking(),
-      tapToTalkStart: () => this.tapToTalkStart(),
+      tapToTalkStart: options => this.tapToTalkStart(options),
       tapToTalkEnd: () => this.tapToTalkEnd(),
       clearContent: () => this.clearContent(),
       toggleCaptions: () => this.toggleCaptions(),
@@ -24457,10 +24474,11 @@ class AvatarClientManager extends ActorManager {
   get tapToTalkInfo() {
     return this._tapToTalkInfo.consumer;
   }
-  tapToTalkStart() {
+  tapToTalkStart(options) {
     var _a;
     (_a = this._actor) === null || _a === void 0 ? void 0 : _a.send({
-      type: AvatarConnectionMachineEventTypes.RequestTapToTalkStart
+      type: AvatarConnectionMachineEventTypes.RequestTapToTalkStart,
+      options
     });
   }
   tapToTalkEnd() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaltura-sdk/avatars",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "author": "kaltura",
   "license": "AGPL-3.0",
   "repository": {
@@ -13,7 +13,7 @@
     "@kaltura-sdk/rtc-core": "^1.26.2",
     "@local/genie-shared-utils": "^1.0.0",
     "@unisphere/core": "^1.99.0",
-    "@unisphere/genie-types": "^1.43.0",
+    "@unisphere/genie-types": "^1.46.0",
     "@unisphere/notifications-core": "^1.25.0",
     "@unisphere/runtime": "^1.98.0",
     "@unisphere/runtime-js": "^1.98.0",

package/src/lib/avatar-client-manager/avatar-client-manager.d.ts

@@ -1,6 +1,6 @@
 import { UnisphereLoggerType } from '@unisphere/core';
 import { KalturaAnalyticsServiceType, PubSubServiceType } from '@unisphere/runtime';
-import { AgentData, AgentKalturaContextData, AgentProgressBar, AgentScreenShareInfo, AgentTapToTalkInfo, AvatarClientManagerType, AvatarConnectionProxInternalType, AvatarConnectionProxyType, AvatarConnectionStatus, AvatarContentData, AvatarRuntimeSettings, CaptionConfig, Captions, ChatEntry, ClientToolCallLogEntry, DisconnectReasons } from '@unisphere/genie-types';
+import { AgentData, AgentKalturaContextData, AgentProgressBar, AgentScreenShareInfo, AgentTapToTalkInfo, AvatarClientManagerType, AvatarConnectionProxInternalType, AvatarConnectionProxyType, AvatarConnectionStatus, AvatarContentData, AvatarRuntimeSettings, CaptionConfig, Captions, ChatEntry, ClientToolCallLogEntry, DisconnectReasons, TapToTalkStartOptions } from '@unisphere/genie-types';
 import { type AvatarClientToolsInput, type AvatarConnectionActor } from './machines/avatar-connection';
 import { AvatarClientManagerActions } from './types';
 import { DeviceType } from '@kaltura-sdk/rtc-core';
@@ -128,7 +128,7 @@ export declare class AvatarClientManager extends ActorManager<AvatarConnectionAc
     startScreenShare(): void;
     stopScreenShare(): void;
     get tapToTalkInfo(): import("@unisphere/core").TinyDataStoreConsumer<AgentTapToTalkInfo | null>;
-    tapToTalkStart(): void;
+    tapToTalkStart(options?: TapToTalkStartOptions): void;
     tapToTalkEnd(): void;
     toggleTapToTalkMode(enabled: boolean): void;
     get captions(): Captions;

package/src/lib/avatar-client-manager/machines/avatar-connection/actions/server/send-tap-to-talk-start.d.ts

@@ -1,4 +1,2 @@
-import { AvatarConnectionMachineContext } from '../../types';
-export declare const sendTapToTalkStart: ({ context, }: {
-    context: AvatarConnectionMachineContext;
-}) => void;
+import { AvatarConnectionMachineAction } from '../../types';
+export declare const sendTapToTalkStart: AvatarConnectionMachineAction;

package/src/lib/avatar-client-manager/machines/avatar-connection/types/events.d.ts

@@ -2,7 +2,7 @@ import { DoneActorEvent, ErrorActorEvent } from 'xstate';
 import { ChatEntry, UnisphereChatBlock } from '@unisphere/genie-types';
 import { askPermissionsSchema, clientConfigurationSchema, conversationEndedSchema, conversationTimeWarningSchema, joinCompleteSchema, noAgentSchema, onServerConnectedSchema, showAgentSchema, showStartSpeechSchema, stvFinishedTalkingSchema, stvNewSessionSchema, stvStartedTalkingSchema } from './schemas';
 import z from 'zod';
-import { AgentProgressBar, CaptionState, ClientToolCallLogEntry, DisconnectReasons } from '@unisphere/genie-types';
+import { AgentProgressBar, CaptionState, ClientToolCallLogEntry, DisconnectReasons, TapToTalkStartOptions } from '@unisphere/genie-types';
 export declare enum AvatarConnectionMachineEventTypes {
     Disconnect = "Disconnect",
     WebsocketReconnected = "WebsocketReconnected",
@@ -212,6 +212,7 @@ export type SetDynamicVariablesEvent = {
 };
 export type RequestTapToTalkStartEvent = {
     type: AvatarConnectionMachineEventTypes.RequestTapToTalkStart;
+    options?: TapToTalkStartOptions;
 };
 export type RequestTapToTalkEndEvent = {
     type: AvatarConnectionMachineEventTypes.RequestTapToTalkEnd;