larksr_websdk 3.2.333 → 3.2.336

package/dist/doc/config.md

@@ -213,5 +213,10 @@ interface ILarkSRConfig {
      * 默认 20S
      */
     playTimeout?: number;
+    /**
+     * 是否使用新版摄像头/麦克风协议
+     * 单独上传流程要求渲染服务器版本大于3290）
+     */
+    useSeparateMediaSharePeer?: boolean;
 }
 ```

package/dist/doc/functions.md

@@ -358,6 +358,16 @@ openAudio(deviceId?: string);
  * @returns
  */
 closeAudio(): boolean | undefined;
+/**
+ * 暂停发送音频
+ * @returns
+ */
+pauseAudioSending(): any;
+/**
+ * 恢复发送音频
+ * @returns
+ */
+resumeAudioSending(): any;
 /**
  * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
  * @returns
@@ -369,6 +379,15 @@ getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
  * @returns
  */
 setAudioEnable(enable: boolean): void | undefined;
+
+/**
+ * 请求浏览器打开媒体并且打开上传到服务器通道。
+ * 要注意的是在服务器连接成功之后请求打开
+ * @param constraints 参考 navigator.mediaDevices.getUserMedia(constraints)
+ * @param reset 是否重制媒体通道。true 的情况下重制整个 peerconnection
+ * @returns 打开的通道的绑定信息。管理媒体通道如关闭暂停或恢复使用。
+ */
+openUserMedia(constraints?: MediaStreamConstraints, reset?: boolean): Promise<any>;
 ```
 
 larksr 配置项自动打开麦克风配置,在`new LarkSR({ ... 此处省略其他配置 ... audioInputAutoStart: true})` 时传入，
@@ -384,6 +403,23 @@ larksr 配置项自动打开麦克风配置,在`new LarkSR({ ... 此处省略其
 audioInputAutoStart?: boolean;
 ```
 
+获取当前打开音频设备的状态, 如 `larksr.audioPaused`
+
+```javascript
+/**
+ * 当前打开的音频设备 ID，如果打开时没指定为空
+ */
+get audioDeviceId(): string | null | undefined;
+/**
+ * 当前打开音频的track对象，未打开状态为空
+ */
+get audioTrack(): MediaStreamTrack | null | undefined;
+/**
+ * 音频通道是否暂停
+ */
+get audioPaused(): boolean | undefined;
+```
+
 ## 视频输入接口
 
 客户端打开后云端应用可直接通过读取服务端的摄像头读取视频数据。
@@ -397,9 +433,19 @@ audioInputAutoStart?: boolean;
  * 打开一个视频设备，要注意浏览器限制在 https 或者 localhost 下才能打开视频
  * @param audio boolean 是否同时开启音频
  * @param cameraId 视频设备id，如果不传将打开默认设备。@see getConnectedVideoinputDevices
+ * @param width 限制打开设备的宽
+ * @param height 限制打开设备的高
  * @returns Promise
  */
-openVideo(audio?: boolean, cameraId?: string);
+openVideo(audio?: boolean, cameraId?: string, width?: number, height?: number): Promise<any>;
+/**
+ * 打开摄像头设备
+ * @param cameraId 摄像头设备ID，@see getConnectedVideoinputDevices
+ * @param minWidth 限制打开设备的宽
+ * @param minHeight 限制打开设备的高
+ * @returns @see openUserMedia
+ */
+openCamera(cameraId: string, minWidth?: number, minHeight?: number): Promise<any>;
 /**
  * 打开默认媒体设备，要注意浏览器限制在 https 或者 localhost 下
  * 如果需要指定特殊的媒体设备请单独使用 @see openAudio @see openVideo
@@ -419,6 +465,36 @@ getConnectedVideoinputDevices();
  * @returns void
  */
 setVideoEnable(enable: boolean);
+
+/**
+ * 暂停发送视频
+ * @returns
+ */
+pauseVideoSending(): any;
+/**
+ * 恢复发送视频
+ * @returns
+ */
+resumeVideoSending(): any;
+
+/**
+ * 关闭当前已打开的视频设备
+ * @returns
+ */
+closeVideo(): any;
+/**
+ * 关闭当前已打开的共享设备如共享的标签页等
+ * @returns
+ */
+closeShare(): any;
+/**
+ * 请求浏览器打开媒体并且打开上传到服务器通道。
+ * 要注意的是在服务器连接成功之后请求打开
+ * @param constraints 参考 navigator.mediaDevices.getUserMedia(constraints)
+ * @param reset 是否重制媒体通道。true 的情况下重制整个 peerconnection
+ * @returns 打开的通道的绑定信息。管理媒体通道如关闭暂停或恢复使用。
+ */
+openUserMedia(constraints?: MediaStreamConstraints, reset?: boolean): Promise<any>;
 ```
 
 larksr 配置项自动打开视频输入配置,在`new LarkSR({ ... 此处省略其他配置 ... videoInputAutoStart: true})` 时传入
@@ -434,6 +510,23 @@ larksr 配置项自动打开视频输入配置,在`new LarkSR({ ... 此处省略
 videoInputAutoStart?: boolean;
 ```
 
+获取当前打开视频设备的状态,如 `larksr.videoPaused`
+
+```javascript
+/**
+ * 当前打开视频设备 ID，如果打开时没指定特设备id为空
+ */
+get videoDeviceId(): string | null | undefined;
+/**
+ * 当前打开视频track对象，未打开状态为空
+ */
+get videoTrack(): MediaStreamTrack | null | undefined;
+/**
+ * 视频通道是否暂停
+ */
+get videoPaused(): boolean | undefined;
+```
+
 ## 云端直播推流功能
 
 > 服务端 3.2.7.0 添加， 要注意使用云端直播推流功能要在后台应用管理中开启该功能

package/dist/doc/update.md

@@ -431,3 +431,12 @@ larksr.on('resourcenotenough', function(e) {
  */
 ERROR              = 'error',
 ```
+
+## V3.2.334
+
+优化打开媒体通道实现流程，优化重复打开媒体设备或切换媒体设备效果。添加单独媒体上传通道（单独上传流程要求渲染服务器版本大于3290）。
+
+1. 添加配置项， useSeparateMediaSharePeer，配置是否使用单独的媒体上传通道（摄像头麦克风上传）。默认开启，如果需要使用旧版本服务端应关闭该项。 `new LarkSR({ ... 此处省略其他配置 ... useSeparateMediaSharePeer: true })`
+2. 添加 `pauseVideoSending/resumeVideoSending`,`pauseAudioSending/resumeAudioSending` 暂停和恢复摄像头或者麦克风上传。
+3. 添加 `closeMediaChannel` 关闭单独的媒体上传通道。仅当 useSeparateMediaSharePeer 为 true 时有效。
+4. `openVideo` 接口添加 `openVideo(audio?: boolean, cameraId?: string, width?: number, height?: number)`  宽高参数，限定打开摄像头设备的宽高