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

package/dist/esm/live/index.js

@@ -0,0 +1,250 @@
+import * as __WEBPACK_EXTERNAL_MODULE__coze_api__ from "@coze/api";
+// WTN服务基础URL
+const WTN_BASE_URL = 'https://wtn.volcvideo.com';
+/**
+ * WebRTC资源状态
+ */ var live_ResourceStatus = /*#__PURE__*/ function(ResourceStatus) {
+    ResourceStatus["IDLE"] = "idle";
+    ResourceStatus["CONNECTING"] = "connecting";
+    ResourceStatus["CONNECTED"] = "connected";
+    ResourceStatus["FAILED"] = "failed";
+    ResourceStatus["CLOSING"] = "closing";
+    ResourceStatus["CLOSED"] = "closed";
+    return ResourceStatus;
+}({});
+/**
+ * 同声传译客户端
+ */ class WebLiveClient {
+    /**
+   * 获取当前连接状态
+   */ getStatus() {
+        return this.status;
+    }
+    /**
+   * 添加状态变化监听器
+   * @param callback 状态变化回调函数
+   */ onStatusChange(callback) {
+        this.statusListeners.push(callback);
+    }
+    /**
+   * 移除状态变化监听器
+   * @param callback 要移除的回调函数
+   */ offStatusChange(callback) {
+        this.removeStatusListener(callback);
+    }
+    /**
+   * 移除状态变化监听器
+   * @param callback 要移除的回调函数
+   */ removeStatusListener(callback) {
+        const index = this.statusListeners.indexOf(callback);
+        if (-1 !== index) this.statusListeners.splice(index, 1);
+    }
+    /**
+   * 订阅音频资源
+   * @param appId 应用ID
+   * @param streamId 流ID
+   * @param clientId 客户端ID
+   */ async subscribe(appId, streamId) {
+        let clientId = arguments.length > 2 && void 0 !== arguments[2] ? arguments[2] : '';
+        try {
+            var _pc_localDescription;
+            // 先清理现有连接
+            if (this.peerConnection) {
+                this.peerConnection.close();
+                this.peerConnection = null;
+            }
+            this.setStatus("connecting");
+            // 1. 创建RTCPeerConnection
+            const rtcConfig = {};
+            const pc = new RTCPeerConnection(rtcConfig);
+            pc.ontrack = (event)=>{
+                // 音频流
+                this.player.onloadeddata = ()=>{
+                    this.player.play();
+                };
+                this.player.srcObject = event.streams[0];
+            };
+            this.peerConnection = pc;
+            this.setupPeerConnectionListeners();
+            pc.addTransceiver('audio', {
+                direction: 'recvonly'
+            });
+            // 2. 创建Offer (SDP)
+            const offer = await pc.createOffer();
+            // 设置本地描述
+            await pc.setLocalDescription(offer);
+            // 等待ICE收集完成再继续
+            await this.waitForIceGathering(pc);
+            if (!(null === (_pc_localDescription = pc.localDescription) || void 0 === _pc_localDescription ? void 0 : _pc_localDescription.sdp)) throw new Error('Failed to create SDP offer');
+            // 3. 发送Offer到WTN服务订阅资源
+            let subscribeUrl = `${WTN_BASE_URL}/sub/${appId}/${streamId}?MuteVideo=true`;
+            if (clientId) subscribeUrl += `&clientid=${clientId}`;
+            const response = await fetch(subscribeUrl, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/sdp'
+                },
+                body: offer.sdp
+            });
+            if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
+            // 4. 保存资源URL (用于销毁资源)
+            this.resourceUrl = response.headers.get('location') || '';
+            // 5. 设置远程SDP (Answer)
+            // 直接获取文本响应，因为服务器返回的是application/sdp格式而非json
+            const answerSdp = await response.text();
+            const answer = new RTCSessionDescription({
+                type: 'answer',
+                sdp: answerSdp
+            });
+            await this.peerConnection.setRemoteDescription(answer);
+            // 7. 返回结果
+            return {
+                status: this.status,
+                peerConnection: this.peerConnection
+            };
+        } catch (error) {
+            this.status = "failed";
+            console.error('Failed to subscribe WebRTC stream:', error);
+            return Promise.reject(error);
+        }
+    }
+    /**
+   * 销毁订阅资源
+   */ async unsubscribe() {
+        try {
+            // 销毁订阅资源
+            if (!this.resourceUrl) throw new Error('No valid subscription resource URL to unsubscribe');
+            this.setStatus("closing");
+            const response = await fetch(this.resourceUrl, {
+                method: 'DELETE'
+            });
+            if (!response.ok) throw new Error(`Failed to unsubscribe: ${response.status} ${response.statusText}`);
+            // 关闭RTC连接
+            if (this.peerConnection) {
+                this.peerConnection.close();
+                this.peerConnection = null;
+            }
+            this.resourceUrl = '';
+            this.status = "closed";
+            return true;
+        } catch (error) {
+            console.error('Error unsubscribing resource:', error);
+            this.status = "failed";
+            return Promise.reject(error);
+        }
+    }
+    /**
+   * 静音/取消静音
+   * @param muted 是否静音
+   */ setMuted(muted) {
+        this.player.muted = muted;
+    }
+    /**
+   * 关闭并清理资源
+   */ close() {
+        // 关闭PeerConnection
+        this.closePeerConnection();
+        // Clean up audio element
+        if (this.player) {
+            this.player.pause();
+            this.player.srcObject = null;
+            this.player.remove();
+        }
+        // 重置状态
+        this.resourceUrl = '';
+        this.setStatus("idle");
+    }
+    /**
+   * 等待ICE收集完成
+   * @param pc RTCPeerConnection实例
+   */ waitForIceGathering(pc) {
+        return new Promise((resolve)=>{
+            // 如果已经收集完成，直接返回
+            if ('complete' === pc.iceGatheringState) {
+                resolve();
+                return;
+            }
+            // 设置收集完成时的回调
+            const checkState = ()=>{
+                if ('complete' === pc.iceGatheringState) {
+                    pc.removeEventListener('icegatheringstatechange', checkState);
+                    resolve();
+                }
+            };
+            // 监听收集状态变化
+            pc.addEventListener('icegatheringstatechange', checkState);
+            // 添加超时处理，防止永远等待
+            setTimeout(()=>resolve(), 5000);
+        });
+    }
+    setupPeerConnectionListeners() {
+        if (!this.peerConnection) return;
+        this.peerConnection.oniceconnectionstatechange = ()=>{
+            var _this_peerConnection, _this_peerConnection1;
+            console.log('ICE connection state changed:', null === (_this_peerConnection = this.peerConnection) || void 0 === _this_peerConnection ? void 0 : _this_peerConnection.iceConnectionState);
+            switch(null === (_this_peerConnection1 = this.peerConnection) || void 0 === _this_peerConnection1 ? void 0 : _this_peerConnection1.iceConnectionState){
+                case 'connected':
+                case 'completed':
+                    this.setStatus("connected");
+                    break;
+                case 'failed':
+                case 'disconnected':
+                    this.setStatus("failed");
+                    break;
+                case 'closed':
+                    this.setStatus("closed");
+                    break;
+                default:
+                    var _this_peerConnection2;
+                    console.log('ICE connection state changed:', null === (_this_peerConnection2 = this.peerConnection) || void 0 === _this_peerConnection2 ? void 0 : _this_peerConnection2.iceConnectionState);
+                    break;
+            }
+        };
+        this.peerConnection.onicecandidate = (event)=>{
+            if (event.candidate) console.log('New ICE candidate:', event.candidate);
+        };
+    }
+    /**
+   * 关闭PeerConnection
+   */ closePeerConnection() {
+        if (this.peerConnection) {
+            this.peerConnection.close();
+            this.peerConnection = null;
+        }
+    }
+    /**
+   * 设置状态并触发监听回调
+   * @param newStatus 新状态
+   * @private 私有方法，仅内部使用
+   */ setStatus(newStatus) {
+        const oldStatus = this.status;
+        if (oldStatus !== newStatus) {
+            this.status = newStatus;
+            // 触发所有监听器
+            for (const listener of this.statusListeners)try {
+                listener(newStatus);
+            } catch (error) {
+                console.error('Error in status listener:', error);
+            }
+        }
+    }
+    constructor(liveId){
+        this.peerConnection = null;
+        this.resourceUrl = '';
+        this.status = "idle";
+        this.statusListeners = [];
+        /**
+   * 获取直播信息
+   */ this.getLiveData = async ()=>{
+            const api = new __WEBPACK_EXTERNAL_MODULE__coze_api__.CozeAPI({
+                baseURL: __WEBPACK_EXTERNAL_MODULE__coze_api__.COZE_CN_BASE_URL,
+                token: ''
+            });
+            return await api.audio.live.retrieve(this.liveId);
+        };
+        this.setupPeerConnectionListeners();
+        this.player = document.createElement('audio');
+        this.liveId = liveId;
+    }
+}
+export { live_ResourceStatus as ResourceStatus, WebLiveClient };

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

@@ -148,6 +148,66 @@ declare enum EventNames {
      * en: Session updated
      * zh: 会话更新
      */
-    SESSION_UPDATED = "server.session.updated"
+    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/event-names/index.d.ts

@@ -1,5 +1,5 @@
 import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
-import { type CreateRoomData, type GetToken, type RoomMode } from '@coze/api';
+import { RoomMode, type CreateRoomData, type GetToken, type TranslateConfig } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import EventNames from './event-names';
 import { RealtimeEventHandler } from './event-handler';
@@ -32,6 +32,7 @@ export interface RealtimeClientConfig {
     isAutoSubscribeAudio?: boolean /** optional, Whether to automatically subscribe to bot reply audio streams, defaults to true */;
     prologueContent?: string /** optional, Prologue content */;
     roomMode?: RoomMode /** optional, Room mode */;
+    translateConfig?: TranslateConfig /** optional, Translation configuration */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     _config: RealtimeClientConfig;

package/dist/types/event-names/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/event-names.d.ts

@@ -148,6 +148,66 @@ declare enum EventNames {
      * en: Session updated
      * zh: 会话更新
      */
-    SESSION_UPDATED = "server.session.updated"
+    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/index.d.ts

@@ -1,5 +1,5 @@
 import { type ScreenConfig, type AudioPropertiesConfig, type IRTCEngine } from '@volcengine/rtc';
-import { type CreateRoomData, type GetToken, type RoomMode } from '@coze/api';
+import { RoomMode, type CreateRoomData, type GetToken, type TranslateConfig } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import EventNames from './event-names';
 import { RealtimeEventHandler } from './event-handler';
@@ -32,6 +32,7 @@ export interface RealtimeClientConfig {
     isAutoSubscribeAudio?: boolean /** optional, Whether to automatically subscribe to bot reply audio streams, defaults to true */;
     prologueContent?: string /** optional, Prologue content */;
     roomMode?: RoomMode /** optional, Room mode */;
+    translateConfig?: TranslateConfig /** optional, Translation configuration */;
 }
 declare class RealtimeClient extends RealtimeEventHandler {
     _config: RealtimeClientConfig;

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

@@ -0,0 +1,49 @@
+import { type AudioPropertiesConfig, type IRTCEngine, type NetworkQuality, type onUserJoinedEvent, type onUserLeaveEvent, type UserMessageEvent } from '@volcengine/rtc';
+import { RealtimeEventHandler } from './event-handler';
+import { type VideoConfig } from '.';
+export declare class EngineClient extends RealtimeEventHandler {
+    private engine;
+    private joinUserId;
+    private _AIAnsExtension;
+    private _isSupportVideo;
+    private _videoConfig?;
+    private _streamIndex?;
+    private _roomUserId?;
+    constructor(appId: string, debug?: boolean, isTestEnv?: boolean, isSupportVideo?: boolean, videoConfig?: VideoConfig);
+    bindEngineEvents(): void;
+    removeEventListener(): void;
+    _parseMessage(event: UserMessageEvent): any;
+    handleMessage(event: UserMessageEvent): void;
+    handleEventError(e: unknown): void;
+    handleUserJoin(event: onUserJoinedEvent): void;
+    handleUserLeave(event: onUserLeaveEvent): void;
+    handlePlayerEvent(event: unknown): void;
+    handleNetworkQuality(uplinkNetworkQuality: NetworkQuality, downlinkNetworkQuality: NetworkQuality): void;
+    handleTrackEnded(event: any): void;
+    joinRoom(options: {
+        token: string;
+        roomId: string;
+        uid: string;
+        audioMutedDefault?: boolean;
+        videoOnDefault?: boolean;
+        isAutoSubscribeAudio?: boolean;
+    }): Promise<void>;
+    setAudioInputDevice(deviceId: string): Promise<void>;
+    setAudioOutputDevice(deviceId: string): Promise<void>;
+    setVideoInputDevice(deviceId: string, isAutoCapture?: boolean): Promise<void>;
+    createLocalStream(userId?: string, videoConfig?: VideoConfig): Promise<void>;
+    disconnect(): Promise<void>;
+    changeAudioState(isMicOn: boolean): Promise<void>;
+    changeVideoState(isVideoOn: boolean): Promise<void>;
+    stop(): Promise<void>;
+    sendMessage(message: Record<string, unknown>): Promise<void>;
+    enableAudioPropertiesReport(config?: AudioPropertiesConfig): void;
+    handleLocalAudioPropertiesReport(event: any): void;
+    handleRemoteAudioPropertiesReport(event: unknown): void;
+    enableAudioNoiseReduction(): Promise<void>;
+    initAIAnsExtension(): Promise<void>;
+    changeAIAnsExtension(enable: boolean): void;
+    startAudioPlaybackDeviceTest(): Promise<void>;
+    stopAudioPlaybackDeviceTest(): void;
+    getRtcEngine(): IRTCEngine;
+}

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

@@ -0,0 +1,25 @@
+export declare enum RealtimeError {
+    DEVICE_ACCESS_ERROR = "DEVICE_ACCESS_ERROR",
+    STREAM_CREATION_ERROR = "STREAM_CREATION_ERROR",
+    CONNECTION_ERROR = "CONNECTION_ERROR",
+    DISCONNECTION_ERROR = "DISCONNECTION_ERROR",
+    INTERRUPT_ERROR = "INTERRUPT_ERROR",
+    EVENT_HANDLER_ERROR = "EVENT_HANDLER_ERROR",
+    PERMISSION_DENIED = "PERMISSION_DENIED",
+    NETWORK_ERROR = "NETWORK_ERROR",
+    INVALID_STATE = "INVALID_STATE",
+    CREATE_ROOM_ERROR = "CREATE_ROOM_ERROR",
+    PARSE_MESSAGE_ERROR = "PARSE_MESSAGE_ERROR",
+    HANDLER_MESSAGE_ERROR = "HANDLER_MESSAGE_ERROR"
+}
+export declare const ErrorMessages: Record<RealtimeError, string>;
+export declare class RealtimeAPIError extends Error {
+    code: RealtimeError;
+    error?: unknown;
+    /**
+     * @param code - Error code
+     * @param message - Error message
+     * @param error - Error object
+     */
+    constructor(code: RealtimeError, message: string, error?: unknown);
+}

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

@@ -0,0 +1,12 @@
+export type EventCallback = (eventName: string, event: unknown) => void;
+export declare class RealtimeEventHandler {
+    private eventHandlers;
+    protected _debug: boolean;
+    constructor(debug?: boolean);
+    clearEventHandlers(): void;
+    on(eventName: string, callback: EventCallback): EventCallback;
+    off(eventName: string, callback: EventCallback): void;
+    private _dispatchToHandlers;
+    dispatch(eventName: string, event: unknown, consoleLog?: boolean): void;
+    _log(message: string, event?: unknown): void;
+}