@coze/realtime-api 0.0.3 → 0.0.4

package/dist/index.js

@@ -1,258 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventNames = exports.RealtimeError = exports.RealtimeAPIError = exports.RealtimeClient = exports.RealtimeUtils = void 0;
-const api_1 = require("@coze/api");
-const RealtimeUtils = __importStar(require("./utils"));
-exports.RealtimeUtils = RealtimeUtils;
-const event_handler_1 = require("./event-handler");
-Object.defineProperty(exports, "EventNames", { enumerable: true, get: function () { return event_handler_1.EventNames; } });
-const error_1 = require("./error");
-Object.defineProperty(exports, "RealtimeAPIError", { enumerable: true, get: function () { return error_1.RealtimeAPIError; } });
-Object.defineProperty(exports, "RealtimeError", { enumerable: true, get: function () { return error_1.RealtimeError; } });
-const client_1 = require("./client");
-class RealtimeClient extends event_handler_1.RealtimeEventHandler {
-    /**
-     * Constructor for initializing a RealtimeClient instance.
-     *
-     * 构造函数，初始化RealtimeClient实例。
-     *
-     * @param config
-     * @param config.accessToken - Required, Access Token. |
-     *                            必填，Access Token。
-     * @param config.botId - Required, Bot Id. |
-     *                       必填，Bot Id。
-     * @param config.voiceId - Optional, Voice Id. |
-     *                         可选，音色Id。
-     * @param config.conversationId - Optional, Conversation Id. |
-     *                               可选，会话Id。
-     * @param config.baseURL - Optional, defaults to "https://api.coze.cn". |
-     *                        可选，默认值为 "https://api.coze.cn"。
-     * @param config.debug - Optional, defaults to false.
-     *                      可选，默认值为 false。
-     * @param config.allowPersonalAccessTokenInBrowser
-     * - Optional, whether to allow personal access tokens in browser environment. |
-     *   可选，是否允许在浏览器环境中使用个人访问令牌。
-     * @param config.audioMutedDefault - Optional, whether audio is muted by default, defaults to false. |
-     *                                  可选，默认是否静音，默认值为 false。
-     * @param config.connectorId - Required, Connector Id. |
-     *                             必填，渠道 Id。
-     * @param config.suppressStationaryNoise - Optional, suppress stationary noise, defaults to false. |
-     *                                       可选，默认是否抑制静态噪声，默认值为 false。
-     * @param config.suppressNonStationaryNoise - Optional, suppress non-stationary noise, defaults to false. |
-     *                                         可选，默认是否抑制非静态噪声，默认值为 false。
-     */
-    constructor(config) {
-        var _a;
-        super(config.debug);
-        this._client = null;
-        this._roomInfo = null;
-        this.isConnected = false;
-        this._isTestEnv = false;
-        this._config = config;
-        const defaultBaseURL = (_a = this._config.baseURL) !== null && _a !== void 0 ? _a : 'https://api.coze.cn';
-        this._config.baseURL = defaultBaseURL;
-        // init api
-        this._api = new api_1.CozeAPI({
-            token: this._config.accessToken,
-            baseURL: defaultBaseURL,
-            allowPersonalAccessTokenInBrowser: this._config.allowPersonalAccessTokenInBrowser,
-        });
-        this._isTestEnv = defaultBaseURL !== 'https://api.coze.cn';
-    }
-    /**
-     * en: Establish a connection to the Coze API and join the room
-     *
-     * zh: 建立与 Coze API 的连接并加入房间
-     */
-    async connect() {
-        var _a;
-        const { botId, conversationId, voiceId } = this._config;
-        let roomInfo;
-        try {
-            // Step1 get token
-            roomInfo = await this._api.audio.rooms.create({
-                bot_id: botId,
-                conversation_id: conversationId,
-                voice_id: voiceId && voiceId.length > 0 ? voiceId : undefined,
-                connector_id: this._config.connectorId,
-            });
-        }
-        catch (error) {
-            this.dispatch(event_handler_1.EventNames.ERROR, error);
-            throw new error_1.RealtimeAPIError(error_1.RealtimeError.CREATE_ROOM_ERROR, error instanceof Error ? error.message : 'Unknown error');
-        }
-        this._roomInfo = roomInfo;
-        // Step2 create engine
-        this._client = new client_1.EngineClient(roomInfo.app_id, this._config.debug, this._isTestEnv);
-        // Step3 bind engine events
-        this._client.bindEngineEvents();
-        this._client.on(event_handler_1.EventNames.ALL, (eventName, data) => {
-            this.dispatch(eventName, data);
-        });
-        if (this._config.suppressStationaryNoise) {
-            await this._client.enableAudioNoiseReduction();
-            this.dispatch(event_handler_1.EventNames.SUPPRESS_STATIONARY_NOISE, {});
-        }
-        if (this._config.suppressNonStationaryNoise) {
-            await this._client.initAIAnsExtension();
-            this._client.changeAIAnsExtension(true);
-            this.dispatch(event_handler_1.EventNames.SUPPRESS_NON_STATIONARY_NOISE, {});
-        }
-        // Step4 join room
-        await this._client.joinRoom({
-            token: roomInfo.token,
-            roomId: roomInfo.room_id,
-            uid: roomInfo.uid,
-            audioMutedDefault: (_a = this._config.audioMutedDefault) !== null && _a !== void 0 ? _a : false,
-        });
-        // Step5 create local stream
-        await this._client.createLocalStream();
-        // step6 set connected and dispatch connected event
-        this.isConnected = true;
-        this.dispatch(event_handler_1.EventNames.CONNECTED, {
-            roomId: roomInfo.room_id,
-            uid: roomInfo.uid,
-            token: roomInfo.token,
-            appId: roomInfo.app_id,
-        });
-        this._log('dispatch client.connected event');
-    }
-    /**
-     * en: Interrupt the current conversation
-     *
-     * zh: 中断当前对话
-     */
-    async interrupt() {
-        var _a;
-        await ((_a = this._client) === null || _a === void 0 ? void 0 : _a.stop());
-        this.dispatch(event_handler_1.EventNames.INTERRUPTED, {});
-        this._log('dispatch client.interrupted event');
-    }
-    /**
-     * en: Disconnect from the current session
-     *
-     * zh: 断开与当前会话的连接
-     */
-    async disconnect() {
-        var _a;
-        await ((_a = this._client) === null || _a === void 0 ? void 0 : _a.disconnect());
-        this.isConnected = false;
-        this.dispatch(event_handler_1.EventNames.DISCONNECTED, {});
-    }
-    /**
-     * en: Send a message to the bot
-     *
-     * zh: 发送消息给Bot
-     */
-    async sendMessage(message) {
-        var _a;
-        await ((_a = this._client) === null || _a === void 0 ? void 0 : _a.sendMessage(message));
-        const eventType = typeof message.event_type === 'string'
-            ? message.event_type
-            : 'unknown_event';
-        this.dispatch(`client.${eventType}`, message);
-    }
-    /**
-     * en: Enable or disable audio
-     *
-     * zh: 启用或禁用音频
-     */
-    async setAudioEnable(isEnable) {
-        var _a;
-        await ((_a = this._client) === null || _a === void 0 ? void 0 : _a.changeAudioState(isEnable));
-        if (isEnable) {
-            this.dispatch(event_handler_1.EventNames.AUDIO_UNMUTED, {});
-        }
-        else {
-            this.dispatch(event_handler_1.EventNames.AUDIO_MUTED, {});
-        }
-    }
-    /**
-     * en: Enable audio properties reporting (debug mode only)
-     *
-     * zh: 启用音频属性报告（仅限调试模式）
-     */
-    enableAudioPropertiesReport(config) {
-        var _a;
-        if (this._config.debug) {
-            (_a = this._client) === null || _a === void 0 ? void 0 : _a.enableAudioPropertiesReport(config);
-            return true;
-        }
-        else {
-            console.warn('enableAudioPropertiesReport is not supported in non-debug mode');
-            return false;
-        }
-    }
-    /**
-     * en: Start audio playback device test (debug mode only)
-     *
-     * zh: 开始音频播放设备测试（仅限调试模式）
-     */
-    async startAudioPlaybackDeviceTest() {
-        var _a;
-        if (this._config.debug) {
-            await ((_a = this._client) === null || _a === void 0 ? void 0 : _a.startAudioPlaybackDeviceTest());
-        }
-        else {
-            console.warn('startAudioPlaybackDeviceTest is not supported in non-debug mode');
-        }
-    }
-    /**
-     * en: Stop audio playback device test (debug mode only)
-     *
-     * zh: 停止音频播放设备测试（仅限调试模式）
-     */
-    stopAudioPlaybackDeviceTest() {
-        var _a;
-        if (this._config.debug) {
-            (_a = this._client) === null || _a === void 0 ? void 0 : _a.stopAudioPlaybackDeviceTest();
-        }
-        else {
-            console.warn('stopAudioPlaybackDeviceTest is not supported in non-debug mode');
-        }
-    }
-    /**
-     * en: Set the audio input device
-     *
-     * zh: 设置音频输入设备
-     */
-    async setAudioInputDevice(deviceId) {
-        var _a;
-        await ((_a = this._client) === null || _a === void 0 ? void 0 : _a.setAudioInputDevice(deviceId));
-        this.dispatch(event_handler_1.EventNames.AUDIO_INPUT_DEVICE_CHANGED, { deviceId });
-    }
-    /**
-     * en: Set the audio output device
-     *
-     * zh: 设置音频输出设备
-     */
-    async setAudioOutputDevice(deviceId) {
-        var _a;
-        await ((_a = this._client) === null || _a === void 0 ? void 0 : _a.setAudioOutputDevice(deviceId));
-        this.dispatch(event_handler_1.EventNames.AUDIO_OUTPUT_DEVICE_CHANGED, { deviceId });
-    }
-}
-exports.RealtimeClient = RealtimeClient;

package/dist/utils.js

@@ -1,40 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAudioDevices = exports.checkPermission = exports.sleep = void 0;
-const rtc_1 = __importDefault(require("@volcengine/rtc"));
-/**
-+ * 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
-+ */
-const sleep = (milliseconds) => {
-    if (milliseconds < 0) {
-        throw new Error('Sleep duration must be non-negative');
-    }
-    return new Promise(resolve => setTimeout(resolve, milliseconds));
-};
-exports.sleep = sleep;
-/**
- * Check microphone permission，return boolean
- */
-const checkPermission = async () => (await rtc_1.default.enableDevices({ audio: true, video: false })).audio;
-exports.checkPermission = checkPermission;
-/**
- * Get audio devices
- * @returns Promise<AudioDevices> Object containing arrays of audio input and output devices
- */
-const getAudioDevices = async () => {
-    const devices = await rtc_1.default.enumerateDevices();
-    if (!(devices === null || devices === void 0 ? void 0 : devices.length)) {
-        return { audioInputs: [], audioOutputs: [] };
-    }
-    return {
-        audioInputs: devices.filter(i => i.deviceId && i.kind === 'audioinput'),
-        audioOutputs: devices.filter(i => i.deviceId && i.kind === 'audiooutput'),
-    };
-};
-exports.getAudioDevices = getAudioDevices;