larksr_websdk 3.2.34 → 3.2.35

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.
@@ -637,10 +637,29 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
637
637
  */
638
638
  keyUp(key: string): void;
639
639
  /**
640
+ * 手柄接口消息按照 windows xbox 360 手柄标准定义,即包含 xbox 360 手柄的功能,如按钮,摇杆,扳机键。windows 上最多支持4个手柄,
641
+ * 当前版本服务端只处理1个手柄,后续会放开多个手柄的支持。接口中发送的按键值为对应的 windows 中定义的按键值。
640
642
  * 向云端发送手柄按钮按下事件
641
- * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
642
- * @param userIndex 手柄的索引
643
- * @param button 按鍵
643
+ * 參考 js 中获取手柄事件,参考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
644
+ * @param userIndex 手柄的索引,硬件设备索引 0-3. 第一个连接的手柄为0,第二个为1,以此类推。
645
+ * @param button 按鍵 @see https://docs.microsoft.com/en-us/windows/win32/api/xinput/ns-xinput-xinput_gamepad
646
+ * export const enum XINPUT_BUTTONS {
647
+ * XINPUT_GAMEPAD_DPAD_UP = 0x0001,
648
+ * XINPUT_GAMEPAD_DPAD_DOWN = 0x0002,
649
+ * XINPUT_GAMEPAD_DPAD_LEFT = 0x0004,
650
+ * XINPUT_GAMEPAD_DPAD_RIGHT = 0x0008,
651
+ * XINPUT_GAMEPAD_START = 0x0010,
652
+ * XINPUT_GAMEPAD_BACK = 0x0020,
653
+ * XINPUT_GAMEPAD_LEFT_THUMB = 0x0040,
654
+ * XINPUT_GAMEPAD_RIGHT_THUMB = 0x0080,
655
+ * XINPUT_GAMEPAD_LEFT_SHOULDER = 0x0100,
656
+ * XINPUT_GAMEPAD_RIGHT_SHOULDER = 0x0200,
657
+ * XINPUT_GAMEPAD_A = 0x1000,
658
+ * XINPUT_GAMEPAD_B = 0x2000,
659
+ * XINPUT_GAMEPAD_X = 0x4000,
660
+ * XINPUT_GAMEPAD_Y = 0x8000,
661
+ * XINPUT_UNKNOWN = -1,
662
+ * }
644
663
  * @param isRepeat 是否重复按下
645
664
  * @returns
646
665
  */
@@ -658,25 +677,31 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
658
677
  * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
659
678
  * @param userIndex 手柄的索引
660
679
  * @param isleft 是否是左trigger
661
- * @param value trigger的值
680
+ * @param value trigger的值 扳机键的值 0-255
662
681
  * @returns
663
682
  */
664
683
  gamepadTrigger(userIndex: number, isleft: boolean, value: number): void;
665
684
  /**
666
685
  * 向云端发送手柄按摇杆的值,即 axes 值
667
- * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
686
+ * win MAX
687
+ * |
688
+ * MIN-------------MAX
689
+ * |
690
+ * MIN
691
+ * js 中获取硬件手柄參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
668
692
  * @param userIndex 手柄的索引
669
- * @param thumblx 手柄摇杆的x轴坐标
670
- * @param thumbly 手柄摇杆的y轴坐标
671
- * @param thumbrx 手柄摇杆的x轴相对坐标
672
- * @param thumbry 手柄摇杆的y轴相对坐标
693
+ * @param thumblx 左摇杆 X 值,-32767 到 32767
694
+ * @param thumbly 左摇杆 Y 值,-32767 到 32767
695
+ * @param thumbrx 右摇杆 X 值,-32767 到 32767
696
+ * @param thumbry 右摇杆 Y 值,-32767 到 32767
673
697
  * @returns
674
698
  */
675
699
  joystick(userIndex: number, thumblx: number, thumbly: number, thumbrx: number, thumbry: number): void;
676
700
  /**
677
701
  * 向云端发送触摸按下事件
678
702
  * 坐标位置与 mouseMove 相同,相对与云端的鼠标移动位置
679
- * @param id 手指的id
703
+ * @param id 手指的id,当前触摸事件按下手指的 id,同一个手指 id 相同。id 应每次触摸增加。即 touchdown 时 +1,
704
+ * touch move 和 touch up 时保持。当前手指未离开,又有新的手指 touchdown 时再 +1 获得新的 id
680
705
  * @param x 相对云端的x轴坐标
681
706
  * @param y 相对云端的y轴坐标
682
707
  * @returns
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "larksr_websdk",
3
- "version": "3.2.34",
3
+ "version": "3.2.35",
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",
@@ -64,6 +64,7 @@
64
64
  "url-loader": "^4.1.1",
65
65
  "webpack": "^5.54.0",
66
66
  "webpack-cli": "^4.8.0",
67
- "webpack-dev-server": "^4.3.0"
67
+ "webpack-dev-server": "^4.3.0",
68
+ "vconsole": "^3.12.1"
68
69
  }
69
70
  }
package/types/larksr.d.ts CHANGED
@@ -637,10 +637,29 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
637
637
  */
638
638
  keyUp(key: string): void;
639
639
  /**
640
+ * 手柄接口消息按照 windows xbox 360 手柄标准定义,即包含 xbox 360 手柄的功能,如按钮,摇杆,扳机键。windows 上最多支持4个手柄,
641
+ * 当前版本服务端只处理1个手柄,后续会放开多个手柄的支持。接口中发送的按键值为对应的 windows 中定义的按键值。
640
642
  * 向云端发送手柄按钮按下事件
641
- * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
642
- * @param userIndex 手柄的索引
643
- * @param button 按鍵
643
+ * 參考 js 中获取手柄事件,参考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
644
+ * @param userIndex 手柄的索引,硬件设备索引 0-3. 第一个连接的手柄为0,第二个为1,以此类推。
645
+ * @param button 按鍵 @see https://docs.microsoft.com/en-us/windows/win32/api/xinput/ns-xinput-xinput_gamepad
646
+ * export const enum XINPUT_BUTTONS {
647
+ * XINPUT_GAMEPAD_DPAD_UP = 0x0001,
648
+ * XINPUT_GAMEPAD_DPAD_DOWN = 0x0002,
649
+ * XINPUT_GAMEPAD_DPAD_LEFT = 0x0004,
650
+ * XINPUT_GAMEPAD_DPAD_RIGHT = 0x0008,
651
+ * XINPUT_GAMEPAD_START = 0x0010,
652
+ * XINPUT_GAMEPAD_BACK = 0x0020,
653
+ * XINPUT_GAMEPAD_LEFT_THUMB = 0x0040,
654
+ * XINPUT_GAMEPAD_RIGHT_THUMB = 0x0080,
655
+ * XINPUT_GAMEPAD_LEFT_SHOULDER = 0x0100,
656
+ * XINPUT_GAMEPAD_RIGHT_SHOULDER = 0x0200,
657
+ * XINPUT_GAMEPAD_A = 0x1000,
658
+ * XINPUT_GAMEPAD_B = 0x2000,
659
+ * XINPUT_GAMEPAD_X = 0x4000,
660
+ * XINPUT_GAMEPAD_Y = 0x8000,
661
+ * XINPUT_UNKNOWN = -1,
662
+ * }
644
663
  * @param isRepeat 是否重复按下
645
664
  * @returns
646
665
  */
@@ -658,25 +677,31 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
658
677
  * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
659
678
  * @param userIndex 手柄的索引
660
679
  * @param isleft 是否是左trigger
661
- * @param value trigger的值
680
+ * @param value trigger的值 扳机键的值 0-255
662
681
  * @returns
663
682
  */
664
683
  gamepadTrigger(userIndex: number, isleft: boolean, value: number): void;
665
684
  /**
666
685
  * 向云端发送手柄按摇杆的值,即 axes 值
667
- * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
686
+ * win MAX
687
+ * |
688
+ * MIN-------------MAX
689
+ * |
690
+ * MIN
691
+ * js 中获取硬件手柄參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
668
692
  * @param userIndex 手柄的索引
669
- * @param thumblx 手柄摇杆的x轴坐标
670
- * @param thumbly 手柄摇杆的y轴坐标
671
- * @param thumbrx 手柄摇杆的x轴相对坐标
672
- * @param thumbry 手柄摇杆的y轴相对坐标
693
+ * @param thumblx 左摇杆 X 值,-32767 到 32767
694
+ * @param thumbly 左摇杆 Y 值,-32767 到 32767
695
+ * @param thumbrx 右摇杆 X 值,-32767 到 32767
696
+ * @param thumbry 右摇杆 Y 值,-32767 到 32767
673
697
  * @returns
674
698
  */
675
699
  joystick(userIndex: number, thumblx: number, thumbly: number, thumbrx: number, thumbry: number): void;
676
700
  /**
677
701
  * 向云端发送触摸按下事件
678
702
  * 坐标位置与 mouseMove 相同,相对与云端的鼠标移动位置
679
- * @param id 手指的id
703
+ * @param id 手指的id,当前触摸事件按下手指的 id,同一个手指 id 相同。id 应每次触摸增加。即 touchdown 时 +1,
704
+ * touch move 和 touch up 时保持。当前手指未离开,又有新的手指 touchdown 时再 +1 获得新的 id
680
705
  * @param x 相对云端的x轴坐标
681
706
  * @param y 相对云端的y轴坐标
682
707
  * @returns