larksr_websdk 3.2.311 → 3.2.312

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/doc/member_variables.md +32 -0
  2. package/dist/doc/update.md +32 -0
  3. package/dist/larksr-web-sdk.min.js +1 -1
  4. package/dist/types/lark/lark_event_type.d.ts +2 -0
  5. package/dist/types/larksr.d.ts +18 -0
  6. package/package.json +3 -3
  7. package/types/lark/lark_event_type.d.ts +2 -0
  8. package/types/larksr.d.ts +18 -0
package/dist/types/lark/lark_event_type.d.ts CHANGED
@@ -71,6 +71,8 @@ export declare enum LarkEventType {
71
71
  LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_UP = 10031,
72
72
  LK_IFRAME_POSTER_OPERATE_GAMEPAD_TRIGGER_VALUE = 10032,
73
73
  LK_IFRAME_POSTER_OPERATE_GAMEPAD_JOYSTICK_STATES = 10033,
74
+ LK_IFRAME_POSTER_OPENAUDIO_INPUT = 10040,
75
+ LK_IFRAME_POSTER_CLOSE_AUDIO_INPUT = 10041,
74
76
  LK_IFRAME_POSTER_FUNC_MOUSE_MODE = 10100,
75
77
  LK_IFRAME_POSTER_FUNC_SCALE_MODE = 10101,
76
78
  LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP = 10102,
package/dist/types/larksr.d.ts CHANGED
@@ -773,12 +773,26 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
773
773
  /**
774
774
  * 媒体采集相关
775
775
  */
776
+ /**
777
+ * 设置当前已开启的音频track是否启用状态
778
+ * @param enable 是否启用
779
+ * @returns
780
+ */
776
781
  setAudioEnable(enable: boolean): void | undefined;
777
782
  setVideoEnable(enable: boolean): void | undefined;
778
783
  setShareEnable(enable: boolean): void | undefined;
784
+ /**
785
+ * 关闭当前的音频设备
786
+ * @returns
787
+ */
779
788
  closeAudio(): boolean | undefined;
780
789
  closeVideo(): boolean | undefined;
781
790
  closeShare(): boolean | undefined;
791
+ /**
792
+ * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
793
+ * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
794
+ * @returns
795
+ */
782
796
  openAudio(deviceId?: string): Promise<{
783
797
  streams: MediaStream;
784
798
  rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
@@ -789,6 +803,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
789
803
  } | undefined>;
790
804
  openDefaultMedia(video?: boolean, audio?: boolean): Promise<void | undefined>;
791
805
  openShareMediaDevice(): Promise<void | undefined>;
806
+ /**
807
+ * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
808
+ * @returns
809
+ */
792
810
  getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
793
811
  getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[] | undefined>;
794
812
  getConnectedVideoinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "larksr_websdk",
3
- "version": "3.2.311",
3
+ "version": "3.2.312",
4
4
  "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://pingxingyun.github.io/webclient_sdk/",
5
5
  "keywords": [
6
6
  "pingxingyun",
@@ -62,9 +62,9 @@
62
62
  "typescript": "^4.4.3",
63
63
  "typescript-svelte-plugin": "^0.2.5",
64
64
  "url-loader": "^4.1.1",
65
+ "vconsole": "^3.12.1",
65
66
  "webpack": "^5.54.0",
66
67
  "webpack-cli": "^4.8.0",
67
- "webpack-dev-server": "^4.3.0",
68
- "vconsole": "^3.12.1"
68
+ "webpack-dev-server": "^4.3.0"
69
69
  }
70
70
  }
package/types/lark/lark_event_type.d.ts CHANGED
@@ -71,6 +71,8 @@ export declare enum LarkEventType {
71
71
  LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_UP = 10031,
72
72
  LK_IFRAME_POSTER_OPERATE_GAMEPAD_TRIGGER_VALUE = 10032,
73
73
  LK_IFRAME_POSTER_OPERATE_GAMEPAD_JOYSTICK_STATES = 10033,
74
+ LK_IFRAME_POSTER_OPENAUDIO_INPUT = 10040,
75
+ LK_IFRAME_POSTER_CLOSE_AUDIO_INPUT = 10041,
74
76
  LK_IFRAME_POSTER_FUNC_MOUSE_MODE = 10100,
75
77
  LK_IFRAME_POSTER_FUNC_SCALE_MODE = 10101,
76
78
  LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP = 10102,
package/types/larksr.d.ts CHANGED
@@ -773,12 +773,26 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
773
773
  /**
774
774
  * 媒体采集相关
775
775
  */
776
+ /**
777
+ * 设置当前已开启的音频track是否启用状态
778
+ * @param enable 是否启用
779
+ * @returns
780
+ */
776
781
  setAudioEnable(enable: boolean): void | undefined;
777
782
  setVideoEnable(enable: boolean): void | undefined;
778
783
  setShareEnable(enable: boolean): void | undefined;
784
+ /**
785
+ * 关闭当前的音频设备
786
+ * @returns
787
+ */
779
788
  closeAudio(): boolean | undefined;
780
789
  closeVideo(): boolean | undefined;
781
790
  closeShare(): boolean | undefined;
791
+ /**
792
+ * 打开一个音频设备，要注意浏览器限制在 https 或者 localhost 下才能打开音频
793
+ * @param deviceId 音频设备id，如果不传将打开默认设备。@see getConnectedAudioinputDevices
794
+ * @returns
795
+ */
782
796
  openAudio(deviceId?: string): Promise<{
783
797
  streams: MediaStream;
784
798
  rtcRtpSenders: import("./lark/peer_connection").RTCMediaTrackBinding[];
@@ -789,6 +803,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
789
803
  } | undefined>;
790
804
  openDefaultMedia(video?: boolean, audio?: boolean): Promise<void | undefined>;
791
805
  openShareMediaDevice(): Promise<void | undefined>;
806
+ /**
807
+ * 返回已连接的音频设备列表，设备列表中的设备的 deviceId 可用来打开某个音频设备
808
+ * @returns
809
+ */
792
810
  getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
793
811
  getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[] | undefined>;
794
812
  getConnectedVideoinputDevices(): Promise<MediaDeviceInfo[] | undefined>;