@coze/realtime-api 1.3.0 → 1.3.2

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

@@ -350,6 +350,10 @@
    * 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;
@@ -692,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);
@@ -725,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'
@@ -734,7 +739,9 @@
                                 stream_video_type: 'main'
                             };
                         }
-                        roomInfo = await this._api.audio.rooms.create({
+                        if (this._config.translateConfig) config.translate_config = this._config.translateConfig;
+                        if (this._config.turnDetection) config.turn_detection = this._config.turnDetection;
+                        const params = {
                             bot_id: botId,
                             conversation_id: conversationId || void 0,
                             voice_id: voiceId && voiceId.length > 0 ? voiceId : void 0,
@@ -742,7 +749,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.3.0",
+  "version": "1.3.2",
   "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.3.0",
+    "@coze/api": "1.3.7",
     "@volcengine/rtc": "~4.62.11"
   },
   "devDependencies": {
@@ -86,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",