@doubao-apps/ai 0.0.34 → 0.0.35

package/dist/public/skills/doubao-apps-dev/references/reference/open-api/19-/350/256/276/345/244/207/346/226/271/345/220/221.md

@@ -0,0 +1,120 @@
+# Open API: 设备方向
+
+设备方向监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startDeviceMotionListening](#startdevicemotionlistening) | 开始监听设备方向变化。 |
+| [stopDeviceMotionListening](#stopdevicemotionlistening) | 停止监听设备方向变化。 |
+| [onDeviceMotionChange](#ondevicemotionchange) | 监听设备方向变化事件。 |
+
+## API 详情
+
+<a id="startdevicemotionlistening"></a>
+### startDeviceMotionListening()
+
+开始监听设备方向变化。
+
+## 代码示例
+
+```typescript
+import { startDeviceMotionListening } from '@doubao-apps/framework/api';
+
+await startDeviceMotionListening({ interval: 'normal' });
+```
+
+## 注意事项
+
+需配对调用 stopDeviceMotionListening。
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|interval|`SensorInterval`|否|监听频率。|
+
+**类型说明**
+
+- `SensorInterval`: `"game" | "ui" | "normal"`
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopdevicemotionlistening"></a>
+### stopDeviceMotionListening()
+
+停止监听设备方向变化。
+
+## 代码示例
+
+```typescript
+import { stopDeviceMotionListening } from '@doubao-apps/framework/api';
+
+await stopDeviceMotionListening();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="ondevicemotionchange"></a>
+### onDeviceMotionChange()
+
+监听设备方向变化事件。
+
+## 代码示例
+
+```ts
+import { onDeviceMotionChange } from '@doubao-apps/framework/api';
+
+const off = onDeviceMotionChange(({ alpha, beta, gamma }) => {
+  console.log(alpha, beta, gamma);
+});
+
+off();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|handler|`Function`|是|-|
+|handler.event|`DeviceMotionChangeEvent`|是|-|
+|handler.event.alpha|`number`|是|当手机坐标 X/Y 和地球坐标 X/Y 重合时，绕 Z 轴转动的夹角。<br>范围为 [0, 2π)，逆时针转动为正。|
+|handler.event.beta|`number`|是|当手机坐标 Y/Z 和地球坐标 Y/Z 重合时，绕 X 轴转动的夹角。<br>范围为 [-π, π)。|
+|handler.event.gamma|`number`|是|当手机坐标 X/Z 和地球坐标 X/Z 重合时，绕 Y 轴转动的夹角。<br>范围为 [-π/2, π/2)。|
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+## 相关类型
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+传感器监听频率。
+
+#### Type
+
+`'game' | 'ui' | 'normal'`
+
+<a id="devicemotionchangeevent"></a>
+### DeviceMotionChangeEvent
+
+设备方向变化事件。
+
+#### Properties
+
+• **alpha**: `number` - 当手机坐标 X/Y 和地球坐标 X/Y 重合时，绕 Z 轴转动的夹角。 范围为 [0, 2π)，逆时针转动为正
+• **beta**: `number` - 当手机坐标 Y/Z 和地球坐标 Y/Z 重合时，绕 X 轴转动的夹角。 范围为 [-π, π)
+• **gamma**: `number` - 当手机坐标 X/Z 和地球坐标 X/Z 重合时，绕 Y 轴转动的夹角。 范围为 [-π/2, π/2)

package/dist/public/skills/doubao-apps-dev/references/reference/open-api/20-/351/231/200/350/236/272/344/273/252.md

@@ -0,0 +1,122 @@
+# Open API: 陀螺仪
+
+陀螺仪监听能力。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startGyroscope](#startgyroscope) | 开始监听陀螺仪。 |
+| [stopGyroscope](#stopgyroscope) | 停止监听陀螺仪。 |
+| [onGyroscopeChange](#ongyroscopechange) | 监听陀螺仪数据变化事件。 |
+
+## API 详情
+
+<a id="startgyroscope"></a>
+### startGyroscope()
+
+开始监听陀螺仪。
+
+## 代码示例
+
+```typescript
+import { startGyroscope } from '@doubao-apps/framework/api';
+
+await startGyroscope({ interval: 'normal' });
+```
+
+## 注意事项
+
+需配对调用 stopGyroscope。
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|interval|`SensorInterval`|否|监听频率。|
+
+**类型说明**
+
+- `SensorInterval`: `"game" | "ui" | "normal"`
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="stopgyroscope"></a>
+### stopGyroscope()
+
+停止监听陀螺仪。
+
+## 代码示例
+
+```typescript
+import { stopGyroscope } from '@doubao-apps/framework/api';
+
+await stopGyroscope();
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<object>`。
+
+<a id="ongyroscopechange"></a>
+### onGyroscopeChange()
+
+监听陀螺仪数据变化事件。
+
+## 代码示例
+
+```ts
+import { onGyroscopeChange } from '@doubao-apps/framework/api';
+
+const off = onGyroscopeChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
+});
+
+off();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|handler|`Function`|是|-|
+|handler.event|`GyroscopeChangeEvent`|是|-|
+|handler.event.timestamp|`number`|是|数据采集时间戳，单位纳秒。|
+|handler.event.x|`number`|是|绕 X 轴旋转的角速度，单位 rad/s。|
+|handler.event.y|`number`|是|绕 Y 轴旋转的角速度，单位 rad/s。|
+|handler.event.z|`number`|是|绕 Z 轴旋转的角速度，单位 rad/s。|
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+## 相关类型
+
+<a id="sensorinterval"></a>
+### SensorInterval
+
+传感器监听频率。
+
+#### Type
+
+`'game' | 'ui' | 'normal'`
+
+<a id="gyroscopechangeevent"></a>
+### GyroscopeChangeEvent
+
+陀螺仪数据变化事件。
+
+#### Properties
+
+• **x**: `number` - 绕 X 轴旋转的角速度，单位 rad/s
+• **y**: `number` - 绕 Y 轴旋转的角速度，单位 rad/s
+• **z**: `number` - 绕 Z 轴旋转的角速度，单位 rad/s
+• **timestamp**: `number` - 数据采集时间戳，单位纳秒

package/dist/public/skills/doubao-apps-dev/references/reference/open-api/21-/350/256/276/345/244/207-/347/275/221/347/273/234.md

@@ -0,0 +1,153 @@
+# Open API: 设备 / 网络
+
+网络类型和本机局域网 IP。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getLocalIPAddress](#getlocalipaddress) | 获取局域网 IP 地址。 |
+| [getNetworkType](#getnetworktype) | 获取当前网络类型。 |
+| [onNetworkStatusChange](#onnetworkstatuschange) | 监听网络状态变化事件。 |
+
+## API 详情
+
+<a id="getlocalipaddress"></a>
+### getLocalIPAddress()
+
+获取局域网 IP 地址。
+
+## 代码示例
+
+```typescript
+import { getLocalIPAddress } from '@doubao-apps/framework/api';
+
+const { localIp, netmask } = await getLocalIPAddress();
+
+console.log(localIp, netmask);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetLocalIPAddressResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|localIp|`string`|本机局域网 IP 地址。|
+|netmask|`string`|子网掩码。|
+
+<a id="getnetworktype"></a>
+### getNetworkType()
+
+获取当前网络类型。
+
+## 代码示例
+
+```ts
+import { getNetworkType } from '@doubao-apps/framework/api';
+
+const result = await getNetworkType();
+console.log(result.networkType);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回一个 Promise，解析为 GetNetworkTypeResult。
+
+|字段名|类型|说明|
+|---|---|---|
+|hasSystemProxy|`boolean`|设备是否使用了系统代理。|
+|networkType|`NetworkType`|当前网络类型。|
+|signalStrength|`number`|信号强弱，单位 dBm。|
+|weakNet|`boolean`|是否处于弱网环境。|
+
+**类型说明**
+
+- `NetworkType`: `"wifi" | "2g" | "3g" | "4g" | "5g" | "unknown" | "none"`
+
+<a id="onnetworkstatuschange"></a>
+### onNetworkStatusChange()
+
+监听网络状态变化事件。
+
+## 代码示例
+
+```ts
+import { onNetworkStatusChange } from '@doubao-apps/framework/api';
+
+const off = onNetworkStatusChange(({ isConnected, networkType }) => {
+  console.log(isConnected, networkType);
+});
+
+off();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|handler|`Function`|是|-|
+|handler.event|`NetworkStatusChangeEvent`|是|-|
+|handler.event.isConnected|`boolean`|是|当前是否有可用网络连接。|
+|handler.event.networkType|`NetworkType`|是|当前网络类型。|
+
+**类型说明**
+
+- `NetworkType`: `"wifi" | "2g" | "3g" | "4g" | "5g" | "unknown" | "none"`
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+## 相关类型
+
+<a id="getlocalipaddressresult"></a>
+### GetLocalIPAddressResult
+
+获取局域网 IP 的返回结果。
+
+#### Properties
+
+• **localIp**: `string` - 本机局域网 IP 地址
+• **netmask?**: `string` - 子网掩码
+
+<a id="networktype"></a>
+### NetworkType
+
+网络类型。 - wifi - Wi-Fi 网络 - 2g - 2G 网络 - 3g - 3G 网络 - 4g - 4G 网络 - 5g - 5G 网络 - unknown - Android 下不常见的网络类型 - none - 无网络。
+
+#### Type
+
+`'wifi' | '2g' | '3g' | '4g' | '5g' | 'unknown' | 'none'`
+
+<a id="getnetworktyperesult"></a>
+### GetNetworkTypeResult
+
+获取网络类型的返回结果。
+
+#### Properties
+
+• **networkType**: `NetworkType` - 当前网络类型
+• **signalStrength?**: `number` - 信号强弱，单位 dBm
+• **hasSystemProxy?**: `boolean` - 设备是否使用了系统代理
+• **weakNet?**: `boolean` - 是否处于弱网环境
+
+<a id="networkstatuschangeevent"></a>
+### NetworkStatusChangeEvent
+
+网络状态变化事件。
+
+#### Properties
+
+• **isConnected**: `boolean` - 当前是否有可用网络连接
+• **networkType**: `NetworkType` - 当前网络类型

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/23-/346/227/240/351/232/234/347/242/215.md

@@ -38,3 +38,14 @@ console.log(open);
 |字段名|类型|说明|
 |---|---|---|
 |open|`boolean`|是否开启视觉无障碍能力。|
+
+## 相关类型
+
+<a id="checkisopenaccessibilityresult"></a>
+### CheckIsOpenAccessibilityResult
+
+无障碍能力检测结果。
+
+#### Properties
+
+• **open**: `boolean` - 是否开启视觉无障碍能力

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/24-/345/237/272/347/241/200/344/277/241/346/201/257.md

@@ -84,3 +84,22 @@ console.log(result.platform, result.benchmarkLevel);
 |model|`string`|设备型号。|
 |platform|`string`|客户端平台。|
 |system|`string`|操作系统及版本。|
+
+## 相关类型
+
+<a id="getdeviceinforesult"></a>
+### GetDeviceInfoResult
+
+设备基础信息。
+
+#### Properties
+
+• **abi?**: `string` - 宿主 App 二进制接口类型，仅 Android 支持
+• **deviceAbi?**: `string` - 设备二进制接口类型，仅 Android 支持
+• **benchmarkLevel**: `number` - 设备性能等级，值越高性能越好；-1 表示未知
+• **brand**: `string` - 设备品牌
+• **model**: `string` - 设备型号
+• **system**: `string` - 操作系统及版本
+• **platform**: `string` - 客户端平台
+• **cpuType?**: `string` - 设备 CPU 型号，仅 Android 支持
+• **memorySize**: `string` - 设备内存大小，单位 MB

package/dist/public/skills/doubao-apps-dev/references/reference/open-api/25-/347/224/265/346/261/240.md

@@ -0,0 +1,92 @@
+# Open API: 电池
+
+电池信息读取与变化监听。
+
+[返回目录](./README.md) | [返回速查](../open-api.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getBatteryInfo](#getbatteryinfo) | 获取电池信息。 |
+| [onBatteryInfoChange](#onbatteryinfochange) | 监听电池信息变化事件。 |
+
+## API 详情
+
+<a id="getbatteryinfo"></a>
+### getBatteryInfo()
+
+获取电池信息。
+
+## 代码示例
+
+```typescript
+import { getBatteryInfo } from '@doubao-apps/framework/api';
+
+const { isCharging, level } = await getBatteryInfo();
+
+console.log(isCharging, level);
+```
+
+## 入参
+
+无入参。
+
+## 返回值
+
+返回 `Promise<GetBatteryInfoResult>`。
+
+|字段名|类型|说明|
+|---|---|---|
+|isCharging|`boolean`|是否正在充电。|
+|level|`number`|当前电量，范围 1 - 100。|
+
+<a id="onbatteryinfochange"></a>
+### onBatteryInfoChange()
+
+监听电池信息变化事件。
+
+## 代码示例
+
+```ts
+import { onBatteryInfoChange } from '@doubao-apps/framework/api';
+
+const off = onBatteryInfoChange(({ isLowPowerModeEnabled }) => {
+  console.log(isLowPowerModeEnabled);
+});
+
+off();
+```
+
+## 入参
+
+|参数名|类型|必填|说明|
+|---|---|---|---|
+|handler|`Function`|是|-|
+|handler.event|`BatteryInfoChangeEvent`|是|-|
+|handler.event.isLowPowerModeEnabled|`boolean`|是|是否处于省电模式。|
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+## 相关类型
+
+<a id="getbatteryinforesult"></a>
+### GetBatteryInfoResult
+
+电池信息。
+
+#### Properties
+
+• **isCharging**: `boolean` - 是否正在充电
+• **level**: `number` - 当前电量，范围 1 - 100
+
+<a id="batteryinfochangeevent"></a>
+### BatteryInfoChangeEvent
+
+电池信息变化事件。
+
+#### Properties
+
+• **isLowPowerModeEnabled**: `boolean` - 是否处于省电模式

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/26-/346/227/245/345/216/206.md

@@ -93,3 +93,14 @@ await addPhoneRepeatCalendar({
 ## 返回值
 
 返回 `Promise<object>`。
+
+## 相关类型
+
+<a id="calendarrepeatinterval"></a>
+### CalendarRepeatInterval
+
+日历重复周期。
+
+#### Type
+
+`'day' | 'week' | 'month' | 'year'`

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/27-/345/211/252/350/264/264/346/235/277.md

@@ -62,3 +62,14 @@ await setClipboardData({ data: '复制内容' });
 ## 返回值
 
 返回 `Promise<object>`。
+
+## 相关类型
+
+<a id="getclipboarddataresult"></a>
+### GetClipboardDataResult
+
+剪贴板读取结果。
+
+#### Properties
+
+• **data**: `string` - 当前剪贴板内容

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/28-/350/201/224/347/263/273/344/272/272.md

@@ -99,3 +99,16 @@ await addPhoneContact({
 ## 返回值
 
 返回 `Promise<object>`。
+
+## 相关类型
+
+<a id="choosecontactresult"></a>
+### ChooseContactResult
+
+选取联系人后的返回结果。
+
+#### Properties
+
+• **phoneNumber**: `string` - 选中的手机号
+• **displayName**: `string` - 联系人名称
+• **phoneNumberList**: `string[]` - 联系人所有手机号

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/29-/345/212/240/345/257/206.md

@@ -41,3 +41,14 @@ console.log(bytes);
 |字段名|类型|说明|
 |---|---|---|
 |randomValues|`ArrayBuffer`|生成的随机字节。|
+
+## 相关类型
+
+<a id="getrandomvaluesresult"></a>
+### GetRandomValuesResult
+
+获取安全随机数的返回结果。
+
+#### Properties
+
+• **randomValues**: `ArrayBuffer` - 生成的随机字节

package/dist/{skills → public/skills}/doubao-apps-dev/references/reference/open-api/31-/346/211/253/347/240/201.md

@@ -56,3 +56,54 @@ console.log(result, scanType);
 **类型说明**
 
 - `ScanResultType`: `"QR_CODE" | "AZTEC" | "CODABAR" | "CODE_39" | "CODE_93" | "CODE_128" | "DATA_MATRIX" | "EAN_8" | "EAN_13" | "ITF" | "MAXICODE" | "PDF_417" | "RSS_14" | "RSS_EXPANDED" | "UPC_A" | "UPC_E" | "UPC_EAN_EXTENSION" | "WX_CODE" | "CODE_25"`
+
+## 相关类型
+
+<a id="scancodetype"></a>
+### ScanCodeType
+
+扫码类型。
+
+#### Type
+
+`'barCode' | 'qrCode' | 'datamatrix' | 'pdf417'`
+
+<a id="scanresulttype"></a>
+### ScanResultType
+
+扫码结果类型。
+
+#### Type
+
+`| 'QR_CODE'
+  | 'AZTEC'
+  | 'CODABAR'
+  | 'CODE_39'
+  | 'CODE_93'
+  | 'CODE_128'
+  | 'DATA_MATRIX'
+  | 'EAN_8'
+  | 'EAN_13'
+  | 'ITF'
+  | 'MAXICODE'
+  | 'PDF_417'
+  | 'RSS_14'
+  | 'RSS_EXPANDED'
+  | 'UPC_A'
+  | 'UPC_E'
+  | 'UPC_EAN_EXTENSION'
+  | 'WX_CODE'
+  | 'CODE_25'`
+
+<a id="scancoderesult"></a>
+### ScanCodeResult
+
+扫码返回结果。
+
+#### Properties
+
+• **characterSet**: `string` - 字符集
+• **path**: `string` - 当前宿主可识别的页面路径
+• **rawData**: `string` - 原始数据，通常为 Base64 字符串
+• **result**: `string` - 扫码结果文本
+• **scanType**: `ScanResultType` - 扫码结果类型