ms-vite-plugin 1.1.1 → 1.1.3

package/docs/apipython/hid.md

@@ -0,0 +1,1059 @@
+# HID 模块
+
+HID 模块提供全面的输入控制功能，包括点击、滑动、长按滑动、主屏幕导航等操作，通过蓝牙 HID 设备实现。
+
+## 常量
+
+### hidKey - HID 按键常量
+
+预定义的键盘操作按键常量。
+
+```python
+class hidKey:
+    COMMAND: int
+    LEFT_CTRL: int
+    LEFT_SHIFT: int
+    LEFT_ALT: int
+    RIGHT_CTRL: int
+    RIGHT_SHIFT: int
+    RIGHT_ALT: int
+    UP_ARROW: int
+    DOWN_ARROW: int
+    LEFT_ARROW: int
+    RIGHT_ARROW: int
+    SPACE: int
+    BACKSPACE: int
+    TAB: int
+    RETURN: int
+    ESC: int
+    INSERT: int
+    DELETE: int
+    PAGE_UP: int
+    PAGE_DOWN: int
+    HOME: int
+    END: int
+    CAPS_LOCK: int
+    F1: int
+    F2: int
+    F3: int
+    F4: int
+    F5: int
+    F6: int
+    F7: int
+    F8: int
+    F9: int
+    F10: int
+    F11: int
+    F12: int
+```
+
+## 获取和设置设备信息
+
+### isBLEConnected - 是否连接了蓝牙HID设备
+
+判断是否连接了蓝牙HID设备
+
+```python
+def isBLEConnected() -> bool:
+```
+
+**示例:**
+
+```python
+# 检查是否连接了蓝牙HID设备
+isBLEConnected = hid.isBLEConnected()
+print(isBLEConnected) # 输出: True 或 False
+```
+
+### isUSBConnected - 是否连接了USB HID设备
+
+判断是否连接了USB HID设备
+
+```python
+def isUSBConnected() -> bool:
+```
+
+**示例:**
+
+```python
+# 检查是否连接了USB HID设备
+isUSBConnected = hid.isUSBConnected()
+print(isUSBConnected) # 输出: True 或 False
+```
+
+### getBLEHIDDeviceName - 获取蓝牙 HID 设备名称
+
+获取当前连接的蓝牙 HID 设备名称。
+
+```python
+def getBLEHIDDeviceName() -> str:
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| str | 蓝牙 HID 设备名称 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+device_name = hid.getBLEHIDDeviceName()
+print(device_name)
+```
+
+### setBLEHIDDeviceName - 设置蓝牙 HID 设备名称
+
+设置当前蓝牙 HID 设备名称。
+
+```python
+def setBLEHIDDeviceName(name: str) -> bool:
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `name` | str | 是 | - | 要设置的蓝牙 HID 设备名称 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+ok = hid.setBLEHIDDeviceName("KuaiJS-HID")
+print(ok)
+```
+
+### getDeviceMac - 获取设备 MAC 字符串
+
+获取设备返回的 MAC 字符串。
+
+```python
+def getDeviceMac() -> str:
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| str | 设备 MAC 字符串 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+mac = hid.getDeviceMac()
+print(mac)
+```
+
+### resetPosition - 复位坐标
+
+将鼠标坐标复位到左上角（仅相对鼠标模式需要）。
+
+```python
+def resetPosition() -> bool:
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 复位坐标到左上角
+ok = hid.resetPosition()
+print(ok)  # 输出: True 或 False
+```
+
+## 录屏
+
+### openRecordScreen - 打开录屏界面
+
+打开录屏界面，用户可以在界面上操作开始、结束录屏。
+
+```python
+def openRecordScreen() -> None:
+```
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 打开录屏界面
+hid.openRecordScreen()
+```
+
+### isRecording - 是否录屏中
+
+获取录屏开启状态
+
+```python
+def isRecording() -> bool:
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 是否正在录屏 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 检查是否正在录屏
+is_recording = hid.isRecording()
+print(is_recording) # 输出: True 或 False
+```
+
+## 配置
+
+### setJitterValue - 设置抖动值
+
+设置动作的抖动值。带有抖动参数的动作将在像素范围`-value`到`value`内随机偏移。
+
+```python
+def setJitterValue(value: int) -> None
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `value` | int | 是 | - | 随机像素偏移的抖动值 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 设置抖动值为5像素
+hid.setJitterValue(5)
+```
+
+### move - 移动坐标
+
+将光标移动到指定坐标。
+
+```python
+def move(x: int, y: int) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `x` | int | 是 | - | 目标 X 坐标 |
+| `y` | int | 是 | - | 目标 Y 坐标 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 移动到 (100, 200)
+hid.move(100, 200)
+```
+
+## 基础触摸操作
+
+### click - 点击操作
+
+在指定坐标执行点击操作。
+
+```python
+def click(
+    x: int,
+    y: int,
+    duration: int = 10,
+    jitter: bool = False
+) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `x` | int | 是 | - | 点击的 X 坐标 |
+| `y` | int | 是 | - | 点击的 Y 坐标 |
+| `duration` | int | 否 | 10 | 点击持续时间（毫秒） |
+| `jitter` | bool | 否 | False | 启用随机抖动偏移 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 简单点击
+hid.click(100, 200)
+
+# 带持续时间和抖动的点击
+hid.click(100, 200, 150, True)
+```
+
+### clickRandom - 随机点击
+
+在指定矩形区域内执行随机点击。
+
+```python
+def clickRandom(
+    x1: int,
+    y1: int,
+    x2: int,
+    y2: int,
+    duration: int = 20
+) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `x1` | int | 是 | - | 左上角 X 坐标 |
+| `y1` | int | 是 | - | 左上角 Y 坐标 |
+| `x2` | int | 是 | - | 右下角 X 坐标 |
+| `y2` | int | 是 | - | 右下角 Y 坐标 |
+| `duration` | int | 否 | 20 | 点击持续时间（毫秒） |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 在区域内随机点击
+hid.clickRandom(100, 100, 200, 200, 20)
+```
+
+### doubleClick - 双击
+
+在指定坐标执行双击操作。
+
+```python
+def doubleClick(
+    x: int,
+    y: int,
+    duration: int = 20,
+    interval: int = 20,
+    jitter: bool = False
+) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `x` | int | 是 | - | X 坐标 |
+| `y` | int | 是 | - | Y 坐标 |
+| `duration` | int | 否 | 20 | 点击持续时间（毫秒） |
+| `interval` | int | 否 | 20 | 两次点击间隔时间（毫秒） |
+| `jitter` | bool | 否 | False | 启用随机抖动偏移 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 带抖动的双击
+hid.doubleClick(100, 100, 20, 20, True)
+```
+
+### doubleClickRandom - 随机双击
+
+在指定矩形区域内执行随机双击。
+
+```python
+def doubleClickRandom(
+    x1: int,
+    y1: int,
+    x2: int,
+    y2: int,
+    duration: int = 20,
+    interval: int = 20
+) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `x1` | int | 是 | - | 左上角 X 坐标 |
+| `y1` | int | 是 | - | 左上角 Y 坐标 |
+| `x2` | int | 是 | - | 右下角 X 坐标 |
+| `y2` | int | 是 | - | 右下角 Y 坐标 |
+| `duration` | int | 否 | 20 | 点击持续时间（毫秒） |
+| `interval` | int | 否 | 20 | 两次点击间隔时间（毫秒） |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 在区域内随机双击
+hid.doubleClickRandom(100, 100, 200, 200, 20, 20)
+```
+
+## 滑动操作
+
+### swipe - 线性滑动
+
+执行从起始坐标到结束坐标的线性滑动。
+
+```python
+def swipe(
+    x: int,
+    y: int,
+    ex: int,
+    ey: int,
+    jitter: bool = False,
+    steps: int = 6
+) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `x` | int | 是 | - | 起始 X 坐标 |
+| `y` | int | 是 | - | 起始 Y 坐标 |
+| `ex` | int | 是 | - | 结束 X 坐标 |
+| `ey` | int | 是 | - | 结束 Y 坐标 |
+| `jitter` | bool | 否 | False | 启用随机抖动偏移 |
+| `steps` | int | 否 | 6 | 滑动步数 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 简单滑动
+hid.swipe(100, 100, 200, 200)
+
+# 带抖动和自定义步数的滑动
+hid.swipe(100, 100, 200, 200, True, 10)
+```
+
+### pressAndSwipe - 长按并滑动
+
+长按起始坐标，然后滑动到目标坐标。
+
+```python
+def pressAndSwipe(
+    x: int,
+    y: int,
+    ex: int,
+    ey: int,
+    duration: int = 500,
+    jitter: bool = False,
+    steps: int = 6
+) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `x` | int | 是 | - | 起始 X 坐标 |
+| `y` | int | 是 | - | 起始 Y 坐标 |
+| `ex` | int | 是 | - | 结束 X 坐标 |
+| `ey` | int | 是 | - | 结束 Y 坐标 |
+| `duration` | int | 否 | 500 | 长按持续时间（毫秒） |
+| `jitter` | bool | 否 | False | 启用随机抖动偏移 |
+| `steps` | int | 否 | 6 | 滑动步数 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 长按 1 秒后滑动
+hid.pressAndSwipe(100, 100, 200, 200, 1000)
+
+# 长按 1 秒后带抖动和自定义步数的滑动
+hid.pressAndSwipe(100, 100, 200, 200, 1000, True, 10)
+```
+
+### swipeCurve - 曲线滑动
+
+执行 3 点曲线滑动（先快后慢），通过起始点、中间点和结束点。
+
+```python
+def swipeCurve(
+    startX: int,
+    startY: int,
+    midX: int,
+    midY: int,
+    endX: int,
+    endY: int
+) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `startX` | int | 是 | - | 起始 X 坐标 |
+| `startY` | int | 是 | - | 起始 Y 坐标 |
+| `midX` | int | 是 | - | 中间点 X 坐标 |
+| `midY` | int | 是 | - | 中间点 Y 坐标 |
+| `endX` | int | 是 | - | 结束 X 坐标 |
+| `endY` | int | 是 | - | 结束 Y 坐标 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 通过三个点的曲线滑动
+hid.swipeCurve(100, 100, 150, 50, 200, 100)
+```
+
+## 系统导航
+
+### homeScreen - 返回主屏幕
+
+返回到设备主屏幕。
+
+```python
+def homeScreen() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 回到主屏幕
+hid.homeScreen()
+```
+
+## 文本输入
+
+### input - 文本输入
+
+输入文本。
+
+```python
+def input(text: str) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `text` | str | 是 | - | 要输入的文本 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 输入文本
+hid.input("Hello World")
+
+# 输入中文
+hid.input("测试")
+```
+
+### inputSimple - 基础文本输入
+
+输入基础文本（不支持中文），等价于键盘逐字输出。
+
+```python
+def inputSimple(text: str) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `text` | str | 是 | - | 要输入的基础文本（建议 ASCII） |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 输入英文与数字
+hid.inputSimple("hello_123")
+```
+
+## 基础按键操作
+
+### space - 空格键
+
+发送空格键按下。
+
+```python
+def space() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.space()
+```
+
+### backspace - 退格键
+
+发送退格键按下。
+
+```python
+def backspace() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.backspace()
+```
+
+### enter - 回车键
+
+发送回车/换行键按下。
+
+```python
+def enter() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.enter()
+```
+
+### pressButton - 按下系统按钮
+
+```python
+def pressButton(button: Literal["home", "volumeup", "volumedown", "eject"]) -> bool
+```
+
+**参数说明：**
+
+| 参数名   | 类型    | 是否必填 | 默认值 | 描述                                                                                                                     |
+| -------- | ------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------ |
+| `button` | Literal | 是       | -      | 按钮类型： <br>-`"home"` Home 键 <br>- `"volumeup"` 音量上键 <br>- `"volumedown"` 音量下键 <br>- `"eject"` 显示/隐藏键盘 |
+
+**返回值：**
+
+| 类型   | 描述             |
+| ------ | ---------------- |
+| `bool` | 按下按钮是否成功 |
+
+**示例：**
+
+```python
+from kuaijs import hid
+
+# 按下 Home 键
+hid.pressButton("home")
+
+# 调高音量
+hid.pressButton("volumeup")
+
+# 调低音量
+hid.pressButton("volumedown")
+
+# 连续调节音量
+for i in range(5):
+    hid.pressButton("volumeup")
+```
+
+## 组合键
+
+### sendKey - 发送组合键
+
+发送组合键。
+
+```python
+def sendKey(key: List[Union[int, str]]) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `key` | List[int \| str] | 是 | - | 要发送的按键数组 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 发送Cmd+C
+hid.sendKey([hid.hidKey.COMMAND, "c"])
+
+# 发送Ctrl+Alt+Delete
+hid.sendKey([hid.hidKey.LEFT_CTRL, hid.hidKey.LEFT_ALT, hid.hidKey.DELETE])
+```
+
+### copyText - 复制文本
+
+发送 Command+C 复制文本。
+
+```python
+def copyText() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.copyText()
+```
+
+### pasteText - 粘贴文本
+
+发送 Command+V 粘贴文本。
+
+```python
+def pasteText() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.pasteText()
+```
+
+## 导航快捷键
+
+### back - 返回
+
+发送 Tab+B 进行返回导航。
+
+```python
+def back() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.back()
+```
+
+### recent - 最近应用
+
+显示 APP 切换器
+
+```python
+def recent() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.recent()
+```
+
+### lock - 锁屏
+
+发送锁定屏幕指令。
+
+```python
+def lock() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.lock()
+```
+
+### unlock - 解锁
+
+发送两次 Home 键解锁屏幕。
+
+```python
+def unlock() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.unlock()
+```
+
+## 应用控制
+
+### openURL - 打开 URL
+
+在默认浏览器或相应应用中打开 URL。
+
+```python
+def openURL(url: str) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `url` | str | 是 | - | 要打开的 URL |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 打开网站
+hid.openURL("https://www.example.com")
+
+# 使用自定义scheme打开应用
+hid.openURL("myapp://action")
+```
+
+### openApp - 打开应用
+
+按名称打开应用程序。
+
+```python
+def openApp(name: str) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `name` | str | 是 | - | 应用程序名称 或者 包名 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 打开Safari
+hid.openApp("Safari")
+
+# 打开设置
+hid.openApp("Settings")
+
+# 按 bundleId 打开应用
+hid.openApp("com.example.myapp")
+```
+
+### closeApp - 关闭应用
+
+按名称关闭应用程序。
+
+```python
+def closeApp(name: str) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `name` | str | 是 | - | 应用程序名称 或者 包名 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+# 关闭Safari
+hid.closeApp("Safari")
+
+# 关闭设置
+hid.closeApp("Settings")
+
+# 按 bundleId 关闭应用
+hid.closeApp("com.example.myapp")
+```
+
+### takeMeToFront - 置于前台
+
+将当前应用置于前台。
+
+```python
+def takeMeToFront() -> bool
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.takeMeToFront()
+```
+
+### currentAppInfo - 获取当前应用信息
+
+获取当前打开应用的信息（仅 iOS 18.2+）。
+
+```python
+def currentAppInfo() -> Optional[dict]
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| dict \| None | 当前应用信息或 None（如果不可用） |
+
+**返回字典属性:**
+| 属性 | 类型 | 描述 |
+| ---- | ---- | ---- |
+| `name` | str | 应用程序名称 |
+| `bundleId` | str | 应用程序包 ID |
+
+**示例:**
+
+```python
+from kuaijs import hid
+app_info = hid.currentAppInfo()
+if app_info:
+    print(f"当前应用: {app_info.name} ({app_info.bundleId})")
+```
+
+## 剪贴板操作
+
+### setClipboard - 设置剪贴板内容
+
+设置剪贴板内容。
+
+```python
+def setClipboard(text: str) -> bool
+```
+
+**参数:**
+| 参数 | 类型 | 必需 | 默认值 | 描述 |
+| ---- | ---- | ---- | ------ | ---- |
+| `text` | str | 是 | - | 要设置到剪贴板的文本 |
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| bool | 操作是否成功 |
+
+**示例:**
+
+```python
+from kuaijs import hid
+hid.setClipboard("你好，世界！")
+```
+
+### getClipboard - 获取剪贴板内容
+
+获取当前剪贴板内容。
+
+```python
+def getClipboard() -> str
+```
+
+**返回值:**
+| 类型 | 描述 |
+| ---- | ---- |
+| str | 剪贴板内容或 `""`（如果不可用） |
+
+**示例:**
+
+```python
+from kuaijs import hid
+clipboard_text = hid.getClipboard()
+if clipboard_text:
+    print("剪贴板内容:", clipboard_text)
+```