@doubao-dev/plugin-app-dev 0.0.0-stage → 0.0.40-canary-dea0ddc73-20261026073950

package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/22-/351/231/200/350/236/272/344/273/252.md

@@ -0,0 +1,354 @@
+# 豆包应用插件的端能力 API: 陀螺仪
+
+陀螺仪监听能力。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [startGyroscope](#startgyroscope) | 开始监听陀螺仪。 |
+| [stopGyroscope](#stopgyroscope) | 停止监听陀螺仪。 |
+| [onGyroscopeChange](#ongyroscopechange) | 监听陀螺仪数据变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="startgyroscope"></a>
+### startGyroscope()
+
+# startGyroscope
+
+开始监听陀螺仪。
+
+## 扫码预览
+![扫码预览 startGyroscope](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fgyroscope%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.25`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 接入准备
+
+### 前置条件
+
+- 无额外前置条件；建议在启动前注册 `onGyroscopeChange`
+
+## 使用说明
+
+需配对调用 stopGyroscope。
+
+- 不再需要时及时调用 `stopGyroscope`，避免持续采集造成额外功耗
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+startGyroscope(params?: StartGyroscopeParams): Promise<object>
+```
+
+## 入参
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>interval</code></td><td><code>SensorInterval</code></td><td>否</td><td><code>normal</code></td><td>game 表示约 20 次/秒，ui 表示约 60 次/秒，normal 表示约 5 次/秒</td><td>监听频率。</td></tr>
+</tbody>
+</table>
+
+## 调用示例
+
+```typescript
+import { startGyroscope } from '@doubao-dev/framework/api';
+
+await startGyroscope({ interval: 'normal' });
+```
+
+## 成功返回
+
+无返回字段。
+
+### 返回示例
+
+```json
+{}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 失败示例
+
+```json
+{
+  "errNo": 103,
+  "errMsg": "feature not support"
+}
+```
+
+### 错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
+</thead>
+<tbody>
+<tr><td><code>103</code></td><td><code>feature not support</code></td><td>Android、iOS</td><td>当前设备不支持陀螺仪传感器或无法注册监听</td><td>在具备陀螺仪传感器的设备上调用，或提前提示用户设备不支持。</td></tr>
+</tbody>
+</table>
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
+</tbody>
+</table>
+
+<a id="stopgyroscope"></a>
+### stopGyroscope()
+
+# stopGyroscope
+
+停止监听陀螺仪。
+
+## 扫码预览
+![扫码预览 stopGyroscope](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fgyroscope%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.25`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 接入准备
+
+### 前置条件
+
+- 无额外前置条件；通常在 `startGyroscope` 后调用
+
+## 使用说明
+
+- 未启动时调用也会直接成功，可用于安全清理监听状态
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+stopGyroscope(params?: object): Promise<object>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```typescript
+import { stopGyroscope } from '@doubao-dev/framework/api';
+
+await stopGyroscope();
+```
+
+## 成功返回
+
+无返回字段。
+
+### 返回示例
+
+```json
+{}
+```
+
+<a id="ongyroscopechange"></a>
+### onGyroscopeChange()
+
+# onGyroscopeChange
+
+监听陀螺仪数据变化事件。
+
+## 扫码预览
+![扫码预览 onGyroscopeChange](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fgyroscope%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.27`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 接入准备
+
+### 前置条件
+
+- 调用 `startGyroscope` 后事件才会持续回调
+
+## 使用说明
+
+- 取消函数只移除本地回调，需要停止采集时调用 `stopGyroscope`
+
+## 调用方式
+
+### 事件监听 API
+
+```typescript
+onGyroscopeChange(callback: (event: GyroscopeChangeEvent) => void): () => void
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```ts
+import { onGyroscopeChange } from '@doubao-dev/framework/api';
+
+const off = onGyroscopeChange(({ x, y, z, timestamp }) => {
+  console.log(x, y, z, timestamp);
+});
+
+off();
+```
+
+## 回调参数
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>event.timestamp</code></td><td><code>number</code></td><td>是</td><td>数据采集时间戳，单位纳秒。</td></tr>
+<tr><td><code>event.x</code></td><td><code>number</code></td><td>是</td><td>绕 X 轴旋转的角速度，单位 rad/s。</td></tr>
+<tr><td><code>event.y</code></td><td><code>number</code></td><td>是</td><td>绕 Y 轴旋转的角速度，单位 rad/s。</td></tr>
+<tr><td><code>event.z</code></td><td><code>number</code></td><td>是</td><td>绕 Z 轴旋转的角速度，单位 rad/s。</td></tr>
+</tbody>
+</table>
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+### 回调示例
+
+```json
+{
+  "x": 0.01,
+  "y": -0.02,
+  "z": 0.03,
+  "timestamp": 1784088000000000000
+}
+```
+
+## 相关类型
+
+<a id="startgyroscopeparams"></a>
+### StartGyroscopeParams
+
+开始监听陀螺仪的请求参数。
+
+#### Properties
+
+• **interval?**: `SensorInterval` - 监听频率
+
+<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/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/23-/345/252/222/344/275/223-/350/256/276/345/244/207-/347/275/221/347/273/234.md

@@ -0,0 +1,264 @@
+# 豆包应用插件的端能力 API: 媒体 / 设备 / 网络
+
+网络类型和本机局域网 IP。
+
+[返回目录](./groups.md) | [返回速查](./quick-reference.md)
+
+## 速查
+
+| API | 说明 |
+| --- | --- |
+| [getNetworkType](#getnetworktype) | 获取当前网络类型。 |
+| [onNetworkStatusChange](#onnetworkstatuschange) | 监听网络状态变化事件。<br><br>返回取消监听函数。 |
+
+## API 详情
+
+<a id="getnetworktype"></a>
+### getNetworkType()
+
+# getNetworkType
+
+获取当前网络类型。
+
+## 扫码预览
+![扫码预览 getNetworkType](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fget-network-type%252Findex)
+
+## 使用限制
+
+> [!WARNING]
+> **Android、iOS**：iOS 在蜂窝网络下可能返回联合类型外的 &quot;mobile&quot;；依赖联合类型穷举分支的调用方会遗漏该取值。
+
+## 支持版本
+
+前端库版本不低于 `0.0.25`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- 需要持续跟踪网络切换时改用 `onNetworkStatusChange`
+
+## 调用方式
+
+### 异步 API
+
+```typescript
+getNetworkType(params?: GetNetworkTypeParams): Promise<GetNetworkTypeResult>
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```ts
+import { getNetworkType } from '@doubao-dev/framework/api';
+
+const result = await getNetworkType();
+console.log(result.networkType);
+```
+
+## 成功返回
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>约束</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>hasSystemProxy</code></td><td><code>boolean</code></td><td>否</td><td>-</td><td>设备是否使用了系统代理。</td></tr>
+<tr><td><code>networkType</code></td><td><code>NetworkType</code></td><td>是</td><td>-</td><td>当前网络类型。Android、iOS：iOS 在蜂窝网络下可能返回联合类型外的 &quot;mobile&quot;。</td></tr>
+<tr><td><code>signalStrength</code></td><td><code>number</code></td><td>否</td><td>仅 Android Wi-Fi 环境下返回</td><td>信号强弱，单位 dBm。</td></tr>
+<tr><td><code>weakNet</code></td><td><code>boolean</code></td><td>否</td><td>仅 Android 返回</td><td>是否处于弱网环境。</td></tr>
+</tbody>
+</table>
+
+### 返回示例
+
+```json
+{
+  "networkType": "wifi",
+  "hasSystemProxy": false
+}
+```
+
+## 错误处理
+
+错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
+
+### 错误码
+
+#### 通用错误码
+
+<table>
+<thead>
+<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
+</thead>
+<tbody>
+<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android</td></tr>
+</tbody>
+</table>
+
+## 平台差异
+
+- **Android**：正常场景稳定返回网络类型；失败时返回 102。
+- **iOS**：始终成功返回网络类型，无失败分支。
+
+<a id="onnetworkstatuschange"></a>
+### onNetworkStatusChange()
+
+# onNetworkStatusChange
+
+监听网络状态变化事件。
+
+## 扫码预览
+![扫码预览 onNetworkStatusChange](https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fget-network-type%252Findex)
+
+## 支持版本
+
+前端库版本不低于 `0.0.26`。
+
+## 支持平台
+
+<table>
+<thead>
+<tr><th>平台</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>Android</td><td>支持</td></tr>
+<tr><td>iOS</td><td>支持</td></tr>
+<tr><td>PC</td><td>不支持</td></tr>
+<tr><td>HarmonyOS</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 支持场景
+
+<table>
+<thead>
+<tr><th>场景</th><th>支持情况</th></tr>
+</thead>
+<tbody>
+<tr><td>页面</td><td>支持</td></tr>
+<tr><td>卡片</td><td>不支持</td></tr>
+</tbody>
+</table>
+
+## 使用说明
+
+- 取消函数只移除本地回调，不影响系统网络状态
+
+## 调用方式
+
+### 事件监听 API
+
+```typescript
+onNetworkStatusChange(callback: (event: NetworkStatusChangeEvent) => void): () => void
+```
+
+## 入参
+
+无。
+
+## 调用示例
+
+```ts
+import { onNetworkStatusChange } from '@doubao-dev/framework/api';
+
+const off = onNetworkStatusChange(({ isConnected, networkType }) => {
+  console.log(isConnected, networkType);
+});
+
+off();
+```
+
+## 回调参数
+
+<table>
+<thead>
+<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
+</thead>
+<tbody>
+<tr><td><code>event.isConnected</code></td><td><code>boolean</code></td><td>是</td><td>当前是否有可用网络连接。</td></tr>
+<tr><td><code>event.networkType</code></td><td><code>NetworkType</code></td><td>是</td><td>当前网络类型。</td></tr>
+</tbody>
+</table>
+
+## 返回值
+
+返回取消当前监听函数的函数。
+
+### 回调示例
+
+```json
+{
+  "isConnected": true,
+  "networkType": "wifi"
+}
+```
+
+## 相关类型
+
+<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="getnetworktypeparams"></a>
+### GetNetworkTypeParams
+
+获取网络类型的请求参数。 当前无需传入任何字段，预留扩展位。
+
+#### Properties
+
+无字段。
+
+<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` - 当前网络类型