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

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