@coze/realtime-api 1.2.1-beta.9 → 1.3.1

package/dist/types/live/event-names.d.ts

@@ -0,0 +1,213 @@
+declare enum EventNames {
+    /**
+     * en: All events
+     * zh: 所有事件
+     */
+    ALL = "realtime.event",
+    /**
+     * en: All client events
+     * zh: 所有客户端事件
+     */
+    ALL_CLIENT = "client.*",
+    /**
+     * en: All server events
+     * zh: 所有服务端事件
+     */
+    ALL_SERVER = "server.*",
+    /**
+     * en: Room info
+     * zh: 房间信息
+     */
+    ROOM_INFO = "client.room.info",
+    /**
+     * en: Client connected
+     * zh: 客户端连接
+     */
+    CONNECTED = "client.connected",
+    /**
+     * en: Client connecting
+     * zh: 客户端连接中
+     */
+    CONNECTING = "client.connecting",
+    /**
+     * en: Client interrupted
+     * zh: 客户端中断
+     */
+    INTERRUPTED = "client.interrupted",
+    /**
+     * en: Client disconnected
+     * zh: 客户端断开
+     */
+    DISCONNECTED = "client.disconnected",
+    /**
+     * en: Client audio unmuted
+     * zh: 客户端音频未静音
+     */
+    AUDIO_UNMUTED = "client.audio.unmuted",
+    /**
+     * en: Client audio muted
+     * zh: 客户端音频静音
+     */
+    AUDIO_MUTED = "client.audio.muted",
+    /**
+     * en: Client video on
+     * zh: 客户端视频开启
+     */
+    VIDEO_ON = "client.video.on",
+    /**
+     * en: Client video off
+     * zh: 客户端视频关闭
+     */
+    VIDEO_OFF = "client.video.off",
+    /**
+     * en: Client video error
+     * zh: 客户端视频(或屏幕共享）错误
+     */
+    VIDEO_ERROR = "client.video.error",
+    /**
+     * en: Client video event
+     * zh: 客户端视频事件
+     */
+    PLAYER_EVENT = "client.video.event",
+    /**
+     * en: Client error
+     * zh: 客户端错误
+     */
+    ERROR = "client.error",
+    /**
+     * en: Audio noise reduction enabled
+     * zh: 抑制平稳噪声
+     */
+    SUPPRESS_STATIONARY_NOISE = "client.suppress.stationary.noise",
+    /**
+     * en: Suppress non-stationary noise
+     * zh: 抑制非平稳噪声
+     */
+    SUPPRESS_NON_STATIONARY_NOISE = "client.suppress.non.stationary.noise",
+    /**
+     * en: Audio input device changed
+     * zh: 音频输入设备改变
+     */
+    AUDIO_INPUT_DEVICE_CHANGED = "client.input.device.changed",
+    /**
+     * en: Audio output device changed
+     * zh: 音频输出设备改变
+     */
+    AUDIO_OUTPUT_DEVICE_CHANGED = "client.output.device.changed",
+    /**
+     * en: Video input device changed
+     * zh: 视频输入设备改变
+     */
+    VIDEO_INPUT_DEVICE_CHANGED = "client.video.input.device.changed",
+    /**
+     * en: Network quality changed
+     * zh: 网络质量改变
+     */
+    NETWORK_QUALITY = "client.network.quality",
+    /**
+     * en: Bot joined
+     * zh: Bot 加入
+     */
+    BOT_JOIN = "server.bot.join",
+    /**
+     * en: Bot left
+     * zh: Bot 离开
+     */
+    BOT_LEAVE = "server.bot.leave",
+    /**
+     * en: Audio speech started
+     * zh: 开始说话
+     */
+    AUDIO_AGENT_SPEECH_STARTED = "server.audio.agent.speech_started",
+    /**
+     * en: Audio speech stopped
+     * zh: 停止说话
+     */
+    AUDIO_AGENT_SPEECH_STOPPED = "server.audio.agent.speech_stopped",
+    /**
+     * en: Server error
+     * zh: 服务端错误
+     */
+    SERVER_ERROR = "server.error",
+    /**
+     * en: User speech started
+     * zh: 用户开始说话
+     */
+    AUDIO_USER_SPEECH_STARTED = "server.audio.user.speech_started",
+    /**
+     * en: User speech stopped
+     * zh: 用户停止说话
+     */
+    AUDIO_USER_SPEECH_STOPPED = "server.audio.user.speech_stopped",
+    /**
+     * en: User successfully enters the room
+     * zh: 用户成功进入房间后，会收到该事件
+     */
+    SESSION_CREATED = "server.session.created",
+    /**
+     * en: Session updated
+     * zh: 会话更新
+     */
+    SESSION_UPDATED = "server.session.updated",
+    /**
+     * en: Conversation created
+     * zh: 会话创建
+     */
+    CONVERSATION_CREATED = "server.conversation.created",
+    /**
+     * en: Conversation chat created
+     * zh: 会话对话创建
+     */
+    CONVERSATION_CHAT_CREATED = "server.conversation.chat.created",
+    /**
+     * en: Conversation chat in progress
+     * zh: 对话正在处理中
+     */
+    CONVERSATION_CHAT_IN_PROGRESS = "server.conversation.chat.in_progress",
+    /**
+     * en: Conversation message delta received
+     * zh: 文本消息增量返回
+     */
+    CONVERSATION_MESSAGE_DELTA = "server.conversation.message.delta",
+    /**
+     * en: Conversation message completed
+     * zh: 文本消息完成
+     */
+    CONVERSATION_MESSAGE_COMPLETED = "server.conversation.message.completed",
+    /**
+     * en: Conversation chat completed
+     * zh: 对话完成
+     */
+    CONVERSATION_CHAT_COMPLETED = "server.conversation.chat.completed",
+    /**
+     * en: Conversation chat requires action
+     * zh: 对话需要插件
+     */
+    CONVERSATION_CHAT_REQUIRES_ACTION = "server.conversation.chat.requires_action",
+    /**
+     * en: Conversation chat failed
+     * zh: 对话失败
+     */
+    CONVERSATION_CHAT_FAILED = "server.conversation.chat.failed",
+    /**
+     * en: Session pre answer updated
+     * zh: 安抚配置更新成功
+     */
+    SESSION_PRE_ANSWER_UPDATED = "server.session.pre_answer.updated",
+    /**
+     * en: Conversation audio transcript delta
+     * zh: 用户语音识别字幕
+     */
+    CONVERSATION_AUDIO_TRANSCRIPT_DELTA = "server.conversation.audio_transcript.delta",
+    /**
+     * en: Mode updated
+     * zh: 更新房间模式成功
+     */
+    MODE_UPDATED = "server.mode.updated",
+    /**
+     * en: Live created
+     * zh: 直播创建
+     */
+    LIVE_CREATED = "server.live.created"
+}
+export default EventNames;

package/dist/types/live/index.d.ts

@@ -0,0 +1,86 @@
+/**
+ * WebRTC资源状态
+ */
+export declare enum ResourceStatus {
+    IDLE = "idle",// 初始状态
+    CONNECTING = "connecting",// 连接中
+    CONNECTED = "connected",// 已连接
+    FAILED = "failed",// 连接失败
+    CLOSING = "closing",// 关闭中
+    CLOSED = "closed"
+}
+export type StatusChangeCallback = (status: ResourceStatus) => void;
+/**
+ * 同声传译客户端
+ */
+export declare class WebLiveClient {
+    private peerConnection;
+    private resourceUrl;
+    private status;
+    private player;
+    private statusListeners;
+    private liveId;
+    constructor(liveId: string);
+    /**
+     * 获取当前连接状态
+     */
+    getStatus(): ResourceStatus;
+    /**
+     * 添加状态变化监听器
+     * @param callback 状态变化回调函数
+     */
+    onStatusChange(callback: StatusChangeCallback): void;
+    /**
+     * 移除状态变化监听器
+     * @param callback 要移除的回调函数
+     */
+    offStatusChange(callback: StatusChangeCallback): void;
+    /**
+     * 移除状态变化监听器
+     * @param callback 要移除的回调函数
+     */
+    removeStatusListener(callback: StatusChangeCallback): void;
+    /**
+     * 订阅音频资源
+     * @param appId 应用ID
+     * @param streamId 流ID
+     * @param clientId 客户端ID
+     */
+    subscribe(appId: string, streamId: string, clientId?: string): Promise<{
+        status: ResourceStatus;
+        peerConnection: RTCPeerConnection;
+    }>;
+    /**
+     * 销毁订阅资源
+     */
+    unsubscribe(): Promise<boolean>;
+    /**
+     * 静音/取消静音
+     * @param muted 是否静音
+     */
+    setMuted(muted: boolean): void;
+    /**
+     * 关闭并清理资源
+     */
+    close(): void;
+    /**
+     * 获取直播信息
+     */
+    getLiveData: () => Promise<import("@coze/api").RetrieveLiveData>;
+    /**
+     * 等待ICE收集完成
+     * @param pc RTCPeerConnection实例
+     */
+    private waitForIceGathering;
+    private setupPeerConnectionListeners;
+    /**
+     * 关闭PeerConnection
+     */
+    private closePeerConnection;
+    /**
+     * 设置状态并触发监听回调
+     * @param newStatus 新状态
+     * @private 私有方法，仅内部使用
+     */
+    private setStatus;
+}

package/dist/types/live/live/index.d.ts

@@ -0,0 +1,86 @@
+/**
+ * WebRTC资源状态
+ */
+export declare enum ResourceStatus {
+    IDLE = "idle",// 初始状态
+    CONNECTING = "connecting",// 连接中
+    CONNECTED = "connected",// 已连接
+    FAILED = "failed",// 连接失败
+    CLOSING = "closing",// 关闭中
+    CLOSED = "closed"
+}
+export type StatusChangeCallback = (status: ResourceStatus) => void;
+/**
+ * 同声传译客户端
+ */
+export declare class WebLiveClient {
+    private peerConnection;
+    private resourceUrl;
+    private status;
+    private player;
+    private statusListeners;
+    private liveId;
+    constructor(liveId: string);
+    /**
+     * 获取当前连接状态
+     */
+    getStatus(): ResourceStatus;
+    /**
+     * 添加状态变化监听器
+     * @param callback 状态变化回调函数
+     */
+    onStatusChange(callback: StatusChangeCallback): void;
+    /**
+     * 移除状态变化监听器
+     * @param callback 要移除的回调函数
+     */
+    offStatusChange(callback: StatusChangeCallback): void;
+    /**
+     * 移除状态变化监听器
+     * @param callback 要移除的回调函数
+     */
+    removeStatusListener(callback: StatusChangeCallback): void;
+    /**
+     * 订阅音频资源
+     * @param appId 应用ID
+     * @param streamId 流ID
+     * @param clientId 客户端ID
+     */
+    subscribe(appId: string, streamId: string, clientId?: string): Promise<{
+        status: ResourceStatus;
+        peerConnection: RTCPeerConnection;
+    }>;
+    /**
+     * 销毁订阅资源
+     */
+    unsubscribe(): Promise<boolean>;
+    /**
+     * 静音/取消静音
+     * @param muted 是否静音
+     */
+    setMuted(muted: boolean): void;
+    /**
+     * 关闭并清理资源
+     */
+    close(): void;
+    /**
+     * 获取直播信息
+     */
+    getLiveData: () => Promise<import("@coze/api").RetrieveLiveData>;
+    /**
+     * 等待ICE收集完成
+     * @param pc RTCPeerConnection实例
+     */
+    private waitForIceGathering;
+    private setupPeerConnectionListeners;
+    /**
+     * 关闭PeerConnection
+     */
+    private closePeerConnection;
+    /**
+     * 设置状态并触发监听回调
+     * @param newStatus 新状态
+     * @private 私有方法，仅内部使用
+     */
+    private setStatus;
+}

package/dist/types/live/utils.d.ts

@@ -0,0 +1,49 @@
+/**
++ * Delays execution for the specified duration
++ * @param milliseconds The time to sleep in milliseconds
++ * @throws {Error} If milliseconds is negative
++ * @returns Promise that resolves after the specified duration
++ */
+export declare const sleep: (milliseconds: number) => Promise<void>;
+/**
+ * @deprecated use checkDevicePermission instead
+ * Check microphone permission，return boolean
+ */
+export declare const checkPermission: ({ audio, video, }?: {
+    audio?: boolean;
+    video?: boolean;
+}) => Promise<boolean>;
+/**
+ * Checks device permissions for audio and video
+ * @param checkVideo Whether to check video permissions (default: false)
+ * @returns Promise that resolves with the device permission status
+ */
+export declare const checkDevicePermission: (checkVideo?: boolean) => Promise<{
+    video: boolean;
+    audio: boolean;
+    videoExceptionError?: DOMException | undefined;
+    audioExceptionError?: DOMException | undefined;
+}>;
+/**
+ * Get audio devices
+ * @returns Promise<AudioDevices> Object containing arrays of audio input and output devices
+ */
+export declare const getAudioDevices: ({ video, }?: {
+    video?: boolean;
+}) => Promise<{
+    audioInputs: MediaDeviceInfo[];
+    audioOutputs: MediaDeviceInfo[];
+    videoInputs: MediaDeviceInfo[];
+}>;
+export declare const isScreenShareDevice: (deviceId?: string) => boolean;
+/**
+ * 判断是否前后置摄像头
+ * @param deviceId
+ * @returns
+ */
+export declare const isMobileVideoDevice: (deviceId?: string) => boolean;
+/**
+ * Check if browser supports screen sharing
+ * 检查浏览器是否支持屏幕共享
+ */
+export declare function isScreenShareSupported(): boolean;

package/dist/umd/index.js

@@ -306,6 +306,54 @@
    * en: Session updated
    * zh: 会话更新
    */ EventNames["SESSION_UPDATED"] = "server.session.updated";
+            /**
+   * en: Conversation created
+   * zh: 会话创建
+   */ EventNames["CONVERSATION_CREATED"] = "server.conversation.created";
+            /**
+   * en: Conversation chat created
+   * zh: 会话对话创建
+   */ EventNames["CONVERSATION_CHAT_CREATED"] = "server.conversation.chat.created";
+            /**
+   * en: Conversation chat in progress
+   * zh: 对话正在处理中
+   */ EventNames["CONVERSATION_CHAT_IN_PROGRESS"] = "server.conversation.chat.in_progress";
+            /**
+   * en: Conversation message delta received
+   * zh: 文本消息增量返回
+   */ EventNames["CONVERSATION_MESSAGE_DELTA"] = "server.conversation.message.delta";
+            /**
+   * en: Conversation message completed
+   * zh: 文本消息完成
+   */ EventNames["CONVERSATION_MESSAGE_COMPLETED"] = "server.conversation.message.completed";
+            /**
+   * en: Conversation chat completed
+   * zh: 对话完成
+   */ EventNames["CONVERSATION_CHAT_COMPLETED"] = "server.conversation.chat.completed";
+            /**
+   * en: Conversation chat requires action
+   * zh: 对话需要插件
+   */ EventNames["CONVERSATION_CHAT_REQUIRES_ACTION"] = "server.conversation.chat.requires_action";
+            /**
+   * en: Conversation chat failed
+   * zh: 对话失败
+   */ EventNames["CONVERSATION_CHAT_FAILED"] = "server.conversation.chat.failed";
+            /**
+   * en: Session pre answer updated
+   * zh: 安抚配置更新成功
+   */ EventNames["SESSION_PRE_ANSWER_UPDATED"] = "server.session.pre_answer.updated";
+            /**
+   * en: Conversation audio transcript delta
+   * zh: 用户语音识别字幕
+   */ EventNames["CONVERSATION_AUDIO_TRANSCRIPT_DELTA"] = "server.conversation.audio_transcript.delta";
+            /**
+   * en: Mode updated
+   * zh: 更新房间模式成功
+   */ EventNames["MODE_UPDATED"] = "server.mode.updated";
+            /**
+   * en: Live created
+   * zh: 直播创建
+   */ EventNames["LIVE_CREATED"] = "server.live.created";
             return EventNames;
         }(event_names_EventNames || {});
         /* ESM default export */ const event_names = event_names_EventNames;
@@ -648,6 +696,7 @@
                 if (isTestEnv) rtc_default().setParameter('ICE_CONFIG_REQUEST_URLS', [
                     'rtc-test.bytedance.com'
                 ]);
+                else localStorage.removeItem('RTC_ACCESS_URLS-VolcEngine');
                 this.engine = rtc_default().createEngine(appId);
                 this.handleMessage = this.handleMessage.bind(this);
                 this.handleUserJoin = this.handleUserJoin.bind(this);
@@ -681,7 +730,7 @@
                     else {
                         const config = {};
                         if (this._config.prologueContent) config.prologue_content = this._config.prologueContent;
-                        if (void 0 !== this._config.roomMode && null !== this._config.roomMode) config.room_mode = this._config.roomMode;
+                        if (void 0 !== this._config.roomMode && null !== this._config.roomMode) config.room_mode = this._config.roomMode || api_.RoomMode.Default;
                         if (this._config.videoConfig) {
                             if (isScreenShareDevice(this._config.videoConfig.videoInputDeviceId)) config.video_config = {
                                 stream_video_type: 'screen'
@@ -690,7 +739,8 @@
                                 stream_video_type: 'main'
                             };
                         }
-                        roomInfo = await this._api.audio.rooms.create({
+                        if (this._config.translateConfig) config.translate_config = this._config.translateConfig;
+                        const params = {
                             bot_id: botId,
                             conversation_id: conversationId || void 0,
                             voice_id: voiceId && voiceId.length > 0 ? voiceId : void 0,
@@ -698,7 +748,8 @@
                             uid: this._config.userId || void 0,
                             workflow_id: this._config.workflowId || void 0,
                             config
-                        });
+                        };
+                        roomInfo = await this._api.audio.rooms.create(params);
                     }
                 } catch (error) {
                     this.dispatch(event_names.ERROR, error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coze/realtime-api",
-  "version": "1.2.1-beta.9",
+  "version": "1.3.1",
   "description": "A powerful real-time communication SDK for voice interactions with Coze AI bots | 扣子官方实时通信 SDK，用于与 Coze AI bots 进行语音交互",
   "keywords": [
     "coze",
@@ -31,6 +31,11 @@
       "require": "./dist/cjs/event-names/index.js",
       "import": "./dist/esm/event-names/index.js",
       "types": "./dist/types/event-names/event-names.d.ts"
+    },
+    "./live": {
+      "require": "./dist/cjs/live/index.js",
+      "import": "./dist/esm/live/index.js",
+      "types": "./dist/types/live/live/index.d.ts"
     }
   },
   "main": "dist/cjs/index.js",
@@ -54,7 +59,7 @@
     "test:cov": "vitest --coverage --run"
   },
   "dependencies": {
-    "@coze/api": "1.2.1-beta.18",
+    "@coze/api": "1.3.3",
     "@volcengine/rtc": "~4.62.11"
   },
   "devDependencies": {
@@ -71,6 +76,10 @@
     "typescript": "^5.5.3",
     "vitest": "~2.1.9"
   },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
   "cozePublishConfig": {
     "exports": {
       ".": {
@@ -82,6 +91,11 @@
         "require": "./dist/cjs/event-names/index.js",
         "import": "./dist/esm/event-names/index.js",
         "types": "./dist/types/event-names/event-names.d.ts"
+      },
+      "./live": {
+        "require": "./dist/cjs/live/index.js",
+        "import": "./dist/esm/live/index.js",
+        "types": "./dist/types/live/live/index.d.ts"
       }
     },
     "main": "dist/cjs/index.js",