@coze/realtime-api 1.0.4-beta.1 → 1.0.4

package/dist/types/client.d.ts

@@ -6,7 +6,10 @@ export declare class EngineClient extends RealtimeEventHandler {
     private joinUserId;
     private _AIAnsExtension;
     private _isSupportVideo;
-    constructor(appId: string, debug?: boolean, isTestEnv?: boolean, isSupportVideo?: boolean);
+    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;
@@ -25,6 +28,7 @@ export declare class EngineClient extends RealtimeEventHandler {
     }): 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>;

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

@@ -79,6 +79,11 @@ export declare enum EventNames {
      * 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: Bot joined
      * zh: Bot 加入

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-import { type AudioPropertiesConfig } from '@volcengine/rtc';
+import { type ScreenConfig, type AudioPropertiesConfig } from '@volcengine/rtc';
 import { type GetToken } from '@coze/api';
 import * as RealtimeUtils from './utils';
 import { RealtimeEventHandler, EventNames } from './event-handler';
@@ -6,6 +6,8 @@ import { RealtimeAPIError, RealtimeError } from './error';
 export interface VideoConfig {
     videoOnDefault?: boolean /** optional, Whether to turn on video by default, defaults to true */;
     renderDom?: string /** optional, The DOM element to render the video stream to */;
+    videoInputDeviceId?: string /** optional, The device ID of the video input device to use */;
+    screenConfig?: ScreenConfig;
 }
 export interface RealtimeClientConfig {
     accessToken: GetToken /** required, Access Token */;
@@ -62,6 +64,16 @@ declare class RealtimeClient extends RealtimeEventHandler {
      * @param config.suppressNonStationaryNoise - Optional, suppress non-stationary noise, defaults to false. |
      *                                         可选，默认是否抑制非静态噪声，默认值为 false。
      * @param config.isAutoSubscribeAudio - Optional, whether to automatically subscribe to bot reply audio streams, defaults to true. |
+     * @param config.videoConfig - Optional, Video configuration. |
+     *                            可选，视频配置。
+     * @param config.videoConfig.videoOnDefault - Optional, Whether to turn on video by default, defaults to true. |
+     *                                            可选，默认是否开启视频，默认值为 true。
+     * @param config.videoConfig.renderDom - Optional, The DOM element to render the video stream to. |
+     *                                       可选，渲染视频流的 DOM 元素。
+     * @param config.videoConfig.videoInputDeviceId - Optional, The device ID of the video input device to use. |
+     *                                               可选，视频输入设备的设备 ID。
+     * @param config.videoConfig.screenConfig - Optional, Screen share configuration if videoInputDeviceId is 'screenShare' see https://www.volcengine.com/docs/6348/104481#screenconfig for more details. |
+     *                                         可选，屏幕共享配置，如果 videoInputDeviceId 是 'screenShare'，请参考 https://www.volcengine.com/docs/6348/104481#screenconfig 了解更多详情。
      */
     constructor(config: RealtimeClientConfig);
     /**
@@ -125,5 +137,6 @@ declare class RealtimeClient extends RealtimeEventHandler {
      * zh: 设置音频输出设备
      */
     setAudioOutputDevice(deviceId: string): Promise<void>;
+    setVideoInputDevice(deviceId: string): Promise<void>;
 }
 export { RealtimeUtils, RealtimeClient, RealtimeAPIError, RealtimeError, EventNames, };

package/dist/types/utils.d.ts

@@ -13,6 +13,11 @@ 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;
@@ -30,3 +35,9 @@ export declare const getAudioDevices: ({ video, }?: {
     audioOutputs: MediaDeviceInfo[];
     videoInputs: MediaDeviceInfo[];
 }>;
+export declare const isScreenShareDevice: (deviceId?: string) => boolean;
+/**
+ * Check if browser supports screen sharing
+ * 检查浏览器是否支持屏幕共享
+ */
+export declare function isScreenShareSupported(): boolean;