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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/ios/VeLiveMixerView.m +5 -15
  2. package/lib/commonjs/typescript/codegen/android/api.d.ts +869 -93
  3. package/lib/commonjs/typescript/codegen/android/callback.d.ts +243 -31
  4. package/lib/commonjs/typescript/codegen/android/errorcode.d.ts +60 -15
  5. package/lib/commonjs/typescript/codegen/android/keytype.d.ts +1173 -219
  6. package/lib/commonjs/typescript/codegen/ios/api.d.ts +899 -102
  7. package/lib/commonjs/typescript/codegen/ios/callback.d.ts +162 -28
  8. package/lib/commonjs/typescript/codegen/ios/errorcode.d.ts +100 -25
  9. package/lib/commonjs/typescript/codegen/ios/keytype.d.ts +692 -180
  10. package/lib/commonjs/typescript/codegen/pack/api.d.ts +1180 -133
  11. package/lib/commonjs/typescript/codegen/pack/callback.d.ts +243 -35
  12. package/lib/commonjs/typescript/codegen/pack/errorcode.d.ts +69 -16
  13. package/lib/commonjs/typescript/codegen/pack/keytype.d.ts +1459 -270
  14. package/lib/commonjs/typescript/core/api.d.ts +8 -1
  15. package/lib/commonjs/typescript/core/effect.d.ts +5 -1
  16. package/lib/commonjs/typescript/core/logger.d.ts +1 -0
  17. package/lib/commonjs/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  18. package/lib/commonjs/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  19. package/lib/module/typescript/codegen/android/api.d.ts +869 -93
  20. package/lib/module/typescript/codegen/android/callback.d.ts +243 -31
  21. package/lib/module/typescript/codegen/android/errorcode.d.ts +60 -15
  22. package/lib/module/typescript/codegen/android/keytype.d.ts +1173 -219
  23. package/lib/module/typescript/codegen/ios/api.d.ts +899 -102
  24. package/lib/module/typescript/codegen/ios/callback.d.ts +162 -28
  25. package/lib/module/typescript/codegen/ios/errorcode.d.ts +100 -25
  26. package/lib/module/typescript/codegen/ios/keytype.d.ts +692 -180
  27. package/lib/module/typescript/codegen/pack/api.d.ts +1180 -133
  28. package/lib/module/typescript/codegen/pack/callback.d.ts +243 -35
  29. package/lib/module/typescript/codegen/pack/errorcode.d.ts +69 -16
  30. package/lib/module/typescript/codegen/pack/keytype.d.ts +1459 -270
  31. package/lib/module/typescript/core/api.d.ts +8 -1
  32. package/lib/module/typescript/core/effect.d.ts +5 -1
  33. package/lib/module/typescript/core/logger.d.ts +1 -0
  34. package/lib/module/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  35. package/lib/module/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  36. package/lib/typescript/codegen/android/api.d.ts +869 -93
  37. package/lib/typescript/codegen/android/callback.d.ts +243 -31
  38. package/lib/typescript/codegen/android/errorcode.d.ts +60 -15
  39. package/lib/typescript/codegen/android/keytype.d.ts +1173 -219
  40. package/lib/typescript/codegen/ios/api.d.ts +899 -102
  41. package/lib/typescript/codegen/ios/callback.d.ts +162 -28
  42. package/lib/typescript/codegen/ios/errorcode.d.ts +100 -25
  43. package/lib/typescript/codegen/ios/keytype.d.ts +692 -180
  44. package/lib/typescript/codegen/pack/api.d.ts +1180 -133
  45. package/lib/typescript/codegen/pack/callback.d.ts +243 -35
  46. package/lib/typescript/codegen/pack/errorcode.d.ts +69 -16
  47. package/lib/typescript/codegen/pack/keytype.d.ts +1459 -270
  48. package/lib/typescript/core/api.d.ts +8 -1
  49. package/lib/typescript/core/effect.d.ts +5 -1
  50. package/lib/typescript/core/logger.d.ts +1 -0
  51. package/lib/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  52. package/lib/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  53. package/package.json +1 -1
@@ -1,7 +1,17 @@
1
1
  import { VeLiveVideoFrame, VeLiveVideoFrameSource, VeLiveAudioFrameSource, VeLiveAudioFrame, VeLivePusherStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel, VeLivePusherStatistics } from './keytype';
2
2
  import { int, String, Bundle, long, Bitmap, float, JSONObject } from './types';
3
3
  export declare class VeLiveVideoFrameFilter {
4
-
4
+ /** {zh}
5
+ * @detail callback
6
+ * @brief 自定义的视频处理方法。
7
+ * @order 20
8
+ * @param srcFrame 源视频帧,详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
9
+ * @param dstFrame 处理后的视频帧,详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
10
+ * @return - 0:处理成功;
11
+ * - <0:处理失败,该帧会被 SDK 丢弃;
12
+ * - >0:处理失败,该帧会被 SDK 继续传递到编码器。
13
+ *
14
+ */
5
15
  /** {en}
6
16
  * @detail callback
7
17
  * @brief Occurs when the SDK captures a video frame. You can use the callback to process the frame in a custom way.
@@ -16,7 +26,13 @@ export declare class VeLiveVideoFrameFilter {
16
26
  onVideoProcess?(srcFrame: VeLiveVideoFrame, dstFrame: VeLiveVideoFrame): int;
17
27
  }
18
28
  export declare class VeLiveVideoFrameListener {
19
-
29
+ /** {zh}
30
+ * @detail callback
31
+ * @brief 设置当前 Listener 需要的视频帧来源。
32
+ * @order 30
33
+ * @return 您所要订阅的视频数据的位置信息,详情请参见 [VeLiveVideoFrameSource](147521#VeLivePusherDef-VeLiveVideoFrameSource)。
34
+ *
35
+ */
20
36
  /** {en}
21
37
  * @detail callback
22
38
  * @brief Sets the source of the video frame that the listener needs.
@@ -25,7 +41,13 @@ export declare class VeLiveVideoFrameListener {
25
41
  *
26
42
  */
27
43
  getObservedVideoFrameSource?(): VeLiveVideoFrameSource;
28
-
44
+ /** {zh}
45
+ * @detail callback
46
+ * @brief 采集视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourceCapture` 时,才会触发该回调。
47
+ * @order 26
48
+ * @param frame 视频帧数据,详情请参见 [VeLiveVideoFrame](#VeLivePusherDef-VeLiveVideoFrameFilter)。
49
+ *
50
+ */
29
51
  /** {en}
30
52
  * @detail callback
31
53
  * @brief Occurs when a video frame is captured. This callback will be triggered only if you return `VeLiveVideoFrameSourceCapture` when implementing the [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) callback method.
@@ -34,7 +56,13 @@ export declare class VeLiveVideoFrameListener {
34
56
  *
35
57
  */
36
58
  onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
37
-
59
+ /** {zh}
60
+ * @detail callback
61
+ * @brief 编码前视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourcePreEncode` 时,才会触发该回调。
62
+ * @order 27
63
+ * @param frame 视频帧数据,详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
64
+ *
65
+ */
38
66
  /** {en}
39
67
  * @detail callback
40
68
  * @brief Occurs when a video frame is to be encoded. This callback will be triggered only if you return `VeLiveVideoFrameSourcePreEncode` when implementing the [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) callback method.
@@ -45,7 +73,14 @@ export declare class VeLiveVideoFrameListener {
45
73
  onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
46
74
  }
47
75
  export declare class VeLiveVideoEffectCallback {
48
-
76
+ /** {zh}
77
+ * @detail callback
78
+ * @brief 视频特效处理结果回调。
79
+ * @param result 处理结果
80
+ * @param msg 消息
81
+ * @order 6
82
+ *
83
+ */
49
84
  /** {en}
50
85
  * @detail callback
51
86
  * @brief Occurs when special effects are processed.
@@ -56,14 +91,25 @@ export declare class VeLiveVideoEffectCallback {
56
91
  onResult?(result: int, msg: String): void;
57
92
  }
58
93
  export declare class VeLiveMediaPlayerListener {
59
-
94
+ /** {zh}
95
+ * @detail callback
96
+ * @brief 开始播放的回调。
97
+ * @order 7
98
+ *
99
+ */
60
100
  /** {en}
61
101
  * @detail callback
62
102
  * @brief Occurs when the playback starts.
63
103
  *
64
104
  */
65
105
  onStart?(info: Bundle): void;
66
-
106
+ /** {zh}
107
+ * @detail callback
108
+ * @brief 播放进度的回调,每 100ms 触发一次。
109
+ * @param timeMs 播放进度,单位为 ms。
110
+ * @order 8
111
+ *
112
+ */
67
113
  /** {en}
68
114
  * @detail callback
69
115
  * @brief Occurs every 100 ms to report the playback progress.
@@ -71,14 +117,26 @@ export declare class VeLiveMediaPlayerListener {
71
117
  *
72
118
  */
73
119
  onProgress?(timeMs: long): void;
74
-
120
+ /** {zh}
121
+ * @detail callback
122
+ * @brief 停止播放的回调。
123
+ * @order 9
124
+ *
125
+ */
75
126
  /** {en}
76
127
  * @detail callback
77
128
  * @brief Occurs when the playback stops.
78
129
  *
79
130
  */
80
131
  onStop?(): void;
81
-
132
+ /** {zh}
133
+ * @detail callback
134
+ * @brief 返错误状态的回调。
135
+ * @param code 错误码,详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
136
+ * @param msg 错误消息。
137
+ * @order 10
138
+ *
139
+ */
82
140
  /** {en}
83
141
  * @detail callback
84
142
  * @brief Occurs when an error occurs in the media player.
@@ -89,7 +147,13 @@ export declare class VeLiveMediaPlayerListener {
89
147
  onError?(code: int, msg: String): void;
90
148
  }
91
149
  export declare class VeLiveAudioFrameListener {
92
-
150
+ /** {zh}
151
+ * @detail callback
152
+ * @brief 设置当前 Listener 需要的音频帧来源。
153
+ * @order 31
154
+ * @return 订阅的音频帧位置信息,详情请参见 [VeLiveAudioFrameSource](147521#VeLivePusherDef-VeLiveAudioFrameSource)。
155
+ *
156
+ */
93
157
  /** {en}
94
158
  * @detail callback
95
159
  * @brief Sets the source of the audio frame that the listener needs.
@@ -98,7 +162,13 @@ export declare class VeLiveAudioFrameListener {
98
162
  *
99
163
  */
100
164
  getObservedAudioFrameSource?(): VeLiveAudioFrameSource;
101
-
165
+ /** {zh}
166
+ * @detail callback
167
+ * @brief 采集音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourceCapture` 时,才会触发该回调。
168
+ * @order 28
169
+ * @param frame 音频帧数据,详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
170
+ *
171
+ */
102
172
  /** {en}
103
173
  * @detail callback
104
174
  * @brief Occurs when an audio frame is captured. This callback will be triggered only if you return `VeLiveAudioFrameSourceCapture` when implementing the [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) callback method.
@@ -107,7 +177,13 @@ export declare class VeLiveAudioFrameListener {
107
177
  *
108
178
  */
109
179
  onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
110
-
180
+ /** {zh}
181
+ * @detail callback
182
+ * @brief 编码前音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourcePreEncode` 时,才会触发该回调。
183
+ * @order 29
184
+ * @param frame 音频帧数据,详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
185
+ *
186
+ */
111
187
  /** {en}
112
188
  * @detail callback
113
189
  * @brief Occurs when an audio frame is to be encoded. This callback will be triggered only if you return `VeLiveAudioFrameSourcePreEncode` when implementing the [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) callback method.
@@ -118,7 +194,13 @@ export declare class VeLiveAudioFrameListener {
118
194
  onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
119
195
  }
120
196
  export declare class VeLiveMediaPlayerFrameListener {
121
-
197
+ /** {zh}
198
+ * @detail callback
199
+ * @brief 播放器音频帧回调。
200
+ * @param frame 音频帧,详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
201
+ * @order 11
202
+ *
203
+ */
122
204
  /** {en}
123
205
  * @detail callback
124
206
  * @brief Occurs when the media player decodes an audio frame.
@@ -126,7 +208,13 @@ export declare class VeLiveMediaPlayerFrameListener {
126
208
  *
127
209
  */
128
210
  onAudioFrame?(frame: VeLiveAudioFrame): void;
129
-
211
+ /** {zh}
212
+ * @detail callback
213
+ * @brief 播放器视频帧回调。当完成一个新的视频帧的解码后,触发该回调。
214
+ * @param frame 视频帧数据,包含了帧的时间戳和格式等信息,详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
215
+ * @order 12
216
+ *
217
+ */
130
218
  /** {en}
131
219
  * @detail callback
132
220
  * @brief Occurs when the media player decodes a video frame.
@@ -136,7 +224,15 @@ export declare class VeLiveMediaPlayerFrameListener {
136
224
  onVideoFrame?(frame: VeLiveVideoFrame): void;
137
225
  }
138
226
  export declare class VeLiveSnapshotListener {
139
-
227
+ /** {zh}
228
+ * @detail callback
229
+ * @brief 截图成功回调。
230
+ * @notes <br>
231
+ * 调用 snapshot{@link #VeLivePusher#snapshot} 截图成功后,会收到这个回调。
232
+ * @order 19
233
+ * @param image 视频的截图。
234
+ *
235
+ */
140
236
  /** {en}
141
237
  * @detail callback
142
238
  * @brief Screenshot success callback.
@@ -147,7 +243,16 @@ export declare class VeLiveSnapshotListener {
147
243
  onSnapshotComplete?(image: Bitmap): void;
148
244
  }
149
245
  export declare class VeLiveAudioFrameFilter {
150
-
246
+ /** {zh}
247
+ * @detail callback
248
+ * @brief 自定义的音频处理方法。
249
+ * @order 21
250
+ * @param srcFrame 源音频帧,详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
251
+ * @param dstFrame 处理后的音频帧,详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
252
+ * - 0:处理成功;
253
+ * - ≠0:处理失败,该帧会被 SDK 继续传递到编码器;
254
+ *
255
+ */
151
256
  /** {en}
152
257
  * @detail callback
153
258
  * @brief Occurs when the SDK captures an audio frame. You can use the callback to process the frame in a custom way.
@@ -161,7 +266,15 @@ export declare class VeLiveAudioFrameFilter {
161
266
  onAudioProcess?(srcFrame: VeLiveAudioFrame, dstFrame: VeLiveAudioFrame): int;
162
267
  }
163
268
  export declare class VeLivePusherObserver {
164
-
269
+ /** {zh}
270
+ * @detail callback
271
+ * @brief 推流错误回调。
272
+ * @order 1
273
+ * @param code 错误码。详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
274
+ * @param subCode 子错误码。
275
+ * @param msg 错误信息。
276
+ *
277
+ */
165
278
  /** {en}
166
279
  * @detail callback
167
280
  * @brief Occurs when a streaming error occurs.
@@ -172,7 +285,13 @@ export declare class VeLivePusherObserver {
172
285
  *
173
286
  */
174
287
  onError?(code: int, subCode: int, msg: String): void;
175
-
288
+ /** {zh}
289
+ * @detail callback
290
+ * @brief 推流状态变化回调。
291
+ * @order 16
292
+ * @param status 变化后的推流状态。详情请参见 [VeLivePusherStatus](147521#VeLivePusherStatus)。
293
+ *
294
+ */
176
295
  /** {en}
177
296
  * @detail callback
178
297
  * @brief Occurs when the streaming status changes.
@@ -181,7 +300,14 @@ export declare class VeLivePusherObserver {
181
300
  *
182
301
  */
183
302
  onStatusChange?(status: VeLivePusherStatus): void;
184
-
303
+ /** {zh}
304
+ * @detail callback
305
+ * @brief 首帧视频回调,当推流器发送出第一帧视频时,触发该回调。
306
+ * @order 2
307
+ * @param type 首帧的类型,详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
308
+ * @param timestampMs 时间戳,单位为 ms。
309
+ *
310
+ */
185
311
  /** {en}
186
312
  * @detail callback
187
313
  * @brief Occurs when the live pusher sends the first video frame.
@@ -191,7 +317,14 @@ export declare class VeLivePusherObserver {
191
317
  *
192
318
  */
193
319
  onFirstVideoFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
194
-
320
+ /** {zh}
321
+ * @detail callback
322
+ * @brief 首帧音频回调,当推流器发送出第一帧音频时,触发该回调。
323
+ * @order 3
324
+ * @param type 首帧的类型,详情请参见 [VeLiveFirstFrameType](147521#VeLiveFirstFrameType)。
325
+ * @param timestampMs 时间戳,单位为 ms。
326
+ *
327
+ */
195
328
  /** {en}
196
329
  * @detail callback
197
330
  * @brief Occurs when the live pusher sends the first audio frame.
@@ -201,7 +334,15 @@ export declare class VeLivePusherObserver {
201
334
  *
202
335
  */
203
336
  onFirstAudioFrame?(type: VeLiveFirstFrameType, timestampMs: long): void;
204
-
337
+ /** {zh}
338
+ * @detail callback
339
+ * @brief 摄像头开启/关闭回调,当推流器的摄像头开启或关闭时,触发该回调。
340
+ * @param open 摄像头的新状态是否为开启。<br>
341
+ * - true:摄像头开启;
342
+ * - false:摄像头关闭。
343
+ * @order 4
344
+ *
345
+ */
205
346
  /** {en}
206
347
  * @detail callback
207
348
  * @brief Occurs when the camera is turned on or turned off.
@@ -212,7 +353,15 @@ export declare class VeLivePusherObserver {
212
353
  *
213
354
  */
214
355
  onCameraOpened?(open: boolean): void;
215
-
356
+ /** {zh}
357
+ * @detail callback
358
+ * @brief 麦克风开启/关闭回调,当推流器的麦克风开启或关闭时,触发该回调。
359
+ * @param open 麦克风的新状态是否为开启。<br>
360
+ * - true:麦克风开启;
361
+ * - false:麦克风关闭。
362
+ * @order 5
363
+ *
364
+ */
216
365
  /** {en}
217
366
  * @detail callback
218
367
  * @brief Occurs when the microphone is turned on or turned off.
@@ -223,7 +372,15 @@ export declare class VeLivePusherObserver {
223
372
  *
224
373
  */
225
374
  onMicrophoneOpened?(open: boolean): void;
226
-
375
+ /** {zh}
376
+ * @detail callback
377
+ * @brief 屏幕采集开启/关闭回调,当推流器的屏幕采集开启或关闭时,触发该回调。
378
+ * @param open 屏幕采集的新状态是否为开启。<br>
379
+ * - true:屏幕采集开启;
380
+ * - false:屏幕采集关闭。
381
+ * @order 14
382
+ *
383
+ */
227
384
  /** {en}
228
385
  * @detail callback
229
386
  * @brief Occurs when screen capture is turned on or turned off.
@@ -234,7 +391,13 @@ export declare class VeLivePusherObserver {
234
391
  *
235
392
  */
236
393
  onScreenRecording?(open: boolean): void;
237
-
394
+ /** {zh}
395
+ * @detail callback
396
+ * @brief 网络质量状态回调,当推流器检测到网络质量发生变化时,触发该回调。
397
+ * @order 17
398
+ * @param quality 变化后的网络质量。详情请参见 [VeLiveNetworkQuality](147521#VeLiveNetworkQuality)。
399
+ *
400
+ */
238
401
  /** {en}
239
402
  * @detail callback
240
403
  * @brief Occurs when the network quality changes.
@@ -243,7 +406,21 @@ export declare class VeLivePusherObserver {
243
406
  *
244
407
  */
245
408
  onNetworkQuality?(quality: VeLiveNetworkQuality): void;
246
-
409
+ /** {zh}
410
+ * @detail callback
411
+ * @brief 音量等级回调,当推流器的音频音量等级发生变化时,触发该回调。
412
+ * @order 15
413
+ * @param level 变化后的音量等级。详情请参见 [VeLiveAudioPowerLevel](147521#VeLiveAudioPowerLevel)。
414
+ * @param value 当前音量的分贝值(dB)。<br/>
415
+ * - \\-1 表示当前没有获取到对应的音量分贝值。
416
+ * - 分贝数小于 1,对应 VeLiveAudioPowerLevelSilent 级别
417
+ * - 分贝数大于 1 小于等于 15,对应 VeLiveAudioPowerLevelQuiet 级别
418
+ * - 分贝数大于 15 小于等于 30,对应 VeLiveAudioPowerLevelLight 级别
419
+ * - 分贝数大于 30 小于等于 60,对应 VeLiveAudioPowerLevelNormal 级别
420
+ * - 分贝数大于 60 小于等于 85,对应 VeLiveAudioPowerLevelLoud
421
+ * - 分贝数大于 85,对应 VeLiveAudioPowerLevelNoisy 级别
422
+ *
423
+ */
247
424
  /** {en}
248
425
  * @detail callback
249
426
  * @brief Occurs when the audio volume level changes.
@@ -262,7 +439,13 @@ export declare class VeLivePusherObserver {
262
439
  onAudioPowerQuality?(level: VeLiveAudioPowerLevel, value: float): void;
263
440
  }
264
441
  export declare class VeLivePusherStatisticsObserver {
265
-
442
+ /** {zh}
443
+ * @detail callback
444
+ * @brief 推流周期性统计信息回调,每 5s 回调一次,您可以调用 [setStatisticsObserver](147517#VeLivePusher-setstatisticsobserver) 修改回调时间间隔。
445
+ * @order 18
446
+ * @param statistics 周期性统计信息,详情请参见 [VeLivePusherStatistics](147521#VeLivePusherDef-VeLivePusherStatistics)。
447
+ *
448
+ */
266
449
  /** {en}
267
450
  * @detail callback
268
451
  * @brief Occurs periodically to report streaming statistics. By default, the callback is triggered every 5 seconds. You can call [setStatisticsObserver](docs-broadcast-sdk-for-android-api#VeLivePusher-setstatisticsobserver) to modify the callback time interval.
@@ -271,7 +454,13 @@ export declare class VeLivePusherStatisticsObserver {
271
454
  *
272
455
  */
273
456
  onStatistics?(statistics: VeLivePusherStatistics): void;
274
-
457
+ /** {zh}
458
+ * @detail callback
459
+ * @brief 周期性日志信息回调。
460
+ * @order 25
461
+ * @param logInfo 周期性日志信息。
462
+ *
463
+ */
275
464
  /** {en}
276
465
  * @detail callback
277
466
  * @brief Occurs periodically to return log information.
@@ -284,7 +473,12 @@ export declare class VeLivePusherStatisticsObserver {
284
473
  export declare class VeLivePusherDef {
285
474
  }
286
475
  export declare class VeLiveFileRecordingListener {
287
-
476
+ /** {zh}
477
+ * @detail callback
478
+ * @brief 直播录制开始回调。
479
+ * @order 22
480
+ *
481
+ */
288
482
  /** {en}
289
483
  * @detail callback
290
484
  * @brief Occurs when recording starts.
@@ -292,7 +486,12 @@ export declare class VeLiveFileRecordingListener {
292
486
  *
293
487
  */
294
488
  onFileRecordingStarted?(): void;
295
-
489
+ /** {zh}
490
+ * @detail callback
491
+ * @brief 直播录制停止回调。
492
+ * @order 23
493
+ *
494
+ */
296
495
  /** {en}
297
496
  * @detail callback
298
497
  * @brief Occurs when recording stops.
@@ -300,7 +499,14 @@ export declare class VeLiveFileRecordingListener {
300
499
  *
301
500
  */
302
501
  onFileRecordingStopped?(): void;
303
-
502
+ /** {zh}
503
+ * @detail callback
504
+ * @brief 直播录制错误回调。
505
+ * @order 24
506
+ * @param errorCode 错误码,详情请参见 [VeLivePusherErrorCode](147520#VeLivePusherErrorCode)。
507
+ * @param message 错误信息。
508
+ *
509
+ */
304
510
  /** {en}
305
511
  * @detail callback
306
512
  * @brief Occurs when an error occurs during recording.
@@ -312,7 +518,13 @@ export declare class VeLiveFileRecordingListener {
312
518
  onFileRecordingError?(errorCode: int, message: String): void;
313
519
  }
314
520
  export declare class VeLiveVideoEffectHandleCallback {
315
-
521
+ /** {zh}
522
+ * @detail callback
523
+ * @brief 视频特效对象回调,调用 [setAdvancedFeature](147517#VeLiveVideoEffectManager-setadvancedfeature) 接口时触发此回调,如需使用请联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
524
+ * @param handle 视频特效对象。
525
+ * @order 13
526
+ *
527
+ */
316
528
  /** {en}
317
529
  * @detail callback
318
530
  * @brief Occurs when the [setAdvancedFeature](docs-broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setadvancedfeature) method is called. Please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
@@ -1,89 +1,134 @@
1
1
  export declare enum VeLivePusherErrorCode {
2
-
2
+ /** {zh}
3
+ * @brief 无错误。
4
+ *
5
+ */
3
6
  /** {en}
4
7
  * @brief No error.
5
8
  *
6
9
  */
7
10
  VeLivePusherSuccess = 0,
8
-
11
+ /** {zh}
12
+ * @brief License 错误,可能 License 集成错误或 License 过期,请检查 License 集成方式和有效性。
13
+ *
14
+ */
9
15
  /** {en}
10
16
  * @brief SDK license error, possibly caused by an invalid or expired certificate.
11
17
  *
12
18
  */
13
19
  VeLivePusherInvalidLicense = -1,
14
-
20
+ /** {zh}
21
+ * @brief 参数错误,请检查入参,并重新调用。
22
+ *
23
+ */
15
24
  /** {en}
16
25
  * @brief Parameter error, possibly caused by an invalid parameter value or parameter type.
17
26
  *
18
27
  */
19
28
  VeLivePusherInvalidParameter = -2,
20
-
29
+ /** {zh}
30
+ * @brief 视频采集错误,可能未开启设备视频采集权限,请检查权限是否获取。
31
+ *
32
+ */
21
33
  /** {en}
22
34
  * @brief Video capture error, possibly caused by the lack of access to the video device.
23
35
  *
24
36
  */
25
37
  VeLivePusherVideoCaptureError = -3,
26
-
38
+ /** {zh}
39
+ * @brief 音频采集错误,可能未开启设备麦克风采集权限,请检查权限是否获取。
40
+ *
41
+ */
27
42
  /** {en}
28
43
  * @brief Audio capture error, possibly caused by the lack of access to the audio device.
29
44
  *
30
45
  */
31
46
  VeLivePusherAudioCaptureError = -4,
32
-
47
+ /** {zh}
48
+ * @brief 视频编码错误,可能配置了当前设备不支持的视频编码方式,请检查编码参数,并重新调用。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
49
+ *
50
+ */
33
51
  /** {en}
34
52
  * @brief Video encoding error, possibly caused by a configuration issue with the video encoder. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
35
53
  *
36
54
  */
37
55
  VeLivePusherVideoEncoderError = -5,
38
-
56
+ /** {zh}
57
+ * @brief 音频编码错误,可能配置了当前设备不支持的音频编码方式,请检查编码参数,并重新调用。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
58
+ *
59
+ */
39
60
  /** {en}
40
61
  * @brief Audio encoding error, possibly caused by a configuration issue with the audio encoder. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
41
62
  *
42
63
  */
43
64
  VeLivePusherAudioEncoderError = -6,
44
-
65
+ /** {zh}
66
+ * @brief 网络发送错误,可能当前网络链路不通,或者开启了代理和关闭了网络权限,请检查网络后重新调用。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
67
+ *
68
+ */
45
69
  /** {en}
46
70
  * @brief Network error, which might be caused by network connection issues such as network instability or high latency. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
47
71
  *
48
72
  */
49
73
  VeLivePusherTransportError = -7,
50
-
74
+ /** {zh}
75
+ * @brief 视频特效错误,请检查视频特效 SDK 是否已经集成并且初试化成功。检查特效资源路径是否配置正确。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
76
+ *
77
+ */
51
78
  /** {en}
52
79
  * @brief Special effects error. Please check if the Effects SDK has been integrated and initialized, and if the path of the effects resources is correctly set. If the error is not eliminated, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
53
80
  *
54
81
  */
55
82
  VeLivePusherVideoEffectError = -8,
56
-
83
+ /** {zh}
84
+ * @brief 音频模块错误,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
85
+ *
86
+ */
57
87
  /** {en}
58
88
  * @brief Audio device error. Please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
59
89
  *
60
90
  */
61
91
  VeLivePusherAudioDeviceError = -9,
62
-
92
+ /** {zh}
93
+ * @brief 您使用的基础版 License 暂不支持 H.265 硬件编码,请登录火山引擎控制台获取高级版 License。
94
+ *
95
+ */
63
96
  /** {en}
64
97
  * @brief The license does not support H265.
65
98
  *
66
99
  */
67
100
  VeLivePusherLicenseUnsupportedH265 = -10,
68
-
101
+ /** {zh}
102
+ * @brief 当前系统版本不支持屏幕采集功能
103
+ *
104
+ */
69
105
  /** {en}
70
106
  * @brief
71
107
  *
72
108
  */
73
109
  VeLivePusherScreenCaptureNotSupportError = -11,
74
-
110
+ /** {zh}
111
+ * @brief 屏幕采集权限的获取被用户拒绝
112
+ *
113
+ */
75
114
  /** {en}
76
115
  * @brief
77
116
  *
78
117
  */
79
118
  VeLivePusherScreenCaptureStartError = -12,
80
-
119
+ /** {zh}
120
+ * @brief 屏幕采集被系统中断,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
121
+ *
122
+ */
81
123
  /** {en}
82
124
  * @brief
83
125
  *
84
126
  */
85
127
  VeLivePusherScreenCaptureInterruptedError = -13,
86
-
128
+ /** {zh}
129
+ * @brief 其他错误类型,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
130
+ *
131
+ */
87
132
  /** {en}
88
133
  * @brief Internal error. Please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support for assistance when using this callback method.
89
134
  *