ConvaiClient（核心 API）

ConvaiClient 是在原生 TypeScript 中管理 Convai 的主类。

创建客户端

const client = new ConvaiClient();

你在调用时进行配置 connect().

---

连接中

await client.connect({
  apiKey: string;                    // 必需：您的 API 密钥
  characterId: string;                // 必需：角色 ID
  endUserId?: string;                 // 可选：用于记忆和分析
  url?: string;                       // 可选：自定义 API 端点
  enableVideo?: boolean;              // 启用视频/屏幕共享（默认：false）
  startWithVideoOn?: boolean;         // 启动时开启摄像头（默认：false）
  startWithAudioOn?: boolean;         // 启动时开启麦克风（默认：false）
  ttsEnabled?: boolean;               // 启用 TTS（默认：true）
  enableLipsync?: boolean;            // 启用 blendshape（默认：false）
  blendshapeConfig?: {
    format?: 'arkit' | 'mha';         // 形变格式（默认：'mha'）
  };
  actionConfig?: {                    // 可选：角色动作
    actions: string[];
    characters: Array<{ name: string; bio: string }>;
    objects: Array<{ name: string; description: string }>;
    currentAttentionObject?: string;
  };
});

---

连接方法

await client.disconnect();
await client.reconnect(); // 使用最后提供的配置
client.resetSession();    // 清除历史记录

---

消息发送

client.sendUserTextMessage('你好');
client.sendTriggerMessage('greet_user', '可选负载');

client.updateTemplateKeys({ user: 'Alex' });
client.updateDynamicInfo({ text: '用户正在博客页面' });

client.toggleTts(true);  // 启用/禁用 TTS

---

媒体控制

所有控制均为异步。

// 音频
await client.audioControls.toggleAudio();
await client.audioControls.muteAudio();
await client.audioControls.unmuteAudio();
await client.audioControls.setAudioDevice('device-id');

// 视频
await client.videoControls.toggleVideo();
await client.videoControls.enableVideo();
await client.videoControls.disableVideo();

// 屏幕共享
await client.screenShareControls.toggleScreenShare();

---

核心属性

client.state                 // 连接 + 活动状态
client.connectionType        // 'audio' | 'video' | null
client.isBotReady            // 机器人已准备好接收消息

client.chatMessages          // ChatMessage 数组
client.userTranscription     // 实时语音转文字
client.characterSessionId    // 会话 ID

client.room