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