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

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 (107) hide show
  1. package/README.md +10 -2
  2. package/dist/147.js +9 -0
  3. package/dist/assets.d.ts +5 -0
  4. package/dist/assets.js +4 -0
  5. package/dist/index.d.ts +43 -0
  6. package/dist/index.js +1378 -0
  7. package/dist/plugin.d.ts +102 -0
  8. package/dist/plugin.js +4995 -0
  9. package/dist/preview.js +16 -0
  10. package/dist/rslib-runtime.js +33 -0
  11. package/dist/skills/doubao-plugin-app/SKILL.md +21 -0
  12. package/dist/skills/doubao-plugin-app/references/app-development.md +85 -0
  13. package/dist/skills/doubao-plugin-app/references/frontend/components/container-overlay.md +131 -0
  14. package/dist/skills/doubao-plugin-app/references/frontend/components/form-controls.md +146 -0
  15. package/dist/skills/doubao-plugin-app/references/frontend/components/interactive-controls.md +120 -0
  16. package/dist/skills/doubao-plugin-app/references/frontend/components/map-canvas.md +107 -0
  17. package/dist/skills/doubao-plugin-app/references/frontend/components/overview.md +43 -0
  18. package/dist/skills/doubao-plugin-app/references/frontend/components/scroll-list.md +149 -0
  19. package/dist/skills/doubao-plugin-app/references/frontend/components/text-media.md +209 -0
  20. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/01-/345/237/272/347/241/200.md +1389 -0
  21. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/02-/347/263/273/347/273/237.md +1376 -0
  22. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/03-/350/207/252/345/256/232/344/271/211/351/200/232/344/277/241.md +127 -0
  23. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/04-/345/256/232/344/275/215.md +784 -0
  24. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/05-/345/255/230/345/202/250.md +1176 -0
  25. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/06-/350/267/257/347/224/261.md +839 -0
  26. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/07-/347/225/214/351/235/242.md +376 -0
  27. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/08-/344/272/244/344/272/222.md +1319 -0
  28. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/09-/350/276/223/345/205/245.md +192 -0
  29. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/10-/347/275/221/347/273/234.md +900 -0
  30. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/11-/345/252/222/344/275/223.md +1496 -0
  31. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/12-/344/270/232/345/212/241/350/203/275/345/212/233.md +1281 -0
  32. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/13-/347/231/273/345/275/225.md +511 -0
  33. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/14-/346/224/257/344/273/230.md +943 -0
  34. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/15-/346/225/260/346/215/256/345/210/206/346/236/220.md +124 -0
  35. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/16-/350/223/235/347/211/231.md +3364 -0
  36. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/17-wi-fi.md +1028 -0
  37. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/18-/345/212/240/351/200/237/345/272/246/350/256/241.md +354 -0
  38. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/19-ibeacon.md +508 -0
  39. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/20-/347/275/227/347/233/230.md +320 -0
  40. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/21-/350/256/276/345/244/207/346/226/271/345/220/221.md +351 -0
  41. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/22-/351/231/200/350/236/272/344/273/252.md +354 -0
  42. 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 +264 -0
  43. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/24-/347/237/255/344/277/241.md +155 -0
  44. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/25-/346/227/240/351/232/234/347/242/215.md +144 -0
  45. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/26-/345/237/272/347/241/200/344/277/241/346/201/257.md +238 -0
  46. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/27-/347/224/265/346/261/240.md +235 -0
  47. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/28-/345/211/252/350/264/264/346/235/277.md +303 -0
  48. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/29-/345/212/240/345/257/206.md +126 -0
  49. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/30-/346/227/245/345/216/206.md +417 -0
  50. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/31-/347/224/265/350/257/235.md +144 -0
  51. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/32-/346/211/253/347/240/201.md +236 -0
  52. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/33-/345/261/217/345/271/225.md +747 -0
  53. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/34-/351/234/207/345/212/250.md +277 -0
  54. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/35-/346/226/207/344/273/266/347/263/273/347/273/237.md +431 -0
  55. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/common-errors.md +69 -0
  56. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/groups.md +43 -0
  57. package/dist/skills/doubao-plugin-app/references/frontend/doubao-agentic-service-api/quick-reference.md +436 -0
  58. package/dist/skills/doubao-plugin-app/references/frontend/examples/common-patterns.md +590 -0
  59. package/dist/skills/doubao-plugin-app/references/frontend/examples/doubao-agentic-service-api-recipes.md +209 -0
  60. package/dist/skills/doubao-plugin-app/references/frontend/examples/page-widget-basics.md +368 -0
  61. package/dist/skills/doubao-plugin-app/references/frontend/examples/page-widget-recipes.md +65 -0
  62. package/dist/skills/doubao-plugin-app/references/frontend/framework/core.md +283 -0
  63. package/dist/skills/doubao-plugin-app/references/frontend/guides/auth.md +277 -0
  64. package/dist/skills/doubao-plugin-app/references/frontend/guides/best-practices.md +574 -0
  65. package/dist/skills/doubao-plugin-app/references/frontend/guides/client-tools-and-events.md +209 -0
  66. package/dist/skills/doubao-plugin-app/references/frontend/guides/component-development.md +832 -0
  67. package/dist/skills/doubao-plugin-app/references/frontend/guides/debugger-mcp.md +537 -0
  68. package/dist/skills/doubao-plugin-app/references/frontend/guides/expired-widget.md +101 -0
  69. package/dist/skills/doubao-plugin-app/references/frontend/guides/performance-optimization.md +417 -0
  70. package/dist/skills/doubao-plugin-app/references/frontend/guides/troubleshooting.md +278 -0
  71. package/dist/skills/doubao-plugin-app/references/frontend/lynx/best-practices.md +720 -0
  72. package/dist/skills/doubao-plugin-app/references/frontend/lynx/css/pseudo-classes.md +149 -0
  73. package/dist/skills/doubao-plugin-app/references/frontend/lynx/css/selectors.md +224 -0
  74. package/dist/skills/doubao-plugin-app/references/frontend/lynx/css/supported-properties.md +269 -0
  75. package/dist/skills/doubao-plugin-app/references/frontend/lynx/css/values-and-units.md +314 -0
  76. package/dist/skills/doubao-plugin-app/references/frontend/lynx/layout/flex-layout.md +334 -0
  77. package/dist/skills/doubao-plugin-app/references/frontend/lynx/layout/grid-layout.md +408 -0
  78. package/dist/skills/doubao-plugin-app/references/frontend/lynx/layout/linear-layout.md +355 -0
  79. package/dist/skills/doubao-plugin-app/references/frontend/lynx/layout/relative-layout.md +189 -0
  80. package/dist/skills/doubao-plugin-app/references/frontend/lynx/lynx-vs-web/css-differences.md +737 -0
  81. package/dist/skills/doubao-plugin-app/references/frontend/lynx/lynx-vs-web/migration-guide.md +669 -0
  82. package/dist/skills/doubao-plugin-app/references/frontend/lynx/lynx-vs-web/unsupported-features.md +290 -0
  83. package/dist/skills/doubao-plugin-app/references/frontend/lynx/overview.md +60 -0
  84. package/dist/skills/doubao-plugin-app/references/frontend/lynx/patterns/animation.md +243 -0
  85. package/dist/skills/doubao-plugin-app/references/frontend/lynx/patterns/responsive.md +194 -0
  86. package/dist/skills/doubao-plugin-app/references/frontend/lynx/patterns/theming.md +143 -0
  87. package/dist/skills/doubao-plugin-app/references/frontend/lynx/quick-reference.md +229 -0
  88. package/dist/skills/doubao-plugin-app/references/frontend/rules/dos-and-donts.md +479 -0
  89. package/dist/skills/doubao-plugin-app/references/frontend/widget-templates/design-boundary.md +46 -0
  90. package/dist/skills/doubao-plugin-app/references/frontend/widget-templates/overview.md +118 -0
  91. package/dist/skills/doubao-plugin-app/references/frontend/widget-templates/props.md +301 -0
  92. package/dist/skills/doubao-plugin-app/references/mcp-and-cards.md +38 -0
  93. package/dist/templates/README.md.template +11 -0
  94. package/dist/templates/com.doubao/app/manifest.yaml +41 -0
  95. package/dist/templates/com.doubao/app/package.json.template +13 -0
  96. package/dist/templates/com.doubao/app/src/app.config.ts.template +5 -0
  97. package/dist/templates/com.doubao/app/src/app.ts.template +3 -0
  98. package/dist/templates/com.doubao/app/src/pages/home/index.css +14 -0
  99. package/dist/templates/com.doubao/app/src/pages/home/index.tsx.template +14 -0
  100. package/dist/templates/com.doubao/app/src/widgets/example/index.tsx.template +29 -0
  101. package/dist/templates/com.doubao/app/tsconfig.json +19 -0
  102. package/dist/templates/mcp.json +9 -0
  103. package/dist/templates/plugin.json.template +29 -0
  104. package/dist/templates/skills/example/SKILL.md.template +14 -0
  105. package/dist/upload.d.ts +44 -0
  106. package/dist/upload.js +38 -0
  107. package/package.json +60 -3
@@ -0,0 +1,320 @@
1
+ # 豆包应用插件的端能力 API: 罗盘
2
+
3
+ 罗盘监听能力。
4
+
5
+ [返回目录](./groups.md) | [返回速查](./quick-reference.md)
6
+
7
+ ## 速查
8
+
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [startCompass](#startcompass) | 开始监听罗盘。 |
12
+ | [stopCompass](#stopcompass) | 停止监听罗盘。 |
13
+ | [onCompassChange](#oncompasschange) | 监听罗盘数据变化事件。<br><br>返回取消监听函数。 |
14
+
15
+ ## API 详情
16
+
17
+ <a id="startcompass"></a>
18
+ ### startCompass()
19
+
20
+ # startCompass
21
+
22
+ 开始监听罗盘。
23
+
24
+ ## 扫码预览
25
+ ![扫码预览 startCompass](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%252Fcompass%252Findex)
26
+
27
+ ## 支持版本
28
+
29
+ 前端库版本不低于 `0.0.25`。
30
+
31
+ ## 支持平台
32
+
33
+ <table>
34
+ <thead>
35
+ <tr><th>平台</th><th>支持情况</th></tr>
36
+ </thead>
37
+ <tbody>
38
+ <tr><td>Android</td><td>支持</td></tr>
39
+ <tr><td>iOS</td><td>支持</td></tr>
40
+ <tr><td>PC</td><td>不支持</td></tr>
41
+ <tr><td>HarmonyOS</td><td>不支持</td></tr>
42
+ </tbody>
43
+ </table>
44
+
45
+ ## 支持场景
46
+
47
+ <table>
48
+ <thead>
49
+ <tr><th>场景</th><th>支持情况</th></tr>
50
+ </thead>
51
+ <tbody>
52
+ <tr><td>页面</td><td>支持</td></tr>
53
+ <tr><td>卡片</td><td>不支持</td></tr>
54
+ </tbody>
55
+ </table>
56
+
57
+ ## 接入准备
58
+
59
+ ### 前置条件
60
+
61
+ - 无额外前置条件;建议在启动前注册 `onCompassChange`
62
+
63
+ ## 使用说明
64
+
65
+ 需配对调用 stopCompass。
66
+
67
+ - 不再需要时及时调用 `stopCompass`,避免持续采集造成额外功耗
68
+
69
+ ## 调用方式
70
+
71
+ ### 异步 API
72
+
73
+ ```typescript
74
+ startCompass(params?: object): Promise<object>
75
+ ```
76
+
77
+ ## 入参
78
+
79
+ 无。
80
+
81
+ ## 调用示例
82
+
83
+ ```typescript
84
+ import { startCompass } from '@doubao-dev/framework/api';
85
+
86
+ await startCompass();
87
+ ```
88
+
89
+ ## 成功返回
90
+
91
+ 无返回字段。
92
+
93
+ ### 返回示例
94
+
95
+ ```json
96
+ {}
97
+ ```
98
+
99
+ ## 错误处理
100
+
101
+ 错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
102
+
103
+ ### 失败示例
104
+
105
+ ```json
106
+ {
107
+ "errNo": 103,
108
+ "errMsg": "feature not support"
109
+ }
110
+ ```
111
+
112
+ ### 错误码
113
+
114
+ <table>
115
+ <thead>
116
+ <tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
117
+ </thead>
118
+ <tbody>
119
+ <tr><td><code>103</code></td><td><code>feature not support</code></td><td>Android、iOS</td><td>当前设备不支持罗盘传感器或无法注册监听</td><td>在具备罗盘传感器的设备上调用,或提前提示用户设备不支持。</td></tr>
120
+ </tbody>
121
+ </table>
122
+
123
+ #### 通用错误码
124
+
125
+ <table>
126
+ <thead>
127
+ <tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
128
+ </thead>
129
+ <tbody>
130
+ <tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
131
+ </tbody>
132
+ </table>
133
+
134
+ <a id="stopcompass"></a>
135
+ ### stopCompass()
136
+
137
+ # stopCompass
138
+
139
+ 停止监听罗盘。
140
+
141
+ ## 扫码预览
142
+ ![扫码预览 stopCompass](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%252Fcompass%252Findex)
143
+
144
+ ## 支持版本
145
+
146
+ 前端库版本不低于 `0.0.25`。
147
+
148
+ ## 支持平台
149
+
150
+ <table>
151
+ <thead>
152
+ <tr><th>平台</th><th>支持情况</th></tr>
153
+ </thead>
154
+ <tbody>
155
+ <tr><td>Android</td><td>支持</td></tr>
156
+ <tr><td>iOS</td><td>支持</td></tr>
157
+ <tr><td>PC</td><td>不支持</td></tr>
158
+ <tr><td>HarmonyOS</td><td>不支持</td></tr>
159
+ </tbody>
160
+ </table>
161
+
162
+ ## 支持场景
163
+
164
+ <table>
165
+ <thead>
166
+ <tr><th>场景</th><th>支持情况</th></tr>
167
+ </thead>
168
+ <tbody>
169
+ <tr><td>页面</td><td>支持</td></tr>
170
+ <tr><td>卡片</td><td>不支持</td></tr>
171
+ </tbody>
172
+ </table>
173
+
174
+ ## 接入准备
175
+
176
+ ### 前置条件
177
+
178
+ - 无额外前置条件;通常在 `startCompass` 后调用
179
+
180
+ ## 使用说明
181
+
182
+ - 未启动时调用也会直接成功,可用于安全清理监听状态
183
+
184
+ ## 调用方式
185
+
186
+ ### 异步 API
187
+
188
+ ```typescript
189
+ stopCompass(params?: object): Promise<object>
190
+ ```
191
+
192
+ ## 入参
193
+
194
+ 无。
195
+
196
+ ## 调用示例
197
+
198
+ ```typescript
199
+ import { stopCompass } from '@doubao-dev/framework/api';
200
+
201
+ await stopCompass();
202
+ ```
203
+
204
+ ## 成功返回
205
+
206
+ 无返回字段。
207
+
208
+ ### 返回示例
209
+
210
+ ```json
211
+ {}
212
+ ```
213
+
214
+ <a id="oncompasschange"></a>
215
+ ### onCompassChange()
216
+
217
+ # onCompassChange
218
+
219
+ 监听罗盘数据变化事件。
220
+
221
+ ## 扫码预览
222
+ ![扫码预览 onCompassChange](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%252Fcompass%252Findex)
223
+
224
+ ## 支持版本
225
+
226
+ 前端库版本不低于 `0.0.26`。
227
+
228
+ ## 支持平台
229
+
230
+ <table>
231
+ <thead>
232
+ <tr><th>平台</th><th>支持情况</th></tr>
233
+ </thead>
234
+ <tbody>
235
+ <tr><td>Android</td><td>支持</td></tr>
236
+ <tr><td>iOS</td><td>支持</td></tr>
237
+ <tr><td>PC</td><td>不支持</td></tr>
238
+ <tr><td>HarmonyOS</td><td>不支持</td></tr>
239
+ </tbody>
240
+ </table>
241
+
242
+ ## 支持场景
243
+
244
+ <table>
245
+ <thead>
246
+ <tr><th>场景</th><th>支持情况</th></tr>
247
+ </thead>
248
+ <tbody>
249
+ <tr><td>页面</td><td>支持</td></tr>
250
+ <tr><td>卡片</td><td>不支持</td></tr>
251
+ </tbody>
252
+ </table>
253
+
254
+ ## 接入准备
255
+
256
+ ### 前置条件
257
+
258
+ - 调用 `startCompass` 后事件才会持续回调
259
+
260
+ ## 使用说明
261
+
262
+ - 取消函数只移除本地回调,需要停止采集时调用 `stopCompass`
263
+
264
+ ## 调用方式
265
+
266
+ ### 事件监听 API
267
+
268
+ ```typescript
269
+ onCompassChange(callback: (event: CompassChangeEvent) => void): () => void
270
+ ```
271
+
272
+ ## 入参
273
+
274
+ 无。
275
+
276
+ ## 调用示例
277
+
278
+ ```ts
279
+ import { onCompassChange } from '@doubao-dev/framework/api';
280
+
281
+ const off = onCompassChange(({ direction }) => {
282
+ console.log(direction);
283
+ });
284
+
285
+ off();
286
+ ```
287
+
288
+ ## 回调参数
289
+
290
+ <table>
291
+ <thead>
292
+ <tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
293
+ </thead>
294
+ <tbody>
295
+ <tr><td><code>event.direction</code></td><td><code>number</code></td><td>是</td><td>面对的方向度数,范围 0 到 360。</td></tr>
296
+ </tbody>
297
+ </table>
298
+
299
+ ## 返回值
300
+
301
+ 返回取消当前监听函数的函数。
302
+
303
+ ### 回调示例
304
+
305
+ ```json
306
+ {
307
+ "direction": 128.5
308
+ }
309
+ ```
310
+
311
+ ## 相关类型
312
+
313
+ <a id="compasschangeevent"></a>
314
+ ### CompassChangeEvent
315
+
316
+ 罗盘数据变化事件。
317
+
318
+ #### Properties
319
+
320
+ • **direction**: `number` - 面对的方向度数,范围 0 到 360
@@ -0,0 +1,351 @@
1
+ # 豆包应用插件的端能力 API: 设备方向
2
+
3
+ 设备方向监听能力。
4
+
5
+ [返回目录](./groups.md) | [返回速查](./quick-reference.md)
6
+
7
+ ## 速查
8
+
9
+ | API | 说明 |
10
+ | --- | --- |
11
+ | [startDeviceMotionListening](#startdevicemotionlistening) | 开始监听设备方向变化。 |
12
+ | [stopDeviceMotionListening](#stopdevicemotionlistening) | 停止监听设备方向变化。 |
13
+ | [onDeviceMotionChange](#ondevicemotionchange) | 监听设备方向变化事件。<br><br>返回取消监听函数。 |
14
+
15
+ ## API 详情
16
+
17
+ <a id="startdevicemotionlistening"></a>
18
+ ### startDeviceMotionListening()
19
+
20
+ # startDeviceMotionListening
21
+
22
+ 开始监听设备方向变化。
23
+
24
+ ## 扫码预览
25
+ ![扫码预览 startDeviceMotionListening](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%252Fdevice-motion%252Findex)
26
+
27
+ ## 支持版本
28
+
29
+ 前端库版本不低于 `0.0.25`。
30
+
31
+ ## 支持平台
32
+
33
+ <table>
34
+ <thead>
35
+ <tr><th>平台</th><th>支持情况</th></tr>
36
+ </thead>
37
+ <tbody>
38
+ <tr><td>Android</td><td>支持</td></tr>
39
+ <tr><td>iOS</td><td>支持</td></tr>
40
+ <tr><td>PC</td><td>不支持</td></tr>
41
+ <tr><td>HarmonyOS</td><td>不支持</td></tr>
42
+ </tbody>
43
+ </table>
44
+
45
+ ## 支持场景
46
+
47
+ <table>
48
+ <thead>
49
+ <tr><th>场景</th><th>支持情况</th></tr>
50
+ </thead>
51
+ <tbody>
52
+ <tr><td>页面</td><td>支持</td></tr>
53
+ <tr><td>卡片</td><td>不支持</td></tr>
54
+ </tbody>
55
+ </table>
56
+
57
+ ## 接入准备
58
+
59
+ ### 前置条件
60
+
61
+ - 无额外前置条件;建议在启动前注册 `onDeviceMotionChange`
62
+
63
+ ## 使用说明
64
+
65
+ 需配对调用 stopDeviceMotionListening。
66
+
67
+ - 不再需要时及时调用 `stopDeviceMotionListening`,避免持续采集造成额外功耗
68
+
69
+ ## 调用方式
70
+
71
+ ### 异步 API
72
+
73
+ ```typescript
74
+ startDeviceMotionListening(params?: StartDeviceMotionListeningParams): Promise<object>
75
+ ```
76
+
77
+ ## 入参
78
+
79
+ <table>
80
+ <thead>
81
+ <tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
82
+ </thead>
83
+ <tbody>
84
+ <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>
85
+ </tbody>
86
+ </table>
87
+
88
+ ## 调用示例
89
+
90
+ ```typescript
91
+ import { startDeviceMotionListening } from '@doubao-dev/framework/api';
92
+
93
+ await startDeviceMotionListening({ interval: 'normal' });
94
+ ```
95
+
96
+ ## 成功返回
97
+
98
+ 无返回字段。
99
+
100
+ ### 返回示例
101
+
102
+ ```json
103
+ {}
104
+ ```
105
+
106
+ ## 错误处理
107
+
108
+ 错误对象和通用错误码见 [通用错误处理](./common-errors.md#错误返回)。
109
+
110
+ ### 失败示例
111
+
112
+ ```json
113
+ {
114
+ "errNo": 103,
115
+ "errMsg": "feature not support"
116
+ }
117
+ ```
118
+
119
+ ### 错误码
120
+
121
+ <table>
122
+ <thead>
123
+ <tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
124
+ </thead>
125
+ <tbody>
126
+ <tr><td><code>103</code></td><td><code>feature not support</code></td><td>Android、iOS</td><td>当前设备不支持方向传感器或无法注册监听</td><td>在具备方向传感器的设备上调用,或提前提示用户设备不支持。</td></tr>
127
+ </tbody>
128
+ </table>
129
+
130
+ #### 通用错误码
131
+
132
+ <table>
133
+ <thead>
134
+ <tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
135
+ </thead>
136
+ <tbody>
137
+ <tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
138
+ </tbody>
139
+ </table>
140
+
141
+ <a id="stopdevicemotionlistening"></a>
142
+ ### stopDeviceMotionListening()
143
+
144
+ # stopDeviceMotionListening
145
+
146
+ 停止监听设备方向变化。
147
+
148
+ ## 扫码预览
149
+ ![扫码预览 stopDeviceMotionListening](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%252Fdevice-motion%252Findex)
150
+
151
+ ## 支持版本
152
+
153
+ 前端库版本不低于 `0.0.25`。
154
+
155
+ ## 支持平台
156
+
157
+ <table>
158
+ <thead>
159
+ <tr><th>平台</th><th>支持情况</th></tr>
160
+ </thead>
161
+ <tbody>
162
+ <tr><td>Android</td><td>支持</td></tr>
163
+ <tr><td>iOS</td><td>支持</td></tr>
164
+ <tr><td>PC</td><td>不支持</td></tr>
165
+ <tr><td>HarmonyOS</td><td>不支持</td></tr>
166
+ </tbody>
167
+ </table>
168
+
169
+ ## 支持场景
170
+
171
+ <table>
172
+ <thead>
173
+ <tr><th>场景</th><th>支持情况</th></tr>
174
+ </thead>
175
+ <tbody>
176
+ <tr><td>页面</td><td>支持</td></tr>
177
+ <tr><td>卡片</td><td>不支持</td></tr>
178
+ </tbody>
179
+ </table>
180
+
181
+ ## 接入准备
182
+
183
+ ### 前置条件
184
+
185
+ - 无额外前置条件;通常在 `startDeviceMotionListening` 后调用
186
+
187
+ ## 使用说明
188
+
189
+ - 未启动时调用也会直接成功,可用于安全清理监听状态
190
+
191
+ ## 调用方式
192
+
193
+ ### 异步 API
194
+
195
+ ```typescript
196
+ stopDeviceMotionListening(params?: object): Promise<object>
197
+ ```
198
+
199
+ ## 入参
200
+
201
+ 无。
202
+
203
+ ## 调用示例
204
+
205
+ ```typescript
206
+ import { stopDeviceMotionListening } from '@doubao-dev/framework/api';
207
+
208
+ await stopDeviceMotionListening();
209
+ ```
210
+
211
+ ## 成功返回
212
+
213
+ 无返回字段。
214
+
215
+ ### 返回示例
216
+
217
+ ```json
218
+ {}
219
+ ```
220
+
221
+ <a id="ondevicemotionchange"></a>
222
+ ### onDeviceMotionChange()
223
+
224
+ # onDeviceMotionChange
225
+
226
+ 监听设备方向变化事件。
227
+
228
+ ## 扫码预览
229
+ ![扫码预览 onDeviceMotionChange](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%252Fdevice-motion%252Findex)
230
+
231
+ ## 支持版本
232
+
233
+ 前端库版本不低于 `0.0.29`。
234
+
235
+ ## 支持平台
236
+
237
+ <table>
238
+ <thead>
239
+ <tr><th>平台</th><th>支持情况</th></tr>
240
+ </thead>
241
+ <tbody>
242
+ <tr><td>Android</td><td>支持</td></tr>
243
+ <tr><td>iOS</td><td>支持</td></tr>
244
+ <tr><td>PC</td><td>不支持</td></tr>
245
+ <tr><td>HarmonyOS</td><td>不支持</td></tr>
246
+ </tbody>
247
+ </table>
248
+
249
+ ## 支持场景
250
+
251
+ <table>
252
+ <thead>
253
+ <tr><th>场景</th><th>支持情况</th></tr>
254
+ </thead>
255
+ <tbody>
256
+ <tr><td>页面</td><td>支持</td></tr>
257
+ <tr><td>卡片</td><td>不支持</td></tr>
258
+ </tbody>
259
+ </table>
260
+
261
+ ## 接入准备
262
+
263
+ ### 前置条件
264
+
265
+ - 调用 `startDeviceMotionListening` 后事件才会持续回调
266
+
267
+ ## 使用说明
268
+
269
+ - 取消函数只移除本地回调,需要停止采集时调用 `stopDeviceMotionListening`
270
+
271
+ ## 调用方式
272
+
273
+ ### 事件监听 API
274
+
275
+ ```typescript
276
+ onDeviceMotionChange(callback: (event: DeviceMotionChangeEvent) => void): () => void
277
+ ```
278
+
279
+ ## 入参
280
+
281
+ 无。
282
+
283
+ ## 调用示例
284
+
285
+ ```ts
286
+ import { onDeviceMotionChange } from '@doubao-dev/framework/api';
287
+
288
+ const off = onDeviceMotionChange(({ alpha, beta, gamma }) => {
289
+ console.log(alpha, beta, gamma);
290
+ });
291
+
292
+ off();
293
+ ```
294
+
295
+ ## 回调参数
296
+
297
+ <table>
298
+ <thead>
299
+ <tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
300
+ </thead>
301
+ <tbody>
302
+ <tr><td><code>event.alpha</code></td><td><code>number</code></td><td>是</td><td>当手机坐标 X/Y 和地球坐标 X/Y 重合时,绕 Z 轴转动的夹角。<br>范围为 [0, 2π),逆时针转动为正。</td></tr>
303
+ <tr><td><code>event.beta</code></td><td><code>number</code></td><td>是</td><td>当手机坐标 Y/Z 和地球坐标 Y/Z 重合时,绕 X 轴转动的夹角。<br>范围为 [-π, π)。</td></tr>
304
+ <tr><td><code>event.gamma</code></td><td><code>number</code></td><td>是</td><td>当手机坐标 X/Z 和地球坐标 X/Z 重合时,绕 Y 轴转动的夹角。<br>范围为 [-π/2, π/2)。</td></tr>
305
+ </tbody>
306
+ </table>
307
+
308
+ ## 返回值
309
+
310
+ 返回取消当前监听函数的函数。
311
+
312
+ ### 回调示例
313
+
314
+ ```json
315
+ {
316
+ "alpha": 1.57,
317
+ "beta": 0.12,
318
+ "gamma": -0.05
319
+ }
320
+ ```
321
+
322
+ ## 相关类型
323
+
324
+ <a id="startdevicemotionlisteningparams"></a>
325
+ ### StartDeviceMotionListeningParams
326
+
327
+ 开始监听设备方向变化的请求参数。
328
+
329
+ #### Properties
330
+
331
+ • **interval?**: `SensorInterval` - 监听频率
332
+
333
+ <a id="sensorinterval"></a>
334
+ ### SensorInterval
335
+
336
+ 传感器监听频率。
337
+
338
+ #### Type
339
+
340
+ `'game' | 'ui' | 'normal'`
341
+
342
+ <a id="devicemotionchangeevent"></a>
343
+ ### DeviceMotionChangeEvent
344
+
345
+ 设备方向变化事件。
346
+
347
+ #### Properties
348
+
349
+ • **alpha**: `number` - 当手机坐标 X/Y 和地球坐标 X/Y 重合时,绕 Z 轴转动的夹角。 范围为 [0, 2π),逆时针转动为正
350
+ • **beta**: `number` - 当手机坐标 Y/Z 和地球坐标 Y/Z 重合时,绕 X 轴转动的夹角。 范围为 [-π, π)
351
+ • **gamma**: `number` - 当手机坐标 X/Z 和地球坐标 X/Z 重合时,绕 Y 轴转动的夹角。 范围为 [-π/2, π/2)