larksr_websdk 3.2.317 → 3.2.320

package/dist/types/api.d.ts

@@ -35,6 +35,9 @@ export interface GetTaskResult {
     wm: number;
     textInputEventPrompt: number;
     audioInput: number;
+    audioInputAutoStart: number;
+    videoInput: number;
+    videoInputAutoStart: number;
 }
 export interface StartAppInfo {
     appliId: string;

package/dist/types/appli_params.d.ts

@@ -172,7 +172,7 @@ export interface IAppliParams {
     /**
      * 优先使用的解码器
      */
-    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    preferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     /**
      * 触摸操作对应的操作方式，触摸屏还是鼠标
      */
@@ -193,6 +193,8 @@ export interface IAppliParams {
     textInputEventPrompt: boolean;
     audioInput: boolean;
     audioInputAutoStart: boolean;
+    videoInput: boolean;
+    videoInputAutoStart: boolean;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -243,7 +245,7 @@ export declare class AppliParams implements IAppliParams {
     mobileVirtualJoystick: boolean;
     mouseZoomDirection: number;
     showPlayerList: boolean;
-    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    preferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     touchOperateMode: 'touchScreen' | 'mouse';
     appliId: string;
     syncLocalToCloudClipboard: boolean;
@@ -255,6 +257,8 @@ export declare class AppliParams implements IAppliParams {
     textInputEventPrompt: boolean;
     audioInput: boolean;
     audioInputAutoStart: boolean;
+    videoInput: boolean;
+    videoInputAutoStart: boolean;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

package/dist/types/lark/application.d.ts

@@ -59,6 +59,8 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private _state;
     get audioDeviceId(): string | undefined;
     get audioTrack(): MediaStreamTrack | undefined;
+    get videoDeviceId(): string | undefined;
+    get videoTrack(): MediaStreamTrack | undefined;
     private retryTime;
     private larksr;
     get voiceId(): number;

package/dist/types/lark/peer_connection.d.ts

@@ -98,6 +98,8 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private videoStream;
     get audioDeviceId(): string | undefined;
     get audioTrack(): MediaStreamTrack | undefined;
+    get videoDeviceId(): string | undefined;
+    get videoTrack(): MediaStreamTrack | undefined;
     private localAudioTrackBinding;
     private localVideoTrackBinding;
     private localShareTrackBinding;

package/dist/types/larksr.d.ts

@@ -277,7 +277,7 @@ interface ILarkSRConfig {
     /**
      * 可选项，优选选择的视频编码格式
      */
-    perferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    preferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     /**
      * 可选项，视频在容器中的缩放模式
      *
@@ -324,9 +324,15 @@ interface ILarkSRConfig {
     /**
      * 当启用音频输入功能，是否自动连入音频设备。
      * 默认关闭。
-     * 需要注意默认打开的时系统中默认的音频设备。
+     * 需要注意默认打开的是系统中默认的音频设备。
      */
     audioInputAutoStart?: boolean;
+    /**
+     * 当启用视频输入功能，是否自动连入视频设备。
+     * 默认关闭。
+     * 需要注意默认打开的是系统中默认的视频设备。
+     */
+    videoInputAutoStart?: boolean;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -462,6 +468,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 当前打开音频的track对象，未打开状态为空
      */
     get audioTrack(): MediaStreamTrack | undefined;
+    /**
+     * 当前打开视频设备 ID，如果打开时没指定特设备id为空
+     */
+    get videoDeviceId(): string | undefined;
+    /**
+     * 当前打开视频track对象，未打开状态为空
+     */
+    get videoTrack(): MediaStreamTrack | undefined;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
      * @param config 本地配置，优先级最高
@@ -782,6 +796,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @returns
      */
     setAudioEnable(enable: boolean): void | undefined;
+    /**
+     * 设置当前已开启的视频track是否启用状态
+     * @param enable 是否启用
+     * @returns
+     */
     setVideoEnable(enable: boolean): void | undefined;
     setShareEnable(enable: boolean): void | undefined;
     /**
@@ -794,24 +813,41 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
      * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
-     * @returns
+     * @returns Promise
      */
     openAudio(deviceId?: string): Promise<{
         streams: MediaStream;
         rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
     } | undefined>;
+    /**
+     * 打开一个视频设备，要注意浏览器限制在 https 或者 localhost 下才能打开视频
+     * @param audio boolean 是否同时开启音频
+     * @param cameraId 视频设备id，如果不传将打开默认设备。@see getConnectedVideoinputDevices
+     * @returns Promise
+     */
     openVideo(audio?: boolean, cameraId?: string): Promise<{
         streams: MediaStream;
         rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
     } | undefined>;
+    /**
+     * 打开默认媒体设备，要注意浏览器限制在 https 或者 localhost 下
+     * 如果需要指定特殊的媒体设备请单独使用 @see openAudio @see openVideo
+     * @param video 是否包含视频
+     * @param audio 是否包含音频
+     * @returns Promise
+     */
     openDefaultMedia(video?: boolean, audio?: boolean): Promise<void | undefined>;
     openShareMediaDevice(): Promise<void | undefined>;
     /**
      * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
-     * @returns
+     * @returns Promise<MediaDeviceInfo[]>
      */
     getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
     getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[] | undefined>;
+    /**
+     * 返回已连接的视频设备
+     * @returns Promise<MediaDeviceInfo[]>
+     */
     getConnectedVideoinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
     getConnectedDevices(type: MediaDeviceKind): Promise<MediaDeviceInfo[] | undefined>;
     openAudioDevice(deviceId: string, kind?: "audioinput" | "audiooutput"): Promise<{

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.317",
+  "version": "3.2.320",
   "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://pingxingyun.github.io/webclient_sdk/",
   "keywords": [
     "pingxingyun",

package/types/api.d.ts

@@ -35,6 +35,9 @@ export interface GetTaskResult {
     wm: number;
     textInputEventPrompt: number;
     audioInput: number;
+    audioInputAutoStart: number;
+    videoInput: number;
+    videoInputAutoStart: number;
 }
 export interface StartAppInfo {
     appliId: string;

package/types/appli_params.d.ts

@@ -172,7 +172,7 @@ export interface IAppliParams {
     /**
      * 优先使用的解码器
      */
-    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    preferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     /**
      * 触摸操作对应的操作方式，触摸屏还是鼠标
      */
@@ -193,6 +193,8 @@ export interface IAppliParams {
     textInputEventPrompt: boolean;
     audioInput: boolean;
     audioInputAutoStart: boolean;
+    videoInput: boolean;
+    videoInputAutoStart: boolean;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -243,7 +245,7 @@ export declare class AppliParams implements IAppliParams {
     mobileVirtualJoystick: boolean;
     mouseZoomDirection: number;
     showPlayerList: boolean;
-    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    preferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     touchOperateMode: 'touchScreen' | 'mouse';
     appliId: string;
     syncLocalToCloudClipboard: boolean;
@@ -255,6 +257,8 @@ export declare class AppliParams implements IAppliParams {
     textInputEventPrompt: boolean;
     audioInput: boolean;
     audioInputAutoStart: boolean;
+    videoInput: boolean;
+    videoInputAutoStart: boolean;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

package/types/lark/application.d.ts

@@ -59,6 +59,8 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private _state;
     get audioDeviceId(): string | undefined;
     get audioTrack(): MediaStreamTrack | undefined;
+    get videoDeviceId(): string | undefined;
+    get videoTrack(): MediaStreamTrack | undefined;
     private retryTime;
     private larksr;
     get voiceId(): number;

package/types/lark/peer_connection.d.ts

@@ -98,6 +98,8 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private videoStream;
     get audioDeviceId(): string | undefined;
     get audioTrack(): MediaStreamTrack | undefined;
+    get videoDeviceId(): string | undefined;
+    get videoTrack(): MediaStreamTrack | undefined;
     private localAudioTrackBinding;
     private localVideoTrackBinding;
     private localShareTrackBinding;

package/types/larksr.d.ts

@@ -277,7 +277,7 @@ interface ILarkSRConfig {
     /**
      * 可选项，优选选择的视频编码格式
      */
-    perferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    preferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'h265' | 'hevc' | 'av1x';
     /**
      * 可选项，视频在容器中的缩放模式
      *
@@ -324,9 +324,15 @@ interface ILarkSRConfig {
     /**
      * 当启用音频输入功能，是否自动连入音频设备。
      * 默认关闭。
-     * 需要注意默认打开的时系统中默认的音频设备。
+     * 需要注意默认打开的是系统中默认的音频设备。
      */
     audioInputAutoStart?: boolean;
+    /**
+     * 当启用视频输入功能，是否自动连入视频设备。
+     * 默认关闭。
+     * 需要注意默认打开的是系统中默认的视频设备。
+     */
+    videoInputAutoStart?: boolean;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -462,6 +468,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 当前打开音频的track对象，未打开状态为空
      */
     get audioTrack(): MediaStreamTrack | undefined;
+    /**
+     * 当前打开视频设备 ID，如果打开时没指定特设备id为空
+     */
+    get videoDeviceId(): string | undefined;
+    /**
+     * 当前打开视频track对象，未打开状态为空
+     */
+    get videoTrack(): MediaStreamTrack | undefined;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
      * @param config 本地配置，优先级最高
@@ -782,6 +796,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @returns
      */
     setAudioEnable(enable: boolean): void | undefined;
+    /**
+     * 设置当前已开启的视频track是否启用状态
+     * @param enable 是否启用
+     * @returns
+     */
     setVideoEnable(enable: boolean): void | undefined;
     setShareEnable(enable: boolean): void | undefined;
     /**
@@ -794,24 +813,41 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
      * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
-     * @returns
+     * @returns Promise
      */
     openAudio(deviceId?: string): Promise<{
         streams: MediaStream;
         rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
     } | undefined>;
+    /**
+     * 打开一个视频设备，要注意浏览器限制在 https 或者 localhost 下才能打开视频
+     * @param audio boolean 是否同时开启音频
+     * @param cameraId 视频设备id，如果不传将打开默认设备。@see getConnectedVideoinputDevices
+     * @returns Promise
+     */
     openVideo(audio?: boolean, cameraId?: string): Promise<{
         streams: MediaStream;
         rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
     } | undefined>;
+    /**
+     * 打开默认媒体设备，要注意浏览器限制在 https 或者 localhost 下
+     * 如果需要指定特殊的媒体设备请单独使用 @see openAudio @see openVideo
+     * @param video 是否包含视频
+     * @param audio 是否包含音频
+     * @returns Promise
+     */
     openDefaultMedia(video?: boolean, audio?: boolean): Promise<void | undefined>;
     openShareMediaDevice(): Promise<void | undefined>;
     /**
      * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
-     * @returns
+     * @returns Promise<MediaDeviceInfo[]>
      */
     getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
     getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[] | undefined>;
+    /**
+     * 返回已连接的视频设备
+     * @returns Promise<MediaDeviceInfo[]>
+     */
     getConnectedVideoinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
     getConnectedDevices(type: MediaDeviceKind): Promise<MediaDeviceInfo[] | undefined>;
     openAudioDevice(deviceId: string, kind?: "audioinput" | "audiooutput"): Promise<{