@volcengine/react-native-live-push 1.0.2 → 1.1.1-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 (36) hide show
  1. package/README.md +1 -0
  2. package/android/build.gradle +1 -1
  3. package/android/src/main/java/com/volcengine/velive/rn/push/NativeVariableManager.java +1 -1
  4. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushModule.java +5 -3
  5. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushView.java +86 -11
  6. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushViewManager.java +29 -40
  7. package/ios/VeLivePushView.m +1 -1
  8. package/ios/VeLivePushViewManager.m +5 -1
  9. package/lib/commonjs/index.js +21800 -17843
  10. package/lib/module/index.js +21800 -17836
  11. package/lib/typescript/android/index.d.ts +3 -0
  12. package/lib/typescript/codegen/android/api.d.ts +353 -125
  13. package/lib/typescript/codegen/android/callback.d.ts +36 -5
  14. package/lib/typescript/codegen/android/errorcode.d.ts +12 -0
  15. package/lib/typescript/codegen/android/keytype.d.ts +305 -73
  16. package/lib/typescript/codegen/android/types.d.ts +7 -6
  17. package/lib/typescript/codegen/ios/api.d.ts +81 -118
  18. package/lib/typescript/codegen/ios/callback.d.ts +22 -58
  19. package/lib/typescript/codegen/ios/external.d.ts +1 -0
  20. package/lib/typescript/codegen/ios/index.d.ts +1 -0
  21. package/lib/typescript/codegen/ios/keytype.d.ts +40 -98
  22. package/lib/typescript/codegen/ios/types.d.ts +16 -5
  23. package/lib/typescript/codegen/pack/api.d.ts +1261 -1195
  24. package/lib/typescript/codegen/pack/callback.d.ts +166 -270
  25. package/lib/typescript/codegen/pack/errorcode.d.ts +24 -122
  26. package/lib/typescript/codegen/pack/index.d.ts +1 -1
  27. package/lib/typescript/codegen/pack/keytype.d.ts +1095 -1244
  28. package/lib/typescript/codegen/pack/types.d.ts +67 -0
  29. package/lib/typescript/component.d.ts +10 -3
  30. package/lib/typescript/core/api.d.ts +2 -2
  31. package/lib/typescript/core/callback.d.ts +2 -2
  32. package/lib/typescript/core/errorcode.d.ts +2 -2
  33. package/lib/typescript/core/keytype.d.ts +2 -7
  34. package/lib/typescript/platforms/ios/extends.d.ts +17 -0
  35. package/package.json +7 -4
  36. package/react-native-velive-push.podspec +1 -1
@@ -4,106 +4,134 @@ export declare class VeLiveVideoEncoderConfiguration {
4
4
  * @detail api
5
5
  * @brief 获取推流视频分辨率。
6
6
  * @return <br>
7
- * 推流视频分辨率 {@link #VeLiveVideoResolution VeLiveVideoResolution}。
7
+ * 推流视频分辨率 VeLiveVideoResolution{@link #VeLiveVideoResolution}。
8
+ *
8
9
  */
10
+
9
11
  getResolution(): VeLiveVideoResolution;
10
12
  /** {zh}
11
13
  * @detail api
12
14
  * @brief 设置推流视频分辨率。
13
- * @param resolution 推流视频分辨率,默认值为 VeLiveVideoResolution720P,详情请参见 {@link #VeLiveVideoResolution VeLiveVideoResolution}
15
+ * @param resolution 推流视频分辨率,默认值为 VeLiveVideoResolution720P,详情请参见 VeLiveVideoResolution{@link #VeLiveVideoResolution}
14
16
  * @return <br>
15
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
17
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
18
+ *
16
19
  */
17
- setResolution(resolution: VeLiveVideoResolution): VeLiveVideoEncoderConfiguration;
20
+
21
+ setResolution(resolution: VeLiveVideoResolution): this;
18
22
  /** {zh}
19
23
  * @detail api
20
24
  * @brief 获取推流视频编码格式。
21
25
  * @return <br>
22
- * 推流视频编码格式,详情请参见 {@link #VeLiveVideoCodec VeLiveVideoCodec}。
26
+ * 推流视频编码格式,详情请参见 VeLiveVideoCodec{@link #VeLiveVideoCodec}。
27
+ *
23
28
  */
29
+
24
30
  getCodec(): VeLiveVideoCodec;
25
31
  /** {zh}
26
32
  * @detail api
27
33
  * @brief 设置推流视频编码格式。
28
34
  * @return 推流视频编码参数,详见 [VeLiveVideoEncoderConfiguration](147521#velivevideoencoderconfiguration)。
29
35
  * @param codec <br>推流视频编码格式,详情请参见 [VeLiveVideoCodec](147521#VeLiveVideoCodec) 。
36
+ *
30
37
  */
31
- setCodec(codec: VeLiveVideoCodec): VeLiveVideoEncoderConfiguration;
38
+
39
+ setCodec(codec: VeLiveVideoCodec): this;
32
40
  /** {zh}
33
41
  * @detail api
34
42
  * @brief 获取推流视频编码码率。
35
43
  * @return <br>
36
44
  * 推流视频编码码率。
45
+ *
37
46
  */
47
+
38
48
  getBitrate(): int;
39
49
  /** {zh}
40
50
  * @detail api
41
51
  * @brief 设置推流视频编码码率。
42
52
  * @param bitrate 推流视频编码码率,单位为 kbps,默认值由 `resolution` 参数值决定。
43
53
  * @return <br>
44
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
54
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
55
+ *
45
56
  */
46
- setBitrate(bitrate: int): VeLiveVideoEncoderConfiguration;
57
+
58
+ setBitrate(bitrate: int): this;
47
59
  /** {zh}
48
60
  * @detail api
49
61
  * @brief 获取推流视频编码最小码率。
50
62
  * @return <br>
51
63
  * 推流视频编码最小码率。
64
+ *
52
65
  */
66
+
53
67
  getMinBitrate(): int;
54
68
  /** {zh}
55
69
  * @detail api
56
70
  * @brief 设置推流视频编码最小码率。
57
71
  * @param minBitrate 推流视频编码最小码率,单位为 kbps,默认值由 `resolution` 参数值决定;如果开启自适应码率,推流 SDK 根据网络情况进行编码码率自适应调整的最小码率
58
72
  * @return <br>
59
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
73
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
74
+ *
60
75
  */
61
- setMinBitrate(minBitrate: int): VeLiveVideoEncoderConfiguration;
76
+
77
+ setMinBitrate(minBitrate: int): this;
62
78
  /** {zh}
63
79
  * @detail api
64
80
  * @brief 获取推流视频编码最大码率。
65
81
  * @return <br>
66
82
  * 推流视频编码最大码率。
83
+ *
67
84
  */
85
+
68
86
  getMaxBitrate(): int;
69
87
  /** {zh}
70
88
  * @detail api
71
89
  * @brief 设置推流视频编码最大码率。
72
90
  * @return <br>
73
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
91
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
74
92
  * @param maxBitrate 推流视频编码最大码率,单位为 kbps,默认值由 `resolution` 参数值决定;如果开启自适应码率,推流 SDK 根据网络情况进行编码码率自适应调整的最大码率。
93
+ *
75
94
  */
76
- setMaxBitrate(maxBitrate: int): VeLiveVideoEncoderConfiguration;
95
+
96
+ setMaxBitrate(maxBitrate: int): this;
77
97
  /** {zh}
78
98
  * @detail api
79
99
  * @brief 获取推流视频编码 GOP。
80
100
  * @return <br>
81
101
  * 推流视频编码 GOP。
102
+ *
82
103
  */
104
+
83
105
  getGopSize(): int;
84
106
  /** {zh}
85
107
  * @detail api
86
108
  * @brief 设置推流视频编码 GOP。
87
109
  * @param gopSize 视频 GOP 大小,单位为 s,默认值为 2
88
110
  * @return <br>
89
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
111
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
112
+ *
90
113
  */
91
- setGopSize(gopSize: int): VeLiveVideoEncoderConfiguration;
114
+
115
+ setGopSize(gopSize: int): this;
92
116
  /** {zh}
93
117
  * @detail api
94
118
  * @brief 获取推流视频编码帧率。
95
119
  * @return <br>
96
120
  * 推流视频编码帧率。
121
+ *
97
122
  */
123
+
98
124
  getFps(): int;
99
125
  /** {zh}
100
126
  * @detail api
101
127
  * @brief 设置推流视频编码帧率。
102
128
  * @param fps 视频编码帧率,单位为 fps,默认值为 15
103
129
  * @return <br>
104
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
130
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
131
+ *
105
132
  */
106
- setFps(fps: int): VeLiveVideoEncoderConfiguration;
133
+
134
+ setFps(fps: int): this;
107
135
  /** {zh}
108
136
  * @detail api
109
137
  * @brief 获取是否开启 B 帧。
@@ -111,7 +139,9 @@ export declare class VeLiveVideoEncoderConfiguration {
111
139
  * 是否开启B帧。<br>
112
140
  * - true:B 帧开启;
113
141
  * - false:B 帧关闭。
142
+ *
114
143
  */
144
+
115
145
  isEnableBFrame(): boolean;
116
146
  /** {zh}
117
147
  * @detail api
@@ -120,9 +150,11 @@ export declare class VeLiveVideoEncoderConfiguration {
120
150
  * - true:开启;
121
151
  * - false:关闭。
122
152
  * @return <br>
123
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
153
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
154
+ *
124
155
  */
125
- setEnableBFrame(enableBFrame: boolean): VeLiveVideoEncoderConfiguration;
156
+
157
+ setEnableBFrame(enableBFrame: boolean): this;
126
158
  /** {zh}
127
159
  * @detail api
128
160
  * @brief 获取是否开启硬件编码。
@@ -130,7 +162,9 @@ export declare class VeLiveVideoEncoderConfiguration {
130
162
  * 是否开启硬件编码。<br>
131
163
  * - true:开启;
132
164
  * - false:关闭。
165
+ *
133
166
  */
167
+
134
168
  isEnableAccelerate(): boolean;
135
169
  /** {zh}
136
170
  * @detail api
@@ -139,289 +173,337 @@ export declare class VeLiveVideoEncoderConfiguration {
139
173
  * - true:开启;
140
174
  * - false:关闭。
141
175
  * @return <br>
142
- * 推流视频编码参数配置对象,详情请参见 {@link #VeLiveVideoEncoderConfiguration VeLiveVideoEncoderConfiguration}。
176
+ * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
177
+ *
143
178
  */
144
- setEnableAccelerate(enableAccelerate: boolean): VeLiveVideoEncoderConfiguration;
179
+
180
+ setEnableAccelerate(enableAccelerate: boolean): this;
145
181
  }
146
182
  export declare enum VeLiveAudioCodec {
147
183
  /** {zh}
148
184
  * @brief FDKAAC 编码。
185
+ *
149
186
  */
150
187
  VeLiveAudioCodecFdkAAC = 0,
151
188
  /** {zh}
152
189
  * @brief Mediacodec AAC 编码。
190
+ *
153
191
  */
154
192
  VeLiveAudioCodecMediaCodecAAC = 1,
155
193
  /** {zh}
156
194
  * @brief FFMPEG AAC 编码。
195
+ *
157
196
  */
158
197
  VeLiveAudioCodecFFmpegAAC = 2
159
198
  }
160
199
  export declare enum VeLiveVideoCodec {
161
200
  /** {zh}
162
201
  * @brief 使用 H.264 视频编码。
202
+ *
163
203
  */
164
204
  VeLiveVideoCodecH264 = 0,
165
205
  /** {zh}
166
206
  * @brief 使用火山引擎自研 ByteVC1 视频编码。
207
+ *
167
208
  */
168
209
  VeLiveVideoCodecByteVC1 = 1
169
210
  }
170
211
  export declare class VeLivePusherStatistics {
171
212
  /** {zh}
172
213
  * @brief 视频编码宽度,单位为 px。
214
+ *
173
215
  */
174
216
  encodeWidth: int;
175
217
  /** {zh}
176
218
  * @brief 视频编码高度,单位为 px。
219
+ *
177
220
  */
178
221
  encodeHeight: int;
179
222
  /** {zh}
180
223
  * @brief 视频采集宽度,单位为 px。
224
+ *
181
225
  */
182
226
  captureWidth: int;
183
227
  /** {zh}
184
228
  * @brief 视频采集高度,单位为 px。
229
+ *
185
230
  */
186
231
  captureHeight: int;
187
232
  /** {zh}
188
233
  * @brief 视频采集帧率,单位为 fps。
234
+ *
189
235
  */
190
236
  captureFps: double;
191
237
  /** {zh}
192
238
  * @brief 视频编码帧率,单位为 fps。
239
+ *
193
240
  */
194
241
  encodeFps: double;
195
242
  /** {zh}
196
243
  * @brief 视频发送帧率,可用展示实时帧率,单位为 fps。
244
+ *
197
245
  */
198
246
  transportFps: double;
199
247
  /** {zh}
200
248
  * @brief 视频推流帧率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的帧率,单位为 fps。
249
+ *
201
250
  */
202
251
  fps: int;
203
252
  /** {zh}
204
253
  * @brief 视频推流码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的码率,单位为 kbps。
254
+ *
205
255
  */
206
256
  videoBitrate: int;
207
257
  /** {zh}
208
258
  * @brief 视频推流最小码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最小码率,单位为 kbps。
259
+ *
209
260
  */
210
261
  minVideoBitrate: int;
211
262
  /** {zh}
212
263
  * @brief 视频推流最大码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最大码率,单位为 kbps。
264
+ *
213
265
  */
214
266
  maxVideoBitrate: int;
215
267
  /** {zh}
216
268
  * @brief 视频编码码率,单位为 kbps。
269
+ *
217
270
  */
218
271
  encodeVideoBitrate: double;
219
272
  /** {zh}
220
273
  * @brief 视频发送码率,可用于展示实时码率,单位为 kbps。
274
+ *
221
275
  */
222
276
  transportVideoBitrate: double;
223
277
  /** {zh}
224
278
  * @brief 音频编码码率,单位为 kbps。
279
+ *
225
280
  */
226
281
  encodeAudioBitrate: double;
227
282
  /** {zh}
228
283
  * @brief 推流地址。
284
+ *
229
285
  */
230
286
  url: String;
231
287
  /** {zh}
232
288
  * @brief 视频编码格式。
289
+ *
233
290
  */
234
291
  codec: String;
235
292
  }
236
293
  export declare enum VeLivePusherRenderMode {
237
294
  /** {zh}
238
295
  * @brief 视频帧自适应画布。视频帧非等比缩放,直至画布被填满。在此过程中,视频帧的长宽比例可能会发生变化。
296
+ *
239
297
  */
240
298
  VeLivePusherRenderModeFill = 0,
241
299
  /** {zh}
242
300
  * @brief 视频帧内容全部显示优先。视频尺寸等比缩放,优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时,会把窗口未被填满的区域填充成背景颜色。
301
+ *
243
302
  */
244
303
  VeLivePusherRenderModeFit = 1,
245
304
  /** {zh}
246
305
  * @brief 视窗填满优先。视频帧等比缩放,直至视窗被视频填满。如果视频帧长宽比例与视窗不同,视频帧的多出部分将无法显示。
306
+ *
247
307
  */
248
308
  VeLivePusherRenderModeHidden = 2
249
309
  }
250
310
  export declare enum VeLiveVideoEffectLicenseType {
251
311
  /** {zh}
252
312
  * @brief 离线认证视频特效许可证。
313
+ *
253
314
  */
254
315
  VeLiveVideoEffectLicenseTypeOffLine = 0,
255
316
  /** {zh}
256
317
  * @brief 在线认证视频特效许可证。
318
+ *
257
319
  */
258
320
  VeLiveVideoEffectLicenseTypeOnLine = 1
259
321
  }
260
322
  export declare enum VeLiveAudioBufferType {
261
323
  /** {zh}
262
324
  * @brief 未知的音频数据类型。
325
+ *
263
326
  */
264
327
  VeLiveAudioBufferTypeUnknown = 0,
265
328
  /** {zh}
266
329
  * @brief ByteBuffer 音频数据类型。
330
+ *
267
331
  */
268
332
  VeLiveAudioBufferTypeByteBuffer = 1
269
333
  }
270
334
  export declare enum VeLiveAudioChannel {
271
335
  /** {zh}
272
336
  * @brief 单声道,适用于语音通信,节省带宽。
337
+ *
273
338
  */
274
- VeLiveAudioChannelMono = 0,
339
+ VeLiveAudioChannelMono = 1,
275
340
  /** {zh}
276
341
  * @brief 立体声,适用于音乐播放,提供更丰富的音频体验。
342
+ *
277
343
  */
278
- VeLiveAudioChannelStereo = 1
344
+ VeLiveAudioChannelStereo = 2
279
345
  }
280
346
  export declare enum VeLiveFirstFrameType {
281
347
  /** {zh}
282
348
  * @brief 视频/音频采集首帧,采集首帧是从音频设备或视频设备(如麦克风、摄像头)获取的第一帧数据。
349
+ *
283
350
  */
284
351
  VeLiveFirstCaptureFrame = 0,
285
352
  /** {zh}
286
353
  * @brief 视频渲染首帧,渲染首帧是在渲染过程中在屏幕上显示的第一帧视频数据。
354
+ *
287
355
  */
288
356
  VeLiveFirstRenderFrame = 1,
289
357
  /** {zh}
290
358
  * @brief 视频/音频编码完成首帧,编码完成首帧是编码为某种特定格式的第一帧数据。
359
+ *
291
360
  */
292
361
  VeLiveFirstEncodedFrame = 2,
293
362
  /** {zh}
294
363
  * @brief 视频/音频发送首帧,发送首帧是在发送过程中,通过网络传输的第一帧数据。
364
+ *
295
365
  */
296
366
  VeLiveFirstSendFrame = 3
297
367
  }
298
- export declare enum VeLiveVideoFluencyLevel {
299
- /** {zh}
300
- * @brief 流畅,帧率能达到预设的目标帧率
301
- */
302
- VeLiveVideoFluencyLevelSmooth = 0,
303
- /** {zh}
304
- * @brief 一般卡顿,帧率比预设的目标帧率低 1fps~3fps
305
- */
306
- VeLiveVideoFluencyLevelSluggish = 1,
307
- /** {zh}
308
- * @brief 严重卡顿,帧率比预设的目标帧率低 4fps 以上
309
- */
310
- VeLiveVideoFluencyLevelBlocked = 2
311
- }
312
368
  export declare enum VeLiveVideoCaptureType {
313
369
  /** {zh}
314
370
  * @brief 使用前置摄像头进行视频采集。
371
+ *
315
372
  */
316
373
  VeLiveVideoCaptureFrontCamera = 0,
317
374
  /** {zh}
318
375
  * @brief 使用后置摄像头进行视频采集。
376
+ *
319
377
  */
320
378
  VeLiveVideoCaptureBackCamera = 1,
321
379
  /** {zh}
322
380
  * @brief 使用设备的双摄进行视频采集。
381
+ *
323
382
  */
324
383
  VeLiveVideoCaptureDualCamera = 2,
325
384
  /** {zh}
326
385
  * @brief 使用屏幕采集。
386
+ *
327
387
  */
328
388
  VeLiveVideoCaptureScreen = 3,
329
389
  /** {zh}
330
390
  * @brief 使用外部设备或源进行视频采集。
391
+ *
331
392
  */
332
393
  VeLiveVideoCaptureExternal = 4,
333
394
  /** {zh}
334
395
  * @brief 使用指定的静态图片作为视频源。
396
+ *
335
397
  */
336
398
  VeLiveVideoCaptureCustomImage = 5,
337
399
  /** {zh}
338
400
  * @brief 使用最近采集的一帧图像重复作为视频源。
401
+ *
339
402
  */
340
403
  VeLiveVideoCaptureLastFrame = 6,
341
404
  /** {zh}
342
405
  * @brief 使用黑色帧作为视频源,一般用于调试或特殊需求。
406
+ *
343
407
  */
344
408
  VeLiveVideoCaptureDummyFrame = 7
345
409
  }
346
410
  export declare enum VeLiveVideoProfile {
347
411
  /** {zh}
348
412
  * @brief 未知的视频配置类型。
413
+ *
349
414
  */
350
415
  VeLiveVideoProfileUnknown = 0,
351
416
  /** {zh}
352
417
  * @brief H.264 编码配置,使用 Baseline 级别。
418
+ *
353
419
  */
354
420
  VeLiveVideoProfileH264Baseline = 1,
355
421
  /** {zh}
356
422
  * @brief H.264 编码配置,使用 Main 级别。
423
+ *
357
424
  */
358
425
  VeLiveVideoProfileH264Main = 2,
359
426
  /** {zh}
360
427
  * @brief H.264 编码配置,使用 High 级别。
428
+ *
361
429
  */
362
430
  VeLiveVideoProfileH264High = 3,
363
431
  /** {zh}
364
432
  * @brief ByteVC1 编码配置,使用 Main 级别。
433
+ *
365
434
  */
366
435
  VeLiveVideoProfileByteVC1Main = 4
367
436
  }
368
437
  export declare enum VeLiveVideoRotation {
369
438
  /** {zh}
370
439
  * @brief 不旋转。
440
+ *
371
441
  */
372
442
  VeLiveVideoRotation0 = 0,
373
443
  /** {zh}
374
444
  * @brief 顺时针旋转 90 度。
445
+ *
375
446
  */
376
- VeLiveVideoRotation90 = 1,
447
+ VeLiveVideoRotation90 = 90,
377
448
  /** {zh}
378
449
  * @brief 顺时针旋转 180 度。
450
+ *
379
451
  */
380
- VeLiveVideoRotation180 = 2,
452
+ VeLiveVideoRotation180 = 180,
381
453
  /** {zh}
382
454
  * @brief 顺时针旋转 270 度。
455
+ *
383
456
  */
384
- VeLiveVideoRotation270 = 3
457
+ VeLiveVideoRotation270 = 270
385
458
  }
386
459
  export declare enum VeLiveVideoFrameSource {
387
460
  /** {zh}
388
461
  * @brief 采集到的原始视频帧。这是从设备的摄像头或其他视频输入源获取的视频帧。
462
+ *
389
463
  */
390
464
  VeLiveVideoFrameSourceCapture = 1,
391
465
  /** {zh}
392
466
  * @brief 编码前的视频帧。这是通过各种处理(例如滤镜、旋转等)后,准备进行编码的视频帧。
467
+ *
393
468
  */
394
469
  VeLiveVideoFrameSourcePreEncode = "1 << 1"
395
470
  }
396
471
  export declare enum VeLiveAudioProfile {
397
472
  /** {zh}
398
473
  * @brief LC-AAC 编码方式。
474
+ *
399
475
  */
400
476
  VeLiveAudioAACProfileLC = 0,
401
477
  /** {zh}
402
478
  * @brief HEv1-AAC 编码方式。
479
+ *
403
480
  */
404
481
  VeLiveAudioAACProfileHEv1 = 1,
405
482
  /** {zh}
406
483
  * @brief HEv2-AAC 编码方式。
484
+ *
407
485
  */
408
486
  VeLiveAudioAACProfileHEv2 = 2
409
487
  }
410
488
  export declare enum VeLiveVideoBufferType {
411
489
  /** {zh}
412
490
  * @brief 未知视频数据类型,当未指定输入视频数据的格式时,会默认为此类型。
491
+ *
413
492
  */
414
493
  VeLiveVideoBufferTypeUnknown = 0,
415
494
  /** {zh}
416
495
  * @brief 视频数据类型为 OpenGL 纹理。
496
+ *
417
497
  */
418
498
  VeLiveVideoBufferTypeTexture = 1,
419
499
  /** {zh}
420
500
  * @brief 视频数据类型为 ByteBuffer 类型。
501
+ *
421
502
  */
422
503
  VeLiveVideoBufferTypeByteBuffer = 2,
423
504
  /** {zh}
424
505
  * @brief 视频数据类型为 ByteArray 类型。
506
+ *
425
507
  */
426
508
  VeLiveVideoBufferTypeByteArray = 3
427
509
  }
@@ -430,90 +512,112 @@ export declare class VeLiveAudioCaptureConfiguration {
430
512
  * @detail api
431
513
  * @brief 获取采集音频采样率。
432
514
  * @return <br>
433
- * 音频采样率,详情请参见 {@link #VeLiveAudioSampleRate VeLiveAudioSampleRate}。
515
+ * 音频采样率,详情请参见 VeLiveAudioSampleRate{@link #VeLiveAudioSampleRate}。
516
+ *
434
517
  */
518
+
435
519
  getSampleRate(): VeLiveAudioSampleRate;
436
520
  /** {zh}
437
521
  * @detail api
438
522
  * @brief 设置采集音频采样率。
439
523
  * @return <br>推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)
440
524
  * @param sampleRate 音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。
525
+ *
441
526
  */
442
- setSampleRate(sampleRate: VeLiveAudioSampleRate): VeLiveAudioCaptureConfiguration;
527
+
528
+ setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
443
529
  /** {zh}
444
530
  * @detail api
445
531
  * @brief 获取采集音频声道数。
446
532
  * @return <br>
447
- * 音频声道数,详情请参见 {@link #VeLiveAudioChannel VeLiveAudioChannel}。
533
+ * 音频声道数,详情请参见 VeLiveAudioChannel{@link #VeLiveAudioChannel}。
534
+ *
448
535
  */
536
+
449
537
  getChannel(): VeLiveAudioChannel;
450
538
  /** {zh}
451
539
  * @detail api
452
540
  * @brief 设置采集音频声道数。
453
541
  * @return <br>推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)。
454
- * @param channel 音频声道数,默认值为 VeLiveAudioChannelStereo,详情请参见 {@link #VeLiveAudioChannel VeLiveAudioChannel}
542
+ * @param channel 音频声道数,默认值为 VeLiveAudioChannelStereo,详情请参见 VeLiveAudioChannel{@link #VeLiveAudioChannel}
543
+ *
455
544
  */
456
- setChannel(channel: VeLiveAudioChannel): VeLiveAudioCaptureConfiguration;
545
+
546
+ setChannel(channel: VeLiveAudioChannel): this;
457
547
  }
458
548
  export declare class VeLiveStreamMixDescription {
459
549
  /** {zh}
460
- * @brief 视频混流布局设置的数组,其中每个元素代表一路视频流的布局。详情请参见 {@link #VeLiveMixVideoLayout VeLiveMixVideoLayout}。
550
+ * @brief 视频混流布局设置的数组,其中每个元素代表一路视频流的布局。详情请参见 VeLiveMixVideoLayout{@link #VeLiveMixVideoLayout}。
551
+ *
461
552
  */
462
553
  mixVideoStreams: ArrayList<VeLiveMixVideoLayout>;
463
554
  /** {zh}
464
555
  * @brief 音频混流设置的数组,其中每个元素代表一路音频流的。详情请参见 [VeLiveMixAudioLayout](#VeLiveMixAudioLayout)。
556
+ *
465
557
  */
466
558
  mixAudioStreams: ArrayList<VeLiveMixAudioLayout>;
467
559
  /** {zh}
468
560
  * @brief 视频混流画布的背景色设置,采用 #RRGGBB 格式。
561
+ *
469
562
  */
470
563
  backgroundColor: String;
471
564
  }
472
565
  export declare enum VeLiveAudioSampleRate {
473
566
  /** {zh}
474
567
  * @brief 8k 采样。
568
+ *
475
569
  */
476
- VeLiveAudioSampleRate8000 = 0,
570
+ VeLiveAudioSampleRate8000 = 8000,
477
571
  /** {zh}
478
572
  * @brief 16k 采样。
573
+ *
479
574
  */
480
- VeLiveAudioSampleRate16000 = 1,
575
+ VeLiveAudioSampleRate16000 = 16000,
481
576
  /** {zh}
482
577
  * @brief 32k 采样。
578
+ *
483
579
  */
484
- VeLiveAudioSampleRate32000 = 2,
580
+ VeLiveAudioSampleRate32000 = 32000,
485
581
  /** {zh}
486
582
  * @brief 44.1k 采样。
583
+ *
487
584
  */
488
- VeLiveAudioSampleRate44100 = 3,
585
+ VeLiveAudioSampleRate44100 = 44100,
489
586
  /** {zh}
490
587
  * @brief 48k 采样。
588
+ *
491
589
  */
492
- VeLiveAudioSampleRate48000 = 4
590
+ VeLiveAudioSampleRate48000 = 48000
493
591
  }
494
592
  export declare enum VeLiveAudioPowerLevel {
495
593
  /** {zh}
496
594
  * @brief 无声,音量 ≤1db。
595
+ *
497
596
  */
498
597
  VeLiveAudioPowerLevelSilent = 0,
499
598
  /** {zh}
500
599
  * @brief 安静,音量 15db 以下。
600
+ *
501
601
  */
502
602
  VeLiveAudioPowerLevelQuiet = 1,
503
603
  /** {zh}
504
604
  * @brief 轻声,接近耳语音量,音量为 16db~30db 之间。
605
+ *
505
606
  */
506
607
  VeLiveAudioPowerLevelLight = 2,
507
608
  /** {zh}
508
609
  * @brief 正常,音量适宜,类似正常对话的音量,音量为 30db~60db 之间。
610
+ *
509
611
  */
510
612
  VeLiveAudioPowerLevelNormal = 3,
511
613
  /** {zh}
512
614
  * @brief 较大,音量较高,类似咖啡馆、餐厅的环境噪音,音量为 61db~85db 之间。
615
+ *
513
616
  */
514
617
  VeLiveAudioPowerLevelLoud = 4,
515
618
  /** {zh}
516
619
  * @brief 吵闹,音量极高,类似于繁忙的街道或者是音乐会现场,音量超过 85db。
620
+ *
517
621
  */
518
622
  VeLiveAudioPowerLevelNoise = 5
519
623
  }
@@ -523,97 +627,122 @@ export declare class VeLiveVideoCaptureConfiguration {
523
627
  * @brief 获取采集视频宽度。
524
628
  * @return <br>
525
629
  * 采集视频宽度。
630
+ *
526
631
  */
632
+
527
633
  getWidth(): int;
528
634
  /** {zh}
529
635
  * @detail api
530
636
  * @brief 设置采集视频宽度。
531
637
  * @return <br>推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
532
638
  * @param width 采集视频宽度,默认值为 720。
639
+ *
533
640
  */
534
- setWidth(width: int): VeLiveVideoCaptureConfiguration;
641
+
642
+ setWidth(width: int): this;
535
643
  /** {zh}
536
644
  * @detail api
537
645
  * @brief 获取采集视频高度。
538
646
  * @return <br>
539
647
  * 采集视频高度。
648
+ *
540
649
  */
650
+
541
651
  getHeight(): int;
542
652
  /** {zh}
543
653
  * @detail api
544
654
  * @brief 设置采集视频高度。
545
655
  * @return <br>推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
546
656
  * @param height 采集视频高度,默认值为 1280。
657
+ *
547
658
  */
548
- setHeight(height: int): VeLiveVideoCaptureConfiguration;
659
+
660
+ setHeight(height: int): this;
549
661
  /** {zh}
550
662
  * @detail api
551
663
  * @brief 获取采集视频帧率。
552
664
  * @return <br>
553
665
  * 采集视频帧率。
666
+ *
554
667
  */
668
+
555
669
  getFps(): int;
556
670
  /** {zh}
557
671
  * @detail api
558
672
  * @brief 设置采集视频帧率。
559
673
  * @return <br>推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
560
674
  * @param fps 采集视频帧率,默认值为 15。
675
+ *
561
676
  */
562
- setFps(fps: int): VeLiveVideoCaptureConfiguration;
677
+
678
+ setFps(fps: int): this;
563
679
  }
564
680
  export declare enum VeLivePixelFormat {
565
681
  /** {zh}
566
682
  * @brief 未知格式。
683
+ *
567
684
  */
568
685
  VeLivePixelFormatUnknown = 0,
569
686
  /** {zh}
570
687
  * @brief I420 格式。
688
+ *
571
689
  */
572
690
  VeLivePixelFormatI420 = 1,
573
691
  /** {zh}
574
692
  * @brief NV12 格式。
693
+ *
575
694
  */
576
695
  VeLivePixelFormatNV12 = 2,
577
696
  /** {zh}
578
697
  * @brief NV21 格式。
698
+ *
579
699
  */
580
700
  VeLivePixelFormatNV21 = 3,
581
701
  /** {zh}
582
702
  * @brief 2D 纹理格式。
703
+ *
583
704
  */
584
705
  VeLivePixelFormat2DTexture = 4,
585
706
  /** {zh}
586
707
  * @brief OES 纹理格式。
708
+ *
587
709
  */
588
710
  VeLivePixelFormatOesTexture = 5
589
711
  }
590
712
  export declare enum VeLivePusherStatus {
591
713
  /** {zh}
592
714
  * @brief 初始状态。
715
+ *
593
716
  */
594
717
  VeLivePushStatusNone = 0,
595
718
  /** {zh}
596
719
  * @brief 正在连接服务器。
720
+ *
597
721
  */
598
722
  VeLivePushStatusConnecting = 1,
599
723
  /** {zh}
600
724
  * @brief 连接服务器成功。
725
+ *
601
726
  */
602
727
  VeLivePushStatusConnectSuccess = 2,
603
728
  /** {zh}
604
729
  * @brief 重连服务器中。
730
+ *
605
731
  */
606
732
  VeLivePushStatusReconnecting = 3,
607
733
  /** {zh}
608
734
  * @brief 推流连接被终止。
735
+ *
609
736
  */
610
737
  VeLivePushStatusConnectStop = 4,
611
738
  /** {zh}
612
739
  * @brief 推流连接失败。
740
+ *
613
741
  */
614
742
  VeLivePushStatusConnectError = 5,
615
743
  /** {zh}
616
744
  * @brief 与服务器断开连接。
745
+ *
617
746
  */
618
747
  VeLivePushStatusDisconnected = 6
619
748
  }
@@ -626,6 +755,7 @@ export declare enum VeLiveVideoResolution {
626
755
  * - 目标码率:500kbps
627
756
  * - 最小码率:250kbps
628
757
  * - 最大码率:800kbps
758
+ *
629
759
  */
630
760
  VeLiveVideoResolution360P = "VeLiveVideoResolution360P",
631
761
  /** {zh}
@@ -636,6 +766,7 @@ export declare enum VeLiveVideoResolution {
636
766
  * - 目标码率:800kbps
637
767
  * - 最小码率:320kbps
638
768
  * - 最大码率:1266kbps
769
+ *
639
770
  */
640
771
  VeLiveVideoResolution480P = "VeLiveVideoResolution480P",
641
772
  /** {zh}
@@ -646,6 +777,7 @@ export declare enum VeLiveVideoResolution {
646
777
  * - 目标码率:1000kbps
647
778
  * - 最小码率:500kbps
648
779
  * - 最大码率:1520kbps
780
+ *
649
781
  */
650
782
  VeLiveVideoResolution540P = "VeLiveVideoResolution540P",
651
783
  /** {zh}
@@ -656,6 +788,7 @@ export declare enum VeLiveVideoResolution {
656
788
  * - 目标码率:1200kbps
657
789
  * - 最小码率:800kbps
658
790
  * - 最大码率:1900kbps
791
+ *
659
792
  */
660
793
  VeLiveVideoResolution720P = "VeLiveVideoResolution720P",
661
794
  /** {zh}
@@ -666,153 +799,187 @@ export declare enum VeLiveVideoResolution {
666
799
  * - 目标码率:2500kbps
667
800
  * - 最小码率:1000kbps
668
801
  * - 最大码率:3800kbps
802
+ *
669
803
  */
670
804
  VeLiveVideoResolution1080P = "VeLiveVideoResolution1080P"
671
805
  }
672
806
  export declare enum VeLiveNetworkQuality {
673
807
  /** {zh}
674
808
  * @brief 未查询到网络状态。
809
+ *
675
810
  */
676
811
  VeLiveNetworkQualityUnknown = 0,
677
812
  /** {zh}
678
813
  * @brief 网络差。
814
+ *
679
815
  */
680
816
  VeLiveNetworkQualityBad = 1,
681
817
  /** {zh}
682
818
  * @brief 网络一般。
819
+ *
683
820
  */
684
821
  VeLiveNetworkQualityPoor = 2,
685
822
  /** {zh}
686
823
  * @brief 网络状态佳。
824
+ *
687
825
  */
688
826
  VeLiveNetworkQualityGood = 3
689
827
  }
690
828
  export declare enum VeLivePusherLogLevel {
691
829
  /** {zh}
692
830
  * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
831
+ *
693
832
  */
694
833
  VeLiveLogLevelVerbose = 0,
695
834
  /** {zh}
696
835
  * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
836
+ *
697
837
  */
698
838
  VeLiveLogLevelDebug = 1,
699
839
  /** {zh}
700
840
  * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
841
+ *
701
842
  */
702
843
  VeLiveLogLevelInfo = 2,
703
844
  /** {zh}
704
845
  * @brief 输出 WARNING 和 ERROR 级别的日志。
846
+ *
705
847
  */
706
848
  VeLiveLogLevelWarn = 3,
707
849
  /** {zh}
708
850
  * @brief 输出 ERROR 级别的日志。
851
+ *
709
852
  */
710
853
  VeLiveLogLevelError = 4,
711
854
  /** {zh}
712
855
  * @brief 关闭日志。
856
+ *
713
857
  */
714
858
  VeLiveLogLevelNone = 5
715
859
  }
716
860
  export declare enum VeLiveAudioBitDepth {
717
861
  /** {zh}
718
862
  * @brief 16bit 位深度。
863
+ *
719
864
  */
720
- VeLiveAudioBitDepth16 = 0
865
+ VeLiveAudioBitDepth16 = 16
721
866
  }
722
867
  export declare class VeLiveMixAudioLayout {
723
868
  /** {zh}
724
869
  * @brief 音频流 ID,唯一标识,用于区分不同的音频流。
870
+ *
725
871
  */
726
872
  streamId: int;
727
873
  /** {zh}
728
874
  * @detail api
729
875
  * @brief 混流音频的音量,范围为 [0.0,4.0]。当您将 [VeLiveAudioMixType](147521#VeLiveAudioMixType) 设置为 `VeLiveAudioMixPlayAndPush` 时,该变量同时控制混流音频在拉流端和本地的播放音量。
876
+ *
730
877
  */
731
878
  volume: float;
732
879
  /** {zh}
733
880
  * @detail api
734
881
  * @brief 更新音频混流设置。
735
882
  * @param other 新的音频混流设置,详情请参见 [VeLiveMixAudioLayout](#VeLiveMixAudioLayout)。
883
+ *
736
884
  */
885
+
737
886
  update(other: VeLiveMixAudioLayout): void;
738
887
  }
739
888
  export declare enum VeLiveOrientation {
740
889
  /** {zh}
741
890
  * @brief 横屏模式。
891
+ *
742
892
  */
743
893
  VeLiveOrientationLandscape = 0,
744
894
  /** {zh}
745
895
  * @brief 竖屏模式。
896
+ *
746
897
  */
747
898
  VeLiveOrientationPortrait = 1
748
899
  }
749
900
  export declare enum VeLiveVideoMirrorType {
750
901
  /** {zh}
751
902
  * @brief 对采集画面的镜像控制。开启时,预览和推流画面都会呈现为镜像状态。
903
+ *
752
904
  */
753
905
  VeLiveVideoMirrorCapture = 0,
754
906
  /** {zh}
755
907
  * @brief 对预览画面的镜像控制。开启时,只有主播预览画面呈现镜像状态。
908
+ *
756
909
  */
757
910
  VeLiveVideoMirrorPreview = 1,
758
911
  /** {zh}
759
912
  * @brief 对编码前画面的镜像控制。开启时,主播推流画面呈现镜像状态。
913
+ *
760
914
  */
761
915
  VeLiveVideoMirrorPushStream = 2
762
916
  }
763
917
  export declare class VeLivePusherLogConfig {
764
918
  /** {zh}
765
919
  * @brief 日志文件保存路径。
920
+ *
766
921
  */
767
922
  logPath: String;
768
923
  /** {zh}
769
924
  * @brief 日志文件整体最大尺寸,单位为 M,默认值为 100。
925
+ *
770
926
  */
771
927
  maxLogSizeM: int;
772
928
  /** {zh}
773
929
  * @brief 单个日志文件最大尺寸,单位为 M,默认值为 2。
930
+ *
774
931
  */
775
932
  singleLogSizeM: int;
776
933
  /** {zh}
777
934
  * @brief 日志文件有效期,单位为 s,默认值为 604,800,即 7 天。
935
+ *
778
936
  */
779
937
  logExpireTimeS: long;
780
938
  /** {zh}
781
939
  * @brief 是否开启线程轮询,默认值为 `1` <br>
782
940
  * - `0`:关闭;
783
941
  * - `1`:开启。
942
+ *
784
943
  */
785
944
  enableThreadLoop: int;
786
945
  /** {zh}
787
946
  * @brief 日志是否打印到控制台输出,默认为不打印。
947
+ *
788
948
  */
789
949
  enableStdout: int;
790
950
  /** {zh}
791
951
  * @brief 日志是否打印到文件输出,默认为打印。
952
+ *
792
953
  */
793
954
  enableLogFile: int;
794
955
  /** {zh}
795
956
  * @brief 日志级别,默认值为 `kVolcLogLevelWarning`。
957
+ *
796
958
  */
797
959
  logLevel: int;
798
960
  /** {zh}
799
961
  * @brief 日志刷新频率,单位为 ms,默认值为 120,000,即 2 分钟。
962
+ *
800
963
  */
801
964
  intervalMs: long;
802
965
  /** {zh}
803
966
  * @brief 日志上报路径。
967
+ *
804
968
  */
805
969
  queryUrl: String;
806
970
  /** {zh}
807
971
  * @brief 设备唯一 ID。
972
+ *
808
973
  */
809
974
  device_id: String;
810
975
  /** {zh}
811
976
  * @brief HTTP 请求超时时间。取值范围:大于 0。
977
+ *
812
978
  */
813
979
  httpTimeoutMS: int;
814
980
  /** {zh}
815
981
  * @brief 文件上传超时时间。取值范围:大于 0。
982
+ *
816
983
  */
817
984
  httpUploadFileTimeoutMS: int;
818
985
  }
@@ -822,96 +989,122 @@ export declare class VeLiveFileRecorderConfiguration {
822
989
  * @brief 获取录制视频宽度。
823
990
  * @return <br>
824
991
  * 录制视频宽度。
992
+ *
825
993
  */
994
+
826
995
  getWidth(): int;
827
996
  /** {zh}
828
997
  * @detail api
829
998
  * @brief 设置录制视频宽度。
830
999
  * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
831
1000
  * @param width 录制视频宽度,默认值为 360
1001
+ *
832
1002
  */
833
- setWidth(width: int): VeLiveFileRecorderConfiguration;
1003
+
1004
+ setWidth(width: int): this;
834
1005
  /** {zh}
835
1006
  * @detail api
836
1007
  * @brief 获取录制视频高度。
837
1008
  * @return <br>
838
1009
  * 录制视频高度。
1010
+ *
839
1011
  */
1012
+
840
1013
  getHeight(): int;
841
1014
  /** {zh}
842
1015
  * @detail api
843
1016
  * @brief 设置录制视频高度。
844
1017
  * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
845
1018
  * @param height 录制视频宽度,默认值为 640。
1019
+ *
846
1020
  */
847
- setHeight(height: int): VeLiveFileRecorderConfiguration;
1021
+
1022
+ setHeight(height: int): this;
848
1023
  /** {zh}
849
1024
  * @detail api
850
1025
  * @brief 获取录制视频帧率。
851
1026
  * @return <br>
852
1027
  * 录制视频帧率。
1028
+ *
853
1029
  */
1030
+
854
1031
  getFps(): int;
855
1032
  /** {zh}
856
1033
  * @detail api
857
1034
  * @brief 设置录制视频帧率。
858
1035
  * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
859
1036
  * @param fps 录制视频帧率,默认值为 15。
1037
+ *
860
1038
  */
861
- setFps(fps: int): VeLiveFileRecorderConfiguration;
1039
+
1040
+ setFps(fps: int): this;
862
1041
  /** {zh}
863
1042
  * @detail api
864
1043
  * @brief 获取录制视频码率。
865
1044
  * @return <br>
866
1045
  * 录制视频码率。
1046
+ *
867
1047
  */
1048
+
868
1049
  getBitrate(): int;
869
1050
  /** {zh}
870
1051
  * @detail api
871
1052
  * @brief 设置录制视频码率。
872
1053
  * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
873
1054
  * @param bitrate 录制视频码率,单位为 kbps,默认值为 2000。
1055
+ *
874
1056
  */
875
- setBitrate(bitrate: int): VeLiveFileRecorderConfiguration;
1057
+
1058
+ setBitrate(bitrate: int): this;
876
1059
  }
877
1060
  export declare class VeLiveMixVideoLayout {
878
1061
  /** {zh}
879
1062
  * @brief 视频流 ID,唯一标识,用于区分不同的视频流。
1063
+ *
880
1064
  */
881
1065
  streamId: int;
882
1066
  /** {zh}
883
1067
  * @brief 视频流对应区域左上角的横坐标,该坐标是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1068
+ *
884
1069
  */
885
1070
  x: float;
886
1071
  /** {zh}
887
1072
  * @brief 视频流对应区域左上角的纵坐标,该坐标是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1073
+ *
888
1074
  */
889
1075
  y: float;
890
1076
  /** {zh}
891
1077
  * @brief 视频流对应区域宽度,该宽度是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1078
+ *
892
1079
  */
893
1080
  width: float;
894
1081
  /** {zh}
895
1082
  * @brief 视频流对应区域高度,该高度是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1083
+ *
896
1084
  */
897
1085
  height: float;
898
1086
  /** {zh}
899
1087
  * @brief 视频流在混流中的透明度,取值范围为 [0.0,1.0],取值 0.0 表示全透明,取值 1.0 表示不透明。
1088
+ *
900
1089
  */
901
1090
  alpha: float;
902
1091
  /** {zh}
903
1092
  * @brief 视频流在混流中的层级。取值范围为 [0,100],取值 0 表示最底层,取值越大,层级越高。
1093
+ *
904
1094
  */
905
1095
  zOrder: int;
906
1096
  /** {zh}
907
- * @brief 视频流的渲染模式。详情请参见 {@link #VeLivePusherRenderMode VeLivePusherRenderMode}。
1097
+ * @brief 视频流的渲染模式。详情请参见 VeLivePusherRenderMode{@link #VeLivePusherRenderMode}。
1098
+ *
908
1099
  */
909
1100
  renderMode: VeLivePusherRenderMode;
910
1101
  /** {zh}
911
1102
  * @detail api
912
1103
  * @brief 更新视频混流设置。
913
1104
  * @param other 新的视频混流设置,详情请参见 [VeLiveMixVideoLayout](147521#VeLiveMixVideoLayout)。
1105
+ *
914
1106
  */
1107
+
915
1108
  update(other: VeLiveMixVideoLayout): void;
916
1109
  }
917
1110
  export declare class VeLiveVideoEffectLicenseConfiguration {
@@ -920,8 +1113,10 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
920
1113
  * @brief 初始化配置为本地验证模式。
921
1114
  * @return <br>返回 VeLiveVideoEffectLicenseConfiguration 类的实例,该实例使用指定的本地路径进行许可证验证。
922
1115
  * @param path 视频特效许可证的本地缓存路径。可通过 [getPath](#VeLiveVideoEffectLicenseConfiguration-getpath) 获取。
1116
+ *
923
1117
  */
924
- static create_String(path: String): VeLiveVideoEffectLicenseConfiguration;
1118
+
1119
+ static create(path: String): VeLiveVideoEffectLicenseConfiguration;
925
1120
  /** {zh}
926
1121
  * @detail api
927
1122
  * @brief 初始化配置为在线验证模式。
@@ -929,51 +1124,65 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
929
1124
  * @param key 视频特效许可证的在线认证 key。可通过 [getKey](#VeLiveVideoEffectLicenseConfiguration-getkey) 获取。
930
1125
  * @param secret 视频特效许可证的在线认证 secret。可通过 [getSecret](#VeLiveVideoEffectLicenseConfiguration-getsecret) 获取。
931
1126
  * @param url 视频特效许可证的在线认证地址,如果传入 `null`,可通过 [getUrl](147521#VeLiveVideoEffectLicenseConfiguration-geturl) 获取在线认证地址。
1127
+ *
932
1128
  */
933
- static create_String$String$String(key: String, secret: String, url: String): VeLiveVideoEffectLicenseConfiguration;
1129
+
1130
+ static create_key$secret$url(key: String, secret: String, url: String): VeLiveVideoEffectLicenseConfiguration;
934
1131
  /** {zh}
935
1132
  * @detail api
936
1133
  * @brief 获取视频特效许可证类型。
937
1134
  * @return <br>
938
- * 视频特效许可证类型,许可证类型请参见 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType}。
1135
+ * 视频特效许可证类型,许可证类型请参见 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType}。
1136
+ *
939
1137
  */
1138
+
940
1139
  getType(): VeLiveVideoEffectLicenseType;
941
1140
  /** {zh}
942
1141
  * @detail api
943
- * @brief 获取视频特效许可证的本地路径。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOffLine` 时,返回许可证文件的本地路径。
1142
+ * @brief 获取视频特效许可证的本地路径。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOffLine` 时,返回许可证文件的本地路径。
944
1143
  * @return <br>
945
1144
  * 视频特效许可证的本地路径。
1145
+ *
946
1146
  */
1147
+
947
1148
  getPath(): String;
948
1149
  /** {zh}
949
1150
  * @detail api
950
- * @brief 获取视频特效许可证的在线认证 key。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 key。
1151
+ * @brief 获取视频特效许可证的在线认证 key。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 key。
951
1152
  * @return <br>
952
1153
  * 视频特效许可证的在线认证 key。
1154
+ *
953
1155
  */
1156
+
954
1157
  getKey(): String;
955
1158
  /** {zh}
956
1159
  * @detail api
957
- * @brief 获取视频特效许可证的在线认证 secret。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 secret。
1160
+ * @brief 获取视频特效许可证的在线认证 secret。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 secret。
958
1161
  * @return <br>
959
1162
  * 视频特效许可证的在线认证 secret。
1163
+ *
960
1164
  */
1165
+
961
1166
  getSecret(): String;
962
1167
  /** {zh}
963
1168
  * @detail api
964
- * @brief 获取视频特效许可证的在线认证地址。当 {@link #VeLiveVideoEffectLicenseType VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证地址。
1169
+ * @brief 获取视频特效许可证的在线认证地址。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证地址。
965
1170
  * @return <br>
966
1171
  * 视频特效许可证的在线认证地址。
1172
+ *
967
1173
  */
1174
+
968
1175
  getUrl(): String;
969
1176
  }
970
1177
  export declare enum VeLiveAudioFrameSource {
971
1178
  /** {zh}
972
1179
  * @brief 采集到的原始音频帧。这是从设备的麦克风或其他音频输入源获取的音频帧。
1180
+ *
973
1181
  */
974
1182
  VeLiveAudioFrameSourceCapture = 1,
975
1183
  /** {zh}
976
1184
  * @brief 编码前的音频帧。这是通过各种处理(例如噪音消除、回声消除等)后,准备进行编码的音频帧。
1185
+ *
977
1186
  */
978
1187
  VeLiveAudioFrameSourcePreEncode = "1 << 1"
979
1188
  }
@@ -983,87 +1192,110 @@ export declare class VeLiveAudioEncoderConfiguration {
983
1192
  * @brief 获取推流音频编码码率。
984
1193
  * @return <br>
985
1194
  * 推流音频编码码率。
1195
+ *
986
1196
  */
1197
+
987
1198
  getBitrate(): int;
988
1199
  /** {zh}
989
1200
  * @detail api
990
1201
  * @brief 设置推流音频编码码率。
991
1202
  * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
992
1203
  * @param bitrate 推流音频编码码率,单位为 kbps,默认值为 64。
1204
+ *
993
1205
  */
994
- setBitrate(bitrate: int): VeLiveAudioEncoderConfiguration;
1206
+
1207
+ setBitrate(bitrate: int): this;
995
1208
  /** {zh}
996
1209
  * @detail api
997
1210
  * @brief 获取推流音频采样率。
998
1211
  * @return <br>
999
- * 推流音频采样率。详情请参见 {@link #VeLiveAudioSampleRate VeLiveAudioSampleRate}。
1212
+ * 推流音频采样率。详情请参见 VeLiveAudioSampleRate{@link #VeLiveAudioSampleRate}。
1213
+ *
1000
1214
  */
1215
+
1001
1216
  getSampleRate(): VeLiveAudioSampleRate;
1002
1217
  /** {zh}
1003
1218
  * @detail api
1004
1219
  * @brief 设置推流音频采样率。
1005
1220
  * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
1006
1221
  * @param sampleRate 推流音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。
1222
+ *
1007
1223
  */
1008
- setSampleRate(sampleRate: VeLiveAudioSampleRate): VeLiveAudioEncoderConfiguration;
1224
+
1225
+ setSampleRate(sampleRate: VeLiveAudioSampleRate): this;
1009
1226
  /** {zh}
1010
1227
  * @detail api
1011
1228
  * @brief 获取推流音频声道。
1012
1229
  * @return <br>
1013
- * 推流音频声道。详情请参见 {@link #VeLiveAudioChannel VeLiveAudioChannel}。
1230
+ * 推流音频声道。详情请参见 VeLiveAudioChannel{@link #VeLiveAudioChannel}。
1231
+ *
1014
1232
  */
1233
+
1015
1234
  getChannel(): VeLiveAudioChannel;
1016
1235
  /** {zh}
1017
1236
  * @detail api
1018
1237
  * @brief 设置推流音频声道。
1019
1238
  * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
1020
1239
  * @param channel 推流音频声道,默认值为 VeLiveAudioChannelStereo,详情请参见 [VeLiveAudioChannel](147521#VeLiveAudioChannel)。
1240
+ *
1021
1241
  */
1022
- setChannel(channel: VeLiveAudioChannel): VeLiveAudioEncoderConfiguration;
1242
+
1243
+ setChannel(channel: VeLiveAudioChannel): this;
1023
1244
  /** {zh}
1024
1245
  * @detail api
1025
1246
  * @brief 获取推流音频编码类型。
1026
1247
  * @return <br>
1027
- * 推流音频编码类型。详情请参见 {@link #VeLiveAudioProfile VeLiveAudioProfile}。
1248
+ * 推流音频编码类型。详情请参见 VeLiveAudioProfile{@link #VeLiveAudioProfile}。
1249
+ *
1028
1250
  */
1251
+
1029
1252
  getProfile(): VeLiveAudioProfile;
1030
1253
  /** {zh}
1031
1254
  * @detail api
1032
1255
  * @brief 设置推流音频编码类型。
1033
1256
  * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
1034
1257
  * @param profile 推流音频编码类型,默认值为 VeLiveAudioAACProfileLC,详情请参见 [VeLiveAudioProfile](147521#VeLiveAudioProfile)。
1258
+ *
1035
1259
  */
1036
- setProfile(profile: VeLiveAudioProfile): VeLiveAudioEncoderConfiguration;
1260
+
1261
+ setProfile(profile: VeLiveAudioProfile): this;
1037
1262
  }
1038
1263
  export declare enum VeLiveAudioMixType {
1039
1264
  /** {zh}
1040
1265
  * @brief 拉流端可以听到混音效果,本地无法听到。
1266
+ *
1041
1267
  */
1042
1268
  VeLiveAudioMixPush = 0,
1043
1269
  /** {zh}
1044
1270
  * @brief 拉流端和本地都可以听到混音效果。
1271
+ *
1045
1272
  */
1046
1273
  VeLiveAudioMixPlayAndPush = 1
1047
1274
  }
1048
1275
  export declare enum VeLiveAudioCaptureType {
1049
1276
  /** {zh}
1050
1277
  * @brief 使用默认麦克风设备进行音频采集。
1278
+ *
1051
1279
  */
1052
1280
  VeLiveAudioCaptureMicrophone = 0,
1053
1281
  /** {zh}
1054
1282
  * @brief 使用语音通话模式进行音频采集,此模式下会启动硬件的 3A 功能,即自动增益控制、自动频率控制和自动噪声抑制。
1283
+ *
1055
1284
  */
1056
1285
  VeLiveAudioCaptureVoiceCommunication = 1,
1057
1286
  /** {zh}
1058
1287
  * @brief 使用录屏直播无障碍音频模式进行音频采集。
1288
+ *
1059
1289
  */
1060
1290
  VeLiveAudioCaptureVoiceRecognition = 2,
1061
1291
  /** {zh}
1062
1292
  * @brief 使用外部设备或源进行音频采集。
1293
+ *
1063
1294
  */
1064
1295
  VeLiveAudioCaptureExternal = 3,
1065
1296
  /** {zh}
1066
1297
  * @brief 使用静音帧作为音频源。
1298
+ *
1067
1299
  */
1068
1300
  VeLiveAudioCaptureMuteFrame = 4
1069
1301
  }