@byteplus/react-native-live-push 1.5.1-rc.1 → 1.5.1-rc.3

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 (54) hide show
  1. package/ios/RCTVeLivePush/RCTVeLivePush.mm +1 -1
  2. package/ios/VeLiveMixerView.m +5 -15
  3. package/lib/commonjs/typescript/codegen/android/api.d.ts +869 -93
  4. package/lib/commonjs/typescript/codegen/android/callback.d.ts +243 -31
  5. package/lib/commonjs/typescript/codegen/android/errorcode.d.ts +60 -15
  6. package/lib/commonjs/typescript/codegen/android/keytype.d.ts +1173 -219
  7. package/lib/commonjs/typescript/codegen/ios/api.d.ts +899 -102
  8. package/lib/commonjs/typescript/codegen/ios/callback.d.ts +162 -28
  9. package/lib/commonjs/typescript/codegen/ios/errorcode.d.ts +100 -25
  10. package/lib/commonjs/typescript/codegen/ios/keytype.d.ts +692 -180
  11. package/lib/commonjs/typescript/codegen/pack/api.d.ts +1180 -133
  12. package/lib/commonjs/typescript/codegen/pack/callback.d.ts +243 -35
  13. package/lib/commonjs/typescript/codegen/pack/errorcode.d.ts +69 -16
  14. package/lib/commonjs/typescript/codegen/pack/keytype.d.ts +1459 -270
  15. package/lib/commonjs/typescript/core/api.d.ts +8 -1
  16. package/lib/commonjs/typescript/core/effect.d.ts +5 -1
  17. package/lib/commonjs/typescript/core/logger.d.ts +1 -0
  18. package/lib/commonjs/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  19. package/lib/commonjs/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  20. package/lib/module/typescript/codegen/android/api.d.ts +869 -93
  21. package/lib/module/typescript/codegen/android/callback.d.ts +243 -31
  22. package/lib/module/typescript/codegen/android/errorcode.d.ts +60 -15
  23. package/lib/module/typescript/codegen/android/keytype.d.ts +1173 -219
  24. package/lib/module/typescript/codegen/ios/api.d.ts +899 -102
  25. package/lib/module/typescript/codegen/ios/callback.d.ts +162 -28
  26. package/lib/module/typescript/codegen/ios/errorcode.d.ts +100 -25
  27. package/lib/module/typescript/codegen/ios/keytype.d.ts +692 -180
  28. package/lib/module/typescript/codegen/pack/api.d.ts +1180 -133
  29. package/lib/module/typescript/codegen/pack/callback.d.ts +243 -35
  30. package/lib/module/typescript/codegen/pack/errorcode.d.ts +69 -16
  31. package/lib/module/typescript/codegen/pack/keytype.d.ts +1459 -270
  32. package/lib/module/typescript/core/api.d.ts +8 -1
  33. package/lib/module/typescript/core/effect.d.ts +5 -1
  34. package/lib/module/typescript/core/logger.d.ts +1 -0
  35. package/lib/module/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  36. package/lib/module/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  37. package/lib/typescript/codegen/android/api.d.ts +869 -93
  38. package/lib/typescript/codegen/android/callback.d.ts +243 -31
  39. package/lib/typescript/codegen/android/errorcode.d.ts +60 -15
  40. package/lib/typescript/codegen/android/keytype.d.ts +1173 -219
  41. package/lib/typescript/codegen/ios/api.d.ts +899 -102
  42. package/lib/typescript/codegen/ios/callback.d.ts +162 -28
  43. package/lib/typescript/codegen/ios/errorcode.d.ts +100 -25
  44. package/lib/typescript/codegen/ios/keytype.d.ts +692 -180
  45. package/lib/typescript/codegen/pack/api.d.ts +1180 -133
  46. package/lib/typescript/codegen/pack/callback.d.ts +243 -35
  47. package/lib/typescript/codegen/pack/errorcode.d.ts +69 -16
  48. package/lib/typescript/codegen/pack/keytype.d.ts +1459 -270
  49. package/lib/typescript/core/api.d.ts +8 -1
  50. package/lib/typescript/core/effect.d.ts +5 -1
  51. package/lib/typescript/core/logger.d.ts +1 -0
  52. package/lib/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  53. package/lib/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  54. package/package.json +1 -1
@@ -1,11 +1,21 @@
1
1
  import * as $p_a from '../android/index';
2
2
  import * as $p_i from '../ios/index';
3
-
3
+ /** {zh}
4
+ * @detail keytype
5
+ * @brief 推流本地文件录制配置。
6
+ *
7
+ */
4
8
  export declare class VeLiveFileRecorderConfiguration {
5
9
  protected _instance: any;
6
10
  protected __init(...args: any[]): void;
7
11
  protected __new_instance(...args: any[]): any;
8
-
12
+ /** {zh}
13
+ * @detail api
14
+ * @brief 设置录制视频宽度。
15
+ * @param width 录制视频宽度,默认值为 360
16
+ * @return 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
17
+ *
18
+ */
9
19
  /** {en}
10
20
  * @detail api
11
21
  * @brief Sets the width of the recorded video.
@@ -14,7 +24,13 @@ export declare class VeLiveFileRecorderConfiguration {
14
24
  *
15
25
  */
16
26
  setWidth(width: number): void;
17
-
27
+ /** {zh}
28
+ * @detail api
29
+ * @brief 设置录制视频高度。
30
+ * @param height 录制视频宽度,默认值为 640。
31
+ * @return 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。<br/>
32
+ *
33
+ */
18
34
  /** {en}
19
35
  * @detail api
20
36
  * @brief Sets the height of the recorded video.
@@ -23,7 +39,14 @@ export declare class VeLiveFileRecorderConfiguration {
23
39
  *
24
40
  */
25
41
  setHeight(height: number): void;
26
-
42
+ /** {zh}
43
+ * @detail api
44
+ * @brief 设置录制视频码率。
45
+ * @param bitrate 录制视频码率,单位为 kbps,默认值为 2000。
46
+ * @return
47
+ * 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
48
+ *
49
+ */
27
50
  /** {en}
28
51
  * @detail api
29
52
  * @brief Sets the bitrate of the recorded video.
@@ -32,7 +55,13 @@ export declare class VeLiveFileRecorderConfiguration {
32
55
  *
33
56
  */
34
57
  setBitrate(bitrate: number): void;
35
-
58
+ /** {zh}
59
+ * @detail api
60
+ * @brief 设置录制视频帧率。
61
+ * @param fps 录制视频帧率,默认值为 15。
62
+ * @return 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
63
+ *
64
+ */
36
65
  /** {en}
37
66
  * @detail api
38
67
  * @brief Sets the frame rate of the recorded video.
@@ -41,7 +70,14 @@ export declare class VeLiveFileRecorderConfiguration {
41
70
  *
42
71
  */
43
72
  setFps(fps: number): void;
44
-
73
+ /** {zh}
74
+ * @platform android
75
+ * @detail api
76
+ * @brief 获取录制视频宽度。
77
+ * @return <br>
78
+ * 录制视频宽度。
79
+ *
80
+ */
45
81
  /** {en}
46
82
  * @platform android
47
83
  * @detail api
@@ -50,7 +86,14 @@ export declare class VeLiveFileRecorderConfiguration {
50
86
  *
51
87
  */
52
88
  android_getWidth(): number;
53
-
89
+ /** {zh}
90
+ * @platform android
91
+ * @detail api
92
+ * @brief 获取录制视频高度。
93
+ * @return <br>
94
+ * 录制视频高度。
95
+ *
96
+ */
54
97
  /** {en}
55
98
  * @platform android
56
99
  * @detail api
@@ -59,7 +102,14 @@ export declare class VeLiveFileRecorderConfiguration {
59
102
  *
60
103
  */
61
104
  android_getHeight(): number;
62
-
105
+ /** {zh}
106
+ * @platform android
107
+ * @detail api
108
+ * @brief 获取录制视频帧率。
109
+ * @return <br>
110
+ * 录制视频帧率。
111
+ *
112
+ */
63
113
  /** {en}
64
114
  * @platform android
65
115
  * @detail api
@@ -68,7 +118,14 @@ export declare class VeLiveFileRecorderConfiguration {
68
118
  *
69
119
  */
70
120
  android_getFps(): number;
71
-
121
+ /** {zh}
122
+ * @platform android
123
+ * @detail api
124
+ * @brief 获取录制视频码率。
125
+ * @return <br>
126
+ * 录制视频码率。
127
+ *
128
+ */
72
129
  /** {en}
73
130
  * @platform android
74
131
  * @detail api
@@ -78,10 +135,22 @@ export declare class VeLiveFileRecorderConfiguration {
78
135
  */
79
136
  android_getBitrate(): number;
80
137
  }
81
-
138
+ /** {zh}
139
+ * @detail keytype
140
+ * @brief 视频采集配置。
141
+ *
142
+ */
82
143
  export declare class VeLiveVideoCaptureConfiguration {
83
144
  protected _instance: any;
84
-
145
+ /** {zh}
146
+ * @platform ios
147
+ * @brief 视频采集帧类型,默认为 kCVPixelFormatType_420YpCbCr8BiPlanarFullRange。
148
+ * @note 支持以下视频帧类型:
149
+ * - kCVPixelFormatType_32BGRA
150
+ * - kCVPixelFormatType_420YpCbCr8BiPlanarFullRange
151
+ * - kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange
152
+ * - kCVPixelFormatType_420YpCbCr10BiPlanarVideoRange
153
+ */
85
154
  /** {en}
86
155
  * @platform ios
87
156
  * @brief The pixel format. The default format is kCVPixelFormatType_420YpCbCr8BiPlanarFullRange.
@@ -95,7 +164,13 @@ export declare class VeLiveVideoCaptureConfiguration {
95
164
  set pixelFormat(value: $p_i.OSType);
96
165
  protected __init(...args: any[]): void;
97
166
  protected __new_instance(...args: any[]): any;
98
-
167
+ /** {zh}
168
+ * @detail api
169
+ * @brief 设置采集视频宽度。
170
+ * @param width 采集视频宽度,默认值为 720。
171
+ * @return 推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
172
+ *
173
+ */
99
174
  /** {en}
100
175
  * @detail api
101
176
  * @brief Sets the width of the captured video.
@@ -104,7 +179,13 @@ export declare class VeLiveVideoCaptureConfiguration {
104
179
  *
105
180
  */
106
181
  setWidth(width: number): void;
107
-
182
+ /** {zh}
183
+ * @detail api
184
+ * @brief 设置采集视频高度。
185
+ * @param height 采集视频高度,默认值为 1280。
186
+ * @return 推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
187
+ *
188
+ */
108
189
  /** {en}
109
190
  * @detail api
110
191
  * @brief Sets the height of the captured video.
@@ -113,7 +194,13 @@ export declare class VeLiveVideoCaptureConfiguration {
113
194
  *
114
195
  */
115
196
  setHeight(height: number): void;
116
-
197
+ /** {zh}
198
+ * @detail api
199
+ * @brief 设置采集视频帧率。
200
+ * @param fps 采集视频帧率,默认值为 15。
201
+ * @return 推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
202
+ *
203
+ */
117
204
  /** {en}
118
205
  * @detail api
119
206
  * @brief Sets the captured frame rate.
@@ -122,7 +209,13 @@ export declare class VeLiveVideoCaptureConfiguration {
122
209
  *
123
210
  */
124
211
  setFps(fps: number): void;
125
-
212
+ /** {zh}
213
+ * @platform android
214
+ * @detail api
215
+ * @brief 获取采集视频宽度。
216
+ * @return 采集视频宽度。
217
+ *
218
+ */
126
219
  /** {en}
127
220
  * @platform android
128
221
  * @detail api
@@ -131,7 +224,14 @@ export declare class VeLiveVideoCaptureConfiguration {
131
224
  *
132
225
  */
133
226
  android_getWidth(): number;
134
-
227
+ /** {zh}
228
+ * @platform android
229
+ * @detail api
230
+ * @brief 获取采集视频高度。
231
+ * @return <br>
232
+ * 采集视频高度。
233
+ *
234
+ */
135
235
  /** {en}
136
236
  * @platform android
137
237
  * @detail api
@@ -141,7 +241,14 @@ export declare class VeLiveVideoCaptureConfiguration {
141
241
  *
142
242
  */
143
243
  android_getHeight(): number;
144
-
244
+ /** {zh}
245
+ * @platform android
246
+ * @detail api
247
+ * @brief 获取采集视频帧率。
248
+ * @return <br>
249
+ * 采集视频帧率。
250
+ *
251
+ */
145
252
  /** {en}
146
253
  * @platform android
147
254
  * @detail api
@@ -151,50 +258,82 @@ export declare class VeLiveVideoCaptureConfiguration {
151
258
  */
152
259
  android_getFps(): number;
153
260
  }
154
-
261
+ /** {zh}
262
+ * @detail keytype
263
+ * @brief 推流渲染模式。
264
+ *
265
+ */
155
266
  export declare enum VeLivePusherRenderMode {
156
-
267
+ /** {zh}
268
+ * @brief 视频帧自适应画布。视频帧非等比缩放,直至画布被填满。在此过程中,视频帧的长宽比例可能会发生变化。
269
+ *
270
+ */
157
271
  /** {en}
158
272
  * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
159
273
  *
160
274
  */
161
275
  VeLivePusherRenderModeFill = 0,
162
-
276
+ /** {zh}
277
+ * @brief 视频帧内容全部显示优先。视频尺寸等比缩放,优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时,会把窗口未被填满的区域填充成背景颜色。
278
+ *
279
+ */
163
280
  /** {en}
164
281
  * @brief Display the full video. The video is uniformly scaled until one dimension of the video hits the boundary of the screen. Any remaining space on the screen will be filled with background color.
165
282
  *
166
283
  */
167
284
  VeLivePusherRenderModeFit = 1,
168
-
285
+ /** {zh}
286
+ * @brief 视窗填满优先。视频帧等比缩放,直至视窗被视频填满。如果视频帧长宽比例与视窗不同,视频帧的多出部分将无法显示。
287
+ *
288
+ */
169
289
  /** {en}
170
290
  * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
171
291
  *
172
292
  */
173
293
  VeLivePusherRenderModeHidden = 2
174
294
  }
175
-
295
+ /** {zh}
296
+ * @detail keytype
297
+ * @brief 推流音频数据类型。
298
+ *
299
+ */
176
300
  export declare enum VeLiveAudioBufferType {
177
-
301
+ /** {zh}
302
+ * @brief 未知的音频数据类型。
303
+ *
304
+ */
178
305
  /** {en}
179
306
  * @brief Unknown data type.
180
307
  *
181
308
  */
182
309
  VeLiveAudioBufferTypeUnknown = 0,
183
-
310
+ /** {zh}
311
+ * @platform android
312
+ * @brief ByteBuffer 音频数据类型。
313
+ *
314
+ */
184
315
  /** {en}
185
316
  * @platform android
186
317
  * @brief ByteBuffer.
187
318
  *
188
319
  */
189
320
  VeLiveAudioBufferTypeByteBuffer = 1,
190
-
321
+ /** {zh}
322
+ * @platform ios
323
+ * @brief 音频数据类型为 CMSampleBufferRef。
324
+ *
325
+ */
191
326
  /** {en}
192
327
  * @platform ios
193
328
  * @brief CMSampleBufferRef.
194
329
  *
195
330
  */
196
331
  VeLiveAudioBufferTypeSampleBuffer = 2,
197
-
332
+ /** {zh}
333
+ * @platform ios
334
+ * @brief 音频数据类型为 NSData。
335
+ *
336
+ */
198
337
  /** {en}
199
338
  * @platform ios
200
339
  * @brief NSData.
@@ -202,138 +341,219 @@ export declare enum VeLiveAudioBufferType {
202
341
  */
203
342
  VeLiveAudioBufferTypeNSData = 3
204
343
  }
205
-
344
+ /** {zh}
345
+ * @detail keytype
346
+ * @brief 视频采集类型。
347
+ *
348
+ */
206
349
  export declare enum VeLiveVideoCaptureType {
207
-
350
+ /** {zh}
351
+ * @brief 使用前置摄像头进行视频采集。
352
+ *
353
+ */
208
354
  /** {en}
209
355
  * @brief Capture the video with the front-facing camera.
210
356
  *
211
357
  */
212
358
  VeLiveVideoCaptureFrontCamera = 0,
213
-
359
+ /** {zh}
360
+ * @brief 使用后置摄像头进行视频采集。
361
+ *
362
+ */
214
363
  /** {en}
215
364
  * @brief Capture the video with the rear camera.
216
365
  *
217
366
  */
218
367
  VeLiveVideoCaptureBackCamera = 1,
219
-
368
+ /** {zh}
369
+ * @brief 使用设备的双摄进行视频采集。
370
+ *
371
+ */
220
372
  /** {en}
221
373
  * @brief Capture the video with dual cameras.
222
374
  *
223
375
  */
224
-
376
+ /** {zh}
377
+ * @platform android
378
+ * @brief 使用屏幕采集。
379
+ *
380
+ */
225
381
  /** {en}
226
382
  * @platform android
227
383
  * @brief Capture the screen.
228
384
  *
229
385
  */
230
386
  VeLiveVideoCaptureScreen = 2,
231
-
387
+ /** {zh}
388
+ * @brief 使用外部设备或源进行视频采集。
389
+ *
390
+ */
232
391
  /** {en}
233
392
  * @brief Capture the video with an external device or source.
234
393
  *
235
394
  */
236
395
  VeLiveVideoCaptureExternal = 3,
237
-
396
+ /** {zh}
397
+ * @brief 使用指定的静态图片作为视频源。
398
+ *
399
+ */
238
400
  /** {en}
239
401
  * @brief Use a static image as the video source.
240
402
  *
241
403
  */
242
404
  VeLiveVideoCaptureCustomImage = 4,
243
-
405
+ /** {zh}
406
+ * @brief 使用最近采集的一帧图像重复作为视频源。
407
+ *
408
+ */
244
409
  /** {en}
245
410
  * @brief Use the last frame as the video source.
246
411
  *
247
412
  */
248
413
  VeLiveVideoCaptureLastFrame = 5,
249
-
414
+ /** {zh}
415
+ * @brief 使用黑色帧作为视频源,一般用于调试或特殊需求。
416
+ *
417
+ */
250
418
  /** {en}
251
419
  * @brief Use a black frame as the video source. This is usually used for debugging purposes or in special circumstances.
252
420
  *
253
421
  */
254
422
  VeLiveVideoCaptureDummyFrame = 6
255
423
  }
256
-
424
+ /** {zh}
425
+ * @detail keytype
426
+ * @brief 视频帧旋转角度。以 App 方向为旋转参考系。
427
+ *
428
+ */
257
429
  export declare enum VeLiveVideoRotation {
258
-
430
+ /** {zh}
431
+ * @brief 不旋转。
432
+ *
433
+ */
259
434
  /** {en}
260
435
  * @brief Do not rotate.
261
436
  *
262
437
  */
263
438
  VeLiveVideoRotation0 = 0,
264
-
439
+ /** {zh}
440
+ * @brief 顺时针旋转 90 度。
441
+ *
442
+ */
265
443
  /** {en}
266
444
  * @brief Rotate by 90 degrees clockwise.
267
445
  *
268
446
  */
269
447
  VeLiveVideoRotation90 = 1,
270
-
448
+ /** {zh}
449
+ * @brief 顺时针旋转 180 度。
450
+ *
451
+ */
271
452
  /** {en}
272
453
  * @brief Rotate by 180 degrees clockwise.
273
454
  *
274
455
  */
275
456
  VeLiveVideoRotation180 = 2,
276
-
457
+ /** {zh}
458
+ * @brief 顺时针旋转 270 度。
459
+ *
460
+ */
277
461
  /** {en}
278
462
  * @brief Rotate by 270 degrees clockwise.
279
463
  *
280
464
  */
281
465
  VeLiveVideoRotation270 = 3
282
466
  }
283
-
467
+ /** {zh}
468
+ * @detail keytype
469
+ * @brief 网络质量/状态。
470
+ *
471
+ */
284
472
  export declare enum VeLiveNetworkQuality {
285
-
473
+ /** {zh}
474
+ * @brief 未查询到网络状态。
475
+ *
476
+ */
286
477
  /** {en}
287
478
  * @brief Network status not found.
288
479
  *
289
480
  */
290
481
  VeLiveNetworkQualityUnknown = 0,
291
-
482
+ /** {zh}
483
+ * @brief 网络差。
484
+ *
485
+ */
292
486
  /** {en}
293
487
  * @brief Bad network condition.
294
488
  *
295
489
  */
296
490
  VeLiveNetworkQualityBad = 1,
297
-
491
+ /** {zh}
492
+ * @brief 网络一般。
493
+ *
494
+ */
298
495
  /** {en}
299
496
  * @brief Poor network condition.
300
497
  *
301
498
  */
302
499
  VeLiveNetworkQualityPoor = 2,
303
-
500
+ /** {zh}
501
+ * @brief 网络状态佳。
502
+ *
503
+ */
304
504
  /** {en}
305
505
  * @brief Good network condition.
306
506
  *
307
507
  */
308
508
  VeLiveNetworkQualityGood = 3
309
509
  }
310
-
510
+ /** {zh}
511
+ * @detail keytype
512
+ * @brief 音频采集类型。
513
+ *
514
+ */
311
515
  export declare enum VeLiveAudioCaptureType {
312
-
516
+ /** {zh}
517
+ * @brief 使用默认麦克风设备进行音频采集。
518
+ *
519
+ */
313
520
  /** {en}
314
521
  * @brief Capture the audio with the default microphone.
315
522
  *
316
523
  */
317
524
  VeLiveAudioCaptureMicrophone = 0,
318
-
525
+ /** {zh}
526
+ * @brief 使用语音通话模式进行音频采集,此模式下会启动硬件的 3A 功能,即自动增益控制、自动频率控制和自动噪声抑制。
527
+ *
528
+ */
319
529
  /** {en}
320
530
  * @brief Capture the audio in voice call mode, which will activate the 3A features of the hardware, including automatic gain control, automatic frequency control, and automatic noise suppression.
321
531
  *
322
532
  */
323
533
  VeLiveAudioCaptureVoiceCommunication = 1,
324
-
534
+ /** {zh}
535
+ * @brief 使用外部设备或源进行音频采集。
536
+ *
537
+ */
325
538
  /** {en}
326
539
  * @brief Capture the audio with an external device or source.
327
540
  *
328
541
  */
329
542
  VeLiveAudioCaptureExternal = 3,
330
-
543
+ /** {zh}
544
+ * @brief 使用静音帧作为音频源。
545
+ *
546
+ */
331
547
  /** {en}
332
548
  * @brief Use muted frames as the audio source.
333
549
  *
334
550
  */
335
551
  VeLiveAudioCaptureMuteFrame = 4,
336
-
552
+ /** {zh}
553
+ * @platform android
554
+ * @brief 使用录屏直播无障碍音频模式进行音频采集。
555
+ *
556
+ */
337
557
  /** {en}
338
558
  * @platform android
339
559
  * @brief Capture the audio in screen recording.
@@ -341,49 +561,79 @@ export declare enum VeLiveAudioCaptureType {
341
561
  */
342
562
  VeLiveAudioCaptureVoiceRecognition = 5
343
563
  }
344
-
564
+ /** {zh}
565
+ * @detail keytype
566
+ * @brief 推流视频数据类型。
567
+ *
568
+ */
345
569
  export declare enum VeLiveVideoBufferType {
346
-
570
+ /** {zh}
571
+ * @brief 未知视频数据类型,当未指定输入视频数据的格式时,会默认为此类型。
572
+ *
573
+ */
347
574
  /** {en}
348
575
  * @brief Unknown data type, which is the default type if you do not specify any type.
349
576
  *
350
577
  */
351
578
  VeLiveVideoBufferTypeUnknown = 0,
352
-
579
+ /** {zh}
580
+ * @brief 视频数据类型为 OpenGL 纹理。
581
+ *
582
+ */
353
583
  /** {en}
354
584
  * @brief OpenGL texture.
355
585
  *
356
586
  */
357
587
  VeLiveVideoBufferTypeTexture = 1,
358
-
588
+ /** {zh}
589
+ * @platform android
590
+ * @brief 视频数据类型为 ByteBuffer 类型。
591
+ *
592
+ */
359
593
  /** {en}
360
594
  * @platform android
361
595
  * @brief ByteBuffer.
362
596
  *
363
597
  */
364
598
  VeLiveVideoBufferTypeByteBuffer = 2,
365
-
599
+ /** {zh}
600
+ * @platform android
601
+ * @brief 视频数据类型为 ByteArray 类型。
602
+ *
603
+ */
366
604
  /** {en}
367
605
  * @platform android
368
606
  * @brief ByteArray.
369
607
  *
370
608
  */
371
609
  VeLiveVideoBufferTypeByteArray = 3,
372
-
610
+ /** {zh}
611
+ * @platform ios
612
+ * @brief 视频数据类型为 CVPixelBuffer。
613
+ *
614
+ */
373
615
  /** {en}
374
616
  * @platform ios
375
617
  * @brief CVPixelBuffer.
376
618
  *
377
619
  */
378
620
  VeLiveVideoBufferTypePixelBuffer = 4,
379
-
621
+ /** {zh}
622
+ * @platform ios
623
+ * @brief 视频数据类型为 CMSampleBufferRef。
624
+ *
625
+ */
380
626
  /** {en}
381
627
  * @platform ios
382
628
  * @brief CMSampleBufferRef.
383
629
  *
384
630
  */
385
631
  VeLiveVideoBufferTypeSampleBuffer = 5,
386
-
632
+ /** {zh}
633
+ * @platform ios
634
+ * @brief 视频数据类型为 NSData。
635
+ *
636
+ */
387
637
  /** {en}
388
638
  * @platform ios
389
639
  * @brief NSData.
@@ -391,15 +641,25 @@ export declare enum VeLiveVideoBufferType {
391
641
  */
392
642
  VeLiveVideoBufferTypeNSData = 6
393
643
  }
394
-
644
+ /** {zh}
645
+ * @detail keytype
646
+ * @brief 推流横竖屏模式。
647
+ *
648
+ */
395
649
  export declare enum VeLiveOrientation {
396
-
650
+ /** {zh}
651
+ * @brief 横屏模式。
652
+ *
653
+ */
397
654
  /** {en}
398
655
  * @brief The landscape mode.
399
656
  *
400
657
  */
401
658
  VeLiveOrientationLandscape = 0,
402
-
659
+ /** {zh}
660
+ * @brief 竖屏模式。
661
+ *
662
+ */
403
663
  /** {en}
404
664
  * @brief The portrait mode.
405
665
  *
@@ -418,130 +678,204 @@ export declare enum VeLiveOrientation {
418
678
  */
419
679
  UIInterfaceOrientationLandscapeRight = 4
420
680
  }
421
-
681
+ /** {zh}
682
+ * @detail keytype
683
+ * @brief 推流器与服务器的连接状态。
684
+ *
685
+ */
422
686
  export declare enum VeLivePusherStatus {
423
-
687
+ /** {zh}
688
+ * @brief 初始状态。
689
+ *
690
+ */
424
691
  /** {en}
425
692
  * @brief The initial state.
426
693
  *
427
694
  */
428
695
  VeLivePushStatusNone = 0,
429
-
696
+ /** {zh}
697
+ * @brief 正在连接服务器。
698
+ *
699
+ */
430
700
  /** {en}
431
701
  * @brief Connecting to the server.
432
702
  *
433
703
  */
434
704
  VeLivePushStatusConnecting = 1,
435
-
705
+ /** {zh}
706
+ * @brief 连接服务器成功。
707
+ *
708
+ */
436
709
  /** {en}
437
710
  * @brief The connection with the server is established.
438
711
  *
439
712
  */
440
713
  VeLivePushStatusConnectSuccess = 2,
441
-
714
+ /** {zh}
715
+ * @brief 重连服务器中。
716
+ *
717
+ */
442
718
  /** {en}
443
719
  * @brief Reconnecting to the server.
444
720
  *
445
721
  */
446
722
  VeLivePushStatusReconnecting = 3,
447
-
723
+ /** {zh}
724
+ * @brief 推流连接被终止。
725
+ *
726
+ */
448
727
  /** {en}
449
728
  * @brief Stops connecting to the server.
450
729
  *
451
730
  */
452
731
  VeLivePushStatusConnectStop = 4,
453
-
732
+ /** {zh}
733
+ * @brief 推流连接失败。
734
+ *
735
+ */
454
736
  /** {en}
455
737
  * @brief Fails to connect to the server.
456
738
  *
457
739
  */
458
740
  VeLivePushStatusConnectError = 5,
459
-
741
+ /** {zh}
742
+ * @brief 与服务器断开连接。
743
+ *
744
+ */
460
745
  /** {en}
461
746
  * @brief The connection with the server is lost.
462
747
  *
463
748
  */
464
749
  VeLivePushStatusDisconnected = 6
465
750
  }
466
-
751
+ /** {zh}
752
+ * @detail keytype
753
+ * @brief 音量等级,用于评估和控制音频的响度。
754
+ *
755
+ */
467
756
  export declare enum VeLiveAudioPowerLevel {
468
-
757
+ /** {zh}
758
+ * @brief 吵闹,音量极高,类似于繁忙的街道或者是音乐会现场,音量超过 85db。
759
+ *
760
+ */
469
761
  /** {en}
470
762
  * @brief Noisy, similar to the volume of the noise on a busy street or at a concert. The volume is higher than 85 dB.
471
763
  *
472
764
  */
473
765
  VeLiveAudioPowerLevelNoise = 6,
474
-
766
+ /** {zh}
767
+ * @brief 无声,音量 ≤1db。
768
+ *
769
+ */
475
770
  /** {en}
476
771
  * @brief Muted. The volume is 1 dB or less.
477
772
  *
478
773
  */
479
774
  VeLiveAudioPowerLevelSilent = 0,
480
-
775
+ /** {zh}
776
+ * @brief 安静,音量 15db 以下。
777
+ *
778
+ */
481
779
  /** {en}
482
780
  * @brief Quiet. The volume is below 15 dB.
483
781
  *
484
782
  */
485
783
  VeLiveAudioPowerLevelQuiet = 1,
486
-
784
+ /** {zh}
785
+ * @brief 轻声,接近耳语音量,音量为 16db~30db 之间。
786
+ *
787
+ */
487
788
  /** {en}
488
789
  * @brief Soft, close to whisper. The volume is between 16 dB and 30 dB.
489
790
  *
490
791
  */
491
792
  VeLiveAudioPowerLevelLight = 2,
492
-
793
+ /** {zh}
794
+ * @brief 正常,音量适宜,类似正常对话的音量,音量为 30db~60db 之间。
795
+ *
796
+ */
493
797
  /** {en}
494
798
  * @brief Normal, similar to the volume in a daily conversation. The volume is between 30 dB and 60 dB.
495
799
  *
496
800
  */
497
801
  VeLiveAudioPowerLevelNormal = 3,
498
-
802
+ /** {zh}
803
+ * @brief 较大,音量较高,类似咖啡馆、餐厅的环境噪音,音量为 61db~85db 之间。
804
+ *
805
+ */
499
806
  /** {en}
500
807
  * @brief Loud, similar to the volume of the noise at cafes. The volume is between 61 dB and 85 dB.
501
808
  *
502
809
  */
503
810
  VeLiveAudioPowerLevelLoud = 4
504
811
  }
505
-
812
+ /** {zh}
813
+ * @detail keytype
814
+ * @brief 视频帧的数据格式。
815
+ *
816
+ */
506
817
  export declare enum VeLivePixelFormat {
507
-
818
+ /** {zh}
819
+ * @brief 未知格式。
820
+ *
821
+ */
508
822
  /** {en}
509
823
  * @brief Unknown format.
510
824
  *
511
825
  */
512
826
  VeLivePixelFormatUnknown = 0,
513
-
827
+ /** {zh}
828
+ * @brief I420 格式。
829
+ *
830
+ */
514
831
  /** {en}
515
832
  * @brief I420.
516
833
  *
517
834
  */
518
835
  VeLivePixelFormatI420 = 1,
519
-
836
+ /** {zh}
837
+ * @brief NV12 格式。
838
+ *
839
+ */
520
840
  /** {en}
521
841
  * @brief NV12.
522
842
  *
523
843
  */
524
844
  VeLivePixelFormatNV12 = 2,
525
-
845
+ /** {zh}
846
+ * @brief NV21 格式。
847
+ *
848
+ */
526
849
  /** {en}
527
850
  * @brief NV21.
528
851
  *
529
852
  */
530
853
  VeLivePixelFormatNV21 = 3,
531
-
854
+ /** {zh}
855
+ * @brief 2D 纹理格式。
856
+ *
857
+ */
532
858
  /** {en}
533
859
  * @brief 2D texture.
534
860
  *
535
861
  */
536
862
  VeLivePixelFormat2DTexture = 4,
537
-
863
+ /** {zh}
864
+ * @platform android
865
+ * @brief OES 纹理格式。
866
+ *
867
+ */
538
868
  /** {en}
539
869
  * @platform android
540
870
  * @brief OES texture.
541
871
  *
542
872
  */
543
873
  VeLivePixelFormatOesTexture = 5,
544
-
874
+ /** {zh}
875
+ * @platform ios
876
+ * @brief RAGBA 格式。
877
+ *
878
+ */
545
879
  /** {en}
546
880
  * @platform ios
547
881
  * @brief RAGBA.
@@ -549,49 +883,78 @@ export declare enum VeLivePixelFormat {
549
883
  */
550
884
  VeLivePixelFormatBGRA32 = 6
551
885
  }
552
-
886
+ /** {zh}
887
+ * @detail keytype
888
+ * @brief 输出的日志级别。
889
+ *
890
+ */
553
891
  export declare enum VeLivePusherLogLevel {
554
-
892
+ /** {zh}
893
+ * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
894
+ *
895
+ */
555
896
  /** {en}
556
897
  * @brief Output VERBOSE, DEBUG, INFO, WARNING and ERROR.
557
898
  *
558
899
  */
559
900
  VeLivePusherLogLevelVerbose = 0,
560
-
901
+ /** {zh}
902
+ * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
903
+ *
904
+ */
561
905
  /** {en}
562
906
  * @brief Output DEBUG, INFO, WARNING and ERROR.
563
907
  *
564
908
  */
565
909
  VeLivePusherLogLevelDebug = 1,
566
-
910
+ /** {zh}
911
+ * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
912
+ *
913
+ */
567
914
  /** {en}
568
915
  * @brief Output INFO, WARNING and ERROR.
569
916
  *
570
917
  */
571
918
  VeLivePusherLogLevelInfo = 2,
572
-
919
+ /** {zh}
920
+ * @brief 输出 WARNING 和 ERROR 级别的日志。
921
+ *
922
+ */
573
923
  /** {en}
574
924
  * @brief Output WARNING and ERROR.
575
925
  *
576
926
  */
577
927
  VeLivePusherLogLevelWarn = 3,
578
-
928
+ /** {zh}
929
+ * @brief 输出 ERROR 级别的日志。
930
+ *
931
+ */
579
932
  /** {en}
580
933
  * @brief Output ERROR.
581
934
  *
582
935
  */
583
936
  VeLivePusherLogLevelError = 4,
584
-
937
+ /** {zh}
938
+ * @brief 关闭日志。
939
+ *
940
+ */
585
941
  /** {en}
586
942
  * @brief Disable logging.
587
943
  *
588
944
  */
589
945
  VeLivePusherLogLevelNone = 5
590
946
  }
591
-
947
+ /** {zh}
948
+ * @detail keytype
949
+ * @brief 推流视频编码参数。
950
+ *
951
+ */
592
952
  export declare class VeLiveVideoEncoderConfiguration {
593
953
  protected _instance: any;
594
-
954
+ /** {zh}
955
+ * @platform ios
956
+ * @brief 推流视频分辨率,默认值为 VeLiveVideoResolution720P,详情请参见 [VeLiveVideoResolution](#VeLiveVideoResolution)。
957
+ */
595
958
  /** {en}
596
959
  * @platform ios
597
960
  * @brief The video resolution. See [VeLiveVideoResolution](#VeLiveVideoResolution) for details. The default value is `VeLiveVideoResolution720P`.
@@ -600,7 +963,13 @@ export declare class VeLiveVideoEncoderConfiguration {
600
963
  set resolution(value: $p_i.VeLiveVideoResolution);
601
964
  protected __init(...args: any[]): void;
602
965
  protected __new_instance(...args: any[]): any;
603
-
966
+ /** {zh}
967
+ * @detail api
968
+ * @brief 设置推流视频分辨率。
969
+ * @param resolution 推流视频分辨率,默认值为 VeLiveVideoResolution720P,详情请参见 [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution)。
970
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
971
+ *
972
+ */
604
973
  /** {en}
605
974
  * @detail api
606
975
  * @brief Sets the video resolution.
@@ -609,7 +978,13 @@ export declare class VeLiveVideoEncoderConfiguration {
609
978
  *
610
979
  */
611
980
  initWithResolution(resolution: VeLiveVideoResolution): this;
612
-
981
+ /** {zh}
982
+ * @detail api
983
+ * @brief 设置推流视频编码格式。
984
+ * @param codec 推流视频编码格式,详情请参见 [VeLiveVideoCodec](#VeLiveVideoCodec) 。
985
+ * @return 推流视频编码参数,详见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
986
+ *
987
+ */
613
988
  /** {en}
614
989
  * @detail api
615
990
  * @brief Sets the video codec.
@@ -618,7 +993,13 @@ export declare class VeLiveVideoEncoderConfiguration {
618
993
  *
619
994
  */
620
995
  setCodec(codec: VeLiveVideoCodec): this;
621
-
996
+ /** {zh}
997
+ * @detail api
998
+ * @brief 设置推流视频编码码率。
999
+ * @param bitrate 推流视频编码码率,单位为 kbps,默认值由 `resolution` 参数值决定。
1000
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
1001
+ *
1002
+ */
622
1003
  /** {en}
623
1004
  * @detail api
624
1005
  * @brief Sets the encoded video bitrate.
@@ -627,7 +1008,13 @@ export declare class VeLiveVideoEncoderConfiguration {
627
1008
  *
628
1009
  */
629
1010
  setBitrate(bitrate: number): this;
630
-
1011
+ /** {zh}
1012
+ * @detail api
1013
+ * @brief 设置推流视频编码最小码率。
1014
+ * @param minBitrate 推流视频编码最小码率,单位为 kbps,默认值由 `resolution` 参数值决定;如果开启自适应码率,推流 SDK 根据网络情况进行编码码率自适应调整的最小码率
1015
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
1016
+ *
1017
+ */
631
1018
  /** {en}
632
1019
  * @detail api
633
1020
  * @brief Sets the minimum encoded video bitrate.
@@ -636,7 +1023,14 @@ export declare class VeLiveVideoEncoderConfiguration {
636
1023
  *
637
1024
  */
638
1025
  setMinBitrate(minBitrate: number): this;
639
-
1026
+ /** {zh}
1027
+ * @detail api
1028
+ * @brief 设置推流视频编码最大码率。
1029
+ * @param maxBitrate 推流视频编码最大码率,单位为 kbps,默认值由 `resolution` 参数值决定;如果开启自适应码率,推流 SDK 根据网络情况进行编码码率自适应调整的最大码率。
1030
+ * @return
1031
+ * 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
1032
+ *
1033
+ */
640
1034
  /** {en}
641
1035
  * @detail api
642
1036
  * @brief Sets the maximum encoded video bitrate.
@@ -645,7 +1039,13 @@ export declare class VeLiveVideoEncoderConfiguration {
645
1039
  *
646
1040
  */
647
1041
  setMaxBitrate(maxBitrate: number): this;
648
-
1042
+ /** {zh}
1043
+ * @detail api
1044
+ * @brief 设置推流视频编码 GOP。
1045
+ * @param gopSize 视频 GOP 大小,单位为 s,默认值为 2
1046
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
1047
+ *
1048
+ */
649
1049
  /** {en}
650
1050
  * @detail api
651
1051
  * @brief Sets the encoded video GOP size.
@@ -654,7 +1054,13 @@ export declare class VeLiveVideoEncoderConfiguration {
654
1054
  *
655
1055
  */
656
1056
  setGopSize(gopSize: number): this;
657
-
1057
+ /** {zh}
1058
+ * @detail api
1059
+ * @brief 设置推流视频编码帧率。
1060
+ * @param fps 视频编码帧率,单位为 fps,默认值为 15
1061
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
1062
+ *
1063
+ */
658
1064
  /** {en}
659
1065
  * @detail api
660
1066
  * @brief Sets the encoded frame rate.
@@ -663,7 +1069,15 @@ export declare class VeLiveVideoEncoderConfiguration {
663
1069
  *
664
1070
  */
665
1071
  setFps(fps: number): this;
666
-
1072
+ /** {zh}
1073
+ * @detail api
1074
+ * @brief 设置推流视频编码开启 B 帧。
1075
+ * @param enableBFrame 是否开启 B 帧。默认为 false。 <br>
1076
+ * - true:开启;
1077
+ * - false:关闭。
1078
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
1079
+ *
1080
+ */
667
1081
  /** {en}
668
1082
  * @detail api
669
1083
  * @brief Sets whether to enable B frames.
@@ -674,7 +1088,15 @@ export declare class VeLiveVideoEncoderConfiguration {
674
1088
  *
675
1089
  */
676
1090
  setEnableBFrame(enableBFrame: boolean): this;
677
-
1091
+ /** {zh}
1092
+ * @detail api
1093
+ * @brief 设置推流视频编码开启硬件编码。
1094
+ * @param enableAccelerate 是否开启硬件编码。默认值为 true。 <br>
1095
+ * - true:开启;
1096
+ * - false:关闭。
1097
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
1098
+ *
1099
+ */
678
1100
  /** {en}
679
1101
  * @detail api
680
1102
  * @brief Enables hardware encoding.
@@ -685,7 +1107,13 @@ export declare class VeLiveVideoEncoderConfiguration {
685
1107
  *
686
1108
  */
687
1109
  setEnableAccelerate(enableAccelerate: boolean): this;
688
-
1110
+ /** {zh}
1111
+ * @platform android
1112
+ * @detail api
1113
+ * @brief 获取推流视频分辨率。
1114
+ * @return 推流视频分辨率 [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution)。
1115
+ *
1116
+ */
689
1117
  /** {en}
690
1118
  * @platform android
691
1119
  * @detail api
@@ -694,7 +1122,13 @@ export declare class VeLiveVideoEncoderConfiguration {
694
1122
  *
695
1123
  */
696
1124
  android_getResolution(): $p_a.VeLiveVideoResolution;
697
-
1125
+ /** {zh}
1126
+ * @platform android
1127
+ * @detail api
1128
+ * @brief 获取推流视频编码格式。
1129
+ * @return 推流视频编码格式,详情请参见 [VeLiveVideoCodec](#VeLiveVideoCodec)。
1130
+ *
1131
+ */
698
1132
  /** {en}
699
1133
  * @platform android
700
1134
  * @detail api
@@ -703,7 +1137,14 @@ export declare class VeLiveVideoEncoderConfiguration {
703
1137
  *
704
1138
  */
705
1139
  android_getCodec(): $p_a.VeLiveVideoCodec;
706
-
1140
+ /** {zh}
1141
+ * @platform android
1142
+ * @detail api
1143
+ * @brief 获取推流视频编码码率。
1144
+ * @return <br>
1145
+ * 推流视频编码码率。
1146
+ *
1147
+ */
707
1148
  /** {en}
708
1149
  * @platform android
709
1150
  * @detail api
@@ -712,7 +1153,14 @@ export declare class VeLiveVideoEncoderConfiguration {
712
1153
  *
713
1154
  */
714
1155
  android_getBitrate(): number;
715
-
1156
+ /** {zh}
1157
+ * @platform android
1158
+ * @detail api
1159
+ * @brief 获取推流视频编码最小码率。
1160
+ * @return <br>
1161
+ * 推流视频编码最小码率。
1162
+ *
1163
+ */
716
1164
  /** {en}
717
1165
  * @platform android
718
1166
  * @detail api
@@ -721,7 +1169,14 @@ export declare class VeLiveVideoEncoderConfiguration {
721
1169
  *
722
1170
  */
723
1171
  android_getMinBitrate(): number;
724
-
1172
+ /** {zh}
1173
+ * @platform android
1174
+ * @detail api
1175
+ * @brief 获取推流视频编码最大码率。
1176
+ * @return <br>
1177
+ * 推流视频编码最大码率。
1178
+ *
1179
+ */
725
1180
  /** {en}
726
1181
  * @platform android
727
1182
  * @detail api
@@ -730,7 +1185,14 @@ export declare class VeLiveVideoEncoderConfiguration {
730
1185
  *
731
1186
  */
732
1187
  android_getMaxBitrate(): number;
733
-
1188
+ /** {zh}
1189
+ * @platform android
1190
+ * @detail api
1191
+ * @brief 获取推流视频编码 GOP。
1192
+ * @return <br>
1193
+ * 推流视频编码 GOP。
1194
+ *
1195
+ */
734
1196
  /** {en}
735
1197
  * @platform android
736
1198
  * @detail api
@@ -739,7 +1201,13 @@ export declare class VeLiveVideoEncoderConfiguration {
739
1201
  *
740
1202
  */
741
1203
  android_getGopSize(): number;
742
-
1204
+ /** {zh}
1205
+ * @platform android
1206
+ * @detail api
1207
+ * @brief 获取推流视频编码帧率。
1208
+ * @return 推流视频编码帧率。
1209
+ *
1210
+ */
743
1211
  /** {en}
744
1212
  * @platform android
745
1213
  * @detail api
@@ -748,7 +1216,15 @@ export declare class VeLiveVideoEncoderConfiguration {
748
1216
  *
749
1217
  */
750
1218
  android_getFps(): number;
751
-
1219
+ /** {zh}
1220
+ * @platform android
1221
+ * @detail api
1222
+ * @brief 获取是否开启 B 帧。
1223
+ * @return 是否开启B帧。<br/>
1224
+ * - true:B 帧开启;
1225
+ * - false:B 帧关闭。
1226
+ *
1227
+ */
752
1228
  /** {en}
753
1229
  * @platform android
754
1230
  * @detail api
@@ -759,7 +1235,16 @@ export declare class VeLiveVideoEncoderConfiguration {
759
1235
  *
760
1236
  */
761
1237
  android_isEnableBFrame(): boolean;
762
-
1238
+ /** {zh}
1239
+ * @platform android
1240
+ * @detail api
1241
+ * @brief 获取是否开启硬件编码。
1242
+ * @return <br>
1243
+ * 是否开启硬件编码。<br>
1244
+ * - true:开启;
1245
+ * - false:关闭。
1246
+ *
1247
+ */
763
1248
  /** {en}
764
1249
  * @platform android
765
1250
  * @detail api
@@ -771,75 +1256,108 @@ export declare class VeLiveVideoEncoderConfiguration {
771
1256
  */
772
1257
  android_isEnableAccelerate(): boolean;
773
1258
  }
774
-
1259
+ /** {zh}
1260
+ * @detail keytype
1261
+ * @brief 视频帧的数据信息。
1262
+ */
775
1263
  export declare class VeLiveVideoFrame {
776
1264
  constructor(width: number, height: number, pts: number, data: ArrayBuffer);
777
1265
  constructor();
778
1266
  protected _instance: any;
779
-
1267
+ /** {zh}
1268
+ * @platform ios
1269
+ * @brief 视频数据包装格式。默认值为 VeLiveVideoBufferTypeUnknown,详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
1270
+ */
780
1271
  /** {en}
781
1272
  * @platform ios
782
1273
  * @brief The video buffer type. The default value is `VeLiveVideoBufferTypeUnknown`. See [VeLiveVideoBufferType](#VeLiveVideoBufferType) for details.
783
1274
  */
784
1275
  get bufferType(): $p_i.VeLiveVideoBufferType;
785
1276
  set bufferType(value: $p_i.VeLiveVideoBufferType);
786
-
1277
+ /** {zh}
1278
+ * @platform ios
1279
+ * @brief 视频帧像素格式。bufferType 为 VeLiveVideoBufferTypeNSData 时,需要指定数据格式。详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
1280
+ */
787
1281
  /** {en}
788
1282
  * @platform ios
789
1283
  * @brief The pixel format. When `bufferType` is `VeLiveVideoBufferTypeNSData`, you must specify `pixelFormat`. See [VeLivePixelFormat](#VeLivePixelFormat) for details.
790
1284
  */
791
1285
  get pixelFormat(): $p_i.VeLivePixelFormat;
792
1286
  set pixelFormat(value: $p_i.VeLivePixelFormat);
793
-
1287
+ /** {zh}
1288
+ * @platform ios
1289
+ * @brief 视频帧顺时针旋转角度。详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
1290
+ */
794
1291
  /** {en}
795
1292
  * @platform ios
796
1293
  * @brief The rotation angle in a clockwise direction. See [VeLiveVideoRotation](#VeLiveVideoRotation) for details.
797
1294
  */
798
1295
  get rotation(): $p_i.VeLiveVideoRotation;
799
1296
  set rotation(value: $p_i.VeLiveVideoRotation);
800
-
1297
+ /** {zh}
1298
+ * @platform ios
1299
+ * @brief 视频宽度,单位为 px。
1300
+ */
801
1301
  /** {en}
802
1302
  * @platform ios
803
1303
  * @brief The width of the video, in pixels.
804
1304
  */
805
1305
  get width(): $p_i.int;
806
1306
  set width(value: $p_i.int);
807
-
1307
+ /** {zh}
1308
+ * @platform ios
1309
+ * @brief 视频高度,单位为 px。
1310
+ */
808
1311
  /** {en}
809
1312
  * @platform ios
810
1313
  * @brief The height of the video, in pixels.
811
1314
  */
812
1315
  get height(): $p_i.int;
813
1316
  set height(value: $p_i.int);
814
-
1317
+ /** {zh}
1318
+ * @platform ios
1319
+ * @brief 视频帧时间戳,单位为 μs。
1320
+ */
815
1321
  /** {en}
816
1322
  * @platform ios
817
1323
  * @brief The timestamp of the video frame, in μs.
818
1324
  */
819
1325
  get pts(): $p_i.CMTime;
820
1326
  set pts(value: $p_i.CMTime);
821
-
1327
+ /** {zh}
1328
+ * @platform ios
1329
+ * @brief `bufferType` 为 `VeLiveVideoBufferTypeTexture` 时的视频数据。
1330
+ */
822
1331
  /** {en}
823
1332
  * @platform ios
824
1333
  * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypeTexture`.
825
1334
  */
826
1335
  get textureId(): $p_i.GLuint;
827
1336
  set textureId(value: $p_i.GLuint);
828
-
1337
+ /** {zh}
1338
+ * @platform ios
1339
+ * @brief `bufferType` 为 `VeLiveVideoBufferTypePixelBuffer` 时的视频数据。
1340
+ */
829
1341
  /** {en}
830
1342
  * @platform ios
831
1343
  * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypePixelBuffer`.
832
1344
  */
833
1345
  get pixelBuffer(): $p_i.CVPixelBufferRef;
834
1346
  set pixelBuffer(value: $p_i.CVPixelBufferRef);
835
-
1347
+ /** {zh}
1348
+ * @platform ios
1349
+ * @brief `bufferType` 为 `VeLiveVideoBufferTypeSampleBuffer` 时的视频数据。
1350
+ */
836
1351
  /** {en}
837
1352
  * @platform ios
838
1353
  * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypeSampleBuffer`.
839
1354
  */
840
1355
  get sampleBuffer(): $p_i.CMSampleBufferRef;
841
1356
  set sampleBuffer(value: $p_i.CMSampleBufferRef);
842
-
1357
+ /** {zh}
1358
+ * @platform ios
1359
+ * @brief `bufferType` 为 `VeLiveVideoBufferTypeNSData` 时的视频数据。
1360
+ */
843
1361
  /** {en}
844
1362
  * @platform ios
845
1363
  * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypeNSData`.
@@ -848,7 +1366,12 @@ export declare class VeLiveVideoFrame {
848
1366
  set data(value: $p_i.NSData);
849
1367
  protected __init(...args: any[]): void;
850
1368
  protected __new_instance(...args: any[]): any;
851
-
1369
+ /** {zh}
1370
+ * @platform android
1371
+ * @detail api
1372
+ * @brief 增加 VeLiveVideoFrame 对象的引用计数。当您需要继续使用 VeLiveVideoFrame 对象时,请调用此方法将引用计数增加 1。
1373
+ *
1374
+ */
852
1375
  /** {en}
853
1376
  * @platform android
854
1377
  * @detail api
@@ -856,7 +1379,12 @@ export declare class VeLiveVideoFrame {
856
1379
  *
857
1380
  */
858
1381
  android_retain(): void;
859
-
1382
+ /** {zh}
1383
+ * @platform android
1384
+ * @detail api
1385
+ * @brief 释放对 VeLiveVideoFrame 对象的引用。在您不再需要使用 VeLiveVideoFrame 对象时,应调用此方法将引用计数减少 1。当引用计数减少到零,表示不再有引用指向该对象,可以安全地释放或销毁该对象。
1386
+ *
1387
+ */
860
1388
  /** {en}
861
1389
  * @platform android
862
1390
  * @detail api
@@ -864,7 +1392,13 @@ export declare class VeLiveVideoFrame {
864
1392
  *
865
1393
  */
866
1394
  android_release(): void;
867
-
1395
+ /** {zh}
1396
+ * @platform android
1397
+ * @detail api
1398
+ * @brief 获取视频数据类型。
1399
+ * @return 视频数据类型,详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
1400
+ *
1401
+ */
868
1402
  /** {en}
869
1403
  * @platform android
870
1404
  * @detail api
@@ -873,7 +1407,14 @@ export declare class VeLiveVideoFrame {
873
1407
  *
874
1408
  */
875
1409
  android_getBufferType(): $p_a.VeLiveVideoBufferType;
876
-
1410
+ /** {zh}
1411
+ * @platform android
1412
+ * @detail api
1413
+ * @brief 设置视频数据类型。
1414
+ * @param bufferType 视频数据类型,详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
1415
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
1416
+ *
1417
+ */
877
1418
  /** {en}
878
1419
  * @platform android
879
1420
  * @detail api
@@ -883,7 +1424,13 @@ export declare class VeLiveVideoFrame {
883
1424
  *
884
1425
  */
885
1426
  android_setBufferType(bufferType: $p_a.VeLiveVideoBufferType): this;
886
-
1427
+ /** {zh}
1428
+ * @platform android
1429
+ * @detail api
1430
+ * @brief 获取视频像素格式。
1431
+ * @return 视频像素格式,详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
1432
+ *
1433
+ */
887
1434
  /** {en}
888
1435
  * @platform android
889
1436
  * @detail api
@@ -893,7 +1440,14 @@ export declare class VeLiveVideoFrame {
893
1440
  *
894
1441
  */
895
1442
  android_getPixelFormat(): $p_a.VeLivePixelFormat;
896
-
1443
+ /** {zh}
1444
+ * @platform android
1445
+ * @detail api
1446
+ * @brief 设置视频像素格式。
1447
+ * @param pixelFormat 视频像素格式,详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
1448
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
1449
+ *
1450
+ */
897
1451
  /** {en}
898
1452
  * @platform android
899
1453
  * @detail api
@@ -903,7 +1457,13 @@ export declare class VeLiveVideoFrame {
903
1457
  *
904
1458
  */
905
1459
  android_setPixelFormat(pixelFormat: $p_a.VeLivePixelFormat): this;
906
-
1460
+ /** {zh}
1461
+ * @platform android
1462
+ * @detail api
1463
+ * @brief 获取视频帧旋转角度。
1464
+ * @return 视频帧旋转角度,详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
1465
+ *
1466
+ */
907
1467
  /** {en}
908
1468
  * @platform android
909
1469
  * @detail api
@@ -912,7 +1472,14 @@ export declare class VeLiveVideoFrame {
912
1472
  *
913
1473
  */
914
1474
  android_getRotation(): $p_a.VeLiveVideoRotation;
915
-
1475
+ /** {zh}
1476
+ * @platform android
1477
+ * @detail api
1478
+ * @brief 设置视频帧旋转角度。
1479
+ * @param rotation 视频帧旋转角度,详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
1480
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
1481
+ *
1482
+ */
916
1483
  /** {en}
917
1484
  * @platform android
918
1485
  * @detail api
@@ -923,7 +1490,14 @@ export declare class VeLiveVideoFrame {
923
1490
  *
924
1491
  */
925
1492
  android_setRotation(rotation: $p_a.VeLiveVideoRotation): this;
926
-
1493
+ /** {zh}
1494
+ * @platform android
1495
+ * @detail api
1496
+ * @brief 获取视频帧宽度。
1497
+ * @return <br>
1498
+ * 视频帧宽度。
1499
+ *
1500
+ */
927
1501
  /** {en}
928
1502
  * @platform android
929
1503
  * @detail api
@@ -933,7 +1507,14 @@ export declare class VeLiveVideoFrame {
933
1507
  *
934
1508
  */
935
1509
  android_getWidth(): number;
936
-
1510
+ /** {zh}
1511
+ * @platform android
1512
+ * @detail api
1513
+ * @brief 获取视频帧高度。
1514
+ * @return <br>
1515
+ * 视频帧高度。
1516
+ *
1517
+ */
937
1518
  /** {en}
938
1519
  * @platform android
939
1520
  * @detail api
@@ -943,7 +1524,14 @@ export declare class VeLiveVideoFrame {
943
1524
  *
944
1525
  */
945
1526
  android_getHeight(): number;
946
-
1527
+ /** {zh}
1528
+ * @platform android
1529
+ * @detail api
1530
+ * @brief 获取带旋转角度的视频帧宽度。
1531
+ * @return <br>
1532
+ * 带旋转角度的视频帧宽度。
1533
+ *
1534
+ */
947
1535
  /** {en}
948
1536
  * @platform android
949
1537
  * @detail api
@@ -953,7 +1541,14 @@ export declare class VeLiveVideoFrame {
953
1541
  *
954
1542
  */
955
1543
  android_getRotatedWidth(): number;
956
-
1544
+ /** {zh}
1545
+ * @platform android
1546
+ * @detail api
1547
+ * @brief 获取带旋转角度的视频帧高度。
1548
+ * @return <br>
1549
+ * 带旋转角度的视频帧高度。
1550
+ *
1551
+ */
957
1552
  /** {en}
958
1553
  * @platform android
959
1554
  * @detail api
@@ -963,7 +1558,14 @@ export declare class VeLiveVideoFrame {
963
1558
  *
964
1559
  */
965
1560
  android_getRotatedHeight(): number;
966
-
1561
+ /** {zh}
1562
+ * @platform android
1563
+ * @detail api
1564
+ * @brief 获取视频帧时间戳。
1565
+ * @return <br>
1566
+ * 视频帧时间戳,单位为 μs。
1567
+ *
1568
+ */
967
1569
  /** {en}
968
1570
  * @platform android
969
1571
  * @detail api
@@ -973,7 +1575,14 @@ export declare class VeLiveVideoFrame {
973
1575
  *
974
1576
  */
975
1577
  android_getPts(): number;
976
-
1578
+ /** {zh}
1579
+ * @platform android
1580
+ * @detail api
1581
+ * @brief 获取视频帧纹理 ID。
1582
+ * @return <br>
1583
+ * 视频帧纹理 ID。
1584
+ *
1585
+ */
977
1586
  /** {en}
978
1587
  * @platform android
979
1588
  * @detail api
@@ -983,7 +1592,13 @@ export declare class VeLiveVideoFrame {
983
1592
  *
984
1593
  */
985
1594
  android_getTextureId(): number;
986
-
1595
+ /** {zh}
1596
+ * @platform android
1597
+ * @detail api
1598
+ * @brief 获取视频帧纹理矩阵。
1599
+ * @return 视频帧纹理矩阵。
1600
+ *
1601
+ */
987
1602
  /** {en}
988
1603
  * @platform android
989
1604
  * @detail api
@@ -992,7 +1607,14 @@ export declare class VeLiveVideoFrame {
992
1607
  *
993
1608
  */
994
1609
  android_getTextureMatrix(): $p_a.Matrix;
995
-
1610
+ /** {zh}
1611
+ * @platform android
1612
+ * @detail api
1613
+ * @brief 获取 ByteBuffer 格式的视频数据。
1614
+ * @return <br>
1615
+ * ByteBuffer 格式的视频数据。
1616
+ *
1617
+ */
996
1618
  /** {en}
997
1619
  * @platform android
998
1620
  * @detail api
@@ -1001,7 +1623,13 @@ export declare class VeLiveVideoFrame {
1001
1623
  *
1002
1624
  */
1003
1625
  android_getBuffer(): $p_a.ByteBuffer;
1004
-
1626
+ /** {zh}
1627
+ * @platform android
1628
+ * @detail api
1629
+ * @brief 获取 byte[] 格式的视频数据。
1630
+ * @return byte[] 格式的视频数据。
1631
+ *
1632
+ */
1005
1633
  /** {en}
1006
1634
  * @platform android
1007
1635
  * @detail api
@@ -1010,7 +1638,14 @@ export declare class VeLiveVideoFrame {
1010
1638
  *
1011
1639
  */
1012
1640
  android_getData(): ArrayBuffer;
1013
-
1641
+ /** {zh}
1642
+ * @platform android
1643
+ * @detail api
1644
+ * @brief 获取视频帧内部销毁回调。
1645
+ * @return <br>
1646
+ * 视频帧内部销毁回调。
1647
+ *
1648
+ */
1014
1649
  /** {en}
1015
1650
  * @platform android
1016
1651
  * @detail api
@@ -1019,7 +1654,14 @@ export declare class VeLiveVideoFrame {
1019
1654
  *
1020
1655
  */
1021
1656
  android_getReleaseCallback(): $p_a.Runnable;
1022
-
1657
+ /** {zh}
1658
+ * @platform android
1659
+ * @detail api
1660
+ * @brief 设置视频帧内部销毁回调。
1661
+ * @param releaseCallback 视频帧内部销毁回调
1662
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
1663
+ *
1664
+ */
1023
1665
  /** {en}
1024
1666
  * @platform android
1025
1667
  * @detail api
@@ -1029,137 +1671,202 @@ export declare class VeLiveVideoFrame {
1029
1671
  *
1030
1672
  */
1031
1673
  android_setReleaseCallback(releaseCallback: $p_a.Runnable): this;
1032
-
1674
+ /** {zh}
1675
+ * @platform ios
1676
+ * @brief 释放回调函数,用于在 SDK 内部处理完 VideoFrame 后通知外部释放相关资源。此回调主要用于 SDK 外部为 VideoFrame 申请内存,以便 SDK 内部使用。但无法预知内部何时使用完毕。
1677
+ */
1033
1678
  /** {en}
1034
1679
  * @platform ios
1035
1680
  * @brief Triggered when the SDK has completed processing the video frame and no longer needs the memory. You can release the memory for the video frame after receiving this callback.
1036
1681
  */
1037
1682
  ios_releaseCallback(): void;
1038
1683
  }
1039
-
1684
+ /** {zh}
1685
+ * @detail keytype
1686
+ * @brief 视频编码格式。
1687
+ *
1688
+ */
1040
1689
  export declare enum VeLiveVideoCodec {
1041
-
1690
+ /** {zh}
1691
+ * @brief 使用 H.264 视频编码。
1692
+ *
1693
+ */
1042
1694
  /** {en}
1043
1695
  * @brief H.264.
1044
1696
  *
1045
1697
  */
1046
1698
  VeLiveVideoCodecH264 = 0,
1047
-
1699
+ /** {zh}
1700
+ * @brief 使用火山引擎自研 ByteVC1 视频编码。
1701
+ *
1702
+ */
1048
1703
  /** {en}
1049
1704
  * @brief ByteVC1, an encoding format developed by BytePlus.
1050
1705
  *
1051
1706
  */
1052
1707
  VeLiveVideoCodecByteVC1 = 1
1053
1708
  }
1054
-
1709
+ /** {zh}
1710
+ * @detail keytype
1711
+ * @brief 推流周期性统计信息。
1712
+ *
1713
+ */
1055
1714
  export declare class VeLivePusherStatistics {
1056
1715
  protected _instance: any;
1057
-
1716
+ /** {zh}
1717
+ * @brief 视频编码宽度,单位为 px。
1718
+ *
1719
+ */
1058
1720
  /** {en}
1059
1721
  * @brief The width of the encoded video, in pixels.
1060
1722
  *
1061
1723
  */
1062
1724
  get encodeWidth(): number;
1063
1725
  set encodeWidth(value: number);
1064
-
1726
+ /** {zh}
1727
+ * @brief 视频编码高度,单位为 px。
1728
+ *
1729
+ */
1065
1730
  /** {en}
1066
1731
  * @brief The height of the encoded video, in pixels.
1067
1732
  *
1068
1733
  */
1069
1734
  get encodeHeight(): number;
1070
1735
  set encodeHeight(value: number);
1071
-
1736
+ /** {zh}
1737
+ * @brief 视频采集宽度,单位为 px。
1738
+ *
1739
+ */
1072
1740
  /** {en}
1073
1741
  * @brief The width of the captured video, in pixels.
1074
1742
  *
1075
1743
  */
1076
1744
  get captureWidth(): number;
1077
1745
  set captureWidth(value: number);
1078
-
1746
+ /** {zh}
1747
+ * @brief 视频采集高度,单位为 px。
1748
+ *
1749
+ */
1079
1750
  /** {en}
1080
1751
  * @brief The height of the captured video, in pixels.
1081
1752
  *
1082
1753
  */
1083
1754
  get captureHeight(): number;
1084
1755
  set captureHeight(value: number);
1085
-
1756
+ /** {zh}
1757
+ * @brief 视频采集帧率,单位为 fps。
1758
+ *
1759
+ */
1086
1760
  /** {en}
1087
1761
  * @brief The captured frame rate, in fps.
1088
1762
  *
1089
1763
  */
1090
1764
  get captureFps(): number;
1091
1765
  set captureFps(value: number);
1092
-
1766
+ /** {zh}
1767
+ * @brief 视频编码帧率,单位为 fps。
1768
+ *
1769
+ */
1093
1770
  /** {en}
1094
1771
  * @brief The encoded frame rate, in fps.
1095
1772
  *
1096
1773
  */
1097
1774
  get encodeFps(): number;
1098
1775
  set encodeFps(value: number);
1099
-
1776
+ /** {zh}
1777
+ * @brief 视频发送帧率,可用展示实时帧率,单位为 fps。
1778
+ *
1779
+ */
1100
1780
  /** {en}
1101
1781
  * @brief The transmission frame rate, in fps. You can use this parameter to showcase the real-time frame rate on the user interface.
1102
1782
  *
1103
1783
  */
1104
1784
  get transportFps(): number;
1105
1785
  set transportFps(value: number);
1106
-
1786
+ /** {zh}
1787
+ * @brief 视频推流帧率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的帧率,单位为 fps。
1788
+ *
1789
+ */
1107
1790
  /** {en}
1108
1791
  * @brief The encoded frame rate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in fps.
1109
1792
  *
1110
1793
  */
1111
1794
  get fps(): number;
1112
1795
  set fps(value: number);
1113
-
1796
+ /** {zh}
1797
+ * @brief 视频推流码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的码率,单位为 kbps。
1798
+ *
1799
+ */
1114
1800
  /** {en}
1115
1801
  * @brief The encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
1116
1802
  *
1117
1803
  */
1118
1804
  get videoBitrate(): number;
1119
1805
  set videoBitrate(value: number);
1120
-
1806
+ /** {zh}
1807
+ * @brief 视频推流最小码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最小码率,单位为 kbps。
1808
+ *
1809
+ */
1121
1810
  /** {en}
1122
1811
  * @brief The minimum encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
1123
1812
  *
1124
1813
  */
1125
1814
  get minVideoBitrate(): number;
1126
1815
  set minVideoBitrate(value: number);
1127
-
1816
+ /** {zh}
1817
+ * @brief 视频推流最大码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最大码率,单位为 kbps。
1818
+ *
1819
+ */
1128
1820
  /** {en}
1129
1821
  * @brief The maximum encoded bitrate you specify in the setVideoEncoderConfiguration {@link #VeLivePusher#setVideoEncoderConfiguration} method, in Kbps.
1130
1822
  *
1131
1823
  */
1132
1824
  get maxVideoBitrate(): number;
1133
1825
  set maxVideoBitrate(value: number);
1134
-
1826
+ /** {zh}
1827
+ * @brief 视频编码码率,单位为 kbps。
1828
+ *
1829
+ */
1135
1830
  /** {en}
1136
1831
  * @brief The encoded video bitrate, in Kbps.
1137
1832
  *
1138
1833
  */
1139
1834
  get encodeVideoBitrate(): number;
1140
1835
  set encodeVideoBitrate(value: number);
1141
-
1836
+ /** {zh}
1837
+ * @brief 视频发送码率,可用于展示实时码率,单位为 kbps。
1838
+ *
1839
+ */
1142
1840
  /** {en}
1143
1841
  * @brief The transmission bitrate, in Kbps. You can use this parameter to showcase the real-time bitrate on the user interface.
1144
1842
  *
1145
1843
  */
1146
1844
  get transportVideoBitrate(): number;
1147
1845
  set transportVideoBitrate(value: number);
1148
-
1846
+ /** {zh}
1847
+ * @brief 音频编码码率,单位为 kbps。
1848
+ *
1849
+ */
1149
1850
  /** {en}
1150
1851
  * @brief The audio encoding bitrate, in Kbps.
1151
1852
  *
1152
1853
  */
1153
1854
  get encodeAudioBitrate(): number;
1154
1855
  set encodeAudioBitrate(value: number);
1155
-
1856
+ /** {zh}
1857
+ * @brief 推流地址。
1858
+ *
1859
+ */
1156
1860
  /** {en}
1157
1861
  * @brief The push stream address.
1158
1862
  *
1159
1863
  */
1160
1864
  get url(): string;
1161
1865
  set url(value: string);
1162
-
1866
+ /** {zh}
1867
+ * @brief 视频编码格式。
1868
+ *
1869
+ */
1163
1870
  /** {en}
1164
1871
  * @brief The video codec.
1165
1872
  *
@@ -1169,63 +1876,103 @@ export declare class VeLivePusherStatistics {
1169
1876
  protected __init(...args: any[]): void;
1170
1877
  protected __new_instance(...args: any[]): any;
1171
1878
  }
1172
-
1879
+ /** {zh}
1880
+ * @detail keytype
1881
+ * @brief 视频特效的许可证认证方式。
1882
+ *
1883
+ */
1173
1884
  export declare enum VeLiveVideoEffectLicenseType {
1174
-
1885
+ /** {zh}
1886
+ * @brief 离线认证视频特效许可证。
1887
+ *
1888
+ */
1175
1889
  /** {en}
1176
1890
  * @brief Authenticate offline.
1177
1891
  *
1178
1892
  */
1179
1893
  VeLiveVideoEffectLicenseTypeOffLine = 0,
1180
-
1894
+ /** {zh}
1895
+ * @brief 在线认证视频特效许可证。
1896
+ *
1897
+ */
1181
1898
  /** {en}
1182
1899
  * @brief Authenticate online.
1183
1900
  *
1184
1901
  */
1185
1902
  VeLiveVideoEffectLicenseTypeOnLine = 1
1186
1903
  }
1187
-
1904
+ /** {zh}
1905
+ * @detail keytype
1906
+ * @brief 推流音频声道数,决定音频的立体感。
1907
+ *
1908
+ */
1188
1909
  export declare enum VeLiveAudioChannel {
1189
-
1910
+ /** {zh}
1911
+ * @brief 单声道,适用于语音通信,节省带宽。
1912
+ *
1913
+ */
1190
1914
  /** {en}
1191
1915
  * @brief Mono, which is suitable for voice communication and saves bandwidth.
1192
1916
  *
1193
1917
  */
1194
1918
  VeLiveAudioChannelMono = 0,
1195
-
1919
+ /** {zh}
1920
+ * @brief 立体声,适用于音乐播放,提供更丰富的音频体验。
1921
+ *
1922
+ */
1196
1923
  /** {en}
1197
1924
  * @brief Stereo, which provides a richer audio experience and is suitable for music playback.
1198
1925
  *
1199
1926
  */
1200
1927
  VeLiveAudioChannelStereo = 1
1201
1928
  }
1202
-
1929
+ /** {zh}
1930
+ * @detail keytype
1931
+ * @brief 定义了推流中首帧的类型,包括音视频的采集首帧、渲染首帧、编码完成首帧和发送首帧。
1932
+ *
1933
+ */
1203
1934
  export declare enum VeLiveFirstFrameType {
1204
-
1935
+ /** {zh}
1936
+ * @brief 视频/音频采集首帧,采集首帧是从音频设备或视频设备(如麦克风、摄像头)获取的第一帧数据。
1937
+ *
1938
+ */
1205
1939
  /** {en}
1206
1940
  * @brief The first audio or video frame captured by the microphone or the camera.
1207
1941
  *
1208
1942
  */
1209
1943
  VeLiveFirstCaptureFrame = 0,
1210
-
1944
+ /** {zh}
1945
+ * @brief 视频渲染首帧,渲染首帧是在渲染过程中在屏幕上显示的第一帧视频数据。
1946
+ *
1947
+ */
1211
1948
  /** {en}
1212
1949
  * @brief The first video frame rendered, which is the first frame displayed on the screen.
1213
1950
  *
1214
1951
  */
1215
1952
  VeLiveFirstRenderFrame = 1,
1216
-
1953
+ /** {zh}
1954
+ * @brief 视频/音频编码完成首帧,编码完成首帧是编码为某种特定格式的第一帧数据。
1955
+ *
1956
+ */
1217
1957
  /** {en}
1218
1958
  * @brief The first audio or video frame encoded in a certain format.
1219
1959
  *
1220
1960
  */
1221
1961
  VeLiveFirstEncodedFrame = 2,
1222
-
1962
+ /** {zh}
1963
+ * @brief 视频/音频发送首帧,发送首帧是在发送过程中,通过网络传输的第一帧数据。
1964
+ *
1965
+ */
1223
1966
  /** {en}
1224
1967
  * @brief The first audio or video frame transmitted through the network.
1225
1968
  *
1226
1969
  */
1227
1970
  VeLiveFirstSendFrame = 3,
1228
-
1971
+ /** {zh}
1972
+ * @platform ios
1973
+ * @brief 录屏采集开始后,获得的第一个 app 音频帧。
1974
+ *
1975
+ */
1229
1976
  /** {en}
1230
1977
  * @platform ios
1231
1978
  * @brief The first audio frame captured from the app after screen streaming starts.
@@ -1233,53 +1980,86 @@ export declare enum VeLiveFirstFrameType {
1233
1980
  */
1234
1981
  VeLiveFirstAppAudioCaptureFrame = 4
1235
1982
  }
1236
-
1983
+ /** {zh}
1984
+ * @detail keytype
1985
+ * @brief 视频帧来源。
1986
+ *
1987
+ */
1237
1988
  export declare enum VeLiveVideoFrameSource {
1238
-
1989
+ /** {zh}
1990
+ * @brief 采集到的原始视频帧。这是从设备的摄像头或其他视频输入源获取的视频帧。
1991
+ *
1992
+ */
1239
1993
  /** {en}
1240
1994
  * @brief The original video frame captured by the camera or other video sources.
1241
1995
  *
1242
1996
  */
1243
1997
  VeLiveVideoFrameSourceCapture = 0,
1244
-
1998
+ /** {zh}
1999
+ * @brief 编码前的视频帧。这是通过各种处理(例如滤镜、旋转等)后,准备进行编码的视频帧。
2000
+ *
2001
+ */
1245
2002
  /** {en}
1246
2003
  * @brief The video frame to be encoded after undergoing various processes, such as filtering and rotation.
1247
2004
  *
1248
2005
  */
1249
2006
  VeLiveVideoFrameSourcePreEncode = 1
1250
2007
  }
1251
-
2008
+ /** {zh}
2009
+ * @detail keytype
2010
+ * @brief AAC 音频编码档位。
2011
+ *
2012
+ */
1252
2013
  export declare enum VeLiveAudioProfile {
1253
-
2014
+ /** {zh}
2015
+ * @brief LC-AAC 编码方式。
2016
+ *
2017
+ */
1254
2018
  /** {en}
1255
2019
  * @brief LC-AAC.
1256
2020
  *
1257
2021
  */
1258
2022
  VeLiveAudioAACProfileLC = 0,
1259
-
2023
+ /** {zh}
2024
+ * @brief HEv1-AAC 编码方式。
2025
+ *
2026
+ */
1260
2027
  /** {en}
1261
2028
  * @brief HEv1-AAC.
1262
2029
  *
1263
2030
  */
1264
2031
  VeLiveAudioAACProfileHEv1 = 1,
1265
-
2032
+ /** {zh}
2033
+ * @brief HEv2-AAC 编码方式。
2034
+ *
2035
+ */
1266
2036
  /** {en}
1267
2037
  * @brief HEv2-AAC.
1268
2038
  *
1269
2039
  */
1270
2040
  VeLiveAudioAACProfileHEv2 = 2
1271
2041
  }
1272
-
2042
+ /** {zh}
2043
+ * @detail keytype
2044
+ * @brief 音频采集配置。
2045
+ *
2046
+ */
1273
2047
  export declare class VeLiveAudioCaptureConfiguration {
1274
2048
  protected _instance: any;
1275
-
2049
+ /** {zh}
2050
+ * @platform ios
2051
+ * @brief 音频采样率,默认值为 `VeLiveAudioSampleRate44100`,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
2052
+ */
1276
2053
  /** {en}
1277
2054
  * @platform ios
1278
2055
  * @brief The sample rate. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details. The default value is `VeLiveAudioSampleRate44100`.
1279
2056
  */
1280
2057
  get sampleRate(): $p_i.VeLiveAudioSampleRate;
1281
2058
  set sampleRate(value: $p_i.VeLiveAudioSampleRate);
1282
-
2059
+ /** {zh}
2060
+ * @platform ios
2061
+ * @brief 音频采集声道数,默认值为 `VeLiveAudioChannelStereo`,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
2062
+ */
1283
2063
  /** {en}
1284
2064
  * @platform ios
1285
2065
  * @brief The number of audio channels. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details. The default value is `VeLiveAudioChannelStereo`.
@@ -1288,7 +2068,13 @@ export declare class VeLiveAudioCaptureConfiguration {
1288
2068
  set channel(value: $p_i.VeLiveAudioChannel);
1289
2069
  protected __init(...args: any[]): void;
1290
2070
  protected __new_instance(...args: any[]): any;
1291
-
2071
+ /** {zh}
2072
+ * @platform android
2073
+ * @detail api
2074
+ * @brief 获取采集音频采样率。
2075
+ * @return 音频采样率,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
2076
+ *
2077
+ */
1292
2078
  /** {en}
1293
2079
  * @platform android
1294
2080
  * @detail api
@@ -1297,7 +2083,14 @@ export declare class VeLiveAudioCaptureConfiguration {
1297
2083
  *
1298
2084
  */
1299
2085
  android_getSampleRate(): $p_a.VeLiveAudioSampleRate;
1300
-
2086
+ /** {zh}
2087
+ * @platform android
2088
+ * @detail api
2089
+ * @brief 设置采集音频采样率。
2090
+ * @param sampleRate 音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
2091
+ * @return 推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
2092
+ *
2093
+ */
1301
2094
  /** {en}
1302
2095
  * @platform android
1303
2096
  * @detail api
@@ -1307,7 +2100,13 @@ export declare class VeLiveAudioCaptureConfiguration {
1307
2100
  *
1308
2101
  */
1309
2102
  android_setSampleRate(sampleRate: $p_a.VeLiveAudioSampleRate): this;
1310
-
2103
+ /** {zh}
2104
+ * @platform android
2105
+ * @detail api
2106
+ * @brief 获取采集音频声道数。
2107
+ * @return 音频声道数,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
2108
+ *
2109
+ */
1311
2110
  /** {en}
1312
2111
  * @platform android
1313
2112
  * @detail api
@@ -1316,7 +2115,14 @@ export declare class VeLiveAudioCaptureConfiguration {
1316
2115
  *
1317
2116
  */
1318
2117
  android_getChannel(): $p_a.VeLiveAudioChannel;
1319
-
2118
+ /** {zh}
2119
+ * @platform android
2120
+ * @detail api
2121
+ * @brief 设置采集音频声道数。
2122
+ * @param channel 音频声道数,默认值为 VeLiveAudioChannelStereo,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)
2123
+ * @return 推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
2124
+ *
2125
+ */
1320
2126
  /** {en}
1321
2127
  * @platform android
1322
2128
  * @detail api
@@ -1327,10 +2133,17 @@ export declare class VeLiveAudioCaptureConfiguration {
1327
2133
  */
1328
2134
  android_setChannel(channel: $p_a.VeLiveAudioChannel): this;
1329
2135
  }
1330
-
2136
+ /** {zh}
2137
+ * @detail keytype
2138
+ * @brief 音视频混流布局。包含了视频混流布局、音频混流布局和画布背景色等属性。
2139
+ *
2140
+ */
1331
2141
  export declare class VeLiveStreamMixDescription {
1332
2142
  protected _instance: any;
1333
-
2143
+ /** {zh}
2144
+ * @brief 视频混流画布的背景色设置,采用 #RRGGBB 格式。
2145
+ *
2146
+ */
1334
2147
  /** {en}
1335
2148
  * @brief The background color of the mixed video, in #RRGGBB format.
1336
2149
  *
@@ -1340,36 +2153,59 @@ export declare class VeLiveStreamMixDescription {
1340
2153
  protected __init(...args: any[]): void;
1341
2154
  protected __new_instance(...args: any[]): any;
1342
2155
  }
1343
-
2156
+ /** {zh}
2157
+ * @detail keytype
2158
+ * @brief 推流音频采样率。
2159
+ *
2160
+ */
1344
2161
  export declare enum VeLiveAudioSampleRate {
1345
-
2162
+ /** {zh}
2163
+ * @platform android
2164
+ * @brief 8k 采样。
2165
+ *
2166
+ */
1346
2167
  /** {en}
1347
2168
  * @platform android
1348
2169
  * @brief 8K.
1349
2170
  *
1350
2171
  */
1351
2172
  VeLiveAudioSampleRate8000 = 0,
1352
-
2173
+ /** {zh}
2174
+ * @platform android
2175
+ * @brief 16k 采样。
2176
+ *
2177
+ */
1353
2178
  /** {en}
1354
2179
  * @platform android
1355
2180
  * @brief 16K.
1356
2181
  *
1357
2182
  */
1358
2183
  VeLiveAudioSampleRate16000 = 1,
1359
-
2184
+ /** {zh}
2185
+ * @platform android
2186
+ * @brief 32k 采样。
2187
+ *
2188
+ */
1360
2189
  /** {en}
1361
2190
  * @platform android
1362
2191
  * @brief 32K.
1363
2192
  *
1364
2193
  */
1365
2194
  VeLiveAudioSampleRate32000 = 2,
1366
-
2195
+ /** {zh}
2196
+ * @brief 44.1k 采样。
2197
+ *
2198
+ */
1367
2199
  /** {en}
1368
2200
  * @brief 44.1K.
1369
2201
  *
1370
2202
  */
1371
2203
  VeLiveAudioSampleRate44100 = 3,
1372
-
2204
+ /** {zh}
2205
+ * @platform android
2206
+ * @brief 48k 采样。
2207
+ *
2208
+ */
1373
2209
  /** {en}
1374
2210
  * @platform android
1375
2211
  * @brief 48K.
@@ -1377,9 +2213,22 @@ export declare enum VeLiveAudioSampleRate {
1377
2213
  */
1378
2214
  VeLiveAudioSampleRate48000 = 4
1379
2215
  }
1380
-
2216
+ /** {zh}
2217
+ * @detail keytype
2218
+ * @brief 推流视频分辨率档位枚举值。
2219
+ *
2220
+ */
1381
2221
  export declare enum VeLiveVideoResolution {
1382
-
2222
+ /** {zh}
2223
+ * @brief 360P 分辨率。档位详细配置如下所示。
2224
+ * - 横屏分辨率:640x360
2225
+ * - 竖屏分辨率:360x640
2226
+ * - 帧率:15fps
2227
+ * - 目标码率:500kbps
2228
+ * - 最小码率:250kbps
2229
+ * - 最大码率:800kbps
2230
+ *
2231
+ */
1383
2232
  /** {en}
1384
2233
  * @brief 360P.
1385
2234
  * - Resolution in landscape mode: 640x360
@@ -1391,7 +2240,16 @@ export declare enum VeLiveVideoResolution {
1391
2240
  *
1392
2241
  */
1393
2242
  VeLiveVideoResolution360P = 0,
1394
-
2243
+ /** {zh}
2244
+ * @brief 480P 分辨率。档位详细配置如下所示。
2245
+ * - 横屏分辨率:864x480
2246
+ * - 竖屏分辨率:480x864
2247
+ * - 帧率:15fps
2248
+ * - 目标码率:800kbps
2249
+ * - 最小码率:320kbps
2250
+ * - 最大码率:1266kbps
2251
+ *
2252
+ */
1395
2253
  /** {en}
1396
2254
  * @brief 480P.
1397
2255
  * - Resolution in landscape mode: 864x480
@@ -1403,7 +2261,16 @@ export declare enum VeLiveVideoResolution {
1403
2261
  *
1404
2262
  */
1405
2263
  VeLiveVideoResolution480P = 1,
1406
-
2264
+ /** {zh}
2265
+ * @brief 540P 分辨率。档位详细配置如下所示。
2266
+ * - 横屏 960x540
2267
+ * - 竖屏 540x960
2268
+ * - 帧率:15fps
2269
+ * - 目标码率:1000kbps
2270
+ * - 最小码率:500kbps
2271
+ * - 最大码率:1520kbps
2272
+ *
2273
+ */
1407
2274
  /** {en}
1408
2275
  * @brief 540P.
1409
2276
  * - Resolution in landscape mode: 960x540
@@ -1415,7 +2282,16 @@ export declare enum VeLiveVideoResolution {
1415
2282
  *
1416
2283
  */
1417
2284
  VeLiveVideoResolution540P = 2,
1418
-
2285
+ /** {zh}
2286
+ * @brief 720P 分辨率。档位详细配置如下所示。
2287
+ * - 横屏 1280x720
2288
+ * - 竖屏 720x1280
2289
+ * - 帧率:15fps
2290
+ * - 目标码率:1200kbps
2291
+ * - 最小码率:800kbps
2292
+ * - 最大码率:1900kbps
2293
+ *
2294
+ */
1419
2295
  /** {en}
1420
2296
  * @brief 720P.
1421
2297
  * - Resolution in landscape mode: 1280x720
@@ -1427,7 +2303,16 @@ export declare enum VeLiveVideoResolution {
1427
2303
  *
1428
2304
  */
1429
2305
  VeLiveVideoResolution720P = 3,
1430
-
2306
+ /** {zh}
2307
+ * @brief 1080P 分辨率。档位详细配置如下所示。
2308
+ * - 横屏 1920x1080
2309
+ * - 竖屏 1080x1920
2310
+ * - 帧率:20 fps
2311
+ * - 目标码率:2500kbps
2312
+ * - 最小码率:1000kbps
2313
+ * - 最大码率:3800kbps
2314
+ *
2315
+ */
1431
2316
  /** {en}
1432
2317
  * @brief 1080P.
1433
2318
  * - Resolution in landscape mode: 1920x1080
@@ -1439,7 +2324,15 @@ export declare enum VeLiveVideoResolution {
1439
2324
  *
1440
2325
  */
1441
2326
  VeLiveVideoResolution1080P = 4,
1442
-
2327
+ /** {zh}
2328
+ * @platform ios
2329
+ * @brief 屏幕推流分辨率。档位详细配置如下所示。
2330
+ * - 帧率:15fps
2331
+ * - 目标码率:2500kbps
2332
+ * - 最小码率:1000kbps
2333
+ * - 最大码率:3800kbps
2334
+ *
2335
+ */
1443
2336
  /** {en}
1444
2337
  * @platform ios
1445
2338
  * @brief The resolution of the streamed screen. The predefined configurations are as follows:
@@ -1451,47 +2344,68 @@ export declare enum VeLiveVideoResolution {
1451
2344
  */
1452
2345
  VeLiveVideoResolutionScreen = 5
1453
2346
  }
1454
-
2347
+ /** {zh}
2348
+ * @detail keytype
2349
+ * @brief 音频帧的数据信息。
2350
+ */
1455
2351
  export declare class VeLiveAudioFrame {
1456
2352
  constructor();
1457
2353
  constructor();
1458
2354
  protected _instance: any;
1459
-
2355
+ /** {zh}
2356
+ * @platform ios
2357
+ * @brief 音频数据类型,默认值为 `VeLiveAudioBufferTypeUnknown`,详情请参见 [VeLiveAudioBufferType](#VeLiveAudioBufferType)。
2358
+ */
1460
2359
  /** {en}
1461
2360
  * @platform ios
1462
2361
  * @brief The audio data type. The default value is `VeLiveAudioBufferTypeUnknown`. See [VeLiveAudioBufferType](#VeLiveAudioBufferType) for details.
1463
2362
  */
1464
2363
  get bufferType(): $p_i.VeLiveAudioBufferType;
1465
2364
  set bufferType(value: $p_i.VeLiveAudioBufferType);
1466
-
2365
+ /** {zh}
2366
+ * @platform ios
2367
+ * @brief 音频采样率。详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
2368
+ */
1467
2369
  /** {en}
1468
2370
  * @platform ios
1469
2371
  * @brief The audio sample rate. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
1470
2372
  */
1471
2373
  get sampleRate(): $p_i.VeLiveAudioSampleRate;
1472
2374
  set sampleRate(value: $p_i.VeLiveAudioSampleRate);
1473
-
2375
+ /** {zh}
2376
+ * @platform ios
2377
+ * @brief 音频声道数。详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
2378
+ */
1474
2379
  /** {en}
1475
2380
  * @platform ios
1476
2381
  * @brief The number of audio channels. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
1477
2382
  */
1478
2383
  get channels(): $p_i.VeLiveAudioChannel;
1479
2384
  set channels(value: $p_i.VeLiveAudioChannel);
1480
-
2385
+ /** {zh}
2386
+ * @platform ios
2387
+ * @brief 当 bufferType 取值为 `VeLiveAudioBufferNSData` 时的音频帧时间戳,单位为 μs。
2388
+ */
1481
2389
  /** {en}
1482
2390
  * @platform ios
1483
2391
  * @brief The audio frame timestamp, in μs, when `bufferType` is `VeLiveAudioBufferNSData`.
1484
2392
  */
1485
2393
  get pts(): $p_i.CMTime;
1486
2394
  set pts(value: $p_i.CMTime);
1487
-
2395
+ /** {zh}
2396
+ * @platform ios
2397
+ * @brief 当 bufferType 取值为 `VeLiveAudioBufferTypeSampleBuffer` 时的音频数据。
2398
+ */
1488
2399
  /** {en}
1489
2400
  * @platform ios
1490
2401
  * @brief The audio data, when `bufferType` is `VeLiveAudioBufferTypeSampleBuffer`.
1491
2402
  */
1492
2403
  get sampleBuffer(): $p_i.CMSampleBufferRef;
1493
2404
  set sampleBuffer(value: $p_i.CMSampleBufferRef);
1494
-
2405
+ /** {zh}
2406
+ * @platform ios
2407
+ * @brief 当 bufferType 取值为 `VeLiveAudioBufferTypeNSData` 时的音频数据。音频帧数据为 float32 格式小端字节序存储。
2408
+ */
1495
2409
  /** {en}
1496
2410
  * @platform ios
1497
2411
  * @brief The audio data, when `bufferType` is `VeLiveAudioBufferTypeNSData`. The audio data is of type float32 and is stored in little-endian byte order.
@@ -1500,7 +2414,13 @@ export declare class VeLiveAudioFrame {
1500
2414
  set data(value: $p_i.NSData);
1501
2415
  protected __init(...args: any[]): void;
1502
2416
  protected __new_instance(...args: any[]): any;
1503
-
2417
+ /** {zh}
2418
+ * @platform android
2419
+ * @detail api
2420
+ * @brief 获取音频数据类型。
2421
+ * @return 音频数据类型,详情请参见 [VeLiveAudioBufferType](#VeLiveAudioBufferType)。
2422
+ *
2423
+ */
1504
2424
  /** {en}
1505
2425
  * @platform android
1506
2426
  * @detail api
@@ -1509,7 +2429,13 @@ export declare class VeLiveAudioFrame {
1509
2429
  *
1510
2430
  */
1511
2431
  android_getBufferType(): $p_a.VeLiveAudioBufferType;
1512
-
2432
+ /** {zh}
2433
+ * @platform android
2434
+ * @detail api
2435
+ * @brief 获取音频采样率。
2436
+ * @return 音频采样率,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
2437
+ *
2438
+ */
1513
2439
  /** {en}
1514
2440
  * @platform android
1515
2441
  * @detail api
@@ -1518,7 +2444,13 @@ export declare class VeLiveAudioFrame {
1518
2444
  *
1519
2445
  */
1520
2446
  android_getSampleRate(): $p_a.VeLiveAudioSampleRate;
1521
-
2447
+ /** {zh}
2448
+ * @platform android
2449
+ * @detail api
2450
+ * @brief 获取音频声道数。
2451
+ * @return 音频声道数,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
2452
+ *
2453
+ */
1522
2454
  /** {en}
1523
2455
  * @platform android
1524
2456
  * @detail api
@@ -1527,7 +2459,13 @@ export declare class VeLiveAudioFrame {
1527
2459
  *
1528
2460
  */
1529
2461
  android_getChannels(): $p_a.VeLiveAudioChannel;
1530
-
2462
+ /** {zh}
2463
+ * @platform android
2464
+ * @detail api
2465
+ * @brief 获取每个声道的采样点数。
2466
+ * @return 采样点数。
2467
+ *
2468
+ */
1531
2469
  /** {en}
1532
2470
  * @platform android
1533
2471
  * @detail api
@@ -1536,7 +2474,14 @@ export declare class VeLiveAudioFrame {
1536
2474
  *
1537
2475
  */
1538
2476
  android_getSamplesPerChannel(): number;
1539
-
2477
+ /** {zh}
2478
+ * @platform android
2479
+ * @detail api
2480
+ * @brief 获取音频时间戳,单位为 μs。
2481
+ * @return <br>
2482
+ * 音频时间戳,单位为 μs。
2483
+ *
2484
+ */
1540
2485
  /** {en}
1541
2486
  * @platform android
1542
2487
  * @detail api
@@ -1546,7 +2491,14 @@ export declare class VeLiveAudioFrame {
1546
2491
  *
1547
2492
  */
1548
2493
  android_getPts(): number;
1549
-
2494
+ /** {zh}
2495
+ * @platform android
2496
+ * @detail api
2497
+ * @brief 获取音频数据。音频帧数据为小端字节序存储。
2498
+ * @return <br>
2499
+ * 格式为 ByteBuffer 的音频数据。
2500
+ *
2501
+ */
1550
2502
  /** {en}
1551
2503
  * @platform android
1552
2504
  * @detail api
@@ -1557,17 +2509,28 @@ export declare class VeLiveAudioFrame {
1557
2509
  */
1558
2510
  android_getBuffer(): $p_a.ByteBuffer;
1559
2511
  }
1560
-
2512
+ /** {zh}
2513
+ * @detail keytype
2514
+ * @brief 音频混流设置。
2515
+ *
2516
+ */
1561
2517
  export declare class VeLiveMixAudioLayout {
1562
2518
  protected _instance: any;
1563
-
2519
+ /** {zh}
2520
+ * @brief 音频流 ID,唯一标识,用于区分不同的音频流。
2521
+ *
2522
+ */
1564
2523
  /** {en}
1565
2524
  * @brief The unique identifier for an audio stream.
1566
2525
  *
1567
2526
  */
1568
2527
  get streamId(): number;
1569
2528
  set streamId(value: number);
1570
-
2529
+ /** {zh}
2530
+ * @detail api
2531
+ * @brief 混流音频的音量,范围为 [0.0,4.0]。当您将 [VeLiveAudioMixType](#VeLiveAudioMixType) 设置为 `VeLiveAudioMixPlayAndPush` 时,该变量同时控制混流音频在拉流端和本地的播放音量。
2532
+ *
2533
+ */
1571
2534
  /** {en}
1572
2535
  * @detail api
1573
2536
  * @brief The volume of the mixed audio stream. The value range is [0.0,4.0]. If you set [VeLiveAudioMixType](#VeLiveAudioMixType) to `VeLiveAudioMixPlayAndPush`, this variable takes effect on both the host and the audience sides.
@@ -1577,7 +2540,13 @@ export declare class VeLiveMixAudioLayout {
1577
2540
  set volume(value: number);
1578
2541
  protected __init(...args: any[]): void;
1579
2542
  protected __new_instance(...args: any[]): any;
1580
-
2543
+ /** {zh}
2544
+ * @platform android
2545
+ * @detail api
2546
+ * @brief 更新音频混流设置。
2547
+ * @param other 新的音频混流设置,详情请参见 [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout)。
2548
+ *
2549
+ */
1581
2550
  /** {en}
1582
2551
  * @platform android
1583
2552
  * @detail api
@@ -1587,87 +2556,133 @@ export declare class VeLiveMixAudioLayout {
1587
2556
  */
1588
2557
  android_update(other: $p_a.VeLiveMixAudioLayout): void;
1589
2558
  }
1590
-
2559
+ /** {zh}
2560
+ * @detail keytype
2561
+ * @brief 视频镜像类型。
2562
+ *
2563
+ */
1591
2564
  export declare enum VeLiveVideoMirrorType {
1592
-
2565
+ /** {zh}
2566
+ * @brief 对采集画面的镜像控制。开启时,预览和推流画面都会呈现为镜像状态。
2567
+ *
2568
+ */
1593
2569
  /** {en}
1594
2570
  * @brief Mirror the captured video. When turned on, both the preview and the pushed video are mirrored.
1595
2571
  *
1596
2572
  */
1597
2573
  VeLiveVideoMirrorCapture = 0,
1598
-
2574
+ /** {zh}
2575
+ * @brief 对预览画面的镜像控制。开启时,只有主播预览画面呈现镜像状态。
2576
+ *
2577
+ */
1599
2578
  /** {en}
1600
2579
  * @brief Mirror the preview. When turned on, only the preview is mirrored.
1601
2580
  *
1602
2581
  */
1603
2582
  VeLiveVideoMirrorPreview = 1,
1604
-
2583
+ /** {zh}
2584
+ * @brief 对编码前画面的镜像控制。开启时,主播推流画面呈现镜像状态。
2585
+ *
2586
+ */
1605
2587
  /** {en}
1606
2588
  * @brief Mirror the video before encoding. When turned on, only the pushed video is mirrored.
1607
2589
  *
1608
2590
  */
1609
2591
  VeLiveVideoMirrorPushStream = 2
1610
2592
  }
1611
-
2593
+ /** {zh}
2594
+ * @detail keytype
2595
+ * @brief 视频混流设置。
2596
+ *
2597
+ */
1612
2598
  export declare class VeLiveMixVideoLayout {
1613
2599
  protected _instance: any;
1614
-
2600
+ /** {zh}
2601
+ * @brief 视频流 ID,唯一标识,用于区分不同的视频流。
2602
+ *
2603
+ */
1615
2604
  /** {en}
1616
2605
  * @brief The unique identifier for a video stream.
1617
2606
  *
1618
2607
  */
1619
2608
  get streamId(): number;
1620
2609
  set streamId(value: number);
1621
-
2610
+ /** {zh}
2611
+ * @brief 视频流对应区域左上角的横坐标,该坐标是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
2612
+ *
2613
+ */
1622
2614
  /** {en}
1623
2615
  * @brief The horizontal offset, which represents the ratio of the distance between the left edge of the video and the left edge of the screen to the width of the screen. The value range is [0.0,1.0], where `0.0` indicates the left edge and `1.0` indicates the right edge.
1624
2616
  *
1625
2617
  */
1626
2618
  get x(): number;
1627
2619
  set x(value: number);
1628
-
2620
+ /** {zh}
2621
+ * @brief 视频流对应区域左上角的纵坐标,该坐标是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
2622
+ *
2623
+ */
1629
2624
  /** {en}
1630
2625
  * @brief The vertical offset, which represents the ratio of the distance between the top edge of the video and the top edge of the screen to the height of the screen. The value range is [0.0,1.0], where `0.0` indicates the top edge and `1.0` indicates the bottom edge.
1631
2626
  *
1632
2627
  */
1633
2628
  get y(): number;
1634
2629
  set y(value: number);
1635
-
2630
+ /** {zh}
2631
+ * @brief 视频流对应区域宽度,该宽度是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
2632
+ *
2633
+ */
1636
2634
  /** {en}
1637
2635
  * @brief The ratio of the video width to the screen width. The value range is [0.0,1.0], where `1.0` indicates that the video occupies the entire screen width.
1638
2636
  *
1639
2637
  */
1640
2638
  get width(): number;
1641
2639
  set width(value: number);
1642
-
2640
+ /** {zh}
2641
+ * @brief 视频流对应区域高度,该高度是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
2642
+ *
2643
+ */
1643
2644
  /** {en}
1644
2645
  * @brief The ratio of the video height to the screen height. The value range is [0.0,1.0], where `1.0` indicates that the video occupies the entire screen height.
1645
2646
  *
1646
2647
  */
1647
2648
  get height(): number;
1648
2649
  set height(value: number);
1649
-
2650
+ /** {zh}
2651
+ * @brief 视频流在混流中的透明度,取值范围为 [0.0,1.0],取值 0.0 表示全透明,取值 1.0 表示不透明。
2652
+ *
2653
+ */
1650
2654
  /** {en}
1651
2655
  * @brief The video transparency. The value range is [0.0, 1.0], where `0.0` indicates full transparency and `1.0` indicates full opacity.
1652
2656
  *
1653
2657
  */
1654
2658
  get alpha(): number;
1655
2659
  set alpha(value: number);
1656
-
2660
+ /** {zh}
2661
+ * @brief 视频流在混流中的层级。取值范围为 [0,100],取值 0 表示最底层,取值越大,层级越高。
2662
+ *
2663
+ */
1657
2664
  /** {en}
1658
2665
  * @brief The level of video within the final mixed video. The value range is [0,100], where `0` represents the bottom layer. The higher the value, the higher the level of the video in the final output.
1659
2666
  *
1660
2667
  */
1661
2668
  get zOrder(): number;
1662
2669
  set zOrder(value: number);
1663
-
2670
+ /** {zh}
2671
+ * @brief 视频流的渲染模式。详情请参见 [VeLivePusherRenderMode](#VeLivePusherRenderMode)。
2672
+ *
2673
+ */
1664
2674
  /** {en}
1665
2675
  * @brief The render mode of the video. See [VeLivePusherRenderMode](#VeLivePusherRenderMode) for details.
1666
2676
  *
1667
2677
  */
1668
2678
  get renderMode(): VeLivePusherRenderMode;
1669
2679
  set renderMode(value: VeLivePusherRenderMode);
1670
-
2680
+ /** {zh}
2681
+ * @brief 是否保留视频流原 Alpha 通道值,默认为保留,当 [alpha](#VeLiveMixVideoLayout-alpha) 取值在 [0.0, 1.0] 之间时,则忽略该配置。
2682
+ * - YES:保留;
2683
+ * - NO:不保留。
2684
+ *
2685
+ */
1671
2686
  /** {en}
1672
2687
  * @brief Whether to retain the original Alpha channel value of the video stream. The default is retain. When the value of [alpha](#VeLiveMixVideoLayout-alpha) is within the range of [0.0, 1.0], this configuration is ignored.<br/>
1673
2688
  *
@@ -1679,7 +2694,13 @@ export declare class VeLiveMixVideoLayout {
1679
2694
  set enableAlpha(value: boolean);
1680
2695
  protected __init(...args: any[]): void;
1681
2696
  protected __new_instance(...args: any[]): any;
1682
-
2697
+ /** {zh}
2698
+ * @platform android
2699
+ * @detail api
2700
+ * @brief 更新视频混流设置。
2701
+ * @param other 新的视频混流设置,详情请参见 [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout)。
2702
+ *
2703
+ */
1683
2704
  /** {en}
1684
2705
  * @platform android
1685
2706
  * @detail api
@@ -1689,9 +2710,20 @@ export declare class VeLiveMixVideoLayout {
1689
2710
  */
1690
2711
  android_update(other: $p_a.VeLiveMixVideoLayout): void;
1691
2712
  }
1692
-
2713
+ /** {zh}
2714
+ * @detail keytype
2715
+ * @brief 视频特效许可证配置。
2716
+ *
2717
+ */
1693
2718
  export declare class VeLiveVideoEffectLicenseConfiguration {
1694
-
2719
+ /** {zh}
2720
+ * @platform android
2721
+ * @detail api
2722
+ * @brief 初始化配置为本地验证模式。
2723
+ * @param path 视频特效许可证的本地缓存路径。可通过 [getPath](#VeLiveVideoEffectLicenseConfiguration-getpath) 获取。
2724
+ * @return 返回 VeLiveVideoEffectLicenseConfiguration 类的实例,该实例使用指定的本地路径进行许可证验证。
2725
+ *
2726
+ */
1695
2727
  /** {en}
1696
2728
  * @platform android
1697
2729
  * @detail api
@@ -1701,7 +2733,16 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1701
2733
  *
1702
2734
  */
1703
2735
  static android_create(path: string): $p_a.VeLiveVideoEffectLicenseConfiguration;
1704
-
2736
+ /** {zh}
2737
+ * @platform android
2738
+ * @detail api
2739
+ * @brief 初始化配置为在线验证模式。
2740
+ * @return <br>返回 VeLiveVideoEffectLicenseConfiguration 类的实例,该实例使用指定的 key、secret 和 url 进行在线许可证验证。
2741
+ * @param key 视频特效许可证的在线认证 key。可通过 [getKey](#VeLiveVideoEffectLicenseConfiguration-getkey) 获取。
2742
+ * @param secret 视频特效许可证的在线认证 secret。可通过 [getSecret](#VeLiveVideoEffectLicenseConfiguration-getsecret) 获取。
2743
+ * @param url 视频特效许可证的在线认证地址,如果传入 `null`,可通过 [getUrl](147521#VeLiveVideoEffectLicenseConfiguration-geturl) 获取在线认证地址。
2744
+ *
2745
+ */
1705
2746
  /** {en}
1706
2747
  * @platform android
1707
2748
  * @detail api
@@ -1712,35 +2753,50 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1712
2753
  */
1713
2754
  static android_create_key$secret$url(key: string, secret: string, url: string): $p_a.VeLiveVideoEffectLicenseConfiguration;
1714
2755
  protected _instance: any;
1715
-
2756
+ /** {zh}
2757
+ * @platform ios
2758
+ * @brief 获取视频特效许可证类型。许可证类型请参见 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType)。
2759
+ */
1716
2760
  /** {en}
1717
2761
  * @platform ios
1718
2762
  * @brief The special effects license type. See [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) for details.
1719
2763
  */
1720
2764
  get type(): $p_i.VeLiveVideoEffectLicenseType;
1721
2765
  set type(value: $p_i.VeLiveVideoEffectLicenseType);
1722
-
2766
+ /** {zh}
2767
+ * @platform ios
2768
+ * @brief 获取视频特效许可证的本地路径。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOffLine` 时,该属性返回许可证文件的本地路径。
2769
+ */
1723
2770
  /** {en}
1724
2771
  * @platform ios
1725
2772
  * @brief The local path to the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOffLine`.
1726
2773
  */
1727
2774
  get path(): $p_i.NSString;
1728
2775
  set path(value: $p_i.NSString);
1729
-
2776
+ /** {zh}
2777
+ * @platform ios
2778
+ * @brief 获取视频特效许可证的在线认证 key。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,该属性返回在线认证的 key。
2779
+ */
1730
2780
  /** {en}
1731
2781
  * @platform ios
1732
2782
  * @brief The online authentication key for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
1733
2783
  */
1734
2784
  get key(): $p_i.NSString;
1735
2785
  set key(value: $p_i.NSString);
1736
-
2786
+ /** {zh}
2787
+ * @platform ios
2788
+ * @brief 获取视频特效许可证的在线认证 secret。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,该属性返回在线认证的 secret。
2789
+ */
1737
2790
  /** {en}
1738
2791
  * @platform ios
1739
2792
  * @brief The online authentication secret for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
1740
2793
  */
1741
2794
  get secret(): $p_i.NSString;
1742
2795
  set secret(value: $p_i.NSString);
1743
-
2796
+ /** {zh}
2797
+ * @platform ios
2798
+ * @brief 获取视频特效许可证的在线认证地址。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,该属性返回在线认证地址。
2799
+ */
1744
2800
  /** {en}
1745
2801
  * @platform ios
1746
2802
  * @brief The online authentication address for the video effects license, when [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) is `VeLiveVideoEffectLicenseTypeOnLine`.
@@ -1749,7 +2805,13 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1749
2805
  set url(value: $p_i.NSString);
1750
2806
  protected __init(...args: any[]): void;
1751
2807
  protected __new_instance(...args: any[]): any;
1752
-
2808
+ /** {zh}
2809
+ * @platform android
2810
+ * @detail api
2811
+ * @brief 获取视频特效许可证类型。
2812
+ * @return 视频特效许可证类型,许可证类型请参见 [VeLiveVideoEffectLicenseType](147521#VeLiveVideoEffectLicenseType)。
2813
+ *
2814
+ */
1753
2815
  /** {en}
1754
2816
  * @platform android
1755
2817
  * @detail api
@@ -1758,7 +2820,13 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1758
2820
  *
1759
2821
  */
1760
2822
  android_getType(): $p_a.VeLiveVideoEffectLicenseType;
1761
-
2823
+ /** {zh}
2824
+ * @platform android
2825
+ * @detail api
2826
+ * @brief 获取视频特效许可证的本地路径。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOffLine` 时,返回许可证文件的本地路径。
2827
+ * @return 视频特效许可证的本地路径。
2828
+ *
2829
+ */
1762
2830
  /** {en}
1763
2831
  * @platform android
1764
2832
  * @detail api
@@ -1767,7 +2835,13 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1767
2835
  *
1768
2836
  */
1769
2837
  android_getPath(): string;
1770
-
2838
+ /** {zh}
2839
+ * @platform android
2840
+ * @detail api
2841
+ * @brief 获取视频特效许可证的在线认证 key。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 key。
2842
+ * @return 视频特效许可证的在线认证 key。
2843
+ *
2844
+ */
1771
2845
  /** {en}
1772
2846
  * @platform android
1773
2847
  * @detail api
@@ -1776,7 +2850,13 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1776
2850
  *
1777
2851
  */
1778
2852
  android_getKey(): string;
1779
-
2853
+ /** {zh}
2854
+ * @platform android
2855
+ * @detail api
2856
+ * @brief 获取视频特效许可证的在线认证 secret。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 secret。
2857
+ * @return 视频特效许可证的在线认证 secret。
2858
+ *
2859
+ */
1780
2860
  /** {en}
1781
2861
  * @platform android
1782
2862
  * @detail api
@@ -1785,7 +2865,13 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1785
2865
  *
1786
2866
  */
1787
2867
  android_getSecret(): string;
1788
-
2868
+ /** {zh}
2869
+ * @platform android
2870
+ * @detail api
2871
+ * @brief 获取视频特效许可证的在线认证地址。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证地址。
2872
+ * @return 视频特效许可证的在线认证地址。
2873
+ *
2874
+ */
1789
2875
  /** {en}
1790
2876
  * @platform android
1791
2877
  * @detail api
@@ -1794,7 +2880,13 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1794
2880
  *
1795
2881
  */
1796
2882
  android_getUrl(): string;
1797
-
2883
+ /** {zh}
2884
+ * @platform ios
2885
+ * @detail api
2886
+ * @brief 初始化配置为本地验证模式。
2887
+ * @param path 视频特效许可证的本地缓存路径。可通过 [path](#VeLiveVideoEffectLicenseConfiguration-path) 获取
2888
+ * @return 返回 [VeLiveVideoEffectLicenseConfiguration](#VeLiveVideoEffectLicenseConfiguration) 类的实例,该实例使用指定的本地路径进行许可证验证。
2889
+ */
1798
2890
  /** {en}
1799
2891
  * @platform ios
1800
2892
  * @detail api
@@ -1803,7 +2895,15 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1803
2895
  * @return A [VeLiveVideoEffectLicenseConfiguration](#VeLiveVideoEffectLicenseConfiguration) object that uses the specified local path for license authentication.
1804
2896
  */
1805
2897
  ios_initWithPath(path: string): this;
1806
-
2898
+ /** {zh}
2899
+ * @platform ios
2900
+ * @detail api
2901
+ * @brief 初始化配置为在线验证模式。
2902
+ * @param key 视频特效许可证的在线认证 key,可通过 [key](#VeLiveVideoEffectLicenseConfiguration-key) 获取。
2903
+ * @param secret 视频特效许可证的在线认证 secret,可通过 [secret](#VeLiveVideoEffectLicenseConfiguration-secret) 获取。
2904
+ * @param url 视频特效许可证的在线认证地址,如果传入 nil,会使用默认 url,可通过 [url](#VeLiveVideoEffectLicenseConfiguration-url) 获取在线认证地址。
2905
+ * @return 返回 [VeLiveVideoEffectLicenseConfiguration](#VeLiveVideoEffectLicenseConfiguration) 类的实例,该实例使用指定的 key、secret 和 url 进行在线许可证验证。
2906
+ */
1807
2907
  /** {en}
1808
2908
  * @platform ios
1809
2909
  * @detail api
@@ -1815,46 +2915,72 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1815
2915
  */
1816
2916
  ios_initWithKey(key: string, secret: string, url: string): this;
1817
2917
  }
1818
-
2918
+ /** {zh}
2919
+ * @detail keytype
2920
+ * @brief 音频帧来源。
2921
+ *
2922
+ */
1819
2923
  export declare enum VeLiveAudioFrameSource {
1820
-
2924
+ /** {zh}
2925
+ * @brief 采集到的原始音频帧。这是从设备的麦克风或其他音频输入源获取的音频帧。
2926
+ *
2927
+ */
1821
2928
  /** {en}
1822
2929
  * @brief The original audio frame captured by the microphone or other audio sources.
1823
2930
  *
1824
2931
  */
1825
2932
  VeLiveAudioFrameSourceCapture = 0,
1826
-
2933
+ /** {zh}
2934
+ * @brief 编码前的音频帧。这是通过各种处理(例如噪音消除、回声消除等)后,准备进行编码的音频帧。
2935
+ *
2936
+ */
1827
2937
  /** {en}
1828
2938
  * @brief The audio frame to be encoded after undergoing various processes, such as noise cancellation and echo cancellation.
1829
2939
  *
1830
2940
  */
1831
2941
  VeLiveAudioFrameSourcePreEncode = 1
1832
2942
  }
1833
-
2943
+ /** {zh}
2944
+ * @detail keytype
2945
+ * @brief 推流音频编码参数。
2946
+ *
2947
+ */
1834
2948
  export declare class VeLiveAudioEncoderConfiguration {
1835
2949
  protected _instance: any;
1836
-
2950
+ /** {zh}
2951
+ * @platform ios
2952
+ * @brief 音频编码码率,单位为 kbps,默认值为 64。
2953
+ */
1837
2954
  /** {en}
1838
2955
  * @platform ios
1839
2956
  * @brief The audio encoding bitrate, in Kbps. The default value is `64`.
1840
2957
  */
1841
2958
  get bitrate(): $p_i.int;
1842
2959
  set bitrate(value: $p_i.int);
1843
-
2960
+ /** {zh}
2961
+ * @platform ios
2962
+ * @brief 音频编码采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
2963
+ */
1844
2964
  /** {en}
1845
2965
  * @platform ios
1846
2966
  * @brief The encoding sample rate. The default value is `VeLiveAudioSampleRate44100`. See [VeLiveAudioSampleRate](#VeLiveAudioSampleRate) for details.
1847
2967
  */
1848
2968
  get sampleRate(): $p_i.VeLiveAudioSampleRate;
1849
2969
  set sampleRate(value: $p_i.VeLiveAudioSampleRate);
1850
-
2970
+ /** {zh}
2971
+ * @platform ios
2972
+ * @brief 音频声道数,默认值为 VeLiveAudioChannelStereo,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
2973
+ */
1851
2974
  /** {en}
1852
2975
  * @platform ios
1853
2976
  * @brief The number of audio channels. The default value is `VeLiveAudioChannelStereo`. See [VeLiveAudioChannel](#VeLiveAudioChannel) for details.
1854
2977
  */
1855
2978
  get channel(): $p_i.VeLiveAudioChannel;
1856
2979
  set channel(value: $p_i.VeLiveAudioChannel);
1857
-
2980
+ /** {zh}
2981
+ * @platform ios
2982
+ * @brief AAC 编码类型,默认值为 VeLiveAudioAACProfileLC。详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
2983
+ */
1858
2984
  /** {en}
1859
2985
  * @platform ios
1860
2986
  * @brief The AAC encoding format. The default value is `VeLiveAudioAACProfileLC`. See [VeLiveAudioProfile](#VeLiveAudioProfile) for details.
@@ -1863,7 +2989,14 @@ export declare class VeLiveAudioEncoderConfiguration {
1863
2989
  set profile(value: $p_i.VeLiveAudioProfile);
1864
2990
  protected __init(...args: any[]): void;
1865
2991
  protected __new_instance(...args: any[]): any;
1866
-
2992
+ /** {zh}
2993
+ * @platform android
2994
+ * @detail api
2995
+ * @brief 获取推流音频编码码率。
2996
+ * @return <br>
2997
+ * 推流音频编码码率。
2998
+ *
2999
+ */
1867
3000
  /** {en}
1868
3001
  * @platform android
1869
3002
  * @detail api
@@ -1872,7 +3005,14 @@ export declare class VeLiveAudioEncoderConfiguration {
1872
3005
  *
1873
3006
  */
1874
3007
  android_getBitrate(): number;
1875
-
3008
+ /** {zh}
3009
+ * @platform android
3010
+ * @detail api
3011
+ * @brief 设置推流音频编码码率。
3012
+ * @param bitrate 推流音频编码码率,单位为 kbps,默认值为 64。
3013
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
3014
+ *
3015
+ */
1876
3016
  /** {en}
1877
3017
  * @platform android
1878
3018
  * @detail api
@@ -1882,7 +3022,13 @@ export declare class VeLiveAudioEncoderConfiguration {
1882
3022
  *
1883
3023
  */
1884
3024
  android_setBitrate(bitrate: number): this;
1885
-
3025
+ /** {zh}
3026
+ * @platform android
3027
+ * @detail api
3028
+ * @brief 获取推流音频采样率。
3029
+ * @return 推流音频采样率。详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
3030
+ *
3031
+ */
1886
3032
  /** {en}
1887
3033
  * @platform android
1888
3034
  * @detail api
@@ -1891,7 +3037,14 @@ export declare class VeLiveAudioEncoderConfiguration {
1891
3037
  *
1892
3038
  */
1893
3039
  android_getSampleRate(): $p_a.VeLiveAudioSampleRate;
1894
-
3040
+ /** {zh}
3041
+ * @platform android
3042
+ * @detail api
3043
+ * @brief 设置推流音频采样率。
3044
+ * @param sampleRate 推流音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
3045
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
3046
+ *
3047
+ */
1895
3048
  /** {en}
1896
3049
  * @platform android
1897
3050
  * @detail api
@@ -1901,7 +3054,13 @@ export declare class VeLiveAudioEncoderConfiguration {
1901
3054
  *
1902
3055
  */
1903
3056
  android_setSampleRate(sampleRate: $p_a.VeLiveAudioSampleRate): this;
1904
-
3057
+ /** {zh}
3058
+ * @platform android
3059
+ * @detail api
3060
+ * @brief 获取推流音频声道。
3061
+ * @return 推流音频声道。详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
3062
+ *
3063
+ */
1905
3064
  /** {en}
1906
3065
  * @platform android
1907
3066
  * @detail api
@@ -1910,7 +3069,14 @@ export declare class VeLiveAudioEncoderConfiguration {
1910
3069
  *
1911
3070
  */
1912
3071
  android_getChannel(): $p_a.VeLiveAudioChannel;
1913
-
3072
+ /** {zh}
3073
+ * @platform android
3074
+ * @detail api
3075
+ * @brief 设置推流音频声道。
3076
+ * @param channel 推流音频声道,默认值为 VeLiveAudioChannelStereo,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
3077
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
3078
+ *
3079
+ */
1914
3080
  /** {en}
1915
3081
  * @platform android
1916
3082
  * @detail api
@@ -1920,7 +3086,13 @@ export declare class VeLiveAudioEncoderConfiguration {
1920
3086
  *
1921
3087
  */
1922
3088
  android_setChannel(channel: $p_a.VeLiveAudioChannel): this;
1923
-
3089
+ /** {zh}
3090
+ * @platform android
3091
+ * @detail api
3092
+ * @brief 获取推流音频编码类型。
3093
+ * @return 推流音频编码类型。详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
3094
+ *
3095
+ */
1924
3096
  /** {en}
1925
3097
  * @platform android
1926
3098
  * @detail api
@@ -1929,7 +3101,14 @@ export declare class VeLiveAudioEncoderConfiguration {
1929
3101
  *
1930
3102
  */
1931
3103
  android_getProfile(): $p_a.VeLiveAudioProfile;
1932
-
3104
+ /** {zh}
3105
+ * @platform android
3106
+ * @detail api
3107
+ * @brief 设置推流音频编码类型。
3108
+ * @param profile 推流音频编码类型,默认值为 VeLiveAudioAACProfileLC,详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
3109
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
3110
+ *
3111
+ */
1933
3112
  /** {en}
1934
3113
  * @platform android
1935
3114
  * @detail api
@@ -1940,15 +3119,25 @@ export declare class VeLiveAudioEncoderConfiguration {
1940
3119
  */
1941
3120
  android_setProfile(profile: $p_a.VeLiveAudioProfile): this;
1942
3121
  }
1943
-
3122
+ /** {zh}
3123
+ * @detail keytype
3124
+ * @brief 音频混流类型。
3125
+ *
3126
+ */
1944
3127
  export declare enum VeLiveAudioMixType {
1945
-
3128
+ /** {zh}
3129
+ * @brief 拉流端可以听到混音效果,本地无法听到。
3130
+ *
3131
+ */
1946
3132
  /** {en}
1947
3133
  * @brief The audience can hear the mixed audio, but the host cannot.
1948
3134
  *
1949
3135
  */
1950
3136
  VeLiveAudioMixPush = 0,
1951
-
3137
+ /** {zh}
3138
+ * @brief 拉流端和本地都可以听到混音效果。
3139
+ *
3140
+ */
1952
3141
  /** {en}
1953
3142
  * @brief Both the host and audience can hear the mixed audio.
1954
3143
  *