@ray-js/api 1.7.79 → 1.7.80

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 (56) hide show
  1. package/@types/AIKit.d.ts +1140 -1009
  2. package/@types/AVideoKit.d.ts +26 -101
  3. package/@types/BaseKit.d.ts +234 -210
  4. package/@types/BizKit.d.ts +271 -296
  5. package/@types/DeviceKit.d.ts +57 -88
  6. package/@types/GroupCITestKit.d.ts +1 -3
  7. package/@types/HealthKit.d.ts +273 -230
  8. package/@types/HomeKit.d.ts +1062 -891
  9. package/@types/IPCKit.d.ts +23 -50
  10. package/@types/LightKit.d.ts +2 -2
  11. package/@types/MapKit.d.ts +592 -381
  12. package/@types/MediaPlayerKit.d.ts +4 -28
  13. package/@types/MiniKit.d.ts +198 -375
  14. package/@types/P2PKit.d.ts +139 -205
  15. package/@types/PayKit.d.ts +10 -79
  16. package/@types/SweeperKit.d.ts +10 -10
  17. package/@types/ThirdAuthKit.d.ts +28 -252
  18. package/@types/WearKit.d.ts +630 -1593
  19. package/@types/api-extend.d.ts +0 -63
  20. package/lib/AIKit-1.6.0.d.ts +732 -35
  21. package/lib/AIKit-1.6.0.js +732 -51
  22. package/lib/BaseKit-3.17.7.d.ts +0 -214
  23. package/lib/BaseKit-3.17.7.js +1 -227
  24. package/lib/DeviceKit-4.13.1.d.ts +3666 -0
  25. package/lib/DeviceKit-4.13.1.js +3666 -0
  26. package/lib/HealthKit-6.5.0.d.ts +603 -0
  27. package/lib/HealthKit-6.5.0.js +603 -0
  28. package/lib/HomeKit-3.1.4.d.ts +4 -0
  29. package/lib/HomeKit-3.1.4.js +4 -0
  30. package/lib/IPCKit-6.4.5.d.ts +0 -1
  31. package/lib/IPCKit-6.4.5.js +0 -1
  32. package/lib/MapKit-3.4.13.d.ts +251 -0
  33. package/lib/MapKit-3.4.13.js +251 -0
  34. package/lib/MediaKit-3.4.1.d.ts +16 -0
  35. package/lib/MediaKit-3.4.1.js +16 -0
  36. package/lib/PlayNetKit-1.3.30.d.ts +930 -0
  37. package/lib/PlayNetKit-1.3.30.js +930 -0
  38. package/lib/cloud/alarm.d.ts +38 -5
  39. package/lib/cloud/alarm.js +38 -5
  40. package/lib/cloud/device.d.ts +42 -6
  41. package/lib/cloud/device.js +42 -6
  42. package/lib/cloud/gateway.d.ts +16 -0
  43. package/lib/cloud/gateway.js +16 -0
  44. package/lib/cloud/health.d.ts +1 -0
  45. package/lib/cloud/health.js +272 -0
  46. package/lib/cloud/interface.d.ts +161 -0
  47. package/lib/cloud/interface.js +18 -0
  48. package/lib/cloud/statistic.d.ts +112 -26
  49. package/lib/cloud/statistic.js +112 -26
  50. package/lib/cloud/timer.d.ts +2 -4
  51. package/lib/nativeRouters/outdoors.d.ts +2 -0
  52. package/lib/nativeRouters/outdoors.js +2 -0
  53. package/lib/nativeRouters/remoteGroup.d.ts +2 -0
  54. package/lib/nativeRouters/remoteGroup.js +2 -0
  55. package/lib/panel/publishDps.js +1 -1
  56. package/package.json +5 -5
@@ -1,40 +1,19 @@
1
1
  /**
2
2
  * WearKit
3
3
  *
4
- * @version 3.0.4
4
+ * @version 3.0.0
5
5
  */
6
6
  declare namespace ty.wear {
7
7
  /**
8
8
  * QQ音乐授权
9
- * @description.en QQ Music authorization.
9
+ * 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
10
10
  * @public
11
- * @since WearKit 1.0.0
12
- * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
13
- * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
14
- * @example 基础用法
15
- * ```tsx
16
- * `ty.wear.qqMusicAuth({
17
- * params: { type: 0 },
18
- * success: (result) => {
19
- * console.log('qqMusicAuth success', result);
20
- * },
21
- * fail: (error) => {
22
- * console.log('qqMusicAuth fail', error.errorMsg);
23
- * },
24
- * });`
25
- * ```
26
- * @see https://developer.tuya.com/
11
+ * @since WearKit 0.0.5
27
12
  * @platform iOS Android
28
- * @error {10001} 参数错误
29
- * @error {10002} 授权失败
30
- * @error {10003} 解密失败
31
- * @error {10004} JSON解析错误
32
- * @error {10005} 签名校验失败
33
- * @error {10006} 不支持的授权类型
34
13
  */
35
14
  export function qqMusicAuth(params: {
36
15
  /**
37
- * 第三方服务类型,参见 ThirdPartyType 枚举
16
+ * 三方服务列表 ThirdPartyType
38
17
  * @since WearKit 0.0.5
39
18
  */
40
19
  type: number
@@ -43,17 +22,17 @@ declare namespace ty.wear {
43
22
  /** 接口调用成功的回调函数 */
44
23
  success?: (params: {
45
24
  /**
46
- * 过期时间(Unix 时间戳,单位:秒)
25
+ * 过期时间
47
26
  * @since WearKit 0.0.5
48
27
  */
49
28
  expireTime: number
50
29
  /**
51
- * QQ音乐账户 openId
30
+ * openId
52
31
  * @since WearKit 0.0.5
53
32
  */
54
33
  openId: string
55
34
  /**
56
- * QQ音乐访问令牌
35
+ * openToken
57
36
  * @since WearKit 0.0.5
58
37
  */
59
38
  openToken: string
@@ -76,23 +55,9 @@ declare namespace ty.wear {
76
55
 
77
56
  /**
78
57
  * 获取QQ音乐QQ小程序授权参数
79
- * @description.en Get QQ Music QQ Mini Program authorization parameters.
58
+ * 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
80
59
  * @public
81
- * @since WearKit 1.0.0
82
- * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
83
- * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
84
- * @example 基础用法
85
- * ```tsx
86
- * `ty.wear.getQQMusicQQMiniProgramAuthParams({
87
- * success: (result) => {
88
- * console.log('getQQMusicQQMiniProgramAuthParams success', result);
89
- * },
90
- * fail: (error) => {
91
- * console.log('getQQMusicQQMiniProgramAuthParams fail', error.errorMsg);
92
- * },
93
- * });`
94
- * ```
95
- * @see https://developer.tuya.com/
60
+ * @since WearKit 0.0.5
96
61
  * @platform iOS Android
97
62
  */
98
63
  export function getQQMusicQQMiniProgramAuthParams(params?: {
@@ -101,12 +66,12 @@ declare namespace ty.wear {
101
66
  /** 接口调用成功的回调函数 */
102
67
  success?: (params: {
103
68
  /**
104
- * QQ音乐 AppKey
69
+ * qq音乐appkey
105
70
  * @since WearKit 0.0.5
106
71
  */
107
72
  qqMusicAppKey: string
108
73
  /**
109
- * 加密的签名字符串
74
+ * 签名字符串
110
75
  * @since WearKit 0.0.5
111
76
  */
112
77
  encryptString: string
@@ -129,33 +94,14 @@ declare namespace ty.wear {
129
94
 
130
95
  /**
131
96
  * 解析QQ音乐QQ小程序授权结果
132
- * @description.en Parse QQ Music QQ Mini Program authorization result.
97
+ * 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
133
98
  * @public
134
- * @since WearKit 1.0.0
135
- * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
136
- * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
137
- * @example 基础用法
138
- * ```tsx
139
- * `ty.wear.parseQQMusicAuthResult({
140
- * params: { encryptString: 'xxx' },
141
- * success: (result) => {
142
- * console.log('parseQQMusicAuthResult success', result);
143
- * },
144
- * fail: (error) => {
145
- * console.log('parseQQMusicAuthResult fail', error.errorMsg);
146
- * },
147
- * });`
148
- * ```
149
- * @see https://developer.tuya.com/
99
+ * @since WearKit 0.0.5
150
100
  * @platform iOS Android
151
- * @error {10001} 参数错误
152
- * @error {10004} JSON解析错误
153
- * @error {10005} 签名校验失败
154
- * @error {10007} 解密失败
155
101
  */
156
102
  export function parseQQMusicAuthResult(params: {
157
103
  /**
158
- * 加密的授权结果字符串
104
+ * 授权结果
159
105
  * @since WearKit 0.0.5
160
106
  */
161
107
  encryptString: string
@@ -164,17 +110,17 @@ declare namespace ty.wear {
164
110
  /** 接口调用成功的回调函数 */
165
111
  success?: (params: {
166
112
  /**
167
- * 过期时间(Unix 时间戳,单位:秒)
113
+ * 过期时间
168
114
  * @since WearKit 0.0.5
169
115
  */
170
116
  expireTime: number
171
117
  /**
172
- * QQ音乐账户 openId
118
+ * openId
173
119
  * @since WearKit 0.0.5
174
120
  */
175
121
  openId: string
176
122
  /**
177
- * QQ音乐访问令牌
123
+ * openToken
178
124
  * @since WearKit 0.0.5
179
125
  */
180
126
  openToken: string
@@ -197,56 +143,10 @@ declare namespace ty.wear {
197
143
 
198
144
  /**
199
145
  * 获取本地应用支持消息监听的应用列表
200
- * 返回 list\<Int\>,支持的 app 类型有:
201
- * - 0:来电
202
- * - 1:短信
203
- * - 2:QQ
204
- * - 3:微信
205
- * - 4:FB(Facebook)
206
- * - 5:Messenger
207
- * - 6:Twitter
208
- * - 7:WhatsApp
209
- * - 8:Instagram
210
- * - 9:LinkedIn
211
- * - 10:Other Apps(暂未定义的 app 类型,目前该类型用不到)
212
- * - 17:Viber
213
- * - 18:Line
214
- * - 19:Skype
215
- * - 20:Outlook
216
- * @description.en Get the list of locally supported apps for message listening.
217
- *
218
- * Returns list<Int>, supported app types:
219
- * - 0: Phone Call
220
- * - 1: SMS
221
- * - 2: QQ
222
- * - 3: WeChat
223
- * - 4: Facebook
224
- * - 5: Messenger
225
- * - 6: Twitter
226
- * - 7: WhatsApp
227
- * - 8: Instagram
228
- * - 9: LinkedIn
229
- * - 10: Other Apps (undefined app types, currently unused)
230
- * - 17: Viber
231
- * - 18: Line
232
- * - 19: Skype
233
- * - 20: Outlook
146
+ * Int 对应的枚举参考文档 : https://wiki.tuya-inc.com:7799/pages/viewpage.action?pageId=64287278
234
147
  * @public
235
- * @since WearKit 1.0.0
236
- * @example 基础用法
237
- * ```tsx
238
- * `ty.wear.getLocalSupportAppList({
239
- * success: (list) => {
240
- * console.log('supported apps', list);
241
- * },
242
- * fail: (error) => {
243
- * console.log('getLocalSupportAppList fail', error.errorMsg);
244
- * },
245
- * });`
246
- * ```
247
- * @see https://developer.tuya.com/
148
+ * @since WearKit 0.0.4
248
149
  * @platform Android
249
- * @error {10001} 服务未定义
250
150
  */
251
151
  export function getLocalSupportAppList(params?: {
252
152
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -277,24 +177,9 @@ declare namespace ty.wear {
277
177
 
278
178
  /**
279
179
  * 是否正在同步中
280
- * @description.en Check whether stock sync is in progress.
281
180
  * @public
282
- * @since WearKit 1.0.0
283
- * @example 基础用法
284
- * ```tsx
285
- * `ty.wear.isSync({
286
- * data: { deviceId: 'device123', syncType: 1 },
287
- * success: (isSyncing) => {
288
- * console.log('isSync', isSyncing);
289
- * },
290
- * fail: (error) => {
291
- * console.log('isSync fail', error.errorMsg);
292
- * },
293
- * });`
294
- * ```
295
- * @see https://developer.tuya.com/
181
+ * @since WearKit 0.0.4
296
182
  * @platform iOS Android
297
- * @error {10001} 服务未定义
298
183
  */
299
184
  export function isSync(params: {
300
185
  /**
@@ -303,7 +188,7 @@ declare namespace ty.wear {
303
188
  */
304
189
  deviceId: string
305
190
  /**
306
- * 股票同步类型,参考 StockSyncType 枚举
191
+ * 股票同步类型
307
192
  * @since WearKit 0.0.4
308
193
  */
309
194
  syncType: number
@@ -329,23 +214,9 @@ declare namespace ty.wear {
329
214
 
330
215
  /**
331
216
  * 监听股票同步事件
332
- * @description.en Listen for stock sync events.
333
217
  * @public
334
- * @since WearKit 1.0.0
335
- * @example 基础用法
336
- * ```tsx
337
- * `ty.wear.listenStockSync({
338
- * success: () => {
339
- * console.log('listenStockSync success');
340
- * },
341
- * fail: (error) => {
342
- * console.log('listenStockSync fail', error.errorMsg);
343
- * },
344
- * });`
345
- * ```
346
- * @see https://developer.tuya.com/
218
+ * @since WearKit 0.0.4
347
219
  * @platform iOS Android
348
- * @error {10001} 服务未定义
349
220
  */
350
221
  export function listenStockSync(params?: {
351
222
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -369,27 +240,10 @@ declare namespace ty.wear {
369
240
  }): void
370
241
 
371
242
  /**
372
- * 校验并覆盖股票列表
373
- * @description.en Check and cover stocks.
243
+ * 校验和同步
374
244
  * @public
375
- * @since WearKit 1.0.0
376
- * @example 基础用法
377
- * ```tsx
378
- * `ty.wear.checkAndCoverStocks({
379
- * data: { deviceId: 'device123', stocks: [...] },
380
- * success: () => {
381
- * console.log('checkAndCoverStocks success');
382
- * },
383
- * fail: (error) => {
384
- * console.log('checkAndCoverStocks fail', error.errorMsg);
385
- * },
386
- * });`
387
- * ```
388
- * @see https://developer.tuya.com/
245
+ * @since WearKit 0.0.4
389
246
  * @platform iOS Android
390
- * @error {10001} 服务未定义
391
- * @error {10002} 参数缺失
392
- * @error {10003} 内部错误
393
247
  */
394
248
  export function checkAndCoverStocks(params: {
395
249
  /**
@@ -424,26 +278,9 @@ declare namespace ty.wear {
424
278
 
425
279
  /**
426
280
  * 添加股票
427
- * @description.en Add a stock.
428
281
  * @public
429
- * @since WearKit 1.0.0
430
- * @example 基础用法
431
- * ```tsx
432
- * `ty.wear.addStock({
433
- * data: { deviceId: 'device123', stock: {...}, originalStocks: [...] },
434
- * success: () => {
435
- * console.log('addStock success');
436
- * },
437
- * fail: (error) => {
438
- * console.log('addStock fail', error.errorMsg);
439
- * },
440
- * });`
441
- * ```
442
- * @see https://developer.tuya.com/
282
+ * @since WearKit 0.0.4
443
283
  * @platform iOS Android
444
- * @error {10001} 服务未定义
445
- * @error {10002} 参数缺失
446
- * @error {10003} 内部错误
447
284
  */
448
285
  export function addStock(params: {
449
286
  /**
@@ -483,26 +320,9 @@ declare namespace ty.wear {
483
320
 
484
321
  /**
485
322
  * 删除股票
486
- * @description.en Delete a stock.
487
323
  * @public
488
- * @since WearKit 1.0.0
489
- * @example 基础用法
490
- * ```tsx
491
- * `ty.wear.deleteStock({
492
- * data: { deviceId: 'device123', stock: {...}, originalStocks: [...] },
493
- * success: () => {
494
- * console.log('deleteStock success');
495
- * },
496
- * fail: (error) => {
497
- * console.log('deleteStock fail', error.errorMsg);
498
- * },
499
- * });`
500
- * ```
501
- * @see https://developer.tuya.com/
324
+ * @since WearKit 0.0.4
502
325
  * @platform iOS Android
503
- * @error {10001} 服务未定义
504
- * @error {10002} 参数缺失
505
- * @error {10003} 内部错误
506
326
  */
507
327
  export function deleteStock(params: {
508
328
  /**
@@ -542,26 +362,9 @@ declare namespace ty.wear {
542
362
 
543
363
  /**
544
364
  * 股票排序
545
- * @description.en Sort stocks.
546
365
  * @public
547
- * @since WearKit 1.0.0
548
- * @example 基础用法
549
- * ```tsx
550
- * `ty.wear.sortStocks({
551
- * data: { deviceId: 'device123', stocks: [...] },
552
- * success: () => {
553
- * console.log('sortStocks success');
554
- * },
555
- * fail: (error) => {
556
- * console.log('sortStocks fail', error.errorMsg);
557
- * },
558
- * });`
559
- * ```
560
- * @see https://developer.tuya.com/
366
+ * @since WearKit 0.0.4
561
367
  * @platform iOS Android
562
- * @error {10001} 服务未定义
563
- * @error {10002} 参数缺失
564
- * @error {10003} 内部错误
565
368
  */
566
369
  export function sortStocks(params: {
567
370
  /**
@@ -596,22 +399,8 @@ declare namespace ty.wear {
596
399
 
597
400
  /**
598
401
  * 应用是否安装
599
- * @description.en Check whether an app is installed.
600
402
  * @public
601
- * @since WearKit 1.2.0
602
- * @example 基础用法
603
- * ```tsx
604
- * `ty.wear.appHasInstall({
605
- * data: { packageName: 'com.example.app' },
606
- * success: (result) => {
607
- * console.log('appHasInstall', result.hasInstall);
608
- * },
609
- * fail: (error) => {
610
- * console.log('appHasInstall fail', error.errorMsg);
611
- * },
612
- * });`
613
- * ```
614
- * @see https://developer.tuya.com/
403
+ * @since WearKit 0.0.6
615
404
  * @platform Android
616
405
  */
617
406
  export function appHasInstall(params: {
@@ -625,7 +414,6 @@ declare namespace ty.wear {
625
414
  /** 接口调用成功的回调函数 */
626
415
  success?: (params: {
627
416
  /**
628
- * 是否已安装
629
417
  * @since WearKit 0.0.6
630
418
  * @defaultValue false
631
419
  */
@@ -649,27 +437,12 @@ declare namespace ty.wear {
649
437
 
650
438
  /**
651
439
  * 应用是否安装
652
- * @description.en Check whether an app is installed.
653
440
  * @public
654
- * @since WearKit 1.2.0
655
- * @example 基础用法
656
- * ```tsx
657
- * `ty.wear.appHasInstall({
658
- * data: { packageName: 'com.example.app' },
659
- * success: (result) => {
660
- * console.log('appHasInstall', result.hasInstall);
661
- * },
662
- * fail: (error) => {
663
- * console.log('appHasInstall fail', error.errorMsg);
664
- * },
665
- * });`
666
- * ```
667
- * @see https://developer.tuya.com/
441
+ * @since WearKit 0.0.6
668
442
  * @platform Android
669
443
  */
670
444
  export function appHasInstallSync(data?: HasInstallBean): {
671
445
  /**
672
- * 是否已安装
673
446
  * @since WearKit 0.0.6
674
447
  * @defaultValue false
675
448
  */
@@ -678,23 +451,20 @@ declare namespace ty.wear {
678
451
 
679
452
  /**
680
453
  * 初始化纯音检测sdk
681
- * @description.en Initialize pure-tone detection SDK.
682
454
  * @public
683
455
  * @since WearKit 1.0.0
684
- * @example 基础用法
685
- * ```tsx
686
- * `ty.wear.setup({
456
+ * @example Demo
457
+ * ```jsx
458
+ * ty.wear.setup({
687
459
  * success: () => {
688
460
  * console.log('setup success');
689
461
  * },
690
462
  * fail: (error) => {
691
463
  * console.log('setup fail', error.errorMsg);
692
464
  * },
693
- * });`
465
+ * });
694
466
  * ```
695
- * @see https://developer.tuya.com/
696
467
  * @platform iOS Android
697
- * @error {10001} 内部错误
698
468
  */
699
469
  export function setup(params?: {
700
470
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -719,12 +489,11 @@ declare namespace ty.wear {
719
489
 
720
490
  /**
721
491
  * 纯音检测,播放指定配置入参的声音
722
- * @description.en Pure-tone detection, play sound with specified configuration parameters.
723
492
  * @public
724
493
  * @since WearKit 1.0.0
725
- * @example 基础用法
726
- * ```tsx
727
- * `ty.wear.detect({
494
+ * @example Demo
495
+ * ```jsx
496
+ * ty.wear.detect({
728
497
  * channel: 1,
729
498
  * hz: 1000,
730
499
  * db: 60,
@@ -734,12 +503,9 @@ declare namespace ty.wear {
734
503
  * fail: (error) => {
735
504
  * console.log('detect fail', error.errorMsg);
736
505
  * },
737
- * });`
506
+ * });
738
507
  * ```
739
- * @see https://developer.tuya.com/
740
508
  * @platform iOS Android
741
- * @error {10001} 内部错误
742
- * @error {10071} 音频格式错误
743
509
  */
744
510
  export function detect(params: {
745
511
  /**
@@ -779,23 +545,20 @@ declare namespace ty.wear {
779
545
 
780
546
  /**
781
547
  * 结束纯音检测
782
- * @description.en Stop pure-tone detection.
783
548
  * @public
784
549
  * @since WearKit 1.0.0
785
- * @example 基础用法
786
- * ```tsx
787
- * `ty.wear.stopDetect({
550
+ * @example Demo
551
+ * ```jsx
552
+ * ty.wear.stopDetect({
788
553
  * success: () => {
789
554
  * console.log('stopDetect success');
790
555
  * },
791
556
  * fail: (error) => {
792
557
  * console.log('stopDetect fail', error.errorMsg);
793
558
  * },
794
- * });`
559
+ * });
795
560
  * ```
796
- * @see https://developer.tuya.com/
797
561
  * @platform iOS Android
798
- * @error {10001} 内部错误
799
562
  */
800
563
  export function stopDetect(params?: {
801
564
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -820,12 +583,11 @@ declare namespace ty.wear {
820
583
 
821
584
  /**
822
585
  * 发布增益补偿
823
- * @description.en Publish gain compensation.
824
586
  * @public
825
587
  * @since WearKit 1.0.0
826
- * @example 基础用法
827
- * ```tsx
828
- * `ty.wear.publishGains({
588
+ * @example Demo
589
+ * ```jsx
590
+ * ty.wear.publishGains({
829
591
  * deviceId: 'device123',
830
592
  * scene: [1, 2],
831
593
  * result: [
@@ -837,14 +599,9 @@ declare namespace ty.wear {
837
599
  * fail: (error) => {
838
600
  * console.log('publishGains fail', error.errorMsg);
839
601
  * },
840
- * });`
602
+ * });
841
603
  * ```
842
- * @see https://developer.tuya.com/
843
604
  * @platform iOS Android
844
- * @error {10001} 内部错误
845
- * @error {10061} 设备错误
846
- * @error {10082} 蓝牙连接错误
847
- * @error {10083} 设备离线
848
605
  */
849
606
  export function publishGains(params: {
850
607
  /**
@@ -885,12 +642,11 @@ declare namespace ty.wear {
885
642
 
886
643
  /**
887
644
  * 开始录音
888
- * @description.en Start recording.
889
645
  * @public
890
646
  * @since WearKit 1.0.0
891
- * @example 基础用法
892
- * ```tsx
893
- * `ty.wear.startRecord({
647
+ * @example Demo
648
+ * ```jsx
649
+ * ty.wear.startRecord({
894
650
  * deviceId: 'device123',
895
651
  * config: {
896
652
  * saveDataWhenError: true,
@@ -905,29 +661,9 @@ declare namespace ty.wear {
905
661
  * fail: (error) => {
906
662
  * console.log('startRecord fail', error.errorMsg);
907
663
  * },
908
- * });`
664
+ * });
909
665
  * ```
910
- * @see https://developer.tuya.com/
911
- * @platform iOS Android
912
- * @error {10001} 内部错误
913
- * @error {10002} 设备PID未关联Agent
914
- * @error {10021} 超时
915
- * @error {10022} 电话挂断
916
- * @error {10041} 操作错误
917
- * @error {10042} 已处于开始状态
918
- * @error {10046} 已在请求中
919
- * @error {10047} 设备已在录音中
920
- * @error {10061} 设备错误
921
- * @error {10062} 设备不支持录音控制dpCode
922
- * @error {10063} DP值错误
923
- * @error {10064} 设备未全部连接
924
- * @error {10071} 音频格式错误
925
- * @error {10073} 音频引擎初始化失败
926
- * @error {10074} 音频引擎恢复失败
927
- * @error {10075} 音频引擎中断后恢复失败
928
- * @error {10081} 需要付费
929
- * @error {10082} 蓝牙连接错误
930
- * @error {10083} 设备离线
666
+ * @platform iOS Android
931
667
  */
932
668
  export function startRecord(params: {
933
669
  /**
@@ -961,13 +697,14 @@ declare namespace ty.wear {
961
697
  }): void
962
698
 
963
699
  /**
964
- * 切换录音通道,前置条件必须调用startRecord,recordChannel == 0时无效只支持BT 切换micro,或者micro切换BT
965
- * @description.en Switch recording channel.
700
+ * 切换录音通道,
701
+ * 前置条件必须调用startRecord,recordChannel == 0时无效
702
+ * 只支持BT 切换micro,或者micro切换BT
966
703
  * @public
967
704
  * @since WearKit 1.1.3
968
- * @example 基础用法
969
- * ```tsx
970
- * `ty.wear.switchRecordChannel({
705
+ * @example Demo
706
+ * ```jsx
707
+ * ty.wear.switchRecordChannel({
971
708
  * deviceId: 'device123',
972
709
  * recordChannel: 1,
973
710
  * success: () => {
@@ -976,14 +713,9 @@ declare namespace ty.wear {
976
713
  * fail: (error) => {
977
714
  * console.log('switchRecordChannel fail', error.errorMsg);
978
715
  * },
979
- * });`
716
+ * });
980
717
  * ```
981
- * @see https://developer.tuya.com/
982
718
  * @platform iOS Android
983
- * @error {10001} 内部错误
984
- * @error {10041} 操作错误
985
- * @error {10048} 设备未在录音中
986
- * @error {10061} 设备错误
987
719
  */
988
720
  export function switchRecordChannel(params: {
989
721
  /**
@@ -1018,12 +750,11 @@ declare namespace ty.wear {
1018
750
 
1019
751
  /**
1020
752
  * 暂停录音
1021
- * @description.en Pause recording.
1022
753
  * @public
1023
754
  * @since WearKit 1.0.0
1024
- * @example 基础用法
1025
- * ```tsx
1026
- * `ty.wear.pauseRecord({
755
+ * @example Demo
756
+ * ```jsx
757
+ * ty.wear.pauseRecord({
1027
758
  * deviceId: 'device123',
1028
759
  * success: () => {
1029
760
  * console.log('pauseRecord success');
@@ -1031,15 +762,9 @@ declare namespace ty.wear {
1031
762
  * fail: (error) => {
1032
763
  * console.log('pauseRecord fail', error.errorMsg);
1033
764
  * },
1034
- * });`
765
+ * });
1035
766
  * ```
1036
- * @see https://developer.tuya.com/
1037
767
  * @platform iOS Android
1038
- * @error {10001} 内部错误
1039
- * @error {10041} 操作错误
1040
- * @error {10043} 已处于暂停状态
1041
- * @error {10048} 设备未在录音中
1042
- * @error {10061} 设备错误
1043
768
  */
1044
769
  export function pauseRecord(params: {
1045
770
  /**
@@ -1069,12 +794,11 @@ declare namespace ty.wear {
1069
794
 
1070
795
  /**
1071
796
  * 恢复录音
1072
- * @description.en Resume recording.
1073
797
  * @public
1074
798
  * @since WearKit 1.0.0
1075
- * @example 基础用法
1076
- * ```tsx
1077
- * `ty.wear.resumeRecord({
799
+ * @example Demo
800
+ * ```jsx
801
+ * ty.wear.resumeRecord({
1078
802
  * deviceId: 'device123',
1079
803
  * success: () => {
1080
804
  * console.log('resumeRecord success');
@@ -1082,15 +806,9 @@ declare namespace ty.wear {
1082
806
  * fail: (error) => {
1083
807
  * console.log('resumeRecord fail', error.errorMsg);
1084
808
  * },
1085
- * });`
809
+ * });
1086
810
  * ```
1087
- * @see https://developer.tuya.com/
1088
811
  * @platform iOS Android
1089
- * @error {10001} 内部错误
1090
- * @error {10041} 操作错误
1091
- * @error {10044} 已处于恢复状态
1092
- * @error {10049} 录音未在暂停状态
1093
- * @error {10061} 设备错误
1094
812
  */
1095
813
  export function resumeRecord(params: {
1096
814
  /**
@@ -1120,12 +838,11 @@ declare namespace ty.wear {
1120
838
 
1121
839
  /**
1122
840
  * 停止录音
1123
- * @description.en Stop recording.
1124
841
  * @public
1125
842
  * @since WearKit 1.0.0
1126
- * @example 基础用法
1127
- * ```tsx
1128
- * `ty.wear.stopRecord({
843
+ * @example Demo
844
+ * ```jsx
845
+ * ty.wear.stopRecord({
1129
846
  * deviceId: 'device123',
1130
847
  * success: () => {
1131
848
  * console.log('stopRecord success');
@@ -1133,15 +850,9 @@ declare namespace ty.wear {
1133
850
  * fail: (error) => {
1134
851
  * console.log('stopRecord fail', error.errorMsg);
1135
852
  * },
1136
- * });`
853
+ * });
1137
854
  * ```
1138
- * @see https://developer.tuya.com/
1139
855
  * @platform iOS Android
1140
- * @error {10001} 内部错误
1141
- * @error {10041} 操作错误
1142
- * @error {10045} 已处于停止状态
1143
- * @error {10048} 设备未在录音中
1144
- * @error {10061} 设备错误
1145
856
  */
1146
857
  export function stopRecord(params: {
1147
858
  /**
@@ -1171,12 +882,11 @@ declare namespace ty.wear {
1171
882
 
1172
883
  /**
1173
884
  * 获取录音任务
1174
- * @description.en Get recording task.
1175
885
  * @public
1176
886
  * @since WearKit 1.0.0
1177
- * @example 基础用法
1178
- * ```tsx
1179
- * `ty.wear.recordTask({
887
+ * @example Demo
888
+ * ```jsx
889
+ * ty.wear.recordTask({
1180
890
  * deviceId: 'device123',
1181
891
  * success: (result) => {
1182
892
  * console.log('recordTask success', result.task?.state, result.task?.userRecordDuration);
@@ -1184,12 +894,9 @@ declare namespace ty.wear {
1184
894
  * fail: (error) => {
1185
895
  * console.log('recordTask fail', error.errorMsg);
1186
896
  * },
1187
- * });`
897
+ * });
1188
898
  * ```
1189
- * @see https://developer.tuya.com/
1190
899
  * @platform iOS Android
1191
- * @error {10001} 内部错误
1192
- * @error {10048} 设备未在录音中
1193
900
  */
1194
901
  export function recordTask(params: {
1195
902
  /**
@@ -1225,12 +932,11 @@ declare namespace ty.wear {
1225
932
 
1226
933
  /**
1227
934
  * 查询当前设备离线文件下载状态
1228
- * @description.en Query current device offline file download status.
1229
935
  * @public
1230
936
  * @since WearKit 1.1.3
1231
- * @example 基础用法
1232
- * ```tsx
1233
- * `ty.wear.getDeviceOfflineFileStatus({
937
+ * @example Demo
938
+ * ```jsx
939
+ * ty.wear.getDeviceOfflineFileStatus({
1234
940
  * deviceId: 'deviceId',
1235
941
  * success: (data) => {
1236
942
  * console.log('getDeviceOfflineFileStatus success', data);
@@ -1238,13 +944,9 @@ declare namespace ty.wear {
1238
944
  * fail: (error) => {
1239
945
  * console.log('getDeviceOfflineFileStatus fail', error.errorMsg);
1240
946
  * },
1241
- * });`
947
+ * });
1242
948
  * ```
1243
- * @see https://developer.tuya.com/
1244
949
  * @platform iOS Android
1245
- * @error {10001} 内部错误
1246
- * @error {10061} 设备错误
1247
- * @error {10083} 设备离线
1248
950
  */
1249
951
  export function getDeviceOfflineFileStatus(params: {
1250
952
  /**
@@ -1300,12 +1002,11 @@ declare namespace ty.wear {
1300
1002
 
1301
1003
  /**
1302
1004
  * 下载离线文件
1303
- * @description.en Download offline file.
1304
1005
  * @public
1305
1006
  * @since WearKit 1.1.3
1306
- * @example 基础用法
1307
- * ```tsx
1308
- * `ty.wear.loadOfflineFile({
1007
+ * @example Demo
1008
+ * ```jsx
1009
+ * ty.wear.loadOfflineFile({
1309
1010
  * deviceId: 'device123',
1310
1011
  * channel: 1,
1311
1012
  * sessionId: 0,
@@ -1315,24 +1016,9 @@ declare namespace ty.wear {
1315
1016
  * fail: (error) => {
1316
1017
  * console.log('loadOfflineFile fail', error.errorMsg);
1317
1018
  * },
1318
- * });`
1019
+ * });
1319
1020
  * ```
1320
- * @see https://developer.tuya.com/
1321
- * @platform iOS Android
1322
- * @error {10001} 内部错误
1323
- * @error {10090} 获取离线文件列表失败
1324
- * @error {10091} 开启热点失败
1325
- * @error {10092} 连接热点失败
1326
- * @error {10093} 获取热点路由失败
1327
- * @error {10094} WiFi权限未开启
1328
- * @error {10095} 传输速率异常(连续10s速度为0)
1329
- * @error {10096} WiFi热点连接已断开
1330
- * @error {10300} 热点被其他设备连接
1331
- * @error {10301} 检查WiFi权限/局域网/网络
1332
- * @error {10302} VPN开启或AP通道被占用
1333
- * @error {10303} AP连接超时, 请重启设备
1334
- * @error {10304} App进入后台无法连接
1335
- * @error {10305} 授权异常
1021
+ * @platform iOS Android
1336
1022
  */
1337
1023
  export function loadOfflineFile(params: {
1338
1024
  /**
@@ -1372,12 +1058,11 @@ declare namespace ty.wear {
1372
1058
 
1373
1059
  /**
1374
1060
  * 切换到ap/ble模式传输 channel 1:ble 2:ap
1375
- * @description.en Switch to AP/BLE mode for transfer.
1376
1061
  * @public
1377
1062
  * @since WearKit 1.9.1
1378
- * @example 基础用法
1379
- * ```tsx
1380
- * `ty.wear.switchModeLoadOfflineFile({
1063
+ * @example Demo
1064
+ * ```jsx
1065
+ * ty.wear.switchModeLoadOfflineFile({
1381
1066
  * deviceId: 'deviceId',
1382
1067
  * channel: 1,
1383
1068
  * sessionId: 0,
@@ -1387,24 +1072,9 @@ declare namespace ty.wear {
1387
1072
  * fail: (error) => {
1388
1073
  * console.log('switchModeLoadOfflineFile fail', error.errorMsg);
1389
1074
  * },
1390
- * });`
1075
+ * });
1391
1076
  * ```
1392
- * @see https://developer.tuya.com/
1393
- * @platform iOS Android
1394
- * @error {10001} 内部错误
1395
- * @error {10090} 获取离线文件列表失败
1396
- * @error {10091} 开启热点失败
1397
- * @error {10092} 连接热点失败
1398
- * @error {10093} 获取热点路由失败
1399
- * @error {10094} WiFi权限未开启
1400
- * @error {10095} 传输速率异常(连续10s速度为0)
1401
- * @error {10096} WiFi热点连接已断开
1402
- * @error {10300} 热点被其他设备连接
1403
- * @error {10301} 检查WiFi权限/局域网/网络
1404
- * @error {10302} VPN开启或AP通道被占用
1405
- * @error {10303} AP连接超时, 请重启设备
1406
- * @error {10304} App进入后台无法连接
1407
- * @error {10305} 授权异常
1077
+ * @platform iOS Android
1408
1078
  */
1409
1079
  export function switchModeLoadOfflineFile(params: {
1410
1080
  /**
@@ -1444,12 +1114,11 @@ declare namespace ty.wear {
1444
1114
 
1445
1115
  /**
1446
1116
  * 添加文件
1447
- * @description.en Add file.
1448
1117
  * @public
1449
1118
  * @since WearKit 1.0.0
1450
- * @example 基础用法
1451
- * ```tsx
1452
- * `ty.wear.addFile({
1119
+ * @example Demo
1120
+ * ```jsx
1121
+ * ty.wear.addFile({
1453
1122
  * deviceUniqueId: 'unique-id-001',
1454
1123
  * name: 'my-record',
1455
1124
  * recordTime: 1713000000000,
@@ -1465,13 +1134,9 @@ declare namespace ty.wear {
1465
1134
  * fail: (error) => {
1466
1135
  * console.log('addFile fail', error.errorMsg);
1467
1136
  * },
1468
- * });`
1137
+ * });
1469
1138
  * ```
1470
- * @see https://developer.tuya.com/
1471
1139
  * @platform iOS Android
1472
- * @error {10001} 内部错误
1473
- * @error {10031} 创建目录失败
1474
- * @error {10032} 创建文件失败
1475
1140
  */
1476
1141
  export function addFile(params: {
1477
1142
  /**
@@ -1556,12 +1221,11 @@ declare namespace ty.wear {
1556
1221
 
1557
1222
  /**
1558
1223
  * 更新文件
1559
- * @description.en Update file.
1560
1224
  * @public
1561
1225
  * @since WearKit 1.0.0
1562
- * @example 基础用法
1563
- * ```tsx
1564
- * `ty.wear.updateFile({
1226
+ * @example Demo
1227
+ * ```jsx
1228
+ * ty.wear.updateFile({
1565
1229
  * fileId: 1001,
1566
1230
  * name: 'updated-name',
1567
1231
  * fileName: 'updated.m4a',
@@ -1571,12 +1235,9 @@ declare namespace ty.wear {
1571
1235
  * fail: (error) => {
1572
1236
  * console.log('updateFile fail', error.errorMsg);
1573
1237
  * },
1574
- * });`
1238
+ * });
1575
1239
  * ```
1576
- * @see https://developer.tuya.com/
1577
1240
  * @platform iOS Android
1578
- * @error {10001} 内部错误
1579
- * @error {10012} 记录不存在
1580
1241
  */
1581
1242
  export function updateFile(params: {
1582
1243
  /**
@@ -1656,12 +1317,11 @@ declare namespace ty.wear {
1656
1317
 
1657
1318
  /**
1658
1319
  * 批量更新文件transfer状态
1659
- * @description.en Batch update file transfer status.
1660
1320
  * @public
1661
1321
  * @since WearKit 1.0.0
1662
- * @example 基础用法
1663
- * ```tsx
1664
- * `ty.wear.batchUpdateTransfer({
1322
+ * @example Demo
1323
+ * ```jsx
1324
+ * ty.wear.batchUpdateTransfer({
1665
1325
  * files: [
1666
1326
  * { fileId: 1001, transfer: 1 },
1667
1327
  * { fileId: 1002, transfer: 0 },
@@ -1672,11 +1332,9 @@ declare namespace ty.wear {
1672
1332
  * fail: (error) => {
1673
1333
  * console.log('batchUpdateTransfer fail', error.errorMsg);
1674
1334
  * },
1675
- * });`
1335
+ * });
1676
1336
  * ```
1677
- * @see https://developer.tuya.com/
1678
1337
  * @platform iOS Android
1679
- * @error {10001} 内部错误
1680
1338
  */
1681
1339
  export function batchUpdateTransfer(params: {
1682
1340
  /**
@@ -1706,12 +1364,11 @@ declare namespace ty.wear {
1706
1364
 
1707
1365
  /**
1708
1366
  * 删除文件
1709
- * @description.en Remove file.
1710
1367
  * @public
1711
1368
  * @since WearKit 1.0.0
1712
- * @example 基础用法
1713
- * ```tsx
1714
- * `ty.wear.removeFile({
1369
+ * @example Demo
1370
+ * ```jsx
1371
+ * ty.wear.removeFile({
1715
1372
  * fileId: 1001,
1716
1373
  * isDeleteAll: false,
1717
1374
  * success: () => {
@@ -1720,12 +1377,9 @@ declare namespace ty.wear {
1720
1377
  * fail: (error) => {
1721
1378
  * console.log('removeFile fail', error.errorMsg);
1722
1379
  * },
1723
- * });`
1380
+ * });
1724
1381
  * ```
1725
- * @see https://developer.tuya.com/
1726
1382
  * @platform iOS Android
1727
- * @error {10001} 内部错误
1728
- * @error {10033} 远端文件删除失败
1729
1383
  */
1730
1384
  export function removeFile(params: {
1731
1385
  /**
@@ -1760,12 +1414,11 @@ declare namespace ty.wear {
1760
1414
 
1761
1415
  /**
1762
1416
  * 删除多个文件
1763
- * @description.en Remove multiple files.
1764
1417
  * @public
1765
1418
  * @since WearKit 1.1.3
1766
- * @example 基础用法
1767
- * ```tsx
1768
- * `ty.wear.removeFileList({
1419
+ * @example Demo
1420
+ * ```jsx
1421
+ * ty.wear.removeFileList({
1769
1422
  * fileIds: [1001, 1002],
1770
1423
  * isDeleteAll: false,
1771
1424
  * success: () => {
@@ -1774,12 +1427,9 @@ declare namespace ty.wear {
1774
1427
  * fail: (error) => {
1775
1428
  * console.log('removeFileList fail', error.errorMsg);
1776
1429
  * },
1777
- * });`
1430
+ * });
1778
1431
  * ```
1779
- * @see https://developer.tuya.com/
1780
1432
  * @platform iOS Android
1781
- * @error {10001} 内部错误
1782
- * @error {10033} 远端文件删除失败
1783
1433
  */
1784
1434
  export function removeFileList(params: {
1785
1435
  /**
@@ -1814,12 +1464,11 @@ declare namespace ty.wear {
1814
1464
 
1815
1465
  /**
1816
1466
  * 获取文件列表
1817
- * @description.en Get file list.
1818
1467
  * @public
1819
1468
  * @since WearKit 1.0.0
1820
- * @example 基础用法
1821
- * ```tsx
1822
- * `ty.wear.files({
1469
+ * @example Demo
1470
+ * ```jsx
1471
+ * ty.wear.files({
1823
1472
  * directoryId: 'dir1',
1824
1473
  * recordType: '1',
1825
1474
  * deviceId: 'device123',
@@ -1830,11 +1479,9 @@ declare namespace ty.wear {
1830
1479
  * fail: (error) => {
1831
1480
  * console.log('files fail', error.errorMsg);
1832
1481
  * },
1833
- * });`
1482
+ * });
1834
1483
  * ```
1835
- * @see https://developer.tuya.com/
1836
1484
  * @platform iOS Android
1837
- * @error {10001} 内部错误
1838
1485
  */
1839
1486
  export function files(params?: {
1840
1487
  /**
@@ -1909,12 +1556,11 @@ declare namespace ty.wear {
1909
1556
 
1910
1557
  /**
1911
1558
  * 获取文件数量
1912
- * @description.en Get file count.
1913
1559
  * @public
1914
1560
  * @since WearKit 1.0.0
1915
- * @example 基础用法
1916
- * ```tsx
1917
- * `ty.wear.countFiles({
1561
+ * @example Demo
1562
+ * ```jsx
1563
+ * ty.wear.countFiles({
1918
1564
  * directoryId: 'dir1',
1919
1565
  * recordType: '1',
1920
1566
  * source: '1',
@@ -1925,11 +1571,9 @@ declare namespace ty.wear {
1925
1571
  * fail: (error) => {
1926
1572
  * console.log('countFiles fail', error.errorMsg);
1927
1573
  * },
1928
- * });`
1574
+ * });
1929
1575
  * ```
1930
- * @see https://developer.tuya.com/
1931
1576
  * @platform iOS Android
1932
- * @error {10001} 内部错误
1933
1577
  */
1934
1578
  export function countFiles(params?: {
1935
1579
  /**
@@ -1985,12 +1629,11 @@ declare namespace ty.wear {
1985
1629
 
1986
1630
  /**
1987
1631
  * 获取文件详情
1988
- * @description.en Get file details.
1989
1632
  * @public
1990
1633
  * @since WearKit 1.0.0
1991
- * @example 基础用法
1992
- * ```tsx
1993
- * `ty.wear.file({
1634
+ * @example Demo
1635
+ * ```jsx
1636
+ * ty.wear.file({
1994
1637
  * fileId: 1001,
1995
1638
  * ext: {
1996
1639
  * amplitudeMaxCount: 100,
@@ -2001,12 +1644,9 @@ declare namespace ty.wear {
2001
1644
  * fail: (error) => {
2002
1645
  * console.log('file fail', error.errorMsg);
2003
1646
  * },
2004
- * });`
1647
+ * });
2005
1648
  * ```
2006
- * @see https://developer.tuya.com/
2007
1649
  * @platform iOS Android
2008
- * @error {10001} 内部错误
2009
- * @error {10012} 记录不存在
2010
1650
  */
2011
1651
  export function file(params: {
2012
1652
  /**
@@ -2132,12 +1772,11 @@ declare namespace ty.wear {
2132
1772
 
2133
1773
  /**
2134
1774
  * 创建目录
2135
- * @description.en Create directory.
2136
1775
  * @public
2137
1776
  * @since WearKit 1.0.0
2138
- * @example 基础用法
2139
- * ```tsx
2140
- * `ty.wear.addDirectory({
1777
+ * @example Demo
1778
+ * ```jsx
1779
+ * ty.wear.addDirectory({
2141
1780
  * name: 'My Folder',
2142
1781
  * color: '#FF0000',
2143
1782
  * icon: 'folder',
@@ -2147,12 +1786,9 @@ declare namespace ty.wear {
2147
1786
  * fail: (error) => {
2148
1787
  * console.log('addDirectory fail', error.errorMsg);
2149
1788
  * },
2150
- * });`
1789
+ * });
2151
1790
  * ```
2152
- * @see https://developer.tuya.com/
2153
1791
  * @platform iOS Android
2154
- * @error {10001} 内部错误
2155
- * @error {10031} 创建目录失败
2156
1792
  */
2157
1793
  export function addDirectory(params: {
2158
1794
  /**
@@ -2192,12 +1828,11 @@ declare namespace ty.wear {
2192
1828
 
2193
1829
  /**
2194
1830
  * 更新目录
2195
- * @description.en Update directory.
2196
1831
  * @public
2197
1832
  * @since WearKit 1.0.0
2198
- * @example 基础用法
2199
- * ```tsx
2200
- * `ty.wear.updateDirectory({
1833
+ * @example Demo
1834
+ * ```jsx
1835
+ * ty.wear.updateDirectory({
2201
1836
  * directoryId: 10,
2202
1837
  * name: 'Renamed Folder',
2203
1838
  * color: '#00FF00',
@@ -2207,11 +1842,9 @@ declare namespace ty.wear {
2207
1842
  * fail: (error) => {
2208
1843
  * console.log('updateDirectory fail', error.errorMsg);
2209
1844
  * },
2210
- * });`
1845
+ * });
2211
1846
  * ```
2212
- * @see https://developer.tuya.com/
2213
1847
  * @platform iOS Android
2214
- * @error {10001} 内部错误
2215
1848
  */
2216
1849
  export function updateDirectory(params: {
2217
1850
  /**
@@ -2256,12 +1889,11 @@ declare namespace ty.wear {
2256
1889
 
2257
1890
  /**
2258
1891
  * 删除目录
2259
- * @description.en Remove directory.
2260
1892
  * @public
2261
1893
  * @since WearKit 1.0.0
2262
- * @example 基础用法
2263
- * ```tsx
2264
- * `ty.wear.removeDirectory({
1894
+ * @example Demo
1895
+ * ```jsx
1896
+ * ty.wear.removeDirectory({
2265
1897
  * directoryId: 10,
2266
1898
  * success: () => {
2267
1899
  * console.log('removeDirectory success');
@@ -2269,11 +1901,9 @@ declare namespace ty.wear {
2269
1901
  * fail: (error) => {
2270
1902
  * console.log('removeDirectory fail', error.errorMsg);
2271
1903
  * },
2272
- * });`
1904
+ * });
2273
1905
  * ```
2274
- * @see https://developer.tuya.com/
2275
1906
  * @platform iOS Android
2276
- * @error {10001} 内部错误
2277
1907
  */
2278
1908
  export function removeDirectory(params: {
2279
1909
  /**
@@ -2303,12 +1933,11 @@ declare namespace ty.wear {
2303
1933
 
2304
1934
  /**
2305
1935
  * 目录列表
2306
- * @description.en Directory list.
2307
1936
  * @public
2308
1937
  * @since WearKit 1.0.0
2309
- * @example 基础用法
2310
- * ```tsx
2311
- * `ty.wear.directories({
1938
+ * @example Demo
1939
+ * ```jsx
1940
+ * ty.wear.directories({
2312
1941
  * orderBy: 'name',
2313
1942
  * asc: 'true',
2314
1943
  * success: (result) => {
@@ -2317,11 +1946,9 @@ declare namespace ty.wear {
2317
1946
  * fail: (error) => {
2318
1947
  * console.log('directories fail', error.errorMsg);
2319
1948
  * },
2320
- * });`
1949
+ * });
2321
1950
  * ```
2322
- * @see https://developer.tuya.com/
2323
1951
  * @platform iOS Android
2324
- * @error {10001} 内部错误
2325
1952
  */
2326
1953
  export function directories(params?: {
2327
1954
  /**
@@ -2356,23 +1983,20 @@ declare namespace ty.wear {
2356
1983
 
2357
1984
  /**
2358
1985
  * 获取快速启动入口列表,返回各入口(组件/快捷图标/磁贴)的类型与添加状态
2359
- * @description.en Get quick entry list.
2360
1986
  * @public
2361
1987
  * @since WearKit 2.1.0
2362
- * @example 基础用法
2363
- * ```tsx
2364
- * `ty.wear.getQuickEntryList({
1988
+ * @example Demo
1989
+ * ```jsx
1990
+ * ty.wear.getQuickEntryList({
2365
1991
  * success: (result) => {
2366
1992
  * console.log('getQuickEntryList success', result);
2367
1993
  * },
2368
1994
  * fail: (error) => {
2369
1995
  * console.log('getQuickEntryList fail', error.errorMsg);
2370
1996
  * },
2371
- * });`
1997
+ * });
2372
1998
  * ```
2373
- * @see https://developer.tuya.com/
2374
1999
  * @platform iOS Android
2375
- * @error {10001} 内部错误
2376
2000
  */
2377
2001
  export function getQuickEntryList(params?: {
2378
2002
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -2397,12 +2021,11 @@ declare namespace ty.wear {
2397
2021
 
2398
2022
  /**
2399
2023
  * 根据类型、组件 ID 开启或关闭快速启动入口组件
2400
- * @description.en Enable or disable quick entry component by type and component ID.
2401
2024
  * @public
2402
2025
  * @since WearKit 2.1.0
2403
- * @example 基础用法
2404
- * ```tsx
2405
- * `ty.wear.setQuickEntryEnabled({
2026
+ * @example Demo
2027
+ * ```jsx
2028
+ * ty.wear.setQuickEntryEnabled({
2406
2029
  * type: 0,
2407
2030
  * componentId: 0,
2408
2031
  * enabled: 1,
@@ -2412,11 +2035,9 @@ declare namespace ty.wear {
2412
2035
  * fail: (error) => {
2413
2036
  * console.log('setQuickEntryEnabled fail', error.errorMsg);
2414
2037
  * },
2415
- * });`
2038
+ * });
2416
2039
  * ```
2417
- * @see https://developer.tuya.com/
2418
2040
  * @platform iOS Android
2419
- * @error {10001} 内部错误
2420
2041
  */
2421
2042
  export function setQuickEntryEnabled(params: {
2422
2043
  /**
@@ -2456,12 +2077,11 @@ declare namespace ty.wear {
2456
2077
 
2457
2078
  /**
2458
2079
  * 转写文件
2459
- * @description.en Transcribe file.
2460
2080
  * @public
2461
2081
  * @since WearKit 1.0.0
2462
- * @example 基础用法
2463
- * ```tsx
2464
- * `ty.wear.transfer({
2082
+ * @example Demo
2083
+ * ```jsx
2084
+ * ty.wear.transfer({
2465
2085
  * fileId: 0,
2466
2086
  * template: 'default',
2467
2087
  * language: 'zh',
@@ -2471,13 +2091,9 @@ declare namespace ty.wear {
2471
2091
  * fail: (error) => {
2472
2092
  * console.log('transfer fail', error.errorMsg);
2473
2093
  * },
2474
- * });`
2094
+ * });
2475
2095
  * ```
2476
- * @see https://developer.tuya.com/
2477
2096
  * @platform iOS Android
2478
- * @error {10001} 内部错误
2479
- * @error {10011} 网络错误
2480
- * @error {10012} 记录不存在
2481
2097
  */
2482
2098
  export function transfer(params: {
2483
2099
  /**
@@ -2517,12 +2133,11 @@ declare namespace ty.wear {
2517
2133
 
2518
2134
  /**
2519
2135
  * 开始录音转写
2520
- * @description.en Start recording with transcription.
2521
2136
  * @public
2522
2137
  * @since WearKit 1.0.0
2523
- * @example 基础用法
2524
- * ```tsx
2525
- * `ty.wear.startRecordTransfer({
2138
+ * @example Demo
2139
+ * ```jsx
2140
+ * ty.wear.startRecordTransfer({
2526
2141
  * deviceId: 'dev',
2527
2142
  * config: {
2528
2143
  * recordType: 0,
@@ -2542,26 +2157,9 @@ declare namespace ty.wear {
2542
2157
  * fail: (error) => {
2543
2158
  * console.log('startRecordTransfer fail', error.errorMsg);
2544
2159
  * },
2545
- * });`
2160
+ * });
2546
2161
  * ```
2547
- * @see https://developer.tuya.com/
2548
- * @platform iOS Android
2549
- * @error {10001} 内部错误
2550
- * @error {10002} 设备PID未关联Agent
2551
- * @error {10021} 超时
2552
- * @error {10041} 操作错误
2553
- * @error {10042} 已处于开始状态
2554
- * @error {10046} 已在请求中
2555
- * @error {10047} 设备已在录音中
2556
- * @error {10061} 设备错误
2557
- * @error {10062} 设备不支持录音控制dpCode
2558
- * @error {10063} DP值错误
2559
- * @error {10064} 设备未全部连接
2560
- * @error {10071} 音频格式错误
2561
- * @error {10073} 音频引擎初始化失败
2562
- * @error {10081} 需要付费
2563
- * @error {10082} 蓝牙连接错误
2564
- * @error {10083} 设备离线
2162
+ * @platform iOS Android
2565
2163
  */
2566
2164
  export function startRecordTransfer(params: {
2567
2165
  /**
@@ -2596,12 +2194,11 @@ declare namespace ty.wear {
2596
2194
 
2597
2195
  /**
2598
2196
  * 开始录音转写(新),支持输入源与业务模式参数
2599
- * @description.en Start recording with transcription (new), supports input source and business mode parameters.
2600
2197
  * @public
2601
2198
  * @since WearKit 1.3.0
2602
- * @example 基础用法
2603
- * ```tsx
2604
- * `ty.wear.startAudioRecording({
2199
+ * @example Demo
2200
+ * ```jsx
2201
+ * ty.wear.startAudioRecording({
2605
2202
  * deviceId: 'dev',
2606
2203
  * config: {
2607
2204
  * businessType: 0,
@@ -2624,26 +2221,9 @@ declare namespace ty.wear {
2624
2221
  * fail: (error) => {
2625
2222
  * console.log('startAudioRecording fail', error.errorMsg);
2626
2223
  * },
2627
- * });`
2224
+ * });
2628
2225
  * ```
2629
- * @see https://developer.tuya.com/
2630
- * @platform iOS Android
2631
- * @error {10001} 内部错误
2632
- * @error {10002} 设备PID未关联Agent
2633
- * @error {10021} 超时
2634
- * @error {10041} 操作错误
2635
- * @error {10042} 已处于开始状态
2636
- * @error {10046} 已在请求中
2637
- * @error {10047} 设备已在录音中
2638
- * @error {10061} 设备错误
2639
- * @error {10062} 设备不支持录音控制dpCode
2640
- * @error {10063} DP值错误
2641
- * @error {10064} 设备未全部连接
2642
- * @error {10071} 音频格式错误
2643
- * @error {10073} 音频引擎初始化失败
2644
- * @error {10081} 需要付费
2645
- * @error {10082} 蓝牙连接错误
2646
- * @error {10083} 设备离线
2226
+ * @platform iOS Android
2647
2227
  */
2648
2228
  export function startAudioRecording(params: {
2649
2229
  /**
@@ -2684,12 +2264,11 @@ declare namespace ty.wear {
2684
2264
 
2685
2265
  /**
2686
2266
  * 更新录音中的参数,支持模式切换与语言动态切换
2687
- * @description.en Update recording parameters, supports mode switching and dynamic language switching.
2688
2267
  * @public
2689
2268
  * @since WearKit 1.3.0
2690
- * @example 基础用法
2691
- * ```tsx
2692
- * `ty.wear.updateParams({
2269
+ * @example Demo
2270
+ * ```jsx
2271
+ * ty.wear.updateParams({
2693
2272
  * deviceId: 'dev',
2694
2273
  * config: {
2695
2274
  * businessType: 0,
@@ -2712,13 +2291,9 @@ declare namespace ty.wear {
2712
2291
  * fail: (error) => {
2713
2292
  * console.log('updateParams fail', error.errorMsg);
2714
2293
  * },
2715
- * });`
2294
+ * });
2716
2295
  * ```
2717
- * @see https://developer.tuya.com/
2718
2296
  * @platform iOS Android
2719
- * @error {10001} 内部错误
2720
- * @error {10041} 操作错误
2721
- * @error {10048} 设备未在录音中
2722
2297
  */
2723
2298
  export function updateParams(params: {
2724
2299
  /**
@@ -2753,12 +2328,11 @@ declare namespace ty.wear {
2753
2328
 
2754
2329
  /**
2755
2330
  * 暂停录音转写
2756
- * @description.en Pause recording with transcription.
2757
2331
  * @public
2758
2332
  * @since WearKit 1.0.0
2759
- * @example 基础用法
2760
- * ```tsx
2761
- * `ty.wear.pauseRecordTransfer({
2333
+ * @example Demo
2334
+ * ```jsx
2335
+ * ty.wear.pauseRecordTransfer({
2762
2336
  * deviceId: 'dev',
2763
2337
  * success: () => {
2764
2338
  * console.log('pauseRecordTransfer success');
@@ -2766,15 +2340,9 @@ declare namespace ty.wear {
2766
2340
  * fail: (error) => {
2767
2341
  * console.log('pauseRecordTransfer fail', error.errorMsg);
2768
2342
  * },
2769
- * });`
2343
+ * });
2770
2344
  * ```
2771
- * @see https://developer.tuya.com/
2772
2345
  * @platform iOS Android
2773
- * @error {10001} 内部错误
2774
- * @error {10041} 操作错误
2775
- * @error {10043} 已处于暂停状态
2776
- * @error {10048} 设备未在录音中
2777
- * @error {10061} 设备错误
2778
2346
  */
2779
2347
  export function pauseRecordTransfer(params: {
2780
2348
  /**
@@ -2804,12 +2372,11 @@ declare namespace ty.wear {
2804
2372
 
2805
2373
  /**
2806
2374
  * 恢复录音转写
2807
- * @description.en Resume recording with transcription.
2808
2375
  * @public
2809
2376
  * @since WearKit 1.0.0
2810
- * @example 基础用法
2811
- * ```tsx
2812
- * `ty.wear.resumeRecordTransfer({
2377
+ * @example Demo
2378
+ * ```jsx
2379
+ * ty.wear.resumeRecordTransfer({
2813
2380
  * deviceId: 'dev',
2814
2381
  * success: () => {
2815
2382
  * console.log('resumeRecordTransfer success');
@@ -2817,15 +2384,9 @@ declare namespace ty.wear {
2817
2384
  * fail: (error) => {
2818
2385
  * console.log('resumeRecordTransfer fail', error.errorMsg);
2819
2386
  * },
2820
- * });`
2387
+ * });
2821
2388
  * ```
2822
- * @see https://developer.tuya.com/
2823
2389
  * @platform iOS Android
2824
- * @error {10001} 内部错误
2825
- * @error {10041} 操作错误
2826
- * @error {10044} 已处于恢复状态
2827
- * @error {10049} 录音未在暂停状态
2828
- * @error {10061} 设备错误
2829
2390
  */
2830
2391
  export function resumeRecordTransfer(params: {
2831
2392
  /**
@@ -2855,12 +2416,11 @@ declare namespace ty.wear {
2855
2416
 
2856
2417
  /**
2857
2418
  * 停止录音转写
2858
- * @description.en Stop recording with transcription.
2859
2419
  * @public
2860
2420
  * @since WearKit 1.0.0
2861
- * @example 基础用法
2862
- * ```tsx
2863
- * `ty.wear.stopRecordTransfer({
2421
+ * @example Demo
2422
+ * ```jsx
2423
+ * ty.wear.stopRecordTransfer({
2864
2424
  * deviceId: 'dev',
2865
2425
  * success: () => {
2866
2426
  * console.log('stopRecordTransfer success');
@@ -2868,15 +2428,9 @@ declare namespace ty.wear {
2868
2428
  * fail: (error) => {
2869
2429
  * console.log('stopRecordTransfer fail', error.errorMsg);
2870
2430
  * },
2871
- * });`
2431
+ * });
2872
2432
  * ```
2873
- * @see https://developer.tuya.com/
2874
2433
  * @platform iOS Android
2875
- * @error {10001} 内部错误
2876
- * @error {10041} 操作错误
2877
- * @error {10045} 已处于停止状态
2878
- * @error {10048} 设备未在录音中
2879
- * @error {10061} 设备错误
2880
2434
  */
2881
2435
  export function stopRecordTransfer(params: {
2882
2436
  /**
@@ -2906,12 +2460,11 @@ declare namespace ty.wear {
2906
2460
 
2907
2461
  /**
2908
2462
  * 获取录音转写任务
2909
- * @description.en Get recording transcription task.
2910
2463
  * @public
2911
2464
  * @since WearKit 1.0.0
2912
- * @example 基础用法
2913
- * ```tsx
2914
- * `ty.wear.recordTransferTask({
2465
+ * @example Demo
2466
+ * ```jsx
2467
+ * ty.wear.recordTransferTask({
2915
2468
  * deviceId: 'dev',
2916
2469
  * success: (result) => {
2917
2470
  * console.log('recordTransferTask success', result.task);
@@ -2919,12 +2472,9 @@ declare namespace ty.wear {
2919
2472
  * fail: (error) => {
2920
2473
  * console.log('recordTransferTask fail', error.errorMsg);
2921
2474
  * },
2922
- * });`
2475
+ * });
2923
2476
  * ```
2924
- * @see https://developer.tuya.com/
2925
2477
  * @platform iOS Android
2926
- * @error {10001} 内部错误
2927
- * @error {10048} 设备未在录音中
2928
2478
  */
2929
2479
  export function recordTransferTask(params: {
2930
2480
  /**
@@ -2960,12 +2510,11 @@ declare namespace ty.wear {
2960
2510
 
2961
2511
  /**
2962
2512
  * 获取实时转写数据
2963
- * @description.en Get real-time transcription data.
2964
2513
  * @public
2965
2514
  * @since WearKit 1.0.0
2966
- * @example 基础用法
2967
- * ```tsx
2968
- * `ty.wear.getRecordTransferRealTimeResult({
2515
+ * @example Demo
2516
+ * ```jsx
2517
+ * ty.wear.getRecordTransferRealTimeResult({
2969
2518
  * recordId: 'record123',
2970
2519
  * asrId: '100',
2971
2520
  * success: (result) => {
@@ -2974,11 +2523,9 @@ declare namespace ty.wear {
2974
2523
  * fail: (error) => {
2975
2524
  * console.log('getRecordTransferRealTimeResult fail', error.errorMsg);
2976
2525
  * },
2977
- * });`
2526
+ * });
2978
2527
  * ```
2979
- * @see https://developer.tuya.com/
2980
2528
  * @platform iOS Android
2981
- * @error {10001} 内部错误
2982
2529
  */
2983
2530
  export function getRecordTransferRealTimeResult(params?: {
2984
2531
  /**
@@ -3024,12 +2571,11 @@ declare namespace ty.wear {
3024
2571
 
3025
2572
  /**
3026
2573
  * 获取总结模版
3027
- * @description.en Get summary template.
3028
2574
  * @public
3029
2575
  * @since WearKit 1.0.0
3030
- * @example 基础用法
3031
- * ```tsx
3032
- * `ty.wear.getRecordTransferTemplate({
2576
+ * @example Demo
2577
+ * ```jsx
2578
+ * ty.wear.getRecordTransferTemplate({
3033
2579
  * deviceId: 'device123',
3034
2580
  * bizType: 'note',
3035
2581
  * success: (result) => {
@@ -3038,12 +2584,9 @@ declare namespace ty.wear {
3038
2584
  * fail: (error) => {
3039
2585
  * console.log('getRecordTransferTemplate fail', error.errorMsg);
3040
2586
  * },
3041
- * });`
2587
+ * });
3042
2588
  * ```
3043
- * @see https://developer.tuya.com/
3044
2589
  * @platform iOS Android
3045
- * @error {10001} 内部错误
3046
- * @error {10011} 网络错误
3047
2590
  */
3048
2591
  export function getRecordTransferTemplate(params: {
3049
2592
  /**
@@ -3084,12 +2627,11 @@ declare namespace ty.wear {
3084
2627
 
3085
2628
  /**
3086
2629
  * 对录音转写记录进行转写操作
3087
- * @description.en Process recording transcription result.
3088
2630
  * @public
3089
2631
  * @since WearKit 1.0.0
3090
- * @example 基础用法
3091
- * ```tsx
3092
- * `ty.wear.processRecordTransferResult({
2632
+ * @example Demo
2633
+ * ```jsx
2634
+ * ty.wear.processRecordTransferResult({
3093
2635
  * recordTransferId: 1001,
3094
2636
  * template: 'templateStr',
3095
2637
  * language: 'zh',
@@ -3103,13 +2645,9 @@ declare namespace ty.wear {
3103
2645
  * fail: (error) => {
3104
2646
  * console.log('processRecordTransferResult fail', error.errorMsg);
3105
2647
  * },
3106
- * });`
2648
+ * });
3107
2649
  * ```
3108
- * @see https://developer.tuya.com/
3109
2650
  * @platform iOS Android
3110
- * @error {10001} 内部错误
3111
- * @error {10011} 网络错误
3112
- * @error {10012} 记录不存在
3113
2651
  */
3114
2652
  export function processRecordTransferResult(params: {
3115
2653
  /**
@@ -3169,12 +2707,11 @@ declare namespace ty.wear {
3169
2707
 
3170
2708
  /**
3171
2709
  * 转写状态查询
3172
- * @description.en Transcription status query.
3173
2710
  * @public
3174
2711
  * @since WearKit 1.0.0
3175
- * @example 基础用法
3176
- * ```tsx
3177
- * `ty.wear.getRecordTransferProcessStatus({
2712
+ * @example Demo
2713
+ * ```jsx
2714
+ * ty.wear.getRecordTransferProcessStatus({
3178
2715
  * deviceId: 'device123',
3179
2716
  * fileIds: ['file1', 'file2'],
3180
2717
  * taskType: 1,
@@ -3184,11 +2721,9 @@ declare namespace ty.wear {
3184
2721
  * fail: (error) => {
3185
2722
  * console.log('getRecordTransferProcessStatus fail', error.errorMsg);
3186
2723
  * },
3187
- * });`
2724
+ * });
3188
2725
  * ```
3189
- * @see https://developer.tuya.com/
3190
2726
  * @platform iOS Android
3191
- * @error {10001} 内部错误
3192
2727
  */
3193
2728
  export function getRecordTransferProcessStatus(params: {
3194
2729
  /**
@@ -3259,12 +2794,11 @@ declare namespace ty.wear {
3259
2794
 
3260
2795
  /**
3261
2796
  * 转写结果查询
3262
- * @description.en Query transcription results.
3263
2797
  * @public
3264
2798
  * @since WearKit 1.0.0
3265
- * @example 基础用法
3266
- * ```tsx
3267
- * `ty.wear.getRecordTransferRecognizeResult({
2799
+ * @example Demo
2800
+ * ```jsx
2801
+ * ty.wear.getRecordTransferRecognizeResult({
3268
2802
  * recordTransferId: 1001,
3269
2803
  * from: 0,
3270
2804
  * success: (result) => {
@@ -3273,12 +2807,9 @@ declare namespace ty.wear {
3273
2807
  * fail: (error) => {
3274
2808
  * console.log('getRecordTransferRecognizeResult fail', error.errorMsg);
3275
2809
  * },
3276
- * });`
2810
+ * });
3277
2811
  * ```
3278
- * @see https://developer.tuya.com/
3279
2812
  * @platform iOS Android
3280
- * @error {10001} 内部错误
3281
- * @error {10012} 记录不存在
3282
2813
  */
3283
2814
  export function getRecordTransferRecognizeResult(params: {
3284
2815
  /**
@@ -3319,12 +2850,11 @@ declare namespace ty.wear {
3319
2850
 
3320
2851
  /**
3321
2852
  * 转写总结查询
3322
- * @description.en Query transcription summary.
3323
2853
  * @public
3324
2854
  * @since WearKit 1.0.0
3325
- * @example 基础用法
3326
- * ```tsx
3327
- * `ty.wear.getRecordTransferSummaryResult({
2855
+ * @example Demo
2856
+ * ```jsx
2857
+ * ty.wear.getRecordTransferSummaryResult({
3328
2858
  * recordTransferId: 1001,
3329
2859
  * from: 0,
3330
2860
  * success: (result) => {
@@ -3333,12 +2863,9 @@ declare namespace ty.wear {
3333
2863
  * fail: (error) => {
3334
2864
  * console.log('getRecordTransferSummaryResult fail', error.errorMsg);
3335
2865
  * },
3336
- * });`
2866
+ * });
3337
2867
  * ```
3338
- * @see https://developer.tuya.com/
3339
2868
  * @platform iOS Android
3340
- * @error {10001} 内部错误
3341
- * @error {10012} 记录不存在
3342
2869
  */
3343
2870
  export function getRecordTransferSummaryResult(params: {
3344
2871
  /**
@@ -3379,12 +2906,11 @@ declare namespace ty.wear {
3379
2906
 
3380
2907
  /**
3381
2908
  * 保存转写结果
3382
- * @description.en Save transcription result.
3383
2909
  * @public
3384
2910
  * @since WearKit 1.0.0
3385
- * @example 基础用法
3386
- * ```tsx
3387
- * `ty.wear.saveRecordTransferRecognizeResult({
2911
+ * @example Demo
2912
+ * ```jsx
2913
+ * ty.wear.saveRecordTransferRecognizeResult({
3388
2914
  * recordTransferId: 1001,
3389
2915
  * text: 'recognized text',
3390
2916
  * success: () => {
@@ -3393,11 +2919,9 @@ declare namespace ty.wear {
3393
2919
  * fail: (error) => {
3394
2920
  * console.log('saveRecordTransferRecognizeResult fail', error.errorMsg);
3395
2921
  * },
3396
- * });`
2922
+ * });
3397
2923
  * ```
3398
- * @see https://developer.tuya.com/
3399
2924
  * @platform iOS Android
3400
- * @error {10001} 内部错误
3401
2925
  */
3402
2926
  export function saveRecordTransferRecognizeResult(params: {
3403
2927
  /**
@@ -3432,12 +2956,11 @@ declare namespace ty.wear {
3432
2956
 
3433
2957
  /**
3434
2958
  * 保存总结结果
3435
- * @description.en Save summary result.
3436
2959
  * @public
3437
2960
  * @since WearKit 1.0.0
3438
- * @example 基础用法
3439
- * ```tsx
3440
- * `ty.wear.saveRecordTransferSummaryResult({
2961
+ * @example Demo
2962
+ * ```jsx
2963
+ * ty.wear.saveRecordTransferSummaryResult({
3441
2964
  * recordTransferId: 1001,
3442
2965
  * text: 'summary text',
3443
2966
  * success: () => {
@@ -3446,11 +2969,9 @@ declare namespace ty.wear {
3446
2969
  * fail: (error) => {
3447
2970
  * console.log('saveRecordTransferSummaryResult fail', error.errorMsg);
3448
2971
  * },
3449
- * });`
2972
+ * });
3450
2973
  * ```
3451
- * @see https://developer.tuya.com/
3452
2974
  * @platform iOS Android
3453
- * @error {10001} 内部错误
3454
2975
  */
3455
2976
  export function saveRecordTransferSummaryResult(params: {
3456
2977
  /**
@@ -3485,12 +3006,11 @@ declare namespace ty.wear {
3485
3006
 
3486
3007
  /**
3487
3008
  * 更新实时转写结果
3488
- * @description.en Update real-time transcription result.
3489
3009
  * @public
3490
3010
  * @since WearKit 1.0.0
3491
- * @example 基础用法
3492
- * ```tsx
3493
- * `ty.wear.saveRecordTransferRealTimeRecognizeResult({
3011
+ * @example Demo
3012
+ * ```jsx
3013
+ * ty.wear.saveRecordTransferRealTimeRecognizeResult({
3494
3014
  * asrId: 2001,
3495
3015
  * text: 'partial text',
3496
3016
  * success: () => {
@@ -3499,11 +3019,9 @@ declare namespace ty.wear {
3499
3019
  * fail: (error) => {
3500
3020
  * console.log('saveRecordTransferRealTimeRecognizeResult fail', error.errorMsg);
3501
3021
  * },
3502
- * });`
3022
+ * });
3503
3023
  * ```
3504
- * @see https://developer.tuya.com/
3505
3024
  * @platform iOS Android
3506
- * @error {10001} 内部错误
3507
3025
  */
3508
3026
  export function saveRecordTransferRealTimeRecognizeResult(params: {
3509
3027
  /**
@@ -3548,12 +3066,11 @@ declare namespace ty.wear {
3548
3066
 
3549
3067
  /**
3550
3068
  * 获取录音转写列表
3551
- * @description.en Get recording transcription result list.
3552
3069
  * @public
3553
3070
  * @since WearKit 1.0.0
3554
- * @example 基础用法
3555
- * ```tsx
3556
- * `ty.wear.getRecordTransferResultList({
3071
+ * @example Demo
3072
+ * ```jsx
3073
+ * ty.wear.getRecordTransferResultList({
3557
3074
  * deviceId: 'device123',
3558
3075
  * pageSize: 20,
3559
3076
  * success: (result) => {
@@ -3562,11 +3079,9 @@ declare namespace ty.wear {
3562
3079
  * fail: (error) => {
3563
3080
  * console.log('getRecordTransferResultList fail', error.errorMsg);
3564
3081
  * },
3565
- * });`
3082
+ * });
3566
3083
  * ```
3567
- * @see https://developer.tuya.com/
3568
3084
  * @platform iOS Android
3569
- * @error {10001} 内部错误
3570
3085
  */
3571
3086
  export function getRecordTransferResultList(params?: {
3572
3087
  /**
@@ -3641,12 +3156,11 @@ declare namespace ty.wear {
3641
3156
 
3642
3157
  /**
3643
3158
  * 搜索录音转写
3644
- * @description.en Search recording transcription results.
3645
3159
  * @public
3646
3160
  * @since WearKit 2.1.0
3647
- * @example 基础用法
3648
- * ```tsx
3649
- * `ty.wear.searchRecordTransferResult({
3161
+ * @example Demo
3162
+ * ```jsx
3163
+ * ty.wear.searchRecordTransferResult({
3650
3164
  * content: 'keyword',
3651
3165
  * pageNum: 1,
3652
3166
  * pageSize: 20,
@@ -3656,11 +3170,9 @@ declare namespace ty.wear {
3656
3170
  * fail: (error) => {
3657
3171
  * console.log('searchRecordTransferResult fail', error.errorMsg);
3658
3172
  * },
3659
- * });`
3173
+ * });
3660
3174
  * ```
3661
- * @see https://developer.tuya.com/
3662
3175
  * @platform iOS Android
3663
- * @error {10001} 内部错误
3664
3176
  */
3665
3177
  export function searchRecordTransferResult(params: {
3666
3178
  /**
@@ -3700,12 +3212,11 @@ declare namespace ty.wear {
3700
3212
 
3701
3213
  /**
3702
3214
  * 获取录音转写详情
3703
- * @description.en Get recording transcription result detail.
3704
3215
  * @public
3705
3216
  * @since WearKit 1.0.0
3706
- * @example 基础用法
3707
- * ```tsx
3708
- * `ty.wear.getRecordTransferResultDetail({
3217
+ * @example Demo
3218
+ * ```jsx
3219
+ * ty.wear.getRecordTransferResultDetail({
3709
3220
  * recordId: 'rec1',
3710
3221
  * success: (result) => {
3711
3222
  * console.log('getRecordTransferResultDetail success', result);
@@ -3713,12 +3224,9 @@ declare namespace ty.wear {
3713
3224
  * fail: (error) => {
3714
3225
  * console.log('getRecordTransferResultDetail fail', error.errorMsg);
3715
3226
  * },
3716
- * });`
3227
+ * });
3717
3228
  * ```
3718
- * @see https://developer.tuya.com/
3719
3229
  * @platform iOS Android
3720
- * @error {10001} 内部错误
3721
- * @error {10012} 记录不存在
3722
3230
  */
3723
3231
  export function getRecordTransferResultDetail(params?: {
3724
3232
  /**
@@ -3948,12 +3456,11 @@ declare namespace ty.wear {
3948
3456
 
3949
3457
  /**
3950
3458
  * 更新录音转写
3951
- * @description.en Update recording transcription result.
3952
3459
  * @public
3953
3460
  * @since WearKit 1.0.0
3954
- * @example 基础用法
3955
- * ```tsx
3956
- * `ty.wear.updateRecordTransferResult({
3461
+ * @example Demo
3462
+ * ```jsx
3463
+ * ty.wear.updateRecordTransferResult({
3957
3464
  * recordTransferId: 1001,
3958
3465
  * name: 'new title',
3959
3466
  * success: () => {
@@ -3962,12 +3469,9 @@ declare namespace ty.wear {
3962
3469
  * fail: (error) => {
3963
3470
  * console.log('updateRecordTransferResult fail', error.errorMsg);
3964
3471
  * },
3965
- * });`
3472
+ * });
3966
3473
  * ```
3967
- * @see https://developer.tuya.com/
3968
3474
  * @platform iOS Android
3969
- * @error {10001} 内部错误
3970
- * @error {10012} 记录不存在
3971
3475
  */
3972
3476
  export function updateRecordTransferResult(params: {
3973
3477
  /**
@@ -4052,12 +3556,11 @@ declare namespace ty.wear {
4052
3556
 
4053
3557
  /**
4054
3558
  * 删除录音转写
4055
- * @description.en Remove recording transcription result.
4056
3559
  * @public
4057
3560
  * @since WearKit 1.0.0
4058
- * @example 基础用法
4059
- * ```tsx
4060
- * `ty.wear.removeRecordTransferResult({
3561
+ * @example Demo
3562
+ * ```jsx
3563
+ * ty.wear.removeRecordTransferResult({
4061
3564
  * recordTransferId: 1001,
4062
3565
  * success: () => {
4063
3566
  * console.log('removeRecordTransferResult success');
@@ -4065,12 +3568,9 @@ declare namespace ty.wear {
4065
3568
  * fail: (error) => {
4066
3569
  * console.log('removeRecordTransferResult fail', error.errorMsg);
4067
3570
  * },
4068
- * });`
3571
+ * });
4069
3572
  * ```
4070
- * @see https://developer.tuya.com/
4071
3573
  * @platform iOS Android
4072
- * @error {10001} 内部错误
4073
- * @error {10033} 远端文件删除失败
4074
3574
  */
4075
3575
  export function removeRecordTransferResult(params: {
4076
3576
  /**
@@ -4100,12 +3600,11 @@ declare namespace ty.wear {
4100
3600
 
4101
3601
  /**
4102
3602
  * 更新标签
4103
- * @description.en Update tag.
4104
3603
  * @public
4105
3604
  * @since WearKit 2.1.0
4106
- * @example 基础用法
4107
- * ```tsx
4108
- * `ty.wear.updateRecordTagResult({
3605
+ * @example Demo
3606
+ * ```jsx
3607
+ * ty.wear.updateRecordTagResult({
4109
3608
  * recordId: 'rec1',
4110
3609
  * bizType: 1,
4111
3610
  * tags: ['tag1', 'tag2'],
@@ -4115,11 +3614,9 @@ declare namespace ty.wear {
4115
3614
  * fail: (error) => {
4116
3615
  * console.log('updateRecordTagResult fail', error.errorMsg);
4117
3616
  * },
4118
- * });`
3617
+ * });
4119
3618
  * ```
4120
- * @see https://developer.tuya.com/
4121
3619
  * @platform iOS Android
4122
- * @error {10001} 内部错误
4123
3620
  */
4124
3621
  export function updateRecordTagResult(params: {
4125
3622
  /**
@@ -4159,12 +3656,11 @@ declare namespace ty.wear {
4159
3656
 
4160
3657
  /**
4161
3658
  * 获取翻译记录列表
4162
- * @description.en Get translation record list.
4163
3659
  * @public
4164
3660
  * @since WearKit 1.4.0
4165
- * @example 基础用法
4166
- * ```tsx
4167
- * `ty.wear.getTranslateFileList({
3661
+ * @example Demo
3662
+ * ```jsx
3663
+ * ty.wear.getTranslateFileList({
4168
3664
  * deviceId: 'device123',
4169
3665
  * pageSize: 20,
4170
3666
  * success: (result) => {
@@ -4173,11 +3669,9 @@ declare namespace ty.wear {
4173
3669
  * fail: (error) => {
4174
3670
  * console.log('getTranslateFileList fail', error.errorMsg);
4175
3671
  * },
4176
- * });`
3672
+ * });
4177
3673
  * ```
4178
- * @see https://developer.tuya.com/
4179
3674
  * @platform iOS Android
4180
- * @error {10001} 内部错误
4181
3675
  */
4182
3676
  export function getTranslateFileList(params?: {
4183
3677
  /**
@@ -4247,12 +3741,11 @@ declare namespace ty.wear {
4247
3741
 
4248
3742
  /**
4249
3743
  * 获取翻译记录详情
4250
- * @description.en Get translation record details.
4251
3744
  * @public
4252
3745
  * @since WearKit 1.4.0
4253
- * @example 基础用法
4254
- * ```tsx
4255
- * `ty.wear.getTranslateFileDetail({
3746
+ * @example Demo
3747
+ * ```jsx
3748
+ * ty.wear.getTranslateFileDetail({
4256
3749
  * fileId: 3001,
4257
3750
  * success: (result) => {
4258
3751
  * console.log('getTranslateFileDetail success', result);
@@ -4260,12 +3753,9 @@ declare namespace ty.wear {
4260
3753
  * fail: (error) => {
4261
3754
  * console.log('getTranslateFileDetail fail', error.errorMsg);
4262
3755
  * },
4263
- * });`
3756
+ * });
4264
3757
  * ```
4265
- * @see https://developer.tuya.com/
4266
3758
  * @platform iOS Android
4267
- * @error {10001} 内部错误
4268
- * @error {10012} 记录不存在
4269
3759
  */
4270
3760
  export function getTranslateFileDetail(params: {
4271
3761
  /**
@@ -4371,12 +3861,11 @@ declare namespace ty.wear {
4371
3861
 
4372
3862
  /**
4373
3863
  * 发起翻译
4374
- * @description.en Start translation.
4375
3864
  * @public
4376
3865
  * @since WearKit 1.4.0
4377
- * @example 基础用法
4378
- * ```tsx
4379
- * `ty.wear.startTranslate({
3866
+ * @example Demo
3867
+ * ```jsx
3868
+ * ty.wear.startTranslate({
4380
3869
  * originText: 'hello',
4381
3870
  * originLanguage: 'en',
4382
3871
  * targetLanguage: 'zh',
@@ -4387,13 +3876,9 @@ declare namespace ty.wear {
4387
3876
  * fail: (error) => {
4388
3877
  * console.log('startTranslate fail', error.errorMsg);
4389
3878
  * },
4390
- * });`
3879
+ * });
4391
3880
  * ```
4392
- * @see https://developer.tuya.com/
4393
3881
  * @platform iOS Android
4394
- * @error {10001} 内部错误
4395
- * @error {10100} 翻译通用错误
4396
- * @error {10101} TTS URL错误
4397
3882
  */
4398
3883
  export function startTranslate(params: {
4399
3884
  /**
@@ -4464,12 +3949,11 @@ declare namespace ty.wear {
4464
3949
 
4465
3950
  /**
4466
3951
  * 将翻译发送到总结接口
4467
- * @description.en Send translation to summary API.
4468
3952
  * @public
4469
3953
  * @since WearKit 1.4.0
4470
- * @example 基础用法
4471
- * ```tsx
4472
- * `ty.wear.sendToNote({
3954
+ * @example Demo
3955
+ * ```jsx
3956
+ * ty.wear.sendToNote({
4473
3957
  * fileId: 'file1',
4474
3958
  * success: (result) => {
4475
3959
  * console.log('sendToNote success', result);
@@ -4477,12 +3961,9 @@ declare namespace ty.wear {
4477
3961
  * fail: (error) => {
4478
3962
  * console.log('sendToNote fail', error.errorMsg);
4479
3963
  * },
4480
- * });`
3964
+ * });
4481
3965
  * ```
4482
- * @see https://developer.tuya.com/
4483
3966
  * @platform iOS Android
4484
- * @error {10001} 内部错误
4485
- * @error {10012} 记录不存在
4486
3967
  */
4487
3968
  export function sendToNote(params?: {
4488
3969
  /**
@@ -4528,12 +4009,11 @@ declare namespace ty.wear {
4528
4009
 
4529
4010
  /**
4530
4011
  * 批量删除文件
4531
- * @description.en Batch delete files.
4532
4012
  * @public
4533
4013
  * @since WearKit 1.4.0
4534
- * @example 基础用法
4535
- * ```tsx
4536
- * `ty.wear.batchRemoveTranslationFiles({
4014
+ * @example Demo
4015
+ * ```jsx
4016
+ * ty.wear.batchRemoveTranslationFiles({
4537
4017
  * fileIds: [1001, 1002],
4538
4018
  * isDeleteAll: false,
4539
4019
  * success: () => {
@@ -4542,12 +4022,9 @@ declare namespace ty.wear {
4542
4022
  * fail: (error) => {
4543
4023
  * console.log('batchRemoveTranslationFiles fail', error.errorMsg);
4544
4024
  * },
4545
- * });`
4025
+ * });
4546
4026
  * ```
4547
- * @see https://developer.tuya.com/
4548
4027
  * @platform iOS Android
4549
- * @error {10001} 内部错误
4550
- * @error {10033} 远端文件删除失败
4551
4028
  */
4552
4029
  export function batchRemoveTranslationFiles(params: {
4553
4030
  /**
@@ -4582,23 +4059,20 @@ declare namespace ty.wear {
4582
4059
 
4583
4060
  /**
4584
4061
  * 获取云同步开关状态
4585
- * @description.en Get cloud sync switch status.
4586
4062
  * @public
4587
4063
  * @since WearKit 1.5.0
4588
- * @example 基础用法
4589
- * ```tsx
4590
- * `ty.wear.getCloudSyncSwitchStatus({
4064
+ * @example Demo
4065
+ * ```jsx
4066
+ * ty.wear.getCloudSyncSwitchStatus({
4591
4067
  * success: (result) => {
4592
4068
  * console.log('getCloudSyncSwitchStatus success', result);
4593
4069
  * },
4594
4070
  * fail: (error) => {
4595
4071
  * console.log('getCloudSyncSwitchStatus fail', error.errorMsg);
4596
4072
  * },
4597
- * });`
4073
+ * });
4598
4074
  * ```
4599
- * @see https://developer.tuya.com/
4600
4075
  * @platform iOS Android
4601
- * @error {10001} 内部错误
4602
4076
  */
4603
4077
  export function getCloudSyncSwitchStatus(params?: {
4604
4078
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -4639,38 +4113,20 @@ declare namespace ty.wear {
4639
4113
 
4640
4114
  /**
4641
4115
  * 同步上传 Note 记录(文件+音频),下载 Note 文件
4642
- * @description.en Sync upload Note records (file + audio) and download Note files.
4643
4116
  * @public
4644
4117
  * @since WearKit 1.5.0
4645
- * @example 基础用法
4646
- * ```tsx
4647
- * `ty.wear.syncNoteRecord({
4118
+ * @example Demo
4119
+ * ```jsx
4120
+ * ty.wear.syncNoteRecord({
4648
4121
  * success: () => {
4649
4122
  * console.log('syncNoteRecord success');
4650
4123
  * },
4651
4124
  * fail: (error) => {
4652
4125
  * console.log('syncNoteRecord fail', error.errorMsg);
4653
4126
  * },
4654
- * });`
4127
+ * });
4655
4128
  * ```
4656
- * @see https://developer.tuya.com/
4657
- * @platform iOS Android
4658
- * @error {10001} 内部错误
4659
- * @error {10011} 网络错误
4660
- * @error {10200} 重复上传
4661
- * @error {10201} 源文件不存在
4662
- * @error {10202} 加密文件失败
4663
- * @error {10203} 获取存储配置失败
4664
- * @error {10204} 上传错误
4665
- * @error {10205} 同步结果到服务端失败
4666
- * @error {10206} 重复下载
4667
- * @error {10207} 获取解密密钥失败
4668
- * @error {10208} 获取下载链接失败
4669
- * @error {10209} 加密文件不存在
4670
- * @error {10210} 解密文件失败
4671
- * @error {10211} 下载错误
4672
- * @error {10213} 云同步开关未开启
4673
- * @error {10214} 云同步网络类型不匹配
4129
+ * @platform iOS Android
4674
4130
  */
4675
4131
  export function syncNoteRecord(params?: {
4676
4132
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -4695,12 +4151,11 @@ declare namespace ty.wear {
4695
4151
 
4696
4152
  /**
4697
4153
  * 同步下载 Note 音频
4698
- * @description.en Sync download Note audio.
4699
4154
  * @public
4700
4155
  * @since WearKit 1.5.0
4701
- * @example 基础用法
4702
- * ```tsx
4703
- * `ty.wear.syncDownloadNoteAudio({
4156
+ * @example Demo
4157
+ * ```jsx
4158
+ * ty.wear.syncDownloadNoteAudio({
4704
4159
  * fileId: 0,
4705
4160
  * recordId: '',
4706
4161
  * success: () => {
@@ -4709,19 +4164,9 @@ declare namespace ty.wear {
4709
4164
  * fail: (error) => {
4710
4165
  * console.log('syncDownloadNoteAudio fail', error.errorMsg);
4711
4166
  * },
4712
- * });`
4167
+ * });
4713
4168
  * ```
4714
- * @see https://developer.tuya.com/
4715
- * @platform iOS Android
4716
- * @error {10001} 内部错误
4717
- * @error {10011} 网络错误
4718
- * @error {10206} 重复下载
4719
- * @error {10207} 获取解密密钥失败
4720
- * @error {10208} 获取下载链接失败
4721
- * @error {10209} 加密文件不存在
4722
- * @error {10210} 解密文件失败
4723
- * @error {10211} 下载错误
4724
- * @error {10212} 文件记录不存在
4169
+ * @platform iOS Android
4725
4170
  */
4726
4171
  export function syncDownloadNoteAudio(params: {
4727
4172
  /**
@@ -4756,12 +4201,11 @@ declare namespace ty.wear {
4756
4201
 
4757
4202
  /**
4758
4203
  * 事件流控制(ASR流/Note离线文件传输/振幅)
4759
- * @description.en Event stream control (ASR stream / Note offline file transfer / amplitude).
4760
4204
  * @public
4761
4205
  * @since WearKit 1.7.0
4762
- * @example 基础用法
4763
- * ```tsx
4764
- * `ty.wear.operateEventLimit({
4206
+ * @example Demo
4207
+ * ```jsx
4208
+ * ty.wear.operateEventLimit({
4765
4209
  * eventName: '',
4766
4210
  * operate: true,
4767
4211
  * success: () => {
@@ -4770,11 +4214,9 @@ declare namespace ty.wear {
4770
4214
  * fail: (error) => {
4771
4215
  * console.log('operateEventLimit fail', error.errorMsg);
4772
4216
  * },
4773
- * });`
4217
+ * });
4774
4218
  * ```
4775
- * @see https://developer.tuya.com/
4776
4219
  * @platform iOS Android
4777
- * @error {10001} 内部错误
4778
4220
  */
4779
4221
  export function operateEventLimit(params: {
4780
4222
  /**
@@ -4812,12 +4254,11 @@ declare namespace ty.wear {
4812
4254
 
4813
4255
  /**
4814
4256
  * 进入录音页,Token预申请API
4815
- * @description.en Enter recording page, token pre-request API.
4816
4257
  * @public
4817
4258
  * @since WearKit 1.7.0
4818
- * @example 基础用法
4819
- * ```tsx
4820
- * `ty.wear.tokenPreRequest({
4259
+ * @example Demo
4260
+ * ```jsx
4261
+ * ty.wear.tokenPreRequest({
4821
4262
  * startPre: true,
4822
4263
  * config: {
4823
4264
  * deviceId: '',
@@ -4834,12 +4275,9 @@ declare namespace ty.wear {
4834
4275
  * fail: (error) => {
4835
4276
  * console.log('tokenPreRequest fail', error.errorMsg);
4836
4277
  * },
4837
- * });`
4278
+ * });
4838
4279
  * ```
4839
- * @see https://developer.tuya.com/
4840
4280
  * @platform iOS Android
4841
- * @error {10001} 内部错误
4842
- * @error {10081} 需要付费
4843
4281
  */
4844
4282
  export function tokenPreRequest(params: {
4845
4283
  /**
@@ -4874,36 +4312,25 @@ declare namespace ty.wear {
4874
4312
 
4875
4313
  /**
4876
4314
  * 触发导入文件
4877
- * @description.en Trigger file import.
4315
+ * 失败回调,错误信息包含 errorCode errorMessage
4316
+ * 可能返回的错误码:
4317
+ * - 20101: 文件超过十个
4318
+ * - 20102: 文件过大
4319
+ * - 20104: 空间不足
4878
4320
  * @public
4879
4321
  * @since WearKit 1.7.0
4880
- * @example 基础用法
4881
- * ```tsx
4882
- * `ty.wear.startImport({
4322
+ * @example Demo
4323
+ * ```jsx
4324
+ * ty.wear.startImport({
4883
4325
  * success: () => {
4884
4326
  * console.log('startImport success');
4885
4327
  * },
4886
4328
  * fail: (error) => {
4887
4329
  * console.log('startImport fail', error.errorMsg);
4888
4330
  * },
4889
- * });`
4331
+ * });
4890
4332
  * ```
4891
- * @see https://developer.tuya.com/
4892
- * @platform iOS Android
4893
- * @error {20101} 导入文件数量超过上限(10个)
4894
- * @error {20102} 文件过大
4895
- * @error {20103} 文件格式异常
4896
- * @error {20104} 空间不足
4897
- * @error {20105} 文件不存在
4898
- * @error {20106} 文件属性改变
4899
- * @error {20107} 文件时长过长
4900
- * @error {20108} SDK初始化失败
4901
- * @error {20109} 开始解码音频失败
4902
- * @error {20110} 文件格式错误无法解码
4903
- * @error {20111} 解码中文件异常中断
4904
- * @error {20112} 导入任务异常中断
4905
- * @error {20113} MP3创建失败
4906
- * @error {20114} 用户取消导入
4333
+ * @platform iOS Android
4907
4334
  */
4908
4335
  export function startImport(params?: {
4909
4336
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -4928,36 +4355,25 @@ declare namespace ty.wear {
4928
4355
 
4929
4356
  /**
4930
4357
  * 重试导入
4931
- * @description.en Retry import.
4358
+ * 失败回调,错误信息包含 errorCode 和 errorMessage
4359
+ * 可能返回的错误码:
4360
+ * - 20101: 文件超过十个
4361
+ * - 20102: 文件过大
4362
+ * - 20104: 空间不足
4932
4363
  * @public
4933
4364
  * @since WearKit 1.7.0
4934
- * @example 基础用法
4935
- * ```tsx
4936
- * `ty.wear.retryImport({
4365
+ * @example Demo
4366
+ * ```jsx
4367
+ * ty.wear.retryImport({
4937
4368
  * success: () => {
4938
4369
  * console.log('retryImport success');
4939
4370
  * },
4940
4371
  * fail: (error) => {
4941
4372
  * console.log('retryImport fail', error.errorMsg);
4942
4373
  * },
4943
- * });`
4374
+ * });
4944
4375
  * ```
4945
- * @see https://developer.tuya.com/
4946
- * @platform iOS Android
4947
- * @error {20101} 导入文件数量超过上限(10个)
4948
- * @error {20102} 文件过大
4949
- * @error {20103} 文件格式异常
4950
- * @error {20104} 空间不足
4951
- * @error {20105} 文件不存在
4952
- * @error {20106} 文件属性改变
4953
- * @error {20107} 文件时长过长
4954
- * @error {20108} SDK初始化失败
4955
- * @error {20109} 开始解码音频失败
4956
- * @error {20110} 文件格式错误无法解码
4957
- * @error {20111} 解码中文件异常中断
4958
- * @error {20112} 导入任务异常中断
4959
- * @error {20113} MP3创建失败
4960
- * @error {20114} 用户取消导入
4376
+ * @platform iOS Android
4961
4377
  */
4962
4378
  export function retryImport(params?: {
4963
4379
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -4982,23 +4398,20 @@ declare namespace ty.wear {
4982
4398
 
4983
4399
  /**
4984
4400
  * 取消导入
4985
- * @description.en Cancel import.
4986
4401
  * @public
4987
4402
  * @since WearKit 1.7.0
4988
- * @example 基础用法
4989
- * ```tsx
4990
- * `ty.wear.cancelImport({
4403
+ * @example Demo
4404
+ * ```jsx
4405
+ * ty.wear.cancelImport({
4991
4406
  * success: () => {
4992
4407
  * console.log('cancelImport success');
4993
4408
  * },
4994
4409
  * fail: (error) => {
4995
4410
  * console.log('cancelImport fail', error.errorMsg);
4996
4411
  * },
4997
- * });`
4412
+ * });
4998
4413
  * ```
4999
- * @see https://developer.tuya.com/
5000
4414
  * @platform iOS Android
5001
- * @error {10001} 内部错误
5002
4415
  */
5003
4416
  export function cancelImport(params?: {
5004
4417
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -5023,23 +4436,20 @@ declare namespace ty.wear {
5023
4436
 
5024
4437
  /**
5025
4438
  * 取消重试
5026
- * @description.en Cancel retry.
5027
4439
  * @public
5028
4440
  * @since WearKit 1.7.0
5029
- * @example 基础用法
5030
- * ```tsx
5031
- * `ty.wear.cancelRetry({
4441
+ * @example Demo
4442
+ * ```jsx
4443
+ * ty.wear.cancelRetry({
5032
4444
  * success: () => {
5033
4445
  * console.log('cancelRetry success');
5034
4446
  * },
5035
4447
  * fail: (error) => {
5036
4448
  * console.log('cancelRetry fail', error.errorMsg);
5037
4449
  * },
5038
- * });`
4450
+ * });
5039
4451
  * ```
5040
- * @see https://developer.tuya.com/
5041
4452
  * @platform iOS Android
5042
- * @error {10001} 内部错误
5043
4453
  */
5044
4454
  export function cancelRetry(params?: {
5045
4455
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -5064,23 +4474,20 @@ declare namespace ty.wear {
5064
4474
 
5065
4475
  /**
5066
4476
  * 获取音频导入状态
5067
- * @description.en Get audio import status.
5068
4477
  * @public
5069
4478
  * @since WearKit 1.7.0
5070
- * @example 基础用法
5071
- * ```tsx
5072
- * `ty.wear.getAudioImportStatus({
4479
+ * @example Demo
4480
+ * ```jsx
4481
+ * ty.wear.getAudioImportStatus({
5073
4482
  * success: (result) => {
5074
4483
  * console.log('getAudioImportStatus success', result);
5075
4484
  * },
5076
4485
  * fail: (error) => {
5077
4486
  * console.log('getAudioImportStatus fail', error.errorMsg);
5078
4487
  * },
5079
- * });`
4488
+ * });
5080
4489
  * ```
5081
- * @see https://developer.tuya.com/
5082
4490
  * @platform iOS Android
5083
- * @error {10001} 内部错误
5084
4491
  */
5085
4492
  export function getAudioImportStatus(params?: {
5086
4493
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -5148,12 +4555,11 @@ declare namespace ty.wear {
5148
4555
 
5149
4556
  /**
5150
4557
  * 获取耳机设备的蓝牙连接状态
5151
- * @description.en Get earphone Bluetooth connection status.
5152
4558
  * @public
5153
4559
  * @since WearKit 1.8.0
5154
- * @example 基础用法
5155
- * ```tsx
5156
- * `ty.wear.getEarPhoneBTConntectedStatus({
4560
+ * @example Demo
4561
+ * ```jsx
4562
+ * ty.wear.getEarPhoneBTConntectedStatus({
5157
4563
  * devId: '',
5158
4564
  * success: (result) => {
5159
4565
  * console.log('getEarPhoneBTConntectedStatus success', result);
@@ -5161,13 +4567,9 @@ declare namespace ty.wear {
5161
4567
  * fail: (error) => {
5162
4568
  * console.log('getEarPhoneBTConntectedStatus fail', error.errorMsg);
5163
4569
  * },
5164
- * });`
4570
+ * });
5165
4571
  * ```
5166
- * @see https://developer.tuya.com/
5167
4572
  * @platform iOS Android
5168
- * @error {10001} 内部错误
5169
- * @error {10082} 蓝牙连接错误
5170
- * @error {10083} 设备离线
5171
4573
  */
5172
4574
  export function getEarPhoneBTConntectedStatus(params: {
5173
4575
  /**
@@ -5197,12 +4599,11 @@ declare namespace ty.wear {
5197
4599
 
5198
4600
  /**
5199
4601
  * 获取音频分享小程序合规路径
5200
- * @description.en Get audio sharing mini-program compliant path.
5201
4602
  * @public
5202
4603
  * @since WearKit 1.7.6
5203
- * @example 基础用法
5204
- * ```tsx
5205
- * `ty.wear.operateAudioFileSafePath({
4604
+ * @example Demo
4605
+ * ```jsx
4606
+ * ty.wear.operateAudioFileSafePath({
5206
4607
  * isGetPath: true,
5207
4608
  * audioPath: '',
5208
4609
  * success: (result) => {
@@ -5211,11 +4612,9 @@ declare namespace ty.wear {
5211
4612
  * fail: (error) => {
5212
4613
  * console.log('operateAudioFileSafePath fail', error.errorMsg);
5213
4614
  * },
5214
- * });`
4615
+ * });
5215
4616
  * ```
5216
- * @see https://developer.tuya.com/
5217
4617
  * @platform iOS Android
5218
- * @error {10001} 内部错误
5219
4618
  */
5220
4619
  export function operateAudioFileSafePath(params: {
5221
4620
  /**
@@ -5257,13 +4656,13 @@ declare namespace ty.wear {
5257
4656
  }): void
5258
4657
 
5259
4658
  /**
5260
- * 操作录音文件分享链接(开启或关闭)根据 shareStatus 参数决定是开启分享链接还是关闭分享链接
5261
- * @description.en Operate recording file share link (open or close), determined by shareStatus parameter.
4659
+ * 操作录音文件分享链接(开启或关闭)
4660
+ * 根据 shareStatus 参数决定是开启分享链接还是关闭分享链接
5262
4661
  * @public
5263
4662
  * @since WearKit 1.9.1
5264
- * @example 基础用法
5265
- * ```tsx
5266
- * `ty.wear.operateRecordShareLink({
4663
+ * @example Demo
4664
+ * ```jsx
4665
+ * ty.wear.operateRecordShareLink({
5267
4666
  * recordId: '',
5268
4667
  * shareType: [],
5269
4668
  * expireTime: 0,
@@ -5274,15 +4673,9 @@ declare namespace ty.wear {
5274
4673
  * fail: (error) => {
5275
4674
  * console.log('operateRecordShareLink fail', error.errorMsg);
5276
4675
  * },
5277
- * });`
4676
+ * });
5278
4677
  * ```
5279
- * @see https://developer.tuya.com/
5280
4678
  * @platform iOS Android
5281
- * @error {10001} 内部错误
5282
- * @error {20201} 存在敏感内容
5283
- * @error {20202} 分享通用错误
5284
- * @error {20203} 密码位数错误
5285
- * @error {20204} 缺少转写内容
5286
4679
  */
5287
4680
  export function operateRecordShareLink(params: {
5288
4681
  /**
@@ -5347,12 +4740,11 @@ declare namespace ty.wear {
5347
4740
 
5348
4741
  /**
5349
4742
  * 批量合并录音
5350
- * @description.en Batch merge recordings.
5351
4743
  * @public
5352
4744
  * @since WearKit 2.0.0
5353
- * @example 基础用法
5354
- * ```tsx
5355
- * `ty.wear.mergeRecordList({
4745
+ * @example Demo
4746
+ * ```jsx
4747
+ * ty.wear.mergeRecordList({
5356
4748
  * recordIds: [],
5357
4749
  * success: () => {
5358
4750
  * console.log('mergeRecordList success');
@@ -5360,21 +4752,9 @@ declare namespace ty.wear {
5360
4752
  * fail: (error) => {
5361
4753
  * console.log('mergeRecordList fail', error.errorMsg);
5362
4754
  * },
5363
- * });`
4755
+ * });
5364
4756
  * ```
5365
- * @see https://developer.tuya.com/
5366
- * @platform iOS Android
5367
- * @error {10001} 内部错误
5368
- * @error {20220} 入参recordIds为空
5369
- * @error {20221} 通用合并失败
5370
- * @error {20222} 网络不可用
5371
- * @error {20223} 本地文件不存在
5372
- * @error {20224} 下载/上传记录失败
5373
- * @error {20225} 合并上报失败
5374
- * @error {20226} 录音记录未找到
5375
- * @error {20227} 未知错误
5376
- * @error {20229} 创建合并记录失败
5377
- * @error {20230} 取消合并
4757
+ * @platform iOS Android
5378
4758
  */
5379
4759
  export function mergeRecordList(params: {
5380
4760
  /**
@@ -5404,23 +4784,20 @@ declare namespace ty.wear {
5404
4784
 
5405
4785
  /**
5406
4786
  * 取消合并录音
5407
- * @description.en Cancel merge recordings.
5408
4787
  * @public
5409
4788
  * @since WearKit 2.0.0
5410
- * @example 基础用法
5411
- * ```tsx
5412
- * `ty.wear.cancelMergeRecordList({
4789
+ * @example Demo
4790
+ * ```jsx
4791
+ * ty.wear.cancelMergeRecordList({
5413
4792
  * success: () => {
5414
4793
  * console.log('cancelMergeRecordList success');
5415
4794
  * },
5416
4795
  * fail: (error) => {
5417
4796
  * console.log('cancelMergeRecordList fail', error.errorMsg);
5418
4797
  * },
5419
- * });`
4798
+ * });
5420
4799
  * ```
5421
- * @see https://developer.tuya.com/
5422
4800
  * @platform iOS Android
5423
- * @error {10001} 内部错误
5424
4801
  */
5425
4802
  export function cancelMergeRecordList(params?: {
5426
4803
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -5445,23 +4822,20 @@ declare namespace ty.wear {
5445
4822
 
5446
4823
  /**
5447
4824
  * 查询录音的合并状态
5448
- * @description.en Query recording merge status.
5449
4825
  * @public
5450
4826
  * @since WearKit 2.0.0
5451
- * @example 基础用法
5452
- * ```tsx
5453
- * `ty.wear.getFileMergeStatus({
4827
+ * @example Demo
4828
+ * ```jsx
4829
+ * ty.wear.getFileMergeStatus({
5454
4830
  * success: (result) => {
5455
4831
  * console.log('getFileMergeStatus success', result);
5456
4832
  * },
5457
4833
  * fail: (error) => {
5458
4834
  * console.log('getFileMergeStatus fail', error.errorMsg);
5459
4835
  * },
5460
- * });`
4836
+ * });
5461
4837
  * ```
5462
- * @see https://developer.tuya.com/
5463
4838
  * @platform iOS Android
5464
- * @error {10001} 内部错误
5465
4839
  */
5466
4840
  export function getFileMergeStatus(params?: {
5467
4841
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -5526,12 +4900,11 @@ declare namespace ty.wear {
5526
4900
 
5527
4901
  /**
5528
4902
  * 控制原生录音状态悬浮框
5529
- * @description.en Control native recording status floating view.
5530
4903
  * @public
5531
4904
  * @since WearKit 2.0.0
5532
- * @example 基础用法
5533
- * ```tsx
5534
- * `ty.wear.operateRecordingFloat({
4905
+ * @example Demo
4906
+ * ```jsx
4907
+ * ty.wear.operateRecordingFloat({
5535
4908
  * isVisible: true,
5536
4909
  * success: () => {
5537
4910
  * console.log('operateRecordingFloat success');
@@ -5539,11 +4912,9 @@ declare namespace ty.wear {
5539
4912
  * fail: (error) => {
5540
4913
  * console.log('operateRecordingFloat fail', error.errorMsg);
5541
4914
  * },
5542
- * });`
4915
+ * });
5543
4916
  * ```
5544
- * @see https://developer.tuya.com/
5545
4917
  * @platform iOS Android
5546
- * @error {10001} 内部错误
5547
4918
  */
5548
4919
  export function operateRecordingFloat(params: {
5549
4920
  /**
@@ -5574,23 +4945,20 @@ declare namespace ty.wear {
5574
4945
 
5575
4946
  /**
5576
4947
  * 打开小程序后 建立小程序和客户端通道
5577
- * @description.en Establish mini-program and client channel after opening mini-program.
5578
4948
  * @public
5579
4949
  * @since WearKit 2.0.0
5580
- * @example 基础用法
5581
- * ```tsx
5582
- * `ty.wear.readyToSetupNativeChannel({
4950
+ * @example Demo
4951
+ * ```jsx
4952
+ * ty.wear.readyToSetupNativeChannel({
5583
4953
  * success: () => {
5584
4954
  * console.log('readyToSetupNativeChannel success');
5585
4955
  * },
5586
4956
  * fail: (error) => {
5587
4957
  * console.log('readyToSetupNativeChannel fail', error.errorMsg);
5588
4958
  * },
5589
- * });`
4959
+ * });
5590
4960
  * ```
5591
- * @see https://developer.tuya.com/
5592
4961
  * @platform iOS Android
5593
- * @error {10001} 内部错误
5594
4962
  */
5595
4963
  export function readyToSetupNativeChannel(params?: {
5596
4964
  /** 接口调用结束的回调函数(调用成功、失败都会执行) */
@@ -5614,19 +4982,10 @@ declare namespace ty.wear {
5614
4982
  }): void
5615
4983
 
5616
4984
  /**
5617
- * 监听微信授权代理事件
5618
- * @description.en Get WeChat authorization information.
4985
+ * 获取微信授权信息
4986
+ * 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
5619
4987
  * @public
5620
- * @since WearKit 1.0.0
5621
- * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
5622
- * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
5623
- * @example 基础用法
5624
- * ```tsx
5625
- * `ty.wear.onWechatAuthAgentEvent((response) => {
5626
- * console.log('onWechatAuthAgentEvent', response);
5627
- * });`
5628
- * ```
5629
- * @see https://developer.tuya.com/
4988
+ * @since WearKit 0.0.5
5630
4989
  * @platform iOS Android
5631
4990
  */
5632
4991
  export function onWechatAuthAgentEvent(
@@ -5634,19 +4993,10 @@ declare namespace ty.wear {
5634
4993
  ): void
5635
4994
 
5636
4995
  /**
5637
- * 监听微信授权代理事件
5638
- * @description.en Get WeChat authorization information.
4996
+ * 获取微信授权信息
4997
+ * 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
5639
4998
  * @public
5640
- * @since WearKit 1.0.0
5641
- * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
5642
- * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
5643
- * @example 基础用法
5644
- * ```tsx
5645
- * `ty.wear.onWechatAuthAgentEvent((response) => {
5646
- * console.log('onWechatAuthAgentEvent', response);
5647
- * });`
5648
- * ```
5649
- * @see https://developer.tuya.com/
4999
+ * @since WearKit 0.0.5
5650
5000
  * @platform iOS Android
5651
5001
  */
5652
5002
  export function offWechatAuthAgentEvent(
@@ -5654,17 +5004,9 @@ declare namespace ty.wear {
5654
5004
  ): void
5655
5005
 
5656
5006
  /**
5657
- * 监听股票同步状态更新事件
5658
- * @description.en Stock sync status update event.
5007
+ * 发送股票同步状态
5659
5008
  * @public
5660
- * @since WearKit 1.0.0
5661
- * @example 基础用法
5662
- * ```tsx
5663
- * `ty.wear.onStockSyncUpdate((data) => {
5664
- * console.log('onStockSyncUpdate', data);
5665
- * });`
5666
- * ```
5667
- * @see https://developer.tuya.com/
5009
+ * @since WearKit 0.0.4
5668
5010
  * @platform iOS Android
5669
5011
  */
5670
5012
  export function onStockSyncUpdate(
@@ -5672,17 +5014,9 @@ declare namespace ty.wear {
5672
5014
  ): void
5673
5015
 
5674
5016
  /**
5675
- * 监听股票同步状态更新事件
5676
- * @description.en Stock sync status update event.
5017
+ * 发送股票同步状态
5677
5018
  * @public
5678
- * @since WearKit 1.0.0
5679
- * @example 基础用法
5680
- * ```tsx
5681
- * `ty.wear.onStockSyncUpdate((data) => {
5682
- * console.log('onStockSyncUpdate', data);
5683
- * });`
5684
- * ```
5685
- * @see https://developer.tuya.com/
5019
+ * @since WearKit 0.0.4
5686
5020
  * @platform iOS Android
5687
5021
  */
5688
5022
  export function offStockSyncUpdate(
@@ -5691,16 +5025,14 @@ declare namespace ty.wear {
5691
5025
 
5692
5026
  /**
5693
5027
  * 进度
5694
- * @description.en Progress callback for gain publishing.
5695
5028
  * @public
5696
5029
  * @since WearKit 1.0.0
5697
- * @example 基础用法
5698
- * ```tsx
5699
- * `ty.wear.onPublishGainsProgress((body) => {
5030
+ * @example Demo
5031
+ * ```jsx
5032
+ * ty.wear.onPublishGainsProgress((body) => {
5700
5033
  * console.log('onPublishGainsProgress', body.progress, body.devId);
5701
- * });`
5034
+ * });
5702
5035
  * ```
5703
- * @see https://developer.tuya.com/
5704
5036
  * @platform iOS Android
5705
5037
  */
5706
5038
  export function onPublishGainsProgress(
@@ -5709,16 +5041,14 @@ declare namespace ty.wear {
5709
5041
 
5710
5042
  /**
5711
5043
  * 进度
5712
- * @description.en Progress callback for gain publishing.
5713
5044
  * @public
5714
5045
  * @since WearKit 1.0.0
5715
- * @example 基础用法
5716
- * ```tsx
5717
- * `ty.wear.onPublishGainsProgress((body) => {
5046
+ * @example Demo
5047
+ * ```jsx
5048
+ * ty.wear.onPublishGainsProgress((body) => {
5718
5049
  * console.log('onPublishGainsProgress', body.progress, body.devId);
5719
- * });`
5050
+ * });
5720
5051
  * ```
5721
- * @see https://developer.tuya.com/
5722
5052
  * @platform iOS Android
5723
5053
  */
5724
5054
  export function offPublishGainsProgress(
@@ -5727,16 +5057,14 @@ declare namespace ty.wear {
5727
5057
 
5728
5058
  /**
5729
5059
  * 文件传输进度进度
5730
- * @description.en File transfer progress.
5731
5060
  * @public
5732
5061
  * @since WearKit 1.1.3
5733
- * @example 基础用法
5734
- * ```tsx
5735
- * `ty.wear.onOfflineFilesProgressEvent((body) => {
5062
+ * @example Demo
5063
+ * ```jsx
5064
+ * ty.wear.onOfflineFilesProgressEvent((body) => {
5736
5065
  * console.log('onOfflineFilesProgressEvent', body.status, body.sessionId);
5737
- * });`
5066
+ * });
5738
5067
  * ```
5739
- * @see https://developer.tuya.com/
5740
5068
  * @platform iOS Android
5741
5069
  */
5742
5070
  export function onOfflineFilesProgressEvent(
@@ -5745,16 +5073,14 @@ declare namespace ty.wear {
5745
5073
 
5746
5074
  /**
5747
5075
  * 文件传输进度进度
5748
- * @description.en File transfer progress.
5749
5076
  * @public
5750
5077
  * @since WearKit 1.1.3
5751
- * @example 基础用法
5752
- * ```tsx
5753
- * `ty.wear.onOfflineFilesProgressEvent((body) => {
5078
+ * @example Demo
5079
+ * ```jsx
5080
+ * ty.wear.onOfflineFilesProgressEvent((body) => {
5754
5081
  * console.log('onOfflineFilesProgressEvent', body.status, body.sessionId);
5755
- * });`
5082
+ * });
5756
5083
  * ```
5757
- * @see https://developer.tuya.com/
5758
5084
  * @platform iOS Android
5759
5085
  */
5760
5086
  export function offOfflineFilesProgressEvent(
@@ -5763,16 +5089,14 @@ declare namespace ty.wear {
5763
5089
 
5764
5090
  /**
5765
5091
  * 录音结束回调
5766
- * @description.en Recording finished callback.
5767
5092
  * @public
5768
5093
  * @since WearKit 1.0.0
5769
- * @example 基础用法
5770
- * ```tsx
5771
- * `ty.wear.onRecordFinishEvent((body) => {
5094
+ * @example Demo
5095
+ * ```jsx
5096
+ * ty.wear.onRecordFinishEvent((body) => {
5772
5097
  * console.log('onRecordFinishEvent', body.deviceId, body.code, body.message);
5773
- * });`
5098
+ * });
5774
5099
  * ```
5775
- * @see https://developer.tuya.com/
5776
5100
  * @platform iOS Android
5777
5101
  */
5778
5102
  export function onRecordFinishEvent(
@@ -5781,16 +5105,14 @@ declare namespace ty.wear {
5781
5105
 
5782
5106
  /**
5783
5107
  * 录音结束回调
5784
- * @description.en Recording finished callback.
5785
5108
  * @public
5786
5109
  * @since WearKit 1.0.0
5787
- * @example 基础用法
5788
- * ```tsx
5789
- * `ty.wear.onRecordFinishEvent((body) => {
5110
+ * @example Demo
5111
+ * ```jsx
5112
+ * ty.wear.onRecordFinishEvent((body) => {
5790
5113
  * console.log('onRecordFinishEvent', body.deviceId, body.code, body.message);
5791
- * });`
5114
+ * });
5792
5115
  * ```
5793
- * @see https://developer.tuya.com/
5794
5116
  * @platform iOS Android
5795
5117
  */
5796
5118
  export function offRecordFinishEvent(
@@ -5799,16 +5121,14 @@ declare namespace ty.wear {
5799
5121
 
5800
5122
  /**
5801
5123
  * 录音振幅事件
5802
- * @description.en Recording amplitude event.
5803
5124
  * @public
5804
5125
  * @since WearKit 1.0.0
5805
- * @example 基础用法
5806
- * ```tsx
5807
- * `ty.wear.onRecordAmplitudeUpdateEvent((body) => {
5126
+ * @example Demo
5127
+ * ```jsx
5128
+ * ty.wear.onRecordAmplitudeUpdateEvent((body) => {
5808
5129
  * console.log('onRecordAmplitudeUpdateEvent', body.deviceId, body.amplitude);
5809
- * });`
5130
+ * });
5810
5131
  * ```
5811
- * @see https://developer.tuya.com/
5812
5132
  * @platform iOS Android
5813
5133
  */
5814
5134
  export function onRecordAmplitudeUpdateEvent(
@@ -5817,16 +5137,14 @@ declare namespace ty.wear {
5817
5137
 
5818
5138
  /**
5819
5139
  * 录音振幅事件
5820
- * @description.en Recording amplitude event.
5821
5140
  * @public
5822
5141
  * @since WearKit 1.0.0
5823
- * @example 基础用法
5824
- * ```tsx
5825
- * `ty.wear.onRecordAmplitudeUpdateEvent((body) => {
5142
+ * @example Demo
5143
+ * ```jsx
5144
+ * ty.wear.onRecordAmplitudeUpdateEvent((body) => {
5826
5145
  * console.log('onRecordAmplitudeUpdateEvent', body.deviceId, body.amplitude);
5827
- * });`
5146
+ * });
5828
5147
  * ```
5829
- * @see https://developer.tuya.com/
5830
5148
  * @platform iOS Android
5831
5149
  */
5832
5150
  export function offRecordAmplitudeUpdateEvent(
@@ -5835,12 +5153,11 @@ declare namespace ty.wear {
5835
5153
 
5836
5154
  /**
5837
5155
  * 录音状态变更事件
5838
- * @description.en Recording status change event.
5839
5156
  * @public
5840
5157
  * @since WearKit 1.0.0
5841
- * @example 基础用法
5842
- * ```tsx
5843
- * `ty.wear.onRecordStatusUpdateEvent((body) => {
5158
+ * @example Demo
5159
+ * ```jsx
5160
+ * ty.wear.onRecordStatusUpdateEvent((body) => {
5844
5161
  * console.log(
5845
5162
  * 'onRecordStatusUpdateEvent',
5846
5163
  * body.deviceId,
@@ -5850,9 +5167,8 @@ declare namespace ty.wear {
5850
5167
  * body.isResuming,
5851
5168
  * body.isStoping
5852
5169
  * );
5853
- * });`
5170
+ * });
5854
5171
  * ```
5855
- * @see https://developer.tuya.com/
5856
5172
  * @platform iOS Android
5857
5173
  */
5858
5174
  export function onRecordStatusUpdateEvent(
@@ -5861,12 +5177,11 @@ declare namespace ty.wear {
5861
5177
 
5862
5178
  /**
5863
5179
  * 录音状态变更事件
5864
- * @description.en Recording status change event.
5865
5180
  * @public
5866
5181
  * @since WearKit 1.0.0
5867
- * @example 基础用法
5868
- * ```tsx
5869
- * `ty.wear.onRecordStatusUpdateEvent((body) => {
5182
+ * @example Demo
5183
+ * ```jsx
5184
+ * ty.wear.onRecordStatusUpdateEvent((body) => {
5870
5185
  * console.log(
5871
5186
  * 'onRecordStatusUpdateEvent',
5872
5187
  * body.deviceId,
@@ -5876,9 +5191,8 @@ declare namespace ty.wear {
5876
5191
  * body.isResuming,
5877
5192
  * body.isStoping
5878
5193
  * );
5879
- * });`
5194
+ * });
5880
5195
  * ```
5881
- * @see https://developer.tuya.com/
5882
5196
  * @platform iOS Android
5883
5197
  */
5884
5198
  export function offRecordStatusUpdateEvent(
@@ -5887,16 +5201,14 @@ declare namespace ty.wear {
5887
5201
 
5888
5202
  /**
5889
5203
  * 主动切换输入源变更事件
5890
- * @description.en Active input source switch event.
5891
5204
  * @public
5892
5205
  * @since WearKit 1.3.0
5893
- * @example 基础用法
5894
- * ```tsx
5895
- * `ty.wear.onRecordSwitchAudioSourceEvent((body) => {
5206
+ * @example Demo
5207
+ * ```jsx
5208
+ * ty.wear.onRecordSwitchAudioSourceEvent((body) => {
5896
5209
  * console.log('onRecordSwitchAudioSourceEvent', body.deviceId, body.recordType, body.audioSource);
5897
- * });`
5210
+ * });
5898
5211
  * ```
5899
- * @see https://developer.tuya.com/
5900
5212
  * @platform iOS Android
5901
5213
  */
5902
5214
  export function onRecordSwitchAudioSourceEvent(
@@ -5905,16 +5217,14 @@ declare namespace ty.wear {
5905
5217
 
5906
5218
  /**
5907
5219
  * 主动切换输入源变更事件
5908
- * @description.en Active input source switch event.
5909
5220
  * @public
5910
5221
  * @since WearKit 1.3.0
5911
- * @example 基础用法
5912
- * ```tsx
5913
- * `ty.wear.onRecordSwitchAudioSourceEvent((body) => {
5222
+ * @example Demo
5223
+ * ```jsx
5224
+ * ty.wear.onRecordSwitchAudioSourceEvent((body) => {
5914
5225
  * console.log('onRecordSwitchAudioSourceEvent', body.deviceId, body.recordType, body.audioSource);
5915
- * });`
5226
+ * });
5916
5227
  * ```
5917
- * @see https://developer.tuya.com/
5918
5228
  * @platform iOS Android
5919
5229
  */
5920
5230
  export function offRecordSwitchAudioSourceEvent(
@@ -5923,16 +5233,14 @@ declare namespace ty.wear {
5923
5233
 
5924
5234
  /**
5925
5235
  * 快速启动入口添加/设置结果事件
5926
- * @description.en Quick entry add/set result event.
5927
5236
  * @public
5928
5237
  * @since WearKit 2.1.0
5929
- * @example 基础用法
5930
- * ```tsx
5931
- * `ty.wear.onQuickEntryAddEvent((response) => {
5238
+ * @example Demo
5239
+ * ```jsx
5240
+ * ty.wear.onQuickEntryAddEvent((response) => {
5932
5241
  * console.log('onQuickEntryAddEvent', response.componentId);
5933
- * });`
5242
+ * });
5934
5243
  * ```
5935
- * @see https://developer.tuya.com/
5936
5244
  * @platform iOS Android
5937
5245
  */
5938
5246
  export function onQuickEntryAddEvent(
@@ -5941,16 +5249,14 @@ declare namespace ty.wear {
5941
5249
 
5942
5250
  /**
5943
5251
  * 快速启动入口添加/设置结果事件
5944
- * @description.en Quick entry add/set result event.
5945
5252
  * @public
5946
5253
  * @since WearKit 2.1.0
5947
- * @example 基础用法
5948
- * ```tsx
5949
- * `ty.wear.onQuickEntryAddEvent((response) => {
5254
+ * @example Demo
5255
+ * ```jsx
5256
+ * ty.wear.onQuickEntryAddEvent((response) => {
5950
5257
  * console.log('onQuickEntryAddEvent', response.componentId);
5951
- * });`
5258
+ * });
5952
5259
  * ```
5953
- * @see https://developer.tuya.com/
5954
5260
  * @platform iOS Android
5955
5261
  */
5956
5262
  export function offQuickEntryAddEvent(
@@ -5959,16 +5265,14 @@ declare namespace ty.wear {
5959
5265
 
5960
5266
  /**
5961
5267
  * 录音转写结束错误回调
5962
- * @description.en Recording transcription finish error callback.
5963
5268
  * @public
5964
5269
  * @since WearKit 1.0.0
5965
- * @example 基础用法
5966
- * ```tsx
5967
- * `ty.wear.onRecordTransferFinishEvent((response) => {
5270
+ * @example Demo
5271
+ * ```jsx
5272
+ * ty.wear.onRecordTransferFinishEvent((response) => {
5968
5273
  * console.log('onRecordTransferFinishEvent', response.code);
5969
- * });`
5274
+ * });
5970
5275
  * ```
5971
- * @see https://developer.tuya.com/
5972
5276
  * @platform iOS Android
5973
5277
  */
5974
5278
  export function onRecordTransferFinishEvent(
@@ -5977,16 +5281,14 @@ declare namespace ty.wear {
5977
5281
 
5978
5282
  /**
5979
5283
  * 录音转写结束错误回调
5980
- * @description.en Recording transcription finish error callback.
5981
5284
  * @public
5982
5285
  * @since WearKit 1.0.0
5983
- * @example 基础用法
5984
- * ```tsx
5985
- * `ty.wear.onRecordTransferFinishEvent((response) => {
5286
+ * @example Demo
5287
+ * ```jsx
5288
+ * ty.wear.onRecordTransferFinishEvent((response) => {
5986
5289
  * console.log('onRecordTransferFinishEvent', response.code);
5987
- * });`
5290
+ * });
5988
5291
  * ```
5989
- * @see https://developer.tuya.com/
5990
5292
  * @platform iOS Android
5991
5293
  */
5992
5294
  export function offRecordTransferFinishEvent(
@@ -5995,16 +5297,14 @@ declare namespace ty.wear {
5995
5297
 
5996
5298
  /**
5997
5299
  * 录音转写振幅更新事件
5998
- * @description.en Recording transcription amplitude update event.
5999
5300
  * @public
6000
5301
  * @since WearKit 1.0.0
6001
- * @example 基础用法
6002
- * ```tsx
6003
- * `ty.wear.onRecordTransferAmplitudeUpdateEvent((response) => {
5302
+ * @example Demo
5303
+ * ```jsx
5304
+ * ty.wear.onRecordTransferAmplitudeUpdateEvent((response) => {
6004
5305
  * console.log('onRecordTransferAmplitudeUpdateEvent', response.amplitude);
6005
- * });`
5306
+ * });
6006
5307
  * ```
6007
- * @see https://developer.tuya.com/
6008
5308
  * @platform iOS Android
6009
5309
  */
6010
5310
  export function onRecordTransferAmplitudeUpdateEvent(
@@ -6013,16 +5313,14 @@ declare namespace ty.wear {
6013
5313
 
6014
5314
  /**
6015
5315
  * 录音转写振幅更新事件
6016
- * @description.en Recording transcription amplitude update event.
6017
5316
  * @public
6018
5317
  * @since WearKit 1.0.0
6019
- * @example 基础用法
6020
- * ```tsx
6021
- * `ty.wear.onRecordTransferAmplitudeUpdateEvent((response) => {
5318
+ * @example Demo
5319
+ * ```jsx
5320
+ * ty.wear.onRecordTransferAmplitudeUpdateEvent((response) => {
6022
5321
  * console.log('onRecordTransferAmplitudeUpdateEvent', response.amplitude);
6023
- * });`
5322
+ * });
6024
5323
  * ```
6025
- * @see https://developer.tuya.com/
6026
5324
  * @platform iOS Android
6027
5325
  */
6028
5326
  export function offRecordTransferAmplitudeUpdateEvent(
@@ -6031,16 +5329,14 @@ declare namespace ty.wear {
6031
5329
 
6032
5330
  /**
6033
5331
  * 录音转写状态变更事件
6034
- * @description.en Recording transcription status change event.
6035
5332
  * @public
6036
5333
  * @since WearKit 1.0.0
6037
- * @example 基础用法
6038
- * ```tsx
6039
- * `ty.wear.onRecordTransferStatusUpdateEvent((response) => {
5334
+ * @example Demo
5335
+ * ```jsx
5336
+ * ty.wear.onRecordTransferStatusUpdateEvent((response) => {
6040
5337
  * console.log('onRecordTransferStatusUpdateEvent', response.state);
6041
- * });`
5338
+ * });
6042
5339
  * ```
6043
- * @see https://developer.tuya.com/
6044
5340
  * @platform iOS Android
6045
5341
  */
6046
5342
  export function onRecordTransferStatusUpdateEvent(
@@ -6049,16 +5345,14 @@ declare namespace ty.wear {
6049
5345
 
6050
5346
  /**
6051
5347
  * 录音转写状态变更事件
6052
- * @description.en Recording transcription status change event.
6053
5348
  * @public
6054
5349
  * @since WearKit 1.0.0
6055
- * @example 基础用法
6056
- * ```tsx
6057
- * `ty.wear.onRecordTransferStatusUpdateEvent((response) => {
5350
+ * @example Demo
5351
+ * ```jsx
5352
+ * ty.wear.onRecordTransferStatusUpdateEvent((response) => {
6058
5353
  * console.log('onRecordTransferStatusUpdateEvent', response.state);
6059
- * });`
5354
+ * });
6060
5355
  * ```
6061
- * @see https://developer.tuya.com/
6062
5356
  * @platform iOS Android
6063
5357
  */
6064
5358
  export function offRecordTransferStatusUpdateEvent(
@@ -6067,16 +5361,14 @@ declare namespace ty.wear {
6067
5361
 
6068
5362
  /**
6069
5363
  * 录音转写文件上传进度事件
6070
- * @description.en Recording transcription file upload progress event.
6071
5364
  * @public
6072
5365
  * @since WearKit 1.2.0
6073
- * @example 基础用法
6074
- * ```tsx
6075
- * `ty.wear.onRecordTransferFileUploadEvent((response) => {
5366
+ * @example Demo
5367
+ * ```jsx
5368
+ * ty.wear.onRecordTransferFileUploadEvent((response) => {
6076
5369
  * console.log('onRecordTransferFileUploadEvent', response.progress);
6077
- * });`
5370
+ * });
6078
5371
  * ```
6079
- * @see https://developer.tuya.com/
6080
5372
  * @platform iOS Android
6081
5373
  */
6082
5374
  export function onRecordTransferFileUploadEvent(
@@ -6085,16 +5377,14 @@ declare namespace ty.wear {
6085
5377
 
6086
5378
  /**
6087
5379
  * 录音转写文件上传进度事件
6088
- * @description.en Recording transcription file upload progress event.
6089
5380
  * @public
6090
5381
  * @since WearKit 1.2.0
6091
- * @example 基础用法
6092
- * ```tsx
6093
- * `ty.wear.onRecordTransferFileUploadEvent((response) => {
5382
+ * @example Demo
5383
+ * ```jsx
5384
+ * ty.wear.onRecordTransferFileUploadEvent((response) => {
6094
5385
  * console.log('onRecordTransferFileUploadEvent', response.progress);
6095
- * });`
5386
+ * });
6096
5387
  * ```
6097
- * @see https://developer.tuya.com/
6098
5388
  * @platform iOS Android
6099
5389
  */
6100
5390
  export function offRecordTransferFileUploadEvent(
@@ -6103,16 +5393,14 @@ declare namespace ty.wear {
6103
5393
 
6104
5394
  /**
6105
5395
  * 文本翻译 TTS 完成事件
6106
- * @description.en Text translation TTS complete event.
6107
5396
  * @public
6108
5397
  * @since WearKit 1.4.0
6109
- * @example 基础用法
6110
- * ```tsx
6111
- * `ty.wear.onTextTranslateTtsCompleteEvent((response) => {
5398
+ * @example Demo
5399
+ * ```jsx
5400
+ * ty.wear.onTextTranslateTtsCompleteEvent((response) => {
6112
5401
  * console.log('onTextTranslateTtsCompleteEvent', response.fileId);
6113
- * });`
5402
+ * });
6114
5403
  * ```
6115
- * @see https://developer.tuya.com/
6116
5404
  * @platform iOS Android
6117
5405
  */
6118
5406
  export function onTextTranslateTtsCompleteEvent(
@@ -6121,16 +5409,14 @@ declare namespace ty.wear {
6121
5409
 
6122
5410
  /**
6123
5411
  * 文本翻译 TTS 完成事件
6124
- * @description.en Text translation TTS complete event.
6125
5412
  * @public
6126
5413
  * @since WearKit 1.4.0
6127
- * @example 基础用法
6128
- * ```tsx
6129
- * `ty.wear.onTextTranslateTtsCompleteEvent((response) => {
5414
+ * @example Demo
5415
+ * ```jsx
5416
+ * ty.wear.onTextTranslateTtsCompleteEvent((response) => {
6130
5417
  * console.log('onTextTranslateTtsCompleteEvent', response.fileId);
6131
- * });`
5418
+ * });
6132
5419
  * ```
6133
- * @see https://developer.tuya.com/
6134
5420
  * @platform iOS Android
6135
5421
  */
6136
5422
  export function offTextTranslateTtsCompleteEvent(
@@ -6139,19 +5425,17 @@ declare namespace ty.wear {
6139
5425
 
6140
5426
  /**
6141
5427
  * 录音实时转写状态变更事件
6142
- * @description.en Recording real-time transcription status change event.
6143
5428
  * @public
6144
5429
  * @since WearKit 1.0.0
6145
- * @example 基础用法
6146
- * ```tsx
6147
- * `ty.wear.onRecordTransferRealTimeRecognizeStatusUpdateEvent((response) => {
5430
+ * @example Demo
5431
+ * ```jsx
5432
+ * ty.wear.onRecordTransferRealTimeRecognizeStatusUpdateEvent((response) => {
6148
5433
  * console.log(
6149
5434
  * 'onRecordTransferRealTimeRecognizeStatusUpdateEvent',
6150
5435
  * response.status
6151
5436
  * );
6152
- * });`
5437
+ * });
6153
5438
  * ```
6154
- * @see https://developer.tuya.com/
6155
5439
  * @platform iOS Android
6156
5440
  */
6157
5441
  export function onRecordTransferRealTimeRecognizeStatusUpdateEvent(
@@ -6160,19 +5444,17 @@ declare namespace ty.wear {
6160
5444
 
6161
5445
  /**
6162
5446
  * 录音实时转写状态变更事件
6163
- * @description.en Recording real-time transcription status change event.
6164
5447
  * @public
6165
5448
  * @since WearKit 1.0.0
6166
- * @example 基础用法
6167
- * ```tsx
6168
- * `ty.wear.onRecordTransferRealTimeRecognizeStatusUpdateEvent((response) => {
5449
+ * @example Demo
5450
+ * ```jsx
5451
+ * ty.wear.onRecordTransferRealTimeRecognizeStatusUpdateEvent((response) => {
6169
5452
  * console.log(
6170
5453
  * 'onRecordTransferRealTimeRecognizeStatusUpdateEvent',
6171
5454
  * response.status
6172
5455
  * );
6173
- * });`
5456
+ * });
6174
5457
  * ```
6175
- * @see https://developer.tuya.com/
6176
5458
  * @platform iOS Android
6177
5459
  */
6178
5460
  export function offRecordTransferRealTimeRecognizeStatusUpdateEvent(
@@ -6181,16 +5463,14 @@ declare namespace ty.wear {
6181
5463
 
6182
5464
  /**
6183
5465
  * 录音场景电量变化事件
6184
- * @description.en Recording scene battery change event.
6185
5466
  * @public
6186
5467
  * @since WearKit 1.7.0
6187
- * @example 基础用法
6188
- * ```tsx
6189
- * `ty.wear.onRecordBatteryChangeEvent((response) => {
5468
+ * @example Demo
5469
+ * ```jsx
5470
+ * ty.wear.onRecordBatteryChangeEvent((response) => {
6190
5471
  * console.log('onRecordBatteryChangeEvent', response.BatteryValue);
6191
- * });`
5472
+ * });
6192
5473
  * ```
6193
- * @see https://developer.tuya.com/
6194
5474
  * @platform iOS Android
6195
5475
  */
6196
5476
  export function onRecordBatteryChangeEvent(
@@ -6199,16 +5479,14 @@ declare namespace ty.wear {
6199
5479
 
6200
5480
  /**
6201
5481
  * 录音场景电量变化事件
6202
- * @description.en Recording scene battery change event.
6203
5482
  * @public
6204
5483
  * @since WearKit 1.7.0
6205
- * @example 基础用法
6206
- * ```tsx
6207
- * `ty.wear.onRecordBatteryChangeEvent((response) => {
5484
+ * @example Demo
5485
+ * ```jsx
5486
+ * ty.wear.onRecordBatteryChangeEvent((response) => {
6208
5487
  * console.log('onRecordBatteryChangeEvent', response.BatteryValue);
6209
- * });`
5488
+ * });
6210
5489
  * ```
6211
- * @see https://developer.tuya.com/
6212
5490
  * @platform iOS Android
6213
5491
  */
6214
5492
  export function offRecordBatteryChangeEvent(
@@ -6217,16 +5495,14 @@ declare namespace ty.wear {
6217
5495
 
6218
5496
  /**
6219
5497
  * 实时转写/同声传译录音质量(SNR)变化事件
6220
- * @description.en Real-time transcription/simultaneous interpretation recording quality (SNR) change event.
6221
5498
  * @public
6222
5499
  * @since WearKit 1.7.0
6223
- * @example 基础用法
6224
- * ```tsx
6225
- * `ty.wear.onRecordQualityChangeEvent((response) => {
5500
+ * @example Demo
5501
+ * ```jsx
5502
+ * ty.wear.onRecordQualityChangeEvent((response) => {
6226
5503
  * console.log('onRecordQualityChangeEvent', response.snrValue);
6227
- * });`
5504
+ * });
6228
5505
  * ```
6229
- * @see https://developer.tuya.com/
6230
5506
  * @platform iOS Android
6231
5507
  */
6232
5508
  export function onRecordQualityChangeEvent(
@@ -6235,16 +5511,14 @@ declare namespace ty.wear {
6235
5511
 
6236
5512
  /**
6237
5513
  * 实时转写/同声传译录音质量(SNR)变化事件
6238
- * @description.en Real-time transcription/simultaneous interpretation recording quality (SNR) change event.
6239
5514
  * @public
6240
5515
  * @since WearKit 1.7.0
6241
- * @example 基础用法
6242
- * ```tsx
6243
- * `ty.wear.onRecordQualityChangeEvent((response) => {
5516
+ * @example Demo
5517
+ * ```jsx
5518
+ * ty.wear.onRecordQualityChangeEvent((response) => {
6244
5519
  * console.log('onRecordQualityChangeEvent', response.snrValue);
6245
- * });`
5520
+ * });
6246
5521
  * ```
6247
- * @see https://developer.tuya.com/
6248
5522
  * @platform iOS Android
6249
5523
  */
6250
5524
  export function offRecordQualityChangeEvent(
@@ -6253,19 +5527,17 @@ declare namespace ty.wear {
6253
5527
 
6254
5528
  /**
6255
5529
  * 经典蓝牙设备/Pro 耳机连接状态变更事件
6256
- * @description.en Classic Bluetooth device/Pro earphone connection status change event.
6257
5530
  * @public
6258
5531
  * @since WearKit 1.8.0
6259
- * @example 基础用法
6260
- * ```tsx
6261
- * `ty.wear.onEarPhoneBTConnectedStatusChangeEvent((response) => {
5532
+ * @example Demo
5533
+ * ```jsx
5534
+ * ty.wear.onEarPhoneBTConnectedStatusChangeEvent((response) => {
6262
5535
  * console.log(
6263
5536
  * 'onEarPhoneBTConnectedStatusChangeEvent',
6264
5537
  * response.connectedStatus
6265
5538
  * );
6266
- * });`
5539
+ * });
6267
5540
  * ```
6268
- * @see https://developer.tuya.com/
6269
5541
  * @platform iOS Android
6270
5542
  */
6271
5543
  export function onEarPhoneBTConnectedStatusChangeEvent(
@@ -6274,19 +5546,17 @@ declare namespace ty.wear {
6274
5546
 
6275
5547
  /**
6276
5548
  * 经典蓝牙设备/Pro 耳机连接状态变更事件
6277
- * @description.en Classic Bluetooth device/Pro earphone connection status change event.
6278
5549
  * @public
6279
5550
  * @since WearKit 1.8.0
6280
- * @example 基础用法
6281
- * ```tsx
6282
- * `ty.wear.onEarPhoneBTConnectedStatusChangeEvent((response) => {
5551
+ * @example Demo
5552
+ * ```jsx
5553
+ * ty.wear.onEarPhoneBTConnectedStatusChangeEvent((response) => {
6283
5554
  * console.log(
6284
5555
  * 'onEarPhoneBTConnectedStatusChangeEvent',
6285
5556
  * response.connectedStatus
6286
5557
  * );
6287
- * });`
5558
+ * });
6288
5559
  * ```
6289
- * @see https://developer.tuya.com/
6290
5560
  * @platform iOS Android
6291
5561
  */
6292
5562
  export function offEarPhoneBTConnectedStatusChangeEvent(
@@ -6295,16 +5565,14 @@ declare namespace ty.wear {
6295
5565
 
6296
5566
  /**
6297
5567
  * 记录云同步开关状态事件
6298
- * @description.en Cloud sync switch status event.
6299
5568
  * @public
6300
5569
  * @since WearKit 1.5.0
6301
- * @example 基础用法
6302
- * ```tsx
6303
- * `ty.wear.onCloudSyncSwitchStatusEvent((response) => {
5570
+ * @example Demo
5571
+ * ```jsx
5572
+ * ty.wear.onCloudSyncSwitchStatusEvent((response) => {
6304
5573
  * console.log('onCloudSyncSwitchStatusEvent', response.enabled);
6305
- * });`
5574
+ * });
6306
5575
  * ```
6307
- * @see https://developer.tuya.com/
6308
5576
  * @platform iOS Android
6309
5577
  */
6310
5578
  export function onCloudSyncSwitchStatusEvent(
@@ -6313,16 +5581,14 @@ declare namespace ty.wear {
6313
5581
 
6314
5582
  /**
6315
5583
  * 记录云同步开关状态事件
6316
- * @description.en Cloud sync switch status event.
6317
5584
  * @public
6318
5585
  * @since WearKit 1.5.0
6319
- * @example 基础用法
6320
- * ```tsx
6321
- * `ty.wear.onCloudSyncSwitchStatusEvent((response) => {
5586
+ * @example Demo
5587
+ * ```jsx
5588
+ * ty.wear.onCloudSyncSwitchStatusEvent((response) => {
6322
5589
  * console.log('onCloudSyncSwitchStatusEvent', response.enabled);
6323
- * });`
5590
+ * });
6324
5591
  * ```
6325
- * @see https://developer.tuya.com/
6326
5592
  * @platform iOS Android
6327
5593
  */
6328
5594
  export function offCloudSyncSwitchStatusEvent(
@@ -6331,16 +5597,14 @@ declare namespace ty.wear {
6331
5597
 
6332
5598
  /**
6333
5599
  * 记录同步状态事件
6334
- * @description.en Sync status event.
6335
5600
  * @public
6336
5601
  * @since WearKit 1.6.0
6337
- * @example 基础用法
6338
- * ```tsx
6339
- * `ty.wear.onPartialRecordUpdate((response) => {
5602
+ * @example Demo
5603
+ * ```jsx
5604
+ * ty.wear.onPartialRecordUpdate((response) => {
6340
5605
  * console.log('onPartialRecordUpdate', response.updateList);
6341
- * });`
5606
+ * });
6342
5607
  * ```
6343
- * @see https://developer.tuya.com/
6344
5608
  * @platform iOS Android
6345
5609
  */
6346
5610
  export function onPartialRecordUpdate(
@@ -6349,16 +5613,14 @@ declare namespace ty.wear {
6349
5613
 
6350
5614
  /**
6351
5615
  * 记录同步状态事件
6352
- * @description.en Sync status event.
6353
5616
  * @public
6354
5617
  * @since WearKit 1.6.0
6355
- * @example 基础用法
6356
- * ```tsx
6357
- * `ty.wear.onPartialRecordUpdate((response) => {
5618
+ * @example Demo
5619
+ * ```jsx
5620
+ * ty.wear.onPartialRecordUpdate((response) => {
6358
5621
  * console.log('onPartialRecordUpdate', response.updateList);
6359
- * });`
5622
+ * });
6360
5623
  * ```
6361
- * @see https://developer.tuya.com/
6362
5624
  * @platform iOS Android
6363
5625
  */
6364
5626
  export function offPartialRecordUpdate(
@@ -6367,16 +5629,14 @@ declare namespace ty.wear {
6367
5629
 
6368
5630
  /**
6369
5631
  * 文件列表状态刷新事件
6370
- * @description.en File list status refresh event.
6371
5632
  * @public
6372
5633
  * @since WearKit 1.5.0
6373
- * @example 基础用法
6374
- * ```tsx
6375
- * `ty.wear.onFileListUpdateStatusEvent((response) => {
5634
+ * @example Demo
5635
+ * ```jsx
5636
+ * ty.wear.onFileListUpdateStatusEvent((response) => {
6376
5637
  * console.log('onFileListUpdateStatusEvent', response.status);
6377
- * });`
5638
+ * });
6378
5639
  * ```
6379
- * @see https://developer.tuya.com/
6380
5640
  * @platform iOS Android
6381
5641
  */
6382
5642
  export function onFileListUpdateStatusEvent(
@@ -6385,16 +5645,14 @@ declare namespace ty.wear {
6385
5645
 
6386
5646
  /**
6387
5647
  * 文件列表状态刷新事件
6388
- * @description.en File list status refresh event.
6389
5648
  * @public
6390
5649
  * @since WearKit 1.5.0
6391
- * @example 基础用法
6392
- * ```tsx
6393
- * `ty.wear.onFileListUpdateStatusEvent((response) => {
5650
+ * @example Demo
5651
+ * ```jsx
5652
+ * ty.wear.onFileListUpdateStatusEvent((response) => {
6394
5653
  * console.log('onFileListUpdateStatusEvent', response.status);
6395
- * });`
5654
+ * });
6396
5655
  * ```
6397
- * @see https://developer.tuya.com/
6398
5656
  * @platform iOS Android
6399
5657
  */
6400
5658
  export function offFileListUpdateStatusEvent(
@@ -6403,16 +5661,14 @@ declare namespace ty.wear {
6403
5661
 
6404
5662
  /**
6405
5663
  * 文件详情状态刷新事件
6406
- * @description.en File details status refresh event.
6407
5664
  * @public
6408
5665
  * @since WearKit 1.5.0
6409
- * @example 基础用法
6410
- * ```tsx
6411
- * `ty.wear.onFileDetailUpdateStatusEvent((response) => {
5666
+ * @example Demo
5667
+ * ```jsx
5668
+ * ty.wear.onFileDetailUpdateStatusEvent((response) => {
6412
5669
  * console.log('onFileDetailUpdateStatusEvent', response.recordId);
6413
- * });`
5670
+ * });
6414
5671
  * ```
6415
- * @see https://developer.tuya.com/
6416
5672
  * @platform iOS Android
6417
5673
  */
6418
5674
  export function onFileDetailUpdateStatusEvent(
@@ -6421,16 +5677,14 @@ declare namespace ty.wear {
6421
5677
 
6422
5678
  /**
6423
5679
  * 文件详情状态刷新事件
6424
- * @description.en File details status refresh event.
6425
5680
  * @public
6426
5681
  * @since WearKit 1.5.0
6427
- * @example 基础用法
6428
- * ```tsx
6429
- * `ty.wear.onFileDetailUpdateStatusEvent((response) => {
5682
+ * @example Demo
5683
+ * ```jsx
5684
+ * ty.wear.onFileDetailUpdateStatusEvent((response) => {
6430
5685
  * console.log('onFileDetailUpdateStatusEvent', response.recordId);
6431
- * });`
5686
+ * });
6432
5687
  * ```
6433
- * @see https://developer.tuya.com/
6434
5688
  * @platform iOS Android
6435
5689
  */
6436
5690
  export function offFileDetailUpdateStatusEvent(
@@ -6439,16 +5693,14 @@ declare namespace ty.wear {
6439
5693
 
6440
5694
  /**
6441
5695
  * 小程序Push刷新事件
6442
- * @description.en Mini-program push refresh event.
6443
5696
  * @public
6444
5697
  * @since WearKit 1.6.23
6445
- * @example 基础用法
6446
- * ```tsx
6447
- * `ty.wear.onPushRouteInfoEvent((response) => {
5698
+ * @example Demo
5699
+ * ```jsx
5700
+ * ty.wear.onPushRouteInfoEvent((response) => {
6448
5701
  * console.log('onPushRouteInfoEvent', response.pushType);
6449
- * });`
5702
+ * });
6450
5703
  * ```
6451
- * @see https://developer.tuya.com/
6452
5704
  * @platform iOS Android
6453
5705
  */
6454
5706
  export function onPushRouteInfoEvent(
@@ -6457,16 +5709,14 @@ declare namespace ty.wear {
6457
5709
 
6458
5710
  /**
6459
5711
  * 小程序Push刷新事件
6460
- * @description.en Mini-program push refresh event.
6461
5712
  * @public
6462
5713
  * @since WearKit 1.6.23
6463
- * @example 基础用法
6464
- * ```tsx
6465
- * `ty.wear.onPushRouteInfoEvent((response) => {
5714
+ * @example Demo
5715
+ * ```jsx
5716
+ * ty.wear.onPushRouteInfoEvent((response) => {
6466
5717
  * console.log('onPushRouteInfoEvent', response.pushType);
6467
- * });`
5718
+ * });
6468
5719
  * ```
6469
- * @see https://developer.tuya.com/
6470
5720
  * @platform iOS Android
6471
5721
  */
6472
5722
  export function offPushRouteInfoEvent(
@@ -6475,16 +5725,14 @@ declare namespace ty.wear {
6475
5725
 
6476
5726
  /**
6477
5727
  * 文件导入状态透传监听
6478
- * @description.en File import status event.
6479
5728
  * @public
6480
5729
  * @since WearKit 1.7.0
6481
- * @example 基础用法
6482
- * ```tsx
6483
- * `ty.wear.onFileImportStatusEvent((response) => {
5730
+ * @example Demo
5731
+ * ```jsx
5732
+ * ty.wear.onFileImportStatusEvent((response) => {
6484
5733
  * console.log('onFileImportStatusEvent', response.status);
6485
- * });`
5734
+ * });
6486
5735
  * ```
6487
- * @see https://developer.tuya.com/
6488
5736
  * @platform iOS Android
6489
5737
  */
6490
5738
  export function onFileImportStatusEvent(
@@ -6493,16 +5741,14 @@ declare namespace ty.wear {
6493
5741
 
6494
5742
  /**
6495
5743
  * 文件导入状态透传监听
6496
- * @description.en File import status event.
6497
5744
  * @public
6498
5745
  * @since WearKit 1.7.0
6499
- * @example 基础用法
6500
- * ```tsx
6501
- * `ty.wear.onFileImportStatusEvent((response) => {
5746
+ * @example Demo
5747
+ * ```jsx
5748
+ * ty.wear.onFileImportStatusEvent((response) => {
6502
5749
  * console.log('onFileImportStatusEvent', response.status);
6503
- * });`
5750
+ * });
6504
5751
  * ```
6505
- * @see https://developer.tuya.com/
6506
5752
  * @platform iOS Android
6507
5753
  */
6508
5754
  export function offFileImportStatusEvent(
@@ -6511,16 +5757,14 @@ declare namespace ty.wear {
6511
5757
 
6512
5758
  /**
6513
5759
  * 文件合并状态事件
6514
- * @description.en File merge status event.
6515
5760
  * @public
6516
5761
  * @since WearKit 2.0.0
6517
- * @example 基础用法
6518
- * ```tsx
6519
- * `ty.wear.onFileMergeStatusEvent((response) => {
5762
+ * @example Demo
5763
+ * ```jsx
5764
+ * ty.wear.onFileMergeStatusEvent((response) => {
6520
5765
  * console.log('onFileMergeStatusEvent', response.status);
6521
- * });`
5766
+ * });
6522
5767
  * ```
6523
- * @see https://developer.tuya.com/
6524
5768
  * @platform iOS Android
6525
5769
  */
6526
5770
  export function onFileMergeStatusEvent(
@@ -6529,89 +5773,72 @@ declare namespace ty.wear {
6529
5773
 
6530
5774
  /**
6531
5775
  * 文件合并状态事件
6532
- * @description.en File merge status event.
6533
5776
  * @public
6534
5777
  * @since WearKit 2.0.0
6535
- * @example 基础用法
6536
- * ```tsx
6537
- * `ty.wear.onFileMergeStatusEvent((response) => {
5778
+ * @example Demo
5779
+ * ```jsx
5780
+ * ty.wear.onFileMergeStatusEvent((response) => {
6538
5781
  * console.log('onFileMergeStatusEvent', response.status);
6539
- * });`
5782
+ * });
6540
5783
  * ```
6541
- * @see https://developer.tuya.com/
6542
5784
  * @platform iOS Android
6543
5785
  */
6544
5786
  export function offFileMergeStatusEvent(
6545
5787
  listener: (params: FileMergeStatusEvent) => void
6546
5788
  ): void
6547
5789
 
6548
- /**
6549
- * QQ音乐授权请求参数
6550
- * @since WearKit 0.0.5
6551
- */
5790
+ /** @since WearKit 0.0.5 */
6552
5791
  export interface QQMusicAuthParams {
6553
5792
  /**
6554
- * 第三方服务类型,参见 ThirdPartyType 枚举
5793
+ * 三方服务列表 ThirdPartyType
6555
5794
  * @since WearKit 0.0.5
6556
5795
  */
6557
5796
  type: number
6558
5797
  }
6559
5798
 
6560
- /**
6561
- * QQ音乐授权结果
6562
- * @since WearKit 0.0.5
6563
- */
5799
+ /** @since WearKit 0.0.5 */
6564
5800
  export interface QQMusicAuthResult {
6565
5801
  /**
6566
- * 过期时间(Unix 时间戳,单位:秒)
5802
+ * 过期时间
6567
5803
  * @since WearKit 0.0.5
6568
5804
  */
6569
5805
  expireTime: number
6570
5806
  /**
6571
- * QQ音乐账户 openId
5807
+ * openId
6572
5808
  * @since WearKit 0.0.5
6573
5809
  */
6574
5810
  openId: string
6575
5811
  /**
6576
- * QQ音乐访问令牌
5812
+ * openToken
6577
5813
  * @since WearKit 0.0.5
6578
5814
  */
6579
5815
  openToken: string
6580
5816
  }
6581
5817
 
6582
- /**
6583
- * QQ音乐小程序授权参数
6584
- * @since WearKit 0.0.5
6585
- */
5818
+ /** @since WearKit 0.0.5 */
6586
5819
  export interface QQMusicQQMiniProgramAuthParams {
6587
5820
  /**
6588
- * QQ音乐 AppKey
5821
+ * qq音乐appkey
6589
5822
  * @since WearKit 0.0.5
6590
5823
  */
6591
5824
  qqMusicAppKey: string
6592
5825
  /**
6593
- * 加密的签名字符串
5826
+ * 签名字符串
6594
5827
  * @since WearKit 0.0.5
6595
5828
  */
6596
5829
  encryptString: string
6597
5830
  }
6598
5831
 
6599
- /**
6600
- * QQ音乐授权结果解析参数
6601
- * @since WearKit 0.0.5
6602
- */
5832
+ /** @since WearKit 0.0.5 */
6603
5833
  export interface QQMusicAuthResultParseParam {
6604
5834
  /**
6605
- * 加密的授权结果字符串
5835
+ * 授权结果
6606
5836
  * @since WearKit 0.0.5
6607
5837
  */
6608
5838
  encryptString: string
6609
5839
  }
6610
5840
 
6611
- /**
6612
- * 第三方服务类型枚举
6613
- * @since WearKit 0.0.5
6614
- */
5841
+ /** @since WearKit 0.0.5 */
6615
5842
  export enum ThirdPartyType {
6616
5843
  /**
6617
5844
  * qq音乐
@@ -6633,7 +5860,7 @@ declare namespace ty.wear {
6633
5860
  }
6634
5861
 
6635
5862
  /**
6636
- * 本地应用消息监听支持列表的回调数据
5863
+ * 回调
6637
5864
  * @since WearKit 0.0.4
6638
5865
  */
6639
5866
  export interface LocalSupportAppListResponsed {
@@ -6655,7 +5882,7 @@ declare namespace ty.wear {
6655
5882
  */
6656
5883
  deviceId: string
6657
5884
  /**
6658
- * 股票同步类型,参考 StockSyncType 枚举
5885
+ * 股票同步类型
6659
5886
  * @since WearKit 0.0.4
6660
5887
  */
6661
5888
  syncType: number
@@ -6777,7 +6004,7 @@ declare namespace ty.wear {
6777
6004
  */
6778
6005
  deviceId: string
6779
6006
  /**
6780
- * 股票同步类型,参考 StockSyncType 枚举
6007
+ * 股票同步类型
6781
6008
  * @since WearKit 0.0.4
6782
6009
  */
6783
6010
  syncType: number
@@ -6804,7 +6031,7 @@ declare namespace ty.wear {
6804
6031
  }
6805
6032
 
6806
6033
  /**
6807
- * 应用是否安装的入参数据
6034
+ * 是否安装入参数据
6808
6035
  * @since WearKit 0.0.6
6809
6036
  */
6810
6037
  export interface HasInstallBean {
@@ -6815,13 +6042,9 @@ declare namespace ty.wear {
6815
6042
  packageName: string
6816
6043
  }
6817
6044
 
6818
- /**
6819
- * 应用是否安装的结果数据
6820
- * @since WearKit 0.0.6
6821
- */
6045
+ /** @since WearKit 0.0.6 */
6822
6046
  export interface HasInstallResultBean {
6823
6047
  /**
6824
- * 是否已安装
6825
6048
  * @since WearKit 0.0.6
6826
6049
  * @defaultValue false
6827
6050
  */
@@ -7100,10 +6323,7 @@ declare namespace ty.wear {
7100
6323
  task?: RecordTask
7101
6324
  }
7102
6325
 
7103
- /**
7104
- * 文件摘要信息
7105
- * @since WearKit 1.1.3
7106
- */
6326
+ /** @since WearKit 1.1.3 */
7107
6327
  export interface FileDigest {
7108
6328
  /**
7109
6329
  * 文件唯一标识Id
@@ -7139,10 +6359,7 @@ declare namespace ty.wear {
7139
6359
  fileDuring: number
7140
6360
  }
7141
6361
 
7142
- /**
7143
- * 离线文件响应数据
7144
- * @since WearKit 1.1.3
7145
- */
6362
+ /** @since WearKit 1.1.3 */
7146
6363
  export interface OfflineFilesResponse {
7147
6364
  /**
7148
6365
  * 下载资源的通道
@@ -7219,10 +6436,7 @@ declare namespace ty.wear {
7219
6436
  apConnectState: number
7220
6437
  }
7221
6438
 
7222
- /**
7223
- * 设备离线文件下载状态
7224
- * @since WearKit 1.1.3
7225
- */
6439
+ /** @since WearKit 1.1.3 */
7226
6440
  export interface DeviceOfflineFileStatus {
7227
6441
  /**
7228
6442
  * 当前下载状态
@@ -7273,10 +6487,7 @@ declare namespace ty.wear {
7273
6487
  sessionId: number
7274
6488
  }
7275
6489
 
7276
- /**
7277
- * 录音结束事件数据
7278
- * @since WearKit 1.0.0
7279
- */
6490
+ /** @since WearKit 1.0.0 */
7280
6491
  export interface RecordFinishError {
7281
6492
  /**
7282
6493
  * 设备id
@@ -7295,10 +6506,7 @@ declare namespace ty.wear {
7295
6506
  message?: string
7296
6507
  }
7297
6508
 
7298
- /**
7299
- * 录音振幅数据
7300
- * @since WearKit 1.0.0
7301
- */
6509
+ /** @since WearKit 1.0.0 */
7302
6510
  export interface Amplitude {
7303
6511
  /**
7304
6512
  * 设备id
@@ -7312,10 +6520,7 @@ declare namespace ty.wear {
7312
6520
  amplitude: number
7313
6521
  }
7314
6522
 
7315
- /**
7316
- * 录音状态
7317
- * @since WearKit 1.0.0
7318
- */
6523
+ /** @since WearKit 1.0.0 */
7319
6524
  export interface RecordStatus {
7320
6525
  /**
7321
6526
  * 设备id
@@ -7349,10 +6554,7 @@ declare namespace ty.wear {
7349
6554
  isStoping: boolean
7350
6555
  }
7351
6556
 
7352
- /**
7353
- * 切换音频输入源事件数据
7354
- * @since WearKit 1.3.0
7355
- */
6557
+ /** @since WearKit 1.3.0 */
7356
6558
  export interface SwitchAudioSource {
7357
6559
  /**
7358
6560
  * 设备id
@@ -7453,7 +6655,7 @@ declare namespace ty.wear {
7453
6655
  }
7454
6656
 
7455
6657
  /**
7456
- * 文件信息更新参数
6658
+ * 文件更新参数
7457
6659
  * @since WearKit 1.0.0
7458
6660
  */
7459
6661
  export interface FileUpdateParams {
@@ -7532,7 +6734,7 @@ declare namespace ty.wear {
7532
6734
  }
7533
6735
 
7534
6736
  /**
7535
- * 批量文件转写状态更新参数
6737
+ * 文件更新参数
7536
6738
  * @since WearKit 1.0.0
7537
6739
  */
7538
6740
  export interface FileTransferParams {
@@ -7561,7 +6763,7 @@ declare namespace ty.wear {
7561
6763
  }
7562
6764
 
7563
6765
  /**
7564
- * 批量文件删除参数
6766
+ * 文件更新参数
7565
6767
  * @since WearKit 1.1.3
7566
6768
  */
7567
6769
  export interface FileListRemoveParams {
@@ -7578,7 +6780,7 @@ declare namespace ty.wear {
7578
6780
  }
7579
6781
 
7580
6782
  /**
7581
- * 文件列表查询参数
6783
+ * 文件列表参数
7582
6784
  * @since WearKit 1.0.0
7583
6785
  */
7584
6786
  export interface FilesParams {
@@ -7732,7 +6934,7 @@ declare namespace ty.wear {
7732
6934
  }
7733
6935
 
7734
6936
  /**
7735
- * 文件数量查询参数
6937
+ * 文件列表参数
7736
6938
  * @since WearKit 1.0.0
7737
6939
  */
7738
6940
  export interface CountFilesParams {
@@ -7788,7 +6990,7 @@ declare namespace ty.wear {
7788
6990
  }
7789
6991
 
7790
6992
  /**
7791
- * 文件详情查询参数
6993
+ * 文件详情参数
7792
6994
  * @since WearKit 1.0.0
7793
6995
  */
7794
6996
  export interface FileParams {
@@ -7805,7 +7007,7 @@ declare namespace ty.wear {
7805
7007
  }
7806
7008
 
7807
7009
  /**
7808
- * 目录创建参数
7010
+ * 文件详情参数
7809
7011
  * @since WearKit 1.0.0
7810
7012
  */
7811
7013
  export interface DirectoryCreateParams {
@@ -7827,7 +7029,7 @@ declare namespace ty.wear {
7827
7029
  }
7828
7030
 
7829
7031
  /**
7830
- * 目录更新参数
7032
+ * 文件更新参数
7831
7033
  * @since WearKit 1.0.0
7832
7034
  */
7833
7035
  export interface DirectoryUpdateParams {
@@ -7854,7 +7056,7 @@ declare namespace ty.wear {
7854
7056
  }
7855
7057
 
7856
7058
  /**
7857
- * 目录删除参数
7059
+ * 文件更新参数
7858
7060
  * @since WearKit 1.0.0
7859
7061
  */
7860
7062
  export interface DirectoryRemoveParams {
@@ -7866,7 +7068,7 @@ declare namespace ty.wear {
7866
7068
  }
7867
7069
 
7868
7070
  /**
7869
- * 目录列表查询参数
7071
+ * 文件更新参数
7870
7072
  * @since WearKit 1.0.0
7871
7073
  */
7872
7074
  export interface DirectoriesParams {
@@ -7924,10 +7126,7 @@ declare namespace ty.wear {
7924
7126
  * @since WearKit 2.1.0
7925
7127
  */
7926
7128
  state: number
7927
- /**
7928
- * 组件 ID(int):安卓 1 开头(1xxx),iOS 2 开头(2xxx)
7929
- * @since WearKit 2.1.0
7930
- */
7129
+ /** @since WearKit 2.1.0 */
7931
7130
  componentId: number
7932
7131
  }
7933
7132
 
@@ -7997,10 +7196,7 @@ declare namespace ty.wear {
7997
7196
  language: string
7998
7197
  }
7999
7198
 
8000
- /**
8001
- * TTS 配置
8002
- * @since WearKit 1.4.0
8003
- */
7199
+ /** @since WearKit 1.4.0 */
8004
7200
  export interface TtsConfig {
8005
7201
  /**
8006
7202
  * 设备id
@@ -8035,10 +7231,7 @@ declare namespace ty.wear {
8035
7231
  ttsOutputChannel: number
8036
7232
  }
8037
7233
 
8038
- /**
8039
- * 录音转写 3A 音频处理配置
8040
- * @since WearKit 1.2.2
8041
- */
7234
+ /** @since WearKit 1.2.2 */
8042
7235
  export interface RecordTransfer3AConfig {
8043
7236
  /**
8044
7237
  * 是否需要RN降噪
@@ -8067,10 +7260,7 @@ declare namespace ty.wear {
8067
7260
  aecEnable: boolean
8068
7261
  }
8069
7262
 
8070
- /**
8071
- * 开始录音转写配置
8072
- * @since WearKit 1.0.0
8073
- */
7263
+ /** @since WearKit 1.0.0 */
8074
7264
  export interface StartRecordTransferConfig {
8075
7265
  /**
8076
7266
  * 录音类型,0呼叫,1会议,2同声传译 3:f2f翻译
@@ -8152,10 +7342,7 @@ declare namespace ty.wear {
8152
7342
  recordTransfer3Aconfig?: RecordTransfer3AConfig
8153
7343
  }
8154
7344
 
8155
- /**
8156
- * 开始录音转写请求参数
8157
- * @since WearKit 1.0.0
8158
- */
7345
+ /** @since WearKit 1.0.0 */
8159
7346
  export interface StartRecordTransferParams {
8160
7347
  /**
8161
7348
  * 设备id
@@ -8169,10 +7356,7 @@ declare namespace ty.wear {
8169
7356
  config: StartRecordTransferConfig
8170
7357
  }
8171
7358
 
8172
- /**
8173
- * 开始音频录制配置
8174
- * @since WearKit 1.3.0
8175
- */
7359
+ /** @since WearKit 1.3.0 */
8176
7360
  export interface StartAudioRecordingConfig {
8177
7361
  /**
8178
7362
  * 业务类型 0: Note, 1: Translate
@@ -8293,10 +7477,7 @@ declare namespace ty.wear {
8293
7477
  startLivingStatus: number
8294
7478
  }
8295
7479
 
8296
- /**
8297
- * 开始音频录制请求参数
8298
- * @since WearKit 1.3.0
8299
- */
7480
+ /** @since WearKit 1.3.0 */
8300
7481
  export interface StartAudioRecordingParams {
8301
7482
  /**
8302
7483
  * 设备id
@@ -8310,10 +7491,7 @@ declare namespace ty.wear {
8310
7491
  config: StartAudioRecordingConfig
8311
7492
  }
8312
7493
 
8313
- /**
8314
- * 录音转写任务详情
8315
- * @since WearKit 1.0.0
8316
- */
7494
+ /** @since WearKit 1.0.0 */
8317
7495
  export interface RecordTransferTask {
8318
7496
  /**
8319
7497
  * 状态,0未知,1录音中,2暂停,3结束
@@ -8414,10 +7592,7 @@ declare namespace ty.wear {
8414
7592
  businessType: number
8415
7593
  }
8416
7594
 
8417
- /**
8418
- * 查询录音转写任务响应
8419
- * @since WearKit 1.0.0
8420
- */
7595
+ /** @since WearKit 1.0.0 */
8421
7596
  export interface RecordTransferTaskResponse {
8422
7597
  /**
8423
7598
  * 录音任务信息
@@ -8426,10 +7601,7 @@ declare namespace ty.wear {
8426
7601
  task?: RecordTransferTask
8427
7602
  }
8428
7603
 
8429
- /**
8430
- * 暂停录音转写请求参数
8431
- * @since WearKit 1.0.0
8432
- */
7604
+ /** @since WearKit 1.0.0 */
8433
7605
  export interface PauseRecordTransferParams {
8434
7606
  /**
8435
7607
  * 设备id
@@ -8438,10 +7610,7 @@ declare namespace ty.wear {
8438
7610
  deviceId: string
8439
7611
  }
8440
7612
 
8441
- /**
8442
- * 恢复录音转写请求参数
8443
- * @since WearKit 1.0.0
8444
- */
7613
+ /** @since WearKit 1.0.0 */
8445
7614
  export interface ResumeRecordTransferParams {
8446
7615
  /**
8447
7616
  * 设备id
@@ -8450,10 +7619,7 @@ declare namespace ty.wear {
8450
7619
  deviceId: string
8451
7620
  }
8452
7621
 
8453
- /**
8454
- * 停止录音转写请求参数
8455
- * @since WearKit 1.0.0
8456
- */
7622
+ /** @since WearKit 1.0.0 */
8457
7623
  export interface StopRecordTransferParams {
8458
7624
  /**
8459
7625
  * 设备id
@@ -8462,10 +7628,7 @@ declare namespace ty.wear {
8462
7628
  deviceId: string
8463
7629
  }
8464
7630
 
8465
- /**
8466
- * 查询录音转写任务请求参数
8467
- * @since WearKit 1.0.0
8468
- */
7631
+ /** @since WearKit 1.0.0 */
8469
7632
  export interface RecordTransferTaskParams {
8470
7633
  /**
8471
7634
  * 设备id
@@ -8566,10 +7729,7 @@ declare namespace ty.wear {
8566
7729
  ttsPath?: string
8567
7730
  }
8568
7731
 
8569
- /**
8570
- * 获取实时转写结果响应
8571
- * @since WearKit 1.0.0
8572
- */
7732
+ /** @since WearKit 1.0.0 */
8573
7733
  export interface GetRecordTransferRealTimeResultResponse {
8574
7734
  /**
8575
7735
  * 实时转写数据列表
@@ -8578,10 +7738,7 @@ declare namespace ty.wear {
8578
7738
  list?: RecordTransferRealTimeItem[]
8579
7739
  }
8580
7740
 
8581
- /**
8582
- * 录音转写结束事件数据
8583
- * @since WearKit 1.0.0
8584
- */
7741
+ /** @since WearKit 1.0.0 */
8585
7742
  export interface RecordTransferFinishError {
8586
7743
  /**
8587
7744
  * 设备id
@@ -8600,10 +7757,7 @@ declare namespace ty.wear {
8600
7757
  message?: string
8601
7758
  }
8602
7759
 
8603
- /**
8604
- * 录音转写振幅数据
8605
- * @since WearKit 1.0.0
8606
- */
7760
+ /** @since WearKit 1.0.0 */
8607
7761
  export interface RecordTransferAmplitude {
8608
7762
  /**
8609
7763
  * 设备id
@@ -8622,10 +7776,7 @@ declare namespace ty.wear {
8622
7776
  channel: number
8623
7777
  }
8624
7778
 
8625
- /**
8626
- * 录音转写状态
8627
- * @since WearKit 1.0.0
8628
- */
7779
+ /** @since WearKit 1.0.0 */
8629
7780
  export interface RecordTransferStatus {
8630
7781
  /**
8631
7782
  * 设备id
@@ -8659,10 +7810,7 @@ declare namespace ty.wear {
8659
7810
  isStoping: boolean
8660
7811
  }
8661
7812
 
8662
- /**
8663
- * 文件上传进度
8664
- * @since WearKit 1.2.0
8665
- */
7813
+ /** @since WearKit 1.2.0 */
8666
7814
  export interface FileUploadProgress {
8667
7815
  /**
8668
7816
  * 文件ID
@@ -8681,10 +7829,7 @@ declare namespace ty.wear {
8681
7829
  progress: number
8682
7830
  }
8683
7831
 
8684
- /**
8685
- * 文本翻译 TTS 完成事件数据
8686
- * @since WearKit 1.4.0
8687
- */
7832
+ /** @since WearKit 1.4.0 */
8688
7833
  export interface TextTranslateTtsComplete {
8689
7834
  /**
8690
7835
  * 文件ID
@@ -8698,10 +7843,7 @@ declare namespace ty.wear {
8698
7843
  ttsPath: string
8699
7844
  }
8700
7845
 
8701
- /**
8702
- * 实时转写状态
8703
- * @since WearKit 1.0.0
8704
- */
7846
+ /** @since WearKit 1.0.0 */
8705
7847
  export interface RecordTransferRealTimeRecognizeStatus {
8706
7848
  /**
8707
7849
  * 设备id
@@ -8775,10 +7917,7 @@ declare namespace ty.wear {
8775
7917
  errorMessage?: string
8776
7918
  }
8777
7919
 
8778
- /**
8779
- * 录音场景电量变化状态
8780
- * @since WearKit 1.7.0
8781
- */
7920
+ /** @since WearKit 1.7.0 */
8782
7921
  export interface BatteryChangeStatus {
8783
7922
  /**
8784
7923
  * 是否展示横幅
@@ -8792,10 +7931,7 @@ declare namespace ty.wear {
8792
7931
  BatteryValue: number
8793
7932
  }
8794
7933
 
8795
- /**
8796
- * 录音质量(SNR)变化状态
8797
- * @since WearKit 1.7.0
8798
- */
7934
+ /** @since WearKit 1.7.0 */
8799
7935
  export interface QualityChangeStatus {
8800
7936
  /**
8801
7937
  * 是否展示横幅
@@ -8831,10 +7967,7 @@ declare namespace ty.wear {
8831
7967
  desc: string
8832
7968
  }
8833
7969
 
8834
- /**
8835
- * 获取转写模板请求参数
8836
- * @since WearKit 1.0.0
8837
- */
7970
+ /** @since WearKit 1.0.0 */
8838
7971
  export interface GetRecordTransferTemplateParams {
8839
7972
  /**
8840
7973
  * 设备id
@@ -8848,10 +7981,7 @@ declare namespace ty.wear {
8848
7981
  bizType: string
8849
7982
  }
8850
7983
 
8851
- /**
8852
- * 获取转写模板响应
8853
- * @since WearKit 1.0.0
8854
- */
7984
+ /** @since WearKit 1.0.0 */
8855
7985
  export interface getRecordTransferTemplateResponse {
8856
7986
  /**
8857
7987
  * 模版数据
@@ -8860,10 +7990,7 @@ declare namespace ty.wear {
8860
7990
  result: string
8861
7991
  }
8862
7992
 
8863
- /**
8864
- * 处理录音转写结果请求参数
8865
- * @since WearKit 1.0.0
8866
- */
7993
+ /** @since WearKit 1.0.0 */
8867
7994
  export interface ProcessRecordTransferResultParams {
8868
7995
  /**
8869
7996
  * 录音转写id
@@ -8902,10 +8029,7 @@ declare namespace ty.wear {
8902
8029
  enableSpeaker: boolean
8903
8030
  }
8904
8031
 
8905
- /**
8906
- * 查询转写进度状态请求参数
8907
- * @since WearKit 1.0.0
8908
- */
8032
+ /** @since WearKit 1.0.0 */
8909
8033
  export interface GetRecordTransferProcessStatusParams {
8910
8034
  /**
8911
8035
  * 设备id
@@ -8924,10 +8048,7 @@ declare namespace ty.wear {
8924
8048
  taskType: number
8925
8049
  }
8926
8050
 
8927
- /**
8928
- * 查询转写进度状态响应
8929
- * @since WearKit 1.0.0
8930
- */
8051
+ /** @since WearKit 1.0.0 */
8931
8052
  export interface GetRecordTransferProcessStatusResponse {
8932
8053
  /**
8933
8054
  * 转写成功的文件id列表
@@ -8961,10 +8082,7 @@ declare namespace ty.wear {
8961
8082
  translateFail: string[]
8962
8083
  }
8963
8084
 
8964
- /**
8965
- * 查询转写结果请求参数
8966
- * @since WearKit 1.0.0
8967
- */
8085
+ /** @since WearKit 1.0.0 */
8968
8086
  export interface GetRecordTransferRecognizeResultParams {
8969
8087
  /**
8970
8088
  * 录音转写id
@@ -8978,10 +8096,7 @@ declare namespace ty.wear {
8978
8096
  from: number
8979
8097
  }
8980
8098
 
8981
- /**
8982
- * 查询转写结果响应
8983
- * @since WearKit 1.0.0
8984
- */
8099
+ /** @since WearKit 1.0.0 */
8985
8100
  export interface GetRecordTransferRecognizeResultResponse {
8986
8101
  /**
8987
8102
  * 转写结果
@@ -8990,10 +8105,7 @@ declare namespace ty.wear {
8990
8105
  text: string
8991
8106
  }
8992
8107
 
8993
- /**
8994
- * 查询总结结果请求参数
8995
- * @since WearKit 1.0.0
8996
- */
8108
+ /** @since WearKit 1.0.0 */
8997
8109
  export interface GetRecordTransferSummaryResultParams {
8998
8110
  /**
8999
8111
  * 录音转写id
@@ -9007,10 +8119,7 @@ declare namespace ty.wear {
9007
8119
  from: number
9008
8120
  }
9009
8121
 
9010
- /**
9011
- * 查询总结结果响应
9012
- * @since WearKit 1.0.0
9013
- */
8122
+ /** @since WearKit 1.0.0 */
9014
8123
  export interface GetRecordTransferSummaryResultResponse {
9015
8124
  /**
9016
8125
  * 总结文案
@@ -9019,10 +8128,7 @@ declare namespace ty.wear {
9019
8128
  text: string
9020
8129
  }
9021
8130
 
9022
- /**
9023
- * 保存转写结果请求参数
9024
- * @since WearKit 1.0.0
9025
- */
8131
+ /** @since WearKit 1.0.0 */
9026
8132
  export interface SaveRecordTransferRecognizeResultParams {
9027
8133
  /**
9028
8134
  * 录音转写id
@@ -9036,10 +8142,7 @@ declare namespace ty.wear {
9036
8142
  text: string
9037
8143
  }
9038
8144
 
9039
- /**
9040
- * 保存总结结果请求参数
9041
- * @since WearKit 1.0.0
9042
- */
8145
+ /** @since WearKit 1.0.0 */
9043
8146
  export interface SaveRecordTransferSummaryResultParams {
9044
8147
  /**
9045
8148
  * 录音转写id
@@ -9053,10 +8156,7 @@ declare namespace ty.wear {
9053
8156
  text: string
9054
8157
  }
9055
8158
 
9056
- /**
9057
- * 更新实时转写结果请求参数
9058
- * @since WearKit 1.0.0
9059
- */
8159
+ /** @since WearKit 1.0.0 */
9060
8160
  export interface SaveRecordTransferRealTimeRecognizeResultParams {
9061
8161
  /**
9062
8162
  * 请求id
@@ -9080,10 +8180,7 @@ declare namespace ty.wear {
9080
8180
  translate?: string
9081
8181
  }
9082
8182
 
9083
- /**
9084
- * 获取录音转写列表请求参数
9085
- * @since WearKit 1.0.0
9086
- */
8183
+ /** @since WearKit 1.0.0 */
9087
8184
  export interface GetRecordTransferResultListParams {
9088
8185
  /**
9089
8186
  * 目录id, 不传会查出所有目录
@@ -9137,10 +8234,7 @@ declare namespace ty.wear {
9137
8234
  pageSize?: number
9138
8235
  }
9139
8236
 
9140
- /**
9141
- * 录音转写记录
9142
- * @since WearKit 1.0.0
9143
- */
8237
+ /** @since WearKit 1.0.0 */
9144
8238
  export interface RecordTransferResult {
9145
8239
  /**
9146
8240
  * 录音转写id = 其实是 fileId
@@ -9338,10 +8432,7 @@ declare namespace ty.wear {
9338
8432
  summaryImageStatus?: number
9339
8433
  }
9340
8434
 
9341
- /**
9342
- * 搜索录音转写请求参数
9343
- * @since WearKit 2.1.0
9344
- */
8435
+ /** @since WearKit 2.1.0 */
9345
8436
  export interface SearchRecordTransferResultParams {
9346
8437
  /**
9347
8438
  * 搜索关键词
@@ -9360,10 +8451,7 @@ declare namespace ty.wear {
9360
8451
  pageSize: number
9361
8452
  }
9362
8453
 
9363
- /**
9364
- * 搜索录音转写结果项
9365
- * @since WearKit 2.1.0
9366
- */
8454
+ /** @since WearKit 2.1.0 */
9367
8455
  export interface SearchRecordTransferResult {
9368
8456
  /**
9369
8457
  * 录音转写id
@@ -9407,10 +8495,7 @@ declare namespace ty.wear {
9407
8495
  duration: number
9408
8496
  }
9409
8497
 
9410
- /**
9411
- * 获取录音转写详情请求参数
9412
- * @since WearKit 1.0.0
9413
- */
8498
+ /** @since WearKit 1.0.0 */
9414
8499
  export interface GetRecordTransferResultDetailParams {
9415
8500
  /**
9416
8501
  * 录音转写id
@@ -9424,10 +8509,7 @@ declare namespace ty.wear {
9424
8509
  amplitudeMaxCount?: string
9425
8510
  }
9426
8511
 
9427
- /**
9428
- * 更新录音转写记录请求参数
9429
- * @since WearKit 1.0.0
9430
- */
8512
+ /** @since WearKit 1.0.0 */
9431
8513
  export interface UpdateRecordTransferResultParams {
9432
8514
  /**
9433
8515
  * 录音转写id
@@ -9491,10 +8573,7 @@ declare namespace ty.wear {
9491
8573
  tags?: string[]
9492
8574
  }
9493
8575
 
9494
- /**
9495
- * 删除录音转写记录请求参数
9496
- * @since WearKit 1.0.0
9497
- */
8576
+ /** @since WearKit 1.0.0 */
9498
8577
  export interface RemoveRecordTransferResultParams {
9499
8578
  /**
9500
8579
  * 录音转写id
@@ -9503,10 +8582,7 @@ declare namespace ty.wear {
9503
8582
  recordTransferId: number
9504
8583
  }
9505
8584
 
9506
- /**
9507
- * 更新录音标签请求参数
9508
- * @since WearKit 2.1.0
9509
- */
8585
+ /** @since WearKit 2.1.0 */
9510
8586
  export interface UpdateRecordTagResultParams {
9511
8587
  /**
9512
8588
  * 录音记录ID
@@ -9526,7 +8602,7 @@ declare namespace ty.wear {
9526
8602
  }
9527
8603
 
9528
8604
  /**
9529
- * 翻译记录列表查询参数
8605
+ * 文件列表参数
9530
8606
  * @since WearKit 1.4.0
9531
8607
  */
9532
8608
  export interface TranslateFileParams {
@@ -9650,10 +8726,7 @@ declare namespace ty.wear {
9650
8726
  targetText?: string
9651
8727
  }
9652
8728
 
9653
- /**
9654
- * 获取翻译记录详情请求参数
9655
- * @since WearKit 1.4.0
9656
- */
8729
+ /** @since WearKit 1.4.0 */
9657
8730
  export interface GetTranslateFileDetailParams {
9658
8731
  /**
9659
8732
  * fileid
@@ -9667,10 +8740,7 @@ declare namespace ty.wear {
9667
8740
  amplitudeMaxCount?: string
9668
8741
  }
9669
8742
 
9670
- /**
9671
- * 翻译记录详情
9672
- * @since WearKit 1.4.0
9673
- */
8743
+ /** @since WearKit 1.4.0 */
9674
8744
  export interface TranslateFileDetail {
9675
8745
  /**
9676
8746
  * 文件id
@@ -9744,10 +8814,7 @@ declare namespace ty.wear {
9744
8814
  targetText?: string
9745
8815
  }
9746
8816
 
9747
- /**
9748
- * 翻译请求参数
9749
- * @since WearKit 1.4.0
9750
- */
8817
+ /** @since WearKit 1.4.0 */
9751
8818
  export interface TranslateRequest {
9752
8819
  /**
9753
8820
  * 源文本
@@ -9771,10 +8838,7 @@ declare namespace ty.wear {
9771
8838
  needTts: boolean
9772
8839
  }
9773
8840
 
9774
- /**
9775
- * 翻译结果
9776
- * @since WearKit 1.4.0
9777
- */
8841
+ /** @since WearKit 1.4.0 */
9778
8842
  export interface TranslateResult {
9779
8843
  /**
9780
8844
  * 源文本
@@ -9803,10 +8867,7 @@ declare namespace ty.wear {
9803
8867
  ttsPath?: string
9804
8868
  }
9805
8869
 
9806
- /**
9807
- * 发送至 AI Note 的请求参数
9808
- * @since WearKit 1.4.0
9809
- */
8870
+ /** @since WearKit 1.4.0 */
9810
8871
  export interface SendToNoteRequest {
9811
8872
  /**
9812
8873
  * 翻译表的文件id
@@ -9820,10 +8881,7 @@ declare namespace ty.wear {
9820
8881
  recordId?: string
9821
8882
  }
9822
8883
 
9823
- /**
9824
- * 发送至 AI Note 的结果
9825
- * @since WearKit 1.4.0
9826
- */
8884
+ /** @since WearKit 1.4.0 */
9827
8885
  export interface SendToNoteResult {
9828
8886
  /**
9829
8887
  * 发送到Note后产生的记录ID
@@ -9837,10 +8895,7 @@ declare namespace ty.wear {
9837
8895
  recordId?: string
9838
8896
  }
9839
8897
 
9840
- /**
9841
- * 云同步开关状态
9842
- * @since WearKit 1.6.0
9843
- */
8898
+ /** @since WearKit 1.6.0 */
9844
8899
  export interface CloudSyncSwitchStatus {
9845
8900
  /**
9846
8901
  * 开关状态
@@ -9876,10 +8931,7 @@ declare namespace ty.wear {
9876
8931
  recordId: string
9877
8932
  }
9878
8933
 
9879
- /**
9880
- * 事件流控制请求参数
9881
- * @since WearKit 1.7.0
9882
- */
8934
+ /** @since WearKit 1.7.0 */
9883
8935
  export interface OperateEventLimitParams {
9884
8936
  /**
9885
8937
  * 事件名称
@@ -9896,10 +8948,7 @@ declare namespace ty.wear {
9896
8948
  operate: boolean
9897
8949
  }
9898
8950
 
9899
- /**
9900
- * Token 预申请请求参数
9901
- * @since WearKit 1.7.0
9902
- */
8951
+ /** @since WearKit 1.7.0 */
9903
8952
  export interface TokenPreRequestParams {
9904
8953
  /**
9905
8954
  * true:进去页面发起预申请 false: 未开启录音,离开页面取消预申请
@@ -9913,10 +8962,7 @@ declare namespace ty.wear {
9913
8962
  config: StartAudioRecordingParams
9914
8963
  }
9915
8964
 
9916
- /**
9917
- * 导入失败的文件信息
9918
- * @since WearKit 1.7.0
9919
- */
8965
+ /** @since WearKit 1.7.0 */
9920
8966
  export interface FailedFileInfo {
9921
8967
  /**
9922
8968
  * 文件名
@@ -9930,10 +8976,7 @@ declare namespace ty.wear {
9930
8976
  code: string
9931
8977
  }
9932
8978
 
9933
- /**
9934
- * 音频文件导入状态事件
9935
- * @since WearKit 1.7.0
9936
- */
8979
+ /** @since WearKit 1.7.0 */
9937
8980
  export interface FileImportStatusEvent {
9938
8981
  /**
9939
8982
  * 导入状态
@@ -10143,10 +9186,7 @@ declare namespace ty.wear {
10143
9186
  isVisible: boolean
10144
9187
  }
10145
9188
 
10146
- /**
10147
- * 录音记录局部更新项
10148
- * @since WearKit 1.6.0
10149
- */
9189
+ /** @since WearKit 1.6.0 */
10150
9190
  export interface RecordUpdateItem {
10151
9191
  /**
10152
9192
  * 录音id
@@ -10286,10 +9326,7 @@ declare namespace ty.wear {
10286
9326
  syncBusinessType: number
10287
9327
  }
10288
9328
 
10289
- /**
10290
- * 推送路由信息参数
10291
- * @since WearKit 1.6.23
10292
- */
9329
+ /** @since WearKit 1.6.23 */
10293
9330
  export interface PushRouteInfoParams {
10294
9331
  /**
10295
9332
  * 推送事件标识: