larksr_websdk 3.2.311 → 3.2.315

package/README.md

@@ -25,6 +25,7 @@ SDK 功能包括:
 
 > V3.2.30 开始仅支持服务端 [V3.2.3.1](https://www.pingxingyun.com/devCenter.html) 以上版本。
 > [老版本 SDK Demo 下载](https://github.com/pingxingyun/lark_sr_websdk_demos/releases/tag/V3.2.10)
+> V3.2.314 版本对应服务器版本和数据通道版本为 3.2.5.1 及以上
 
 ## 快速接入
 

package/dist/doc/config.md

@@ -121,5 +121,18 @@ interface ILarkSRConfig {
      * }
      */
     publicPortMapping?: PublicPortMapping;
+    /**
+     * 是否提示输入文字 APP_REQUEST_INPUT
+     * 当服务端检测到输入法事件后会抛出事件，可在 web 层添加输入框，配合 inputText 发送文字到云端
+     * 默认打开，当手动关闭时将不会抛出 APP_REQUEST_INPUT 事件
+     */
+    textInputEventPrompt?: boolean;
+
+    /**
+     * 当启用音频输入功能，是否自动连入音频设备。
+     * 默认关闭。
+     * 需要注意默认打开的时系统中默认的音频设备。
+     */
+    audioInputAutoStart?: boolean;
 }
 ```

package/dist/doc/events.md

@@ -107,6 +107,7 @@ declare const enum LarkSRClientEvent {
     DATACHANNEL_CLOSE = "datachannelclose",
     /**
      * 数据通达收到文字消息 .
+     * > V3.2.314 版本对应服务器版本和数据通道版本为 3.2.5.1 及以上
      */
     DATACHANNEL_TEXT = "datachanneltext",
     /**

package/dist/doc/functions.md

@@ -242,6 +242,7 @@ getMouseButtonType(button: 'left' | 'mid' | 'right'): CloudLark.MouseKey;
 /**
  * 发送文字消息给数据通道
  * 注意 云端应用要继承数据通道功能
+ * > V3.2.314 版本对应服务器版本和数据通道版本为 3.2.5.1 及以上
  * @param text 文字
  */
 sendTextToDataChannel(text: string): void;
@@ -292,6 +293,38 @@ larksr.on('aivoicedmresult', (e) => {
 });
 ```
 
+## 麦克风输入接口
+
+客户端打开后云端应用可直接通过读取声卡上的麦克风接收到音频。
+
+> 该功能匹配的服务端版本最低为 V3.2.51
+> 使用该功能要注意在后台开启智能语音功能
+
+```typescript
+/**
+ * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
+ * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
+ * @returns
+ */
+openAudio(deviceId?: string);
+/**
+ * 关闭当前的音频设备
+ * @returns
+ */
+closeAudio(): boolean | undefined;
+/**
+ * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
+ * @returns
+ */
+getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
+/**
+ * 设置当前已开启的音频track是否启用状态
+ * @param enable 是否启用
+ * @returns
+ */
+setAudioEnable(enable: boolean): void | undefined;
+```
+
 ## 其他
 
 ```typescript

package/dist/doc/index.md

@@ -22,6 +22,7 @@ npm i larksr_websdk
 
 > V3.2.30 开始仅支持服务端 [V3.2.3.1](https://www.pingxingyun.com/devCenter.html) 以上版本。
 > [老版本 SDK Demo 下载](https://github.com/pingxingyun/lark_sr_websdk_demos/releases/tag/V3.2.10)
+> V3.2.314 版本对应服务器版本和数据通道版本为 3.2.5.1 及以上
 
 ## 创建 LarkSR 实例
 

package/dist/doc/update.md

@@ -64,3 +64,35 @@ larksr.on('aivoicedmresult', (e) => {
  */
 setMobileForceLandScape(force: boolean): void;
 ```
+
+## V3.2.311
+
+新增麦克风输入接口。客户端打开后云端应用可直接通过读取声卡上的麦克风接收到音频。
+
+> 该功能匹配的服务端版本最低为 V3.2.51
+> 使用该功能要注意在后台开启智能语音功能
+
+```typescript
+/**
+ * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
+ * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
+ * @returns
+ */
+openAudio(deviceId?: string);
+/**
+ * 关闭当前的音频设备
+ * @returns
+ */
+closeAudio(): boolean | undefined;
+/**
+ * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
+ * @returns
+ */
+getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
+/**
+ * 设置当前已开启的音频track是否启用状态
+ * @param enable 是否启用
+ * @returns
+ */
+setAudioEnable(enable: boolean): void | undefined;
+```