@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
@@ -6,6 +6,21 @@ const factory = createFactory('AIKit');
6
6
  /**
7
7
  * @public
8
8
  * @since @ray-js/ray 1.6.29
9
+ * @example 基础调用
10
+ * ```tsx
11
+ * import { ai } from '@ray-js/ray';
12
+ *
13
+ * const { getTranslateRecords } = ai;
14
+ *
15
+ * getTranslateRecords({
16
+ * success: (result) => {
17
+ * console.log('getTranslateRecords success', result);
18
+ * },
19
+ * fail: (error) => {
20
+ * console.log('getTranslateRecords fail', error.errorMsg);
21
+ * },
22
+ * });
23
+ * ```
9
24
  */
10
25
  export const getTranslateRecords = factory('getTranslateRecords', {
11
26
  namespace: 'ai'
@@ -13,6 +28,22 @@ export const getTranslateRecords = factory('getTranslateRecords', {
13
28
  /**
14
29
  * @public
15
30
  * @since @ray-js/ray 1.6.29
31
+ * @example 基础调用
32
+ * ```tsx
33
+ * import { ai } from '@ray-js/ray';
34
+ *
35
+ * const { getTranslateRecord } = ai;
36
+ *
37
+ * getTranslateRecord({
38
+ * translateId: 0,
39
+ * success: (result) => {
40
+ * console.log('getTranslateRecord success', result);
41
+ * },
42
+ * fail: (error) => {
43
+ * console.log('getTranslateRecord fail', error.errorMsg);
44
+ * },
45
+ * });
46
+ * ```
16
47
  */
17
48
  export const getTranslateRecord = factory('getTranslateRecord', {
18
49
  namespace: 'ai'
@@ -20,6 +51,22 @@ export const getTranslateRecord = factory('getTranslateRecord', {
20
51
  /**
21
52
  * @public
22
53
  * @since @ray-js/ray 1.6.29
54
+ * @example 基础调用
55
+ * ```tsx
56
+ * import { ai } from '@ray-js/ray';
57
+ *
58
+ * const { updateTranslateRecord } = ai;
59
+ *
60
+ * updateTranslateRecord({
61
+ * translateId: 0,
62
+ * success: () => {
63
+ * console.log('updateTranslateRecord success');
64
+ * },
65
+ * fail: (error) => {
66
+ * console.log('updateTranslateRecord fail', error.errorMsg);
67
+ * },
68
+ * });
69
+ * ```
23
70
  */
24
71
  export const updateTranslateRecord = factory('updateTranslateRecord', {
25
72
  namespace: 'ai'
@@ -27,6 +74,22 @@ export const updateTranslateRecord = factory('updateTranslateRecord', {
27
74
  /**
28
75
  * @public
29
76
  * @since @ray-js/ray 1.6.29
77
+ * @example 基础调用
78
+ * ```tsx
79
+ * import { ai } from '@ray-js/ray';
80
+ *
81
+ * const { removeTranslateRecord } = ai;
82
+ *
83
+ * removeTranslateRecord({
84
+ * translateId: 0,
85
+ * success: () => {
86
+ * console.log('removeTranslateRecord success');
87
+ * },
88
+ * fail: (error) => {
89
+ * console.log('removeTranslateRecord fail', error.errorMsg);
90
+ * },
91
+ * });
92
+ * ```
30
93
  */
31
94
  export const removeTranslateRecord = factory('removeTranslateRecord', {
32
95
  namespace: 'ai'
@@ -34,6 +97,22 @@ export const removeTranslateRecord = factory('removeTranslateRecord', {
34
97
  /**
35
98
  * @public
36
99
  * @since @ray-js/ray 1.6.29
100
+ * @example 基础调用
101
+ * ```tsx
102
+ * import { ai } from '@ray-js/ray';
103
+ *
104
+ * const { getTranslateRealTimeResult } = ai;
105
+ *
106
+ * getTranslateRealTimeResult({
107
+ * translateId: 'example',
108
+ * success: (result) => {
109
+ * console.log('getTranslateRealTimeResult success', result);
110
+ * },
111
+ * fail: (error) => {
112
+ * console.log('getTranslateRealTimeResult fail', error.errorMsg);
113
+ * },
114
+ * });
115
+ * ```
37
116
  */
38
117
  export const getTranslateRealTimeResult = factory('getTranslateRealTimeResult', {
39
118
  namespace: 'ai'
@@ -41,6 +120,24 @@ export const getTranslateRealTimeResult = factory('getTranslateRealTimeResult',
41
120
  /**
42
121
  * @public
43
122
  * @since @ray-js/ray 1.6.29
123
+ * @example 基础调用
124
+ * ```tsx
125
+ * import { ai } from '@ray-js/ray';
126
+ *
127
+ * const { processTranslateSummary } = ai;
128
+ *
129
+ * processTranslateSummary({
130
+ * translateId: 0,
131
+ * template: 'example',
132
+ * language: 'example',
133
+ * success: () => {
134
+ * console.log('processTranslateSummary success');
135
+ * },
136
+ * fail: (error) => {
137
+ * console.log('processTranslateSummary fail', error.errorMsg);
138
+ * },
139
+ * });
140
+ * ```
44
141
  */
45
142
  export const processTranslateSummary = factory('processTranslateSummary', {
46
143
  namespace: 'ai'
@@ -48,6 +145,22 @@ export const processTranslateSummary = factory('processTranslateSummary', {
48
145
  /**
49
146
  * @public
50
147
  * @since @ray-js/ray 1.6.29
148
+ * @example 基础调用
149
+ * ```tsx
150
+ * import { ai } from '@ray-js/ray';
151
+ *
152
+ * const { getTranslateSummary } = ai;
153
+ *
154
+ * getTranslateSummary({
155
+ * translateId: 0,
156
+ * success: (result) => {
157
+ * console.log('getTranslateSummary success', result);
158
+ * },
159
+ * fail: (error) => {
160
+ * console.log('getTranslateSummary fail', error.errorMsg);
161
+ * },
162
+ * });
163
+ * ```
51
164
  */
52
165
  export const getTranslateSummary = factory('getTranslateSummary', {
53
166
  namespace: 'ai'
@@ -55,6 +168,23 @@ export const getTranslateSummary = factory('getTranslateSummary', {
55
168
  /**
56
169
  * @public
57
170
  * @since @ray-js/ray 1.6.29
171
+ * @example 基础调用
172
+ * ```tsx
173
+ * import { ai } from '@ray-js/ray';
174
+ *
175
+ * const { getTranslateSummaryProcessStatus } = ai;
176
+ *
177
+ * getTranslateSummaryProcessStatus({
178
+ * deviceId: 'device_001',
179
+ * translateIds: ['example'],
180
+ * success: (result) => {
181
+ * console.log('getTranslateSummaryProcessStatus success', result);
182
+ * },
183
+ * fail: (error) => {
184
+ * console.log('getTranslateSummaryProcessStatus fail', error.errorMsg);
185
+ * },
186
+ * });
187
+ * ```
58
188
  */
59
189
  export const getTranslateSummaryProcessStatus = factory('getTranslateSummaryProcessStatus', {
60
190
  namespace: 'ai'
@@ -62,6 +192,21 @@ export const getTranslateSummaryProcessStatus = factory('getTranslateSummaryProc
62
192
  /**
63
193
  * @public
64
194
  * @since @ray-js/ray 1.6.29
195
+ * @example 基础调用
196
+ * ```tsx
197
+ * import { ai } from '@ray-js/ray';
198
+ *
199
+ * const { backgroundMusicList } = ai;
200
+ *
201
+ * backgroundMusicList({
202
+ * success: (result) => {
203
+ * console.log('backgroundMusicList success', result);
204
+ * },
205
+ * fail: (error) => {
206
+ * console.log('backgroundMusicList fail', error.errorMsg);
207
+ * },
208
+ * });
209
+ * ```
65
210
  */
66
211
  export const backgroundMusicList = factory('backgroundMusicList', {
67
212
  namespace: 'ai'
@@ -69,6 +214,23 @@ export const backgroundMusicList = factory('backgroundMusicList', {
69
214
  /**
70
215
  * @public
71
216
  * @since @ray-js/ray 1.6.29
217
+ * @example 基础调用
218
+ * ```tsx
219
+ * import { ai } from '@ray-js/ray';
220
+ *
221
+ * const { backgroundMusicDownload } = ai;
222
+ *
223
+ * backgroundMusicDownload({
224
+ * musicUrl: 'example',
225
+ * musicPath: 'example',
226
+ * success: (result) => {
227
+ * console.log('backgroundMusicDownload success', result);
228
+ * },
229
+ * fail: (error) => {
230
+ * console.log('backgroundMusicDownload fail', error.errorMsg);
231
+ * },
232
+ * });
233
+ * ```
72
234
  */
73
235
  export const backgroundMusicDownload = factory('backgroundMusicDownload', {
74
236
  namespace: 'ai'
@@ -76,6 +238,21 @@ export const backgroundMusicDownload = factory('backgroundMusicDownload', {
76
238
  /**
77
239
  * @public
78
240
  * @since @ray-js/ray 1.6.29
241
+ * @example 基础调用
242
+ * ```tsx
243
+ * import { ai } from '@ray-js/ray';
244
+ *
245
+ * const { objectDetectCreate } = ai;
246
+ *
247
+ * objectDetectCreate({
248
+ * success: () => {
249
+ * console.log('objectDetectCreate success');
250
+ * },
251
+ * fail: (error) => {
252
+ * console.log('objectDetectCreate fail', error.errorMsg);
253
+ * },
254
+ * });
255
+ * ```
79
256
  */
80
257
  export const objectDetectCreate = factory('objectDetectCreate', {
81
258
  namespace: 'ai'
@@ -83,6 +260,21 @@ export const objectDetectCreate = factory('objectDetectCreate', {
83
260
  /**
84
261
  * @public
85
262
  * @since @ray-js/ray 1.6.29
263
+ * @example 基础调用
264
+ * ```tsx
265
+ * import { ai } from '@ray-js/ray';
266
+ *
267
+ * const { objectDetectDestroy } = ai;
268
+ *
269
+ * objectDetectDestroy({
270
+ * success: () => {
271
+ * console.log('objectDetectDestroy success');
272
+ * },
273
+ * fail: (error) => {
274
+ * console.log('objectDetectDestroy fail', error.errorMsg);
275
+ * },
276
+ * });
277
+ * ```
86
278
  */
87
279
  export const objectDetectDestroy = factory('objectDetectDestroy', {
88
280
  namespace: 'ai'
@@ -90,6 +282,23 @@ export const objectDetectDestroy = factory('objectDetectDestroy', {
90
282
  /**
91
283
  * @public
92
284
  * @since @ray-js/ray 1.6.29
285
+ * @example 基础调用
286
+ * ```tsx
287
+ * import { ai } from '@ray-js/ray';
288
+ *
289
+ * const { objectDetectForImage } = ai;
290
+ *
291
+ * objectDetectForImage({
292
+ * inputPath: 'example',
293
+ * outputPath: 'example',
294
+ * success: (result) => {
295
+ * console.log('objectDetectForImage success', result);
296
+ * },
297
+ * fail: (error) => {
298
+ * console.log('objectDetectForImage fail', error.errorMsg);
299
+ * },
300
+ * });
301
+ * ```
93
302
  */
94
303
  export const objectDetectForImage = factory('objectDetectForImage', {
95
304
  namespace: 'ai'
@@ -97,6 +306,21 @@ export const objectDetectForImage = factory('objectDetectForImage', {
97
306
  /**
98
307
  * @public
99
308
  * @since @ray-js/ray 1.6.29
309
+ * @example 基础调用
310
+ * ```tsx
311
+ * import { ai } from '@ray-js/ray';
312
+ *
313
+ * const { objectDetectForImageCancel } = ai;
314
+ *
315
+ * objectDetectForImageCancel({
316
+ * success: () => {
317
+ * console.log('objectDetectForImageCancel success');
318
+ * },
319
+ * fail: (error) => {
320
+ * console.log('objectDetectForImageCancel fail', error.errorMsg);
321
+ * },
322
+ * });
323
+ * ```
100
324
  */
101
325
  export const objectDetectForImageCancel = factory('objectDetectForImageCancel', {
102
326
  namespace: 'ai'
@@ -104,6 +328,24 @@ export const objectDetectForImageCancel = factory('objectDetectForImageCancel',
104
328
  /**
105
329
  * @public
106
330
  * @since @ray-js/ray 1.6.29
331
+ * @example 基础调用
332
+ * ```tsx
333
+ * import { ai } from '@ray-js/ray';
334
+ *
335
+ * const { objectDetectForVideo } = ai;
336
+ *
337
+ * objectDetectForVideo({
338
+ * inputVideoPath: 'example',
339
+ * outputVideoPath: 'example',
340
+ * musicPath: 'example',
341
+ * success: (result) => {
342
+ * console.log('objectDetectForVideo success', result);
343
+ * },
344
+ * fail: (error) => {
345
+ * console.log('objectDetectForVideo fail', error.errorMsg);
346
+ * },
347
+ * });
348
+ * ```
107
349
  */
108
350
  export const objectDetectForVideo = factory('objectDetectForVideo', {
109
351
  namespace: 'ai'
@@ -111,6 +353,21 @@ export const objectDetectForVideo = factory('objectDetectForVideo', {
111
353
  /**
112
354
  * @public
113
355
  * @since @ray-js/ray 1.6.29
356
+ * @example 基础调用
357
+ * ```tsx
358
+ * import { ai } from '@ray-js/ray';
359
+ *
360
+ * const { objectDetectForVideoCancel } = ai;
361
+ *
362
+ * objectDetectForVideoCancel({
363
+ * success: () => {
364
+ * console.log('objectDetectForVideoCancel success');
365
+ * },
366
+ * fail: (error) => {
367
+ * console.log('objectDetectForVideoCancel fail', error.errorMsg);
368
+ * },
369
+ * });
370
+ * ```
114
371
  */
115
372
  export const objectDetectForVideoCancel = factory('objectDetectForVideoCancel', {
116
373
  namespace: 'ai'
@@ -118,6 +375,16 @@ export const objectDetectForVideoCancel = factory('objectDetectForVideoCancel',
118
375
  /**
119
376
  * @public
120
377
  * @since @ray-js/ray 1.6.29
378
+ * @example 基础调用
379
+ * ```tsx
380
+ * import { ai } from '@ray-js/ray';
381
+ *
382
+ * const { onVideoObjectDetectProgress } = ai;
383
+ *
384
+ * onVideoObjectDetectProgress((result) => {
385
+ * console.log('onVideoObjectDetectProgress', result);
386
+ * });
387
+ * ```
121
388
  */
122
389
  export const onVideoObjectDetectProgress = factory('onVideoObjectDetectProgress', {
123
390
  namespace: 'ai'
@@ -125,6 +392,16 @@ export const onVideoObjectDetectProgress = factory('onVideoObjectDetectProgress'
125
392
  /**
126
393
  * @public
127
394
  * @since @ray-js/ray 1.6.29
395
+ * @example 基础调用
396
+ * ```tsx
397
+ * import { ai } from '@ray-js/ray';
398
+ *
399
+ * const { offVideoObjectDetectProgress } = ai;
400
+ *
401
+ * offVideoObjectDetectProgress((result) => {
402
+ * console.log('offVideoObjectDetectProgress', result);
403
+ * });
404
+ * ```
128
405
  */
129
406
  export const offVideoObjectDetectProgress = factory('offVideoObjectDetectProgress', {
130
407
  namespace: 'ai'
@@ -132,6 +409,26 @@ export const offVideoObjectDetectProgress = factory('offVideoObjectDetectProgres
132
409
  /**
133
410
  * @public
134
411
  * @since @ray-js/ray 1.6.29
412
+ * @example 基础调用
413
+ * ```tsx
414
+ * import { ai } from '@ray-js/ray';
415
+ *
416
+ * const { generateTranslateTask } = ai;
417
+ *
418
+ * generateTranslateTask({
419
+ * deviceId: 'device_001',
420
+ * dataTimeout: 0,
421
+ * originalLanguage: 'example',
422
+ * targetLanguage: 'example',
423
+ * agentId: 'example',
424
+ * success: () => {
425
+ * console.log('generateTranslateTask success');
426
+ * },
427
+ * fail: (error) => {
428
+ * console.log('generateTranslateTask fail', error.errorMsg);
429
+ * },
430
+ * });
431
+ * ```
135
432
  */
136
433
  export const generateTranslateTask = factory('generateTranslateTask', {
137
434
  namespace: 'ai'
@@ -139,6 +436,24 @@ export const generateTranslateTask = factory('generateTranslateTask', {
139
436
  /**
140
437
  * @public
141
438
  * @since @ray-js/ray 1.7.9
439
+ * @example 基础调用
440
+ * ```tsx
441
+ * import { ai } from '@ray-js/ray';
442
+ *
443
+ * const { privacyProtectDetectForVideo } = ai;
444
+ *
445
+ * privacyProtectDetectForVideo({
446
+ * inputVideoPath: 'example',
447
+ * outputVideoPath: 'example',
448
+ * musicPath: 'example',
449
+ * success: (result) => {
450
+ * console.log('privacyProtectDetectForVideo success', result);
451
+ * },
452
+ * fail: (error) => {
453
+ * console.log('privacyProtectDetectForVideo fail', error.errorMsg);
454
+ * },
455
+ * });
456
+ * ```
142
457
  */
143
458
  export const privacyProtectDetectForVideo = factory('privacyProtectDetectForVideo', {
144
459
  namespace: 'ai'
@@ -146,6 +461,27 @@ export const privacyProtectDetectForVideo = factory('privacyProtectDetectForVide
146
461
  /**
147
462
  * @public
148
463
  * @since @ray-js/ray 1.7.20
464
+ * @example 基础调用
465
+ * ```tsx
466
+ * import { ai } from '@ray-js/ray';
467
+ *
468
+ * const { petsPictureQualityDetectForImage } = ai;
469
+ *
470
+ * petsPictureQualityDetectForImage({
471
+ * inputImagePath: 'example',
472
+ * objectAreaPercent: 0,
473
+ * objectFaceRotationAngle: 0,
474
+ * objectFaceSideAngle: 0,
475
+ * maximumPictureBrightness: 0,
476
+ * minimumPictureBrightness: 0,
477
+ * success: (result) => {
478
+ * console.log('petsPictureQualityDetectForImage success', result);
479
+ * },
480
+ * fail: (error) => {
481
+ * console.log('petsPictureQualityDetectForImage fail', error.errorMsg);
482
+ * },
483
+ * });
484
+ * ```
149
485
  */
150
486
  export const petsPictureQualityDetectForImage = factory('petsPictureQualityDetectForImage', {
151
487
  namespace: 'ai'
@@ -153,6 +489,21 @@ export const petsPictureQualityDetectForImage = factory('petsPictureQualityDetec
153
489
  /**
154
490
  * @public
155
491
  * @since @ray-js/ray 1.7.20
492
+ * @example 基础调用
493
+ * ```tsx
494
+ * import { ai } from '@ray-js/ray';
495
+ *
496
+ * const { petsDetectCreate } = ai;
497
+ *
498
+ * petsDetectCreate({
499
+ * success: () => {
500
+ * console.log('petsDetectCreate success');
501
+ * },
502
+ * fail: (error) => {
503
+ * console.log('petsDetectCreate fail', error.errorMsg);
504
+ * },
505
+ * });
506
+ * ```
156
507
  */
157
508
  export const petsDetectCreate = factory('petsDetectCreate', {
158
509
  namespace: 'ai'
@@ -160,6 +511,21 @@ export const petsDetectCreate = factory('petsDetectCreate', {
160
511
  /**
161
512
  * @public
162
513
  * @since @ray-js/ray 1.7.20
514
+ * @example 基础调用
515
+ * ```tsx
516
+ * import { ai } from '@ray-js/ray';
517
+ *
518
+ * const { petsDetectDestory } = ai;
519
+ *
520
+ * petsDetectDestory({
521
+ * success: () => {
522
+ * console.log('petsDetectDestory success');
523
+ * },
524
+ * fail: (error) => {
525
+ * console.log('petsDetectDestory fail', error.errorMsg);
526
+ * },
527
+ * });
528
+ * ```
163
529
  */
164
530
  export const petsDetectDestory = factory('petsDetectDestory', {
165
531
  namespace: 'ai'
@@ -167,6 +533,21 @@ export const petsDetectDestory = factory('petsDetectDestory', {
167
533
  /**
168
534
  * @public
169
535
  * @since @ray-js/ray 1.7.27
536
+ * @example 基础调用
537
+ * ```tsx
538
+ * import { ai } from '@ray-js/ray';
539
+ *
540
+ * const { createForegroundVideoService } = ai;
541
+ *
542
+ * createForegroundVideoService({
543
+ * success: () => {
544
+ * console.log('createForegroundVideoService success');
545
+ * },
546
+ * fail: (error) => {
547
+ * console.log('createForegroundVideoService fail', error.errorMsg);
548
+ * },
549
+ * });
550
+ * ```
170
551
  */
171
552
  export const createForegroundVideoService = factory('createForegroundVideoService', {
172
553
  namespace: 'ai'
@@ -174,6 +555,21 @@ export const createForegroundVideoService = factory('createForegroundVideoServic
174
555
  /**
175
556
  * @public
176
557
  * @since @ray-js/ray 1.7.27
558
+ * @example 基础调用
559
+ * ```tsx
560
+ * import { ai } from '@ray-js/ray';
561
+ *
562
+ * const { destroyForegroundVideoService } = ai;
563
+ *
564
+ * destroyForegroundVideoService({
565
+ * success: () => {
566
+ * console.log('destroyForegroundVideoService success');
567
+ * },
568
+ * fail: (error) => {
569
+ * console.log('destroyForegroundVideoService fail', error.errorMsg);
570
+ * },
571
+ * });
572
+ * ```
177
573
  */
178
574
  export const destroyForegroundVideoService = factory('destroyForegroundVideoService', {
179
575
  namespace: 'ai'
@@ -181,6 +577,23 @@ export const destroyForegroundVideoService = factory('destroyForegroundVideoServ
181
577
  /**
182
578
  * @public
183
579
  * @since @ray-js/ray 1.7.27
580
+ * @example 基础调用
581
+ * ```tsx
582
+ * import { ai } from '@ray-js/ray';
583
+ *
584
+ * const { processForegroundMediaByTemplate } = ai;
585
+ *
586
+ * processForegroundMediaByTemplate({
587
+ * templateObject: { type: 'example', effect: { code: 'example', name: 'example', ouputDuration: 0, outputDuration: 0, image: 'example', resource: 'example' } },
588
+ * mediaSource: 'example',
589
+ * success: (result) => {
590
+ * console.log('processForegroundMediaByTemplate success', result);
591
+ * },
592
+ * fail: (error) => {
593
+ * console.log('processForegroundMediaByTemplate fail', error.errorMsg);
594
+ * },
595
+ * });
596
+ * ```
184
597
  */
185
598
  export const processForegroundMediaByTemplate = factory('processForegroundMediaByTemplate', {
186
599
  namespace: 'ai'
@@ -188,6 +601,23 @@ export const processForegroundMediaByTemplate = factory('processForegroundMediaB
188
601
  /**
189
602
  * @public
190
603
  * @since @ray-js/ray 1.7.27
604
+ * @example 基础调用
605
+ * ```tsx
606
+ * import { ai } from '@ray-js/ray';
607
+ *
608
+ * const { processPetForegroundMediaByTemplate } = ai;
609
+ *
610
+ * processPetForegroundMediaByTemplate({
611
+ * templateObject: { type: 'example', effect: { code: 'example', name: 'example', ouputDuration: 0, outputDuration: 0, image: 'example', resource: 'example' } },
612
+ * mediaSource: 'example',
613
+ * success: (result) => {
614
+ * console.log('processPetForegroundMediaByTemplate success', result);
615
+ * },
616
+ * fail: (error) => {
617
+ * console.log('processPetForegroundMediaByTemplate fail', error.errorMsg);
618
+ * },
619
+ * });
620
+ * ```
191
621
  */
192
622
  export const processPetForegroundMediaByTemplate = factory('processPetForegroundMediaByTemplate', {
193
623
  namespace: 'ai'
@@ -195,6 +625,24 @@ export const processPetForegroundMediaByTemplate = factory('processPetForeground
195
625
  /**
196
626
  * @public
197
627
  * @since @ray-js/ray 1.7.37
628
+ * @example 基础调用
629
+ * ```tsx
630
+ * import { ai } from '@ray-js/ray';
631
+ *
632
+ * const { imageEnhanceCreate } = ai;
633
+ *
634
+ * imageEnhanceCreate({
635
+ * trace_id: 'example',
636
+ * device_id: 'device_001',
637
+ * scene_type: 'example',
638
+ * success: () => {
639
+ * console.log('imageEnhanceCreate success');
640
+ * },
641
+ * fail: (error) => {
642
+ * console.log('imageEnhanceCreate fail', error.errorMsg);
643
+ * },
644
+ * });
645
+ * ```
198
646
  */
199
647
  export const imageEnhanceCreate = factory('imageEnhanceCreate', {
200
648
  namespace: 'ai'
@@ -202,6 +650,24 @@ export const imageEnhanceCreate = factory('imageEnhanceCreate', {
202
650
  /**
203
651
  * @public
204
652
  * @since @ray-js/ray 1.7.37
653
+ * @example 基础调用
654
+ * ```tsx
655
+ * import { ai } from '@ray-js/ray';
656
+ *
657
+ * const { imageEnhanceDestroy } = ai;
658
+ *
659
+ * imageEnhanceDestroy({
660
+ * trace_id: 'example',
661
+ * device_id: 'device_001',
662
+ * scene_type: 'example',
663
+ * success: () => {
664
+ * console.log('imageEnhanceDestroy success');
665
+ * },
666
+ * fail: (error) => {
667
+ * console.log('imageEnhanceDestroy fail', error.errorMsg);
668
+ * },
669
+ * });
670
+ * ```
205
671
  */
206
672
  export const imageEnhanceDestroy = factory('imageEnhanceDestroy', {
207
673
  namespace: 'ai'
@@ -209,6 +675,27 @@ export const imageEnhanceDestroy = factory('imageEnhanceDestroy', {
209
675
  /**
210
676
  * @public
211
677
  * @since @ray-js/ray 1.7.37
678
+ * @example 基础调用
679
+ * ```tsx
680
+ * import { ai } from '@ray-js/ray';
681
+ *
682
+ * const { enhanceClarityForImage } = ai;
683
+ *
684
+ * enhanceClarityForImage({
685
+ * trace_id: 'example',
686
+ * device_id: 'device_001',
687
+ * scene_type: 'example',
688
+ * devId: 'device_001',
689
+ * inputImagePath: 'example',
690
+ * outputImagePath: 'example',
691
+ * success: (result) => {
692
+ * console.log('enhanceClarityForImage success', result);
693
+ * },
694
+ * fail: (error) => {
695
+ * console.log('enhanceClarityForImage fail', error.errorMsg);
696
+ * },
697
+ * });
698
+ * ```
212
699
  */
213
700
  export const enhanceClarityForImage = factory('enhanceClarityForImage', {
214
701
  namespace: 'ai'
@@ -216,6 +703,24 @@ export const enhanceClarityForImage = factory('enhanceClarityForImage', {
216
703
  /**
217
704
  * @public
218
705
  * @since @ray-js/ray 1.7.37
706
+ * @example 基础调用
707
+ * ```tsx
708
+ * import { ai } from '@ray-js/ray';
709
+ *
710
+ * const { enhanceClarityCancel } = ai;
711
+ *
712
+ * enhanceClarityCancel({
713
+ * trace_id: 'example',
714
+ * device_id: 'device_001',
715
+ * scene_type: 'example',
716
+ * success: () => {
717
+ * console.log('enhanceClarityCancel success');
718
+ * },
719
+ * fail: (error) => {
720
+ * console.log('enhanceClarityCancel fail', error.errorMsg);
721
+ * },
722
+ * });
723
+ * ```
219
724
  */
220
725
  export const enhanceClarityCancel = factory('enhanceClarityCancel', {
221
726
  namespace: 'ai'
@@ -223,6 +728,16 @@ export const enhanceClarityCancel = factory('enhanceClarityCancel', {
223
728
  /**
224
729
  * @public
225
730
  * @since @ray-js/ray 1.7.37
731
+ * @example 基础调用
732
+ * ```tsx
733
+ * import { ai } from '@ray-js/ray';
734
+ *
735
+ * const { onEnhanceClarityProgress } = ai;
736
+ *
737
+ * onEnhanceClarityProgress((result) => {
738
+ * console.log('onEnhanceClarityProgress', result);
739
+ * });
740
+ * ```
226
741
  */
227
742
  export const onEnhanceClarityProgress = factory('onEnhanceClarityProgress', {
228
743
  namespace: 'ai'
@@ -230,6 +745,16 @@ export const onEnhanceClarityProgress = factory('onEnhanceClarityProgress', {
230
745
  /**
231
746
  * @public
232
747
  * @since @ray-js/ray 1.7.37
748
+ * @example 基础调用
749
+ * ```tsx
750
+ * import { ai } from '@ray-js/ray';
751
+ *
752
+ * const { offEnhanceClarityProgress } = ai;
753
+ *
754
+ * offEnhanceClarityProgress((result) => {
755
+ * console.log('offEnhanceClarityProgress', result);
756
+ * });
757
+ * ```
233
758
  */
234
759
  export const offEnhanceClarityProgress = factory('offEnhanceClarityProgress', {
235
760
  namespace: 'ai'
@@ -237,6 +762,36 @@ export const offEnhanceClarityProgress = factory('offEnhanceClarityProgress', {
237
762
  /**
238
763
  * @public
239
764
  * @since @ray-js/ray 1.7.37
765
+ * @example 基础调用
766
+ * ```tsx
767
+ * import { ai } from '@ray-js/ray';
768
+ *
769
+ * const { enhanceCalibrationForImage } = ai;
770
+ *
771
+ * enhanceCalibrationForImage({
772
+ * trace_id: 'example',
773
+ * device_id: 'device_001',
774
+ * scene_type: 'example',
775
+ * inputImagePath: 'example',
776
+ * outputImagePath: 'example',
777
+ * ratio: 0,
778
+ * fCx: 0,
779
+ * fCy: 0,
780
+ * fFx: 0,
781
+ * fFy: 0,
782
+ * fK1: 0,
783
+ * fK2: 0,
784
+ * fK3: 0,
785
+ * fP1: 0,
786
+ * fP2: 0,
787
+ * success: (result) => {
788
+ * console.log('enhanceCalibrationForImage success', result);
789
+ * },
790
+ * fail: (error) => {
791
+ * console.log('enhanceCalibrationForImage fail', error.errorMsg);
792
+ * },
793
+ * });
794
+ * ```
240
795
  */
241
796
  export const enhanceCalibrationForImage = factory('enhanceCalibrationForImage', {
242
797
  namespace: 'ai'
@@ -244,6 +799,21 @@ export const enhanceCalibrationForImage = factory('enhanceCalibrationForImage',
244
799
  /**
245
800
  * @public
246
801
  * @since @ray-js/ray 1.7.37
802
+ * @example 基础调用
803
+ * ```tsx
804
+ * import { ai } from '@ray-js/ray';
805
+ *
806
+ * const { enhanceCalibrationCancel } = ai;
807
+ *
808
+ * enhanceCalibrationCancel({
809
+ * success: () => {
810
+ * console.log('enhanceCalibrationCancel success');
811
+ * },
812
+ * fail: (error) => {
813
+ * console.log('enhanceCalibrationCancel fail', error.errorMsg);
814
+ * },
815
+ * });
816
+ * ```
247
817
  */
248
818
  export const enhanceCalibrationCancel = factory('enhanceCalibrationCancel', {
249
819
  namespace: 'ai'
@@ -251,6 +821,21 @@ export const enhanceCalibrationCancel = factory('enhanceCalibrationCancel', {
251
821
  /**
252
822
  * @public
253
823
  * @since @ray-js/ray 1.7.43
824
+ * @example 基础调用
825
+ * ```tsx
826
+ * import { ai } from '@ray-js/ray';
827
+ *
828
+ * const { oralDiseaseInit } = ai;
829
+ *
830
+ * oralDiseaseInit({
831
+ * success: () => {
832
+ * console.log('oralDiseaseInit success');
833
+ * },
834
+ * fail: (error) => {
835
+ * console.log('oralDiseaseInit fail', error.errorMsg);
836
+ * },
837
+ * });
838
+ * ```
254
839
  */
255
840
  export const oralDiseaseInit = factory('oralDiseaseInit', {
256
841
  namespace: 'ai'
@@ -258,6 +843,16 @@ export const oralDiseaseInit = factory('oralDiseaseInit', {
258
843
  /**
259
844
  * @public
260
845
  * @since @ray-js/ray 1.7.43
846
+ * @example 基础调用
847
+ * ```tsx
848
+ * import { ai } from '@ray-js/ray';
849
+ *
850
+ * const { onOralModelDownProgress } = ai;
851
+ *
852
+ * onOralModelDownProgress((result) => {
853
+ * console.log('onOralModelDownProgress', result);
854
+ * });
855
+ * ```
261
856
  */
262
857
  export const onOralModelDownProgress = factory('onOralModelDownProgress', {
263
858
  namespace: 'ai'
@@ -265,6 +860,16 @@ export const onOralModelDownProgress = factory('onOralModelDownProgress', {
265
860
  /**
266
861
  * @public
267
862
  * @since @ray-js/ray 1.7.43
863
+ * @example 基础调用
864
+ * ```tsx
865
+ * import { ai } from '@ray-js/ray';
866
+ *
867
+ * const { offOralModelDownProgress } = ai;
868
+ *
869
+ * offOralModelDownProgress((result) => {
870
+ * console.log('offOralModelDownProgress', result);
871
+ * });
872
+ * ```
268
873
  */
269
874
  export const offOralModelDownProgress = factory('offOralModelDownProgress', {
270
875
  namespace: 'ai'
@@ -272,6 +877,24 @@ export const offOralModelDownProgress = factory('offOralModelDownProgress', {
272
877
  /**
273
878
  * @public
274
879
  * @since @ray-js/ray 1.7.43
880
+ * @example 基础调用
881
+ * ```tsx
882
+ * import { ai } from '@ray-js/ray';
883
+ *
884
+ * const { oralDiseasePredictionRun } = ai;
885
+ *
886
+ * oralDiseasePredictionRun({
887
+ * devId: 'device_001',
888
+ * inputImagePath: 'example',
889
+ * outImagePath: 'example',
890
+ * success: (result) => {
891
+ * console.log('oralDiseasePredictionRun success', result);
892
+ * },
893
+ * fail: (error) => {
894
+ * console.log('oralDiseasePredictionRun fail', error.errorMsg);
895
+ * },
896
+ * });
897
+ * ```
275
898
  */
276
899
  export const oralDiseasePredictionRun = factory('oralDiseasePredictionRun', {
277
900
  namespace: 'ai'
@@ -280,6 +903,21 @@ export const oralDiseasePredictionRun = factory('oralDiseasePredictionRun', {
280
903
  /**
281
904
  * @public
282
905
  * @since @ray-js/ray 1.7.60
906
+ * @example 基础调用
907
+ * ```tsx
908
+ * import { ai } from '@ray-js/ray';
909
+ *
910
+ * const { pixelImageInit } = ai;
911
+ *
912
+ * pixelImageInit({
913
+ * success: () => {
914
+ * console.log('pixelImageInit success');
915
+ * },
916
+ * fail: (error) => {
917
+ * console.log('pixelImageInit fail', error.errorMsg);
918
+ * },
919
+ * });
920
+ * ```
283
921
  */
284
922
  export const pixelImageInit = factory('pixelImageInit', {
285
923
  namespace: 'ai'
@@ -287,6 +925,21 @@ export const pixelImageInit = factory('pixelImageInit', {
287
925
  /**
288
926
  * @public
289
927
  * @since @ray-js/ray 1.7.60
928
+ * @example 基础调用
929
+ * ```tsx
930
+ * import { ai } from '@ray-js/ray';
931
+ *
932
+ * const { fetchPixelImageCategoryInfo } = ai;
933
+ *
934
+ * fetchPixelImageCategoryInfo({
935
+ * success: (result) => {
936
+ * console.log('fetchPixelImageCategoryInfo success', result);
937
+ * },
938
+ * fail: (error) => {
939
+ * console.log('fetchPixelImageCategoryInfo fail', error.errorMsg);
940
+ * },
941
+ * });
942
+ * ```
290
943
  */
291
944
  export const fetchPixelImageCategoryInfo = factory('fetchPixelImageCategoryInfo', {
292
945
  namespace: 'ai'
@@ -294,6 +947,26 @@ export const fetchPixelImageCategoryInfo = factory('fetchPixelImageCategoryInfo'
294
947
  /**
295
948
  * @public
296
949
  * @since @ray-js/ray 1.7.60
950
+ * @example 基础调用
951
+ * ```tsx
952
+ * import { ai } from '@ray-js/ray';
953
+ *
954
+ * const { generationPixelImage } = ai;
955
+ *
956
+ * generationPixelImage({
957
+ * deviceId: 'device_001',
958
+ * label: 'example',
959
+ * imageWidth: 0,
960
+ * imageHeight: 0,
961
+ * outImagePath: 'example',
962
+ * success: (result) => {
963
+ * console.log('generationPixelImage success', result);
964
+ * },
965
+ * fail: (error) => {
966
+ * console.log('generationPixelImage fail', error.errorMsg);
967
+ * },
968
+ * });
969
+ * ```
297
970
  */
298
971
  export const generationPixelImage = factory('generationPixelImage', {
299
972
  namespace: 'ai'
@@ -301,6 +974,27 @@ export const generationPixelImage = factory('generationPixelImage', {
301
974
  /**
302
975
  * @public
303
976
  * @since @ray-js/ray 1.7.60
977
+ * @example 基础调用
978
+ * ```tsx
979
+ * import { ai } from '@ray-js/ray';
980
+ *
981
+ * const { generationPixeGifImage } = ai;
982
+ *
983
+ * generationPixeGifImage({
984
+ * deviceId: 'device_001',
985
+ * imageWidth: 0,
986
+ * imageHeight: 0,
987
+ * imagePath: 'example',
988
+ * animType: 'example',
989
+ * outImagePath: 'example',
990
+ * success: (result) => {
991
+ * console.log('generationPixeGifImage success', result);
992
+ * },
993
+ * fail: (error) => {
994
+ * console.log('generationPixeGifImage fail', error.errorMsg);
995
+ * },
996
+ * });
997
+ * ```
304
998
  */
305
999
  export const generationPixeGifImage = factory('generationPixeGifImage', {
306
1000
  namespace: 'ai'
@@ -308,6 +1002,24 @@ export const generationPixeGifImage = factory('generationPixeGifImage', {
308
1002
  /**
309
1003
  * @public
310
1004
  * @since @ray-js/ray 1.7.60
1005
+ * @example 基础调用
1006
+ * ```tsx
1007
+ * import { ai } from '@ray-js/ray';
1008
+ *
1009
+ * const { predictLightScenes } = ai;
1010
+ *
1011
+ * predictLightScenes({
1012
+ * roomId: 0,
1013
+ * generateSceneStyles: [{ name: 'example' }],
1014
+ * sceneType: 0,
1015
+ * success: (result) => {
1016
+ * console.log('predictLightScenes success', result);
1017
+ * },
1018
+ * fail: (error) => {
1019
+ * console.log('predictLightScenes fail', error.errorMsg);
1020
+ * },
1021
+ * });
1022
+ * ```
311
1023
  */
312
1024
  export const predictLightScenes = factory('predictLightScenes', {
313
1025
  namespace: 'ai'
@@ -315,6 +1027,16 @@ export const predictLightScenes = factory('predictLightScenes', {
315
1027
  /**
316
1028
  * @public
317
1029
  * @since @ray-js/ray 1.7.60
1030
+ * @example 基础调用
1031
+ * ```tsx
1032
+ * import { ai } from '@ray-js/ray';
1033
+ *
1034
+ * const { onPixelImageInitProgressEvent } = ai;
1035
+ *
1036
+ * onPixelImageInitProgressEvent((result) => {
1037
+ * console.log('onPixelImageInitProgressEvent', result);
1038
+ * });
1039
+ * ```
318
1040
  */
319
1041
  export const onPixelImageInitProgressEvent = factory('onPixelImageInitProgressEvent', {
320
1042
  namespace: 'ai'
@@ -322,58 +1044,17 @@ export const onPixelImageInitProgressEvent = factory('onPixelImageInitProgressEv
322
1044
  /**
323
1045
  * @public
324
1046
  * @since @ray-js/ray 1.7.60
1047
+ * @example 基础调用
1048
+ * ```tsx
1049
+ * import { ai } from '@ray-js/ray';
1050
+ *
1051
+ * const { offPixelImageInitProgressEvent } = ai;
1052
+ *
1053
+ * offPixelImageInitProgressEvent((result) => {
1054
+ * console.log('offPixelImageInitProgressEvent', result);
1055
+ * });
1056
+ * ```
325
1057
  */
326
1058
  export const offPixelImageInitProgressEvent = factory('offPixelImageInitProgressEvent', {
327
1059
  namespace: 'ai'
328
- });
329
-
330
- // TranslateContext 子方法导出
331
- /**
332
- * @public
333
- * @alias TranslateContext.startSpeak
334
- */
335
- export const translateContextStartSpeak = factory('generateTranslateTask', {
336
- namespace: 'ai'
337
- });
338
- /**
339
- * @public
340
- * @alias TranslateContext.stopSpeak
341
- */
342
- export const translateContextStopSpeak = factory('generateTranslateTask', {
343
- namespace: 'ai'
344
- });
345
- /**
346
- * @public
347
- * @alias TranslateContext.dispose
348
- */
349
- export const translateContextDispose = factory('generateTranslateTask', {
350
- namespace: 'ai'
351
- });
352
- /**
353
- * @public
354
- * @alias TranslateContext.onTranslateError
355
- */
356
- export const translateContextOnTranslateError = factory('generateTranslateTask', {
357
- namespace: 'ai'
358
- });
359
- /**
360
- * @public
361
- * @alias TranslateContext.offTranslateError
362
- */
363
- export const translateContextOffTranslateError = factory('generateTranslateTask', {
364
- namespace: 'ai'
365
- });
366
- /**
367
- * @public
368
- * @alias TranslateContext.onTranslateRealTimeStatusUpdate
369
- */
370
- export const translateContextOnTranslateRealTimeStatusUpdate = factory('generateTranslateTask', {
371
- namespace: 'ai'
372
- });
373
- /**
374
- * @public
375
- * @alias TranslateContext.offTranslateRealTimeStatusUpdate
376
- */
377
- export const translateContextOffTranslateRealTimeStatusUpdate = factory('generateTranslateTask', {
378
- namespace: 'ai'
379
1060
  });