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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/ios/RCTVeLivePush/RCTVeLivePush.mm +1 -1
  2. package/ios/VeLiveMixerView.m +5 -15
  3. package/lib/commonjs/typescript/codegen/android/api.d.ts +869 -93
  4. package/lib/commonjs/typescript/codegen/android/callback.d.ts +243 -31
  5. package/lib/commonjs/typescript/codegen/android/errorcode.d.ts +60 -15
  6. package/lib/commonjs/typescript/codegen/android/keytype.d.ts +1173 -219
  7. package/lib/commonjs/typescript/codegen/ios/api.d.ts +899 -102
  8. package/lib/commonjs/typescript/codegen/ios/callback.d.ts +162 -28
  9. package/lib/commonjs/typescript/codegen/ios/errorcode.d.ts +100 -25
  10. package/lib/commonjs/typescript/codegen/ios/keytype.d.ts +692 -180
  11. package/lib/commonjs/typescript/codegen/pack/api.d.ts +1180 -133
  12. package/lib/commonjs/typescript/codegen/pack/callback.d.ts +243 -35
  13. package/lib/commonjs/typescript/codegen/pack/errorcode.d.ts +69 -16
  14. package/lib/commonjs/typescript/codegen/pack/keytype.d.ts +1459 -270
  15. package/lib/commonjs/typescript/core/api.d.ts +8 -1
  16. package/lib/commonjs/typescript/core/effect.d.ts +5 -1
  17. package/lib/commonjs/typescript/core/logger.d.ts +1 -0
  18. package/lib/commonjs/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  19. package/lib/commonjs/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  20. package/lib/module/typescript/codegen/android/api.d.ts +869 -93
  21. package/lib/module/typescript/codegen/android/callback.d.ts +243 -31
  22. package/lib/module/typescript/codegen/android/errorcode.d.ts +60 -15
  23. package/lib/module/typescript/codegen/android/keytype.d.ts +1173 -219
  24. package/lib/module/typescript/codegen/ios/api.d.ts +899 -102
  25. package/lib/module/typescript/codegen/ios/callback.d.ts +162 -28
  26. package/lib/module/typescript/codegen/ios/errorcode.d.ts +100 -25
  27. package/lib/module/typescript/codegen/ios/keytype.d.ts +692 -180
  28. package/lib/module/typescript/codegen/pack/api.d.ts +1180 -133
  29. package/lib/module/typescript/codegen/pack/callback.d.ts +243 -35
  30. package/lib/module/typescript/codegen/pack/errorcode.d.ts +69 -16
  31. package/lib/module/typescript/codegen/pack/keytype.d.ts +1459 -270
  32. package/lib/module/typescript/core/api.d.ts +8 -1
  33. package/lib/module/typescript/core/effect.d.ts +5 -1
  34. package/lib/module/typescript/core/logger.d.ts +1 -0
  35. package/lib/module/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  36. package/lib/module/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  37. package/lib/typescript/codegen/android/api.d.ts +869 -93
  38. package/lib/typescript/codegen/android/callback.d.ts +243 -31
  39. package/lib/typescript/codegen/android/errorcode.d.ts +60 -15
  40. package/lib/typescript/codegen/android/keytype.d.ts +1173 -219
  41. package/lib/typescript/codegen/ios/api.d.ts +899 -102
  42. package/lib/typescript/codegen/ios/callback.d.ts +162 -28
  43. package/lib/typescript/codegen/ios/errorcode.d.ts +100 -25
  44. package/lib/typescript/codegen/ios/keytype.d.ts +692 -180
  45. package/lib/typescript/codegen/pack/api.d.ts +1180 -133
  46. package/lib/typescript/codegen/pack/callback.d.ts +243 -35
  47. package/lib/typescript/codegen/pack/errorcode.d.ts +69 -16
  48. package/lib/typescript/codegen/pack/keytype.d.ts +1459 -270
  49. package/lib/typescript/core/api.d.ts +8 -1
  50. package/lib/typescript/core/effect.d.ts +5 -1
  51. package/lib/typescript/core/logger.d.ts +1 -0
  52. package/lib/typescript/platforms/android/AppLogWrapper.d.ts +8 -0
  53. package/lib/typescript/platforms/ios/RangersAppLog.d.ts +4 -0
  54. package/package.json +1 -1
@@ -1,7 +1,12 @@
1
1
  import { VeLivePusherStatistics, VeLiveVideoFrame, VeLiveAudioFrame, VeLivePushStatus, VeLiveFirstFrameType, VeLiveNetworkQuality, VeLiveAudioPowerLevel } from './keytype';
2
2
  import { NSDictionary, int, NSString, long, NSError, UIImage, int64_t, BOOL, float } from './types';
3
3
  export declare class VeLivePusherStatisticsObserver {
4
-
4
+ /** {zh}
5
+ * @detail callback
6
+ * @brief 推流周期性统计信息回调。
7
+ * @order 8
8
+ * @param statistics 周期性统计信息,默认每 5s 回调一次,详情请参见 [VeLivePusherStatistics](155321#VeLivePusherStatistics)。
9
+ */
5
10
  /** {en}
6
11
  * @detail callback
7
12
  * @brief Occurs periodically to report streaming statistics. By default, the callback is triggered every 5 seconds.
@@ -9,7 +14,12 @@ export declare class VeLivePusherStatisticsObserver {
9
14
  * @order 8
10
15
  */
11
16
  onStatistics?(statistics: VeLivePusherStatistics): void;
12
-
17
+ /** {zh}
18
+ * @detail callback
19
+ * @brief 周期性日志信息回调。
20
+ * @order 9
21
+ * @param logInfo 周期性日志信息。
22
+ */
13
23
  /** {en}
14
24
  * @detail callback
15
25
  * @brief Occurs periodically to return log information.
@@ -19,14 +29,22 @@ export declare class VeLivePusherStatisticsObserver {
19
29
  onLogMonitor?(logInfo: NSDictionary): void;
20
30
  }
21
31
  export declare class VeLiveMediaPlayerFrameListener {
22
-
32
+ /** {zh}
33
+ * @detail callback
34
+ * @brief 播放器视频帧回调。当完成一个新的视频帧的解码后,触发该回调。
35
+ * @param videoFrame 视频帧数据,包含了帧的时间戳和格式等信息,详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
36
+ */
23
37
  /** {en}
24
38
  * @detail callback
25
39
  * @brief Occurs when the media player decodes a video frame.
26
40
  * @param videoFrame The video frame data, including the timestamp, pixel format, and other information. See [VeLiveVideoFrame](broadcast-sdk-for-ios-type-definition#VeLiveVideoFrame) for details.
27
41
  */
28
42
  onVideoFrame?(videoFrame: VeLiveVideoFrame): void;
29
-
43
+ /** {zh}
44
+ * @detail callback
45
+ * @brief 播放器音频帧回调。
46
+ * @param audioFrame 音频帧,详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
47
+ */
30
48
  /** {en}
31
49
  * @detail callback
32
50
  * @brief Occurs when the media player decodes an audio frame.
@@ -35,21 +53,35 @@ export declare class VeLiveMediaPlayerFrameListener {
35
53
  onAudioFrame?(audioFrame: VeLiveAudioFrame): void;
36
54
  }
37
55
  export declare class VeLiveFileRecordingListener {
38
-
56
+ /** {zh}
57
+ * @detail callback
58
+ * @brief 直播录制开始回调。
59
+ * @order 10
60
+ */
39
61
  /** {en}
40
62
  * @detail callback
41
63
  * @brief Occurs when recording starts.
42
64
  * @order 10
43
65
  */
44
66
  onFileRecordingStarted?(): void;
45
-
67
+ /** {zh}
68
+ * @detail callback
69
+ * @brief 直播录制停止回调。
70
+ * @order 11
71
+ */
46
72
  /** {en}
47
73
  * @detail callback
48
74
  * @brief Occurs when recording stops.
49
75
  * @order 11
50
76
  */
51
77
  onFileRecordingStopped?(): void;
52
-
78
+ /** {zh}
79
+ * @detail callback
80
+ * @brief 直播录制错误回调。
81
+ * @order 12
82
+ * @param errorCode 错误码,详情请参见 [VeLivePusherCode](155320#VeLivePusherCode)。
83
+ * @param msg 错误信息。
84
+ */
53
85
  /** {en}
54
86
  * @detail callback
55
87
  * @brief Occurs when an error occurs during recording.
@@ -60,25 +92,37 @@ export declare class VeLiveFileRecordingListener {
60
92
  onFileRecordingError$message?(errorCode: int, msg: NSString): void;
61
93
  }
62
94
  export declare class VeLiveScreenCaptureStatusObserver {
63
-
95
+ /** {zh}
96
+ * @detail callback
97
+ * @brief 录屏推流开始的回调。当 `[RPBroadcastSampleHandler startBroadcast]` 回调被触发时,会同时触发该回调。
98
+ */
64
99
  /** {en}
65
100
  * @detail callback
66
101
  * @brief Triggered when screen streaming starts. This callback is triggered once the `[RPBroadcastSampleHandler startBroadcast]` callback is triggered.
67
102
  */
68
103
  broadcastStarted?(): void;
69
-
104
+ /** {zh}
105
+ * @detail callback
106
+ * @brief 屏幕推流暂停的回调。当 `[RPBroadcastSampleHandler pauseBroadcast]` 回调被触发时,会同时触发该回调。
107
+ */
70
108
  /** {en}
71
109
  * @detail callback
72
110
  * @brief Triggered when screen streaming pauses. This callback is triggered once the `[RPBroadcastSampleHandler pauseBroadcast]` callback is triggered.
73
111
  */
74
112
  broadcastPaused?(): void;
75
-
113
+ /** {zh}
114
+ * @detail callback
115
+ * @brief 屏幕推流恢复的回调。当 `[RPBroadcastSampleHandler resumeBroadcast]` 回调被触发时,会同时触发该回调。
116
+ */
76
117
  /** {en}
77
118
  * @detail callback
78
119
  * @brief Triggered when screen streaming resumes. This callback is triggered once the `[RPBroadcastSampleHandler resumeBroadcast]` callback is triggered.
79
120
  */
80
121
  broadcastResumed?(): void;
81
-
122
+ /** {zh}
123
+ * @detail callback
124
+ * @brief 屏幕推流结束的回调。当 `[RPBroadcastSampleHandler finishBroadcast]` 回调被触发时,会同时触发该回调。
125
+ */
82
126
  /** {en}
83
127
  * @detail callback
84
128
  * @brief Triggered when screen streaming stops. This callback is triggered once the `[RPBroadcastSampleHandler finishBroadcast]` callback is triggered.
@@ -88,14 +132,22 @@ export declare class VeLiveScreenCaptureStatusObserver {
88
132
  export declare class VeLiveVideoFrameFilter {
89
133
  }
90
134
  export declare class VeLiveVideoFrameListener {
91
-
135
+ /** {zh}
136
+ * @detail callback
137
+ * @brief 采集视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourceCapture` 时,才会触发该回调。
138
+ * @param frame 视频帧数据,详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
139
+ */
92
140
  /** {en}
93
141
  * @detail callback
94
142
  * @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.
95
143
  * @param frame The captured video frame. See VeLiveVideoFrame{@link #VeLiveVideoFrame} for details.
96
144
  */
97
145
  onCaptureVideoFrame?(frame: VeLiveVideoFrame): void;
98
-
146
+ /** {zh}
147
+ * @detail callback
148
+ * @brief 编码前视频帧回调。只有当您通过 [getObservedVideoFrameSource](#VeLiveVideoFrameListener-getobservedvideoframesource) 返回 `VeLiveVideoFrameSourcePreEncode` 时,才会触发该回调。
149
+ * @param frame 视频帧数据,详情请参见 [VeLiveVideoFrame](155321#VeLiveVideoFrame)。
150
+ */
99
151
  /** {en}
100
152
  * @detail callback
101
153
  * @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.
@@ -104,14 +156,22 @@ export declare class VeLiveVideoFrameListener {
104
156
  onPreEncodeVideoFrame?(frame: VeLiveVideoFrame): void;
105
157
  }
106
158
  export declare class VeLiveAudioFrameListener {
107
-
159
+ /** {zh}
160
+ * @detail callback
161
+ * @brief 采集音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourceCapture` 时,才会触发该回调。
162
+ * @param frame 音频帧数据,详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
163
+ */
108
164
  /** {en}
109
165
  * @detail callback
110
166
  * @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.
111
167
  * @param frame The captured audio frame data. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
112
168
  */
113
169
  onCaptureAudioFrame?(frame: VeLiveAudioFrame): void;
114
-
170
+ /** {zh}
171
+ * @detail callback
172
+ * @brief 编码前音频帧回调。只有当您通过 [getObservedAudioFrameSource](#VeLiveAudioFrameListener-getobservedaudioframesource) 返回 `VeLiveAudioFrameSourcePreEncode` 时,才会触发该回调。
173
+ * @param frame 音频帧数据,详情请参见 [VeLiveAudioFrame](155321#VeLiveAudioFrame)。
174
+ */
115
175
  /** {en}
116
176
  * @detail callback
117
177
  * @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.
@@ -120,26 +180,40 @@ export declare class VeLiveAudioFrameListener {
120
180
  onPreEncodeAudioFrame?(frame: VeLiveAudioFrame): void;
121
181
  }
122
182
  export declare class VeLiveMediaPlayerListener {
123
-
183
+ /** {zh}
184
+ * @detail callback
185
+ * @brief 开始播放的回调。
186
+ */
124
187
  /** {en}
125
188
  * @detail callback
126
189
  * @brief Occurs when the playback starts.
127
190
  */
128
191
  onStart?(): void;
129
-
192
+ /** {zh}
193
+ * @detail callback
194
+ * @brief 播放进度的回调,每 100ms 触发一次。
195
+ * @param timeMS 播放进度,单位为 ms。
196
+ */
130
197
  /** {en}
131
198
  * @detail callback
132
199
  * @brief Occurs every 100 ms to report the playback progress.
133
200
  * @param timeMS The playback progress, in milliseconds.
134
201
  */
135
202
  onProgress?(timeMS: long): void;
136
-
203
+ /** {zh}
204
+ * @detail callback
205
+ * @brief 停止播放的回调。
206
+ */
137
207
  /** {en}
138
208
  * @detail callback
139
209
  * @brief Occurs when the playback stops.
140
210
  */
141
211
  onStop?(): void;
142
-
212
+ /** {zh}
213
+ * @detail callback
214
+ * @brief 返错误状态的回调。
215
+ * @param error 错误消息。
216
+ */
143
217
  /** {en}
144
218
  * @detail callback
145
219
  * @brief Occurs when an error occurs in the media player.
@@ -150,7 +224,11 @@ export declare class VeLiveMediaPlayerListener {
150
224
  export declare class VeLiveAudioFrameFilter {
151
225
  }
152
226
  export declare class VeLiveSnapshotListener {
153
-
227
+ /** {zh}
228
+ * @detail callback
229
+ * @brief 截图成功回调。调用 [snapshot:](155318#VeLivePusher-snapshot) 截图成功后,会收到这个回调。
230
+ * @param image 视频的截图。
231
+ */
154
232
  /** {en}
155
233
  * @detail callback
156
234
  * @brief Occurs when a screenshot is successfully taken after snapshot:{@link #VeLivePusher#snapshot} is called.
@@ -159,7 +237,14 @@ export declare class VeLiveSnapshotListener {
159
237
  onSnapshotComplete?(image: UIImage): void;
160
238
  }
161
239
  export declare class VeLivePusherObserver {
162
-
240
+ /** {zh}
241
+ * @detail callback
242
+ * @brief 推流错误回调。
243
+ * @order 0
244
+ * @param code 错误码,详情请参见 [VeLivePusherCode](155320#VeLivePusherCode)。
245
+ * @param subcode 子错误码,详情请参见 [VeLivePusherErrorCode](155320#VeLivePusherErrorCode)。
246
+ * @param msg 错误信息。
247
+ */
163
248
  /** {en}
164
249
  * @detail callback
165
250
  * @brief Occurs when a streaming error occurs.
@@ -169,7 +254,12 @@ export declare class VeLivePusherObserver {
169
254
  * @order 0
170
255
  */
171
256
  onError$subcode$message?(code: int, subcode: int, msg: NSString): void;
172
-
257
+ /** {zh}
258
+ * @detail callback
259
+ * @brief 推流状态变化回调。
260
+ * @order 1
261
+ * @param status 变化后的推流状态,详情请参见 [VeLivePushStatus](155321#VeLivePushStatus)。
262
+ */
173
263
  /** {en}
174
264
  * @detail callback
175
265
  * @brief Occurs when the streaming status changes.
@@ -177,7 +267,13 @@ export declare class VeLivePusherObserver {
177
267
  * @order 1
178
268
  */
179
269
  onStatusChange?(status: VeLivePushStatus): void;
180
-
270
+ /** {zh}
271
+ * @detail callback
272
+ * @brief 首帧视频回调,当推流器发送出第一帧视频时,触发该回调。
273
+ * @order 2
274
+ * @param type 首帧的类型,详情请参见 [VeLiveFirstFrameType](155321#VeLiveFirstFrameType)。
275
+ * @param timestampMs 时间戳,单位为 ms。
276
+ */
181
277
  /** {en}
182
278
  * @detail callback
183
279
  * @brief Occurs when the live pusher sends the first video frame.
@@ -186,7 +282,13 @@ export declare class VeLivePusherObserver {
186
282
  * @order 2
187
283
  */
188
284
  onFirstVideoFrame$timestampMs?(type: VeLiveFirstFrameType, timestampMs: int64_t): void;
189
-
285
+ /** {zh}
286
+ * @detail callback
287
+ * @brief 首帧音频回调,当推流器发送出第一帧音频时,触发该回调。
288
+ * @order 3
289
+ * @param type 首帧的类型,详情请参见 [VeLiveFirstFrameType](155321#VeLiveFirstFrameType)。
290
+ * @param timestampMs 时间戳,单位为 ms。
291
+ */
190
292
  /** {en}
191
293
  * @detail callback
192
294
  * @brief Occurs when the live pusher sends the first audio frame.
@@ -195,7 +297,14 @@ export declare class VeLivePusherObserver {
195
297
  * @order 3
196
298
  */
197
299
  onFirstAudioFrame$timestampMs?(type: VeLiveFirstFrameType, timestampMs: int64_t): void;
198
-
300
+ /** {zh}
301
+ * @detail callback
302
+ * @brief 摄像头开启/关闭回调,当推流器的摄像头开启或关闭时,触发该回调。
303
+ * @param open 摄像头的新状态是否为开启。<br>
304
+ * - YES:摄像头开启;
305
+ * - NO:摄像头关闭。
306
+ * @order 4
307
+ */
199
308
  /** {en}
200
309
  * @detail callback
201
310
  * @brief Occurs when the camera is turned on or turned off.
@@ -205,7 +314,14 @@ export declare class VeLivePusherObserver {
205
314
  * @order 4
206
315
  */
207
316
  onCameraOpened?(open: BOOL): void;
208
-
317
+ /** {zh}
318
+ * @detail callback
319
+ * @brief 麦克风开启/关闭回调,当推流器的麦克风开启或关闭时,触发该回调。
320
+ * @param open 麦克风的新状态是否为开启。<br>
321
+ * - YES:麦克风开启;
322
+ * - NO:麦克风关闭。
323
+ * @order 5
324
+ */
209
325
  /** {en}
210
326
  * @detail callback
211
327
  * @brief Occurs when the microphone is turned on or turned off.
@@ -215,7 +331,12 @@ export declare class VeLivePusherObserver {
215
331
  * @order 5
216
332
  */
217
333
  onMicrophoneOpened?(open: BOOL): void;
218
-
334
+ /** {zh}
335
+ * @detail callback
336
+ * @brief 网络质量状态回调,当推流器检测到网络质量发生变化时,触发该回调。
337
+ * @order 6
338
+ * @param quality 变化后的网络质量。详情请参见 [VeLiveNetworkQuality](155321#VeLiveNetworkQuality)。
339
+ */
219
340
  /** {en}
220
341
  * @detail callback
221
342
  * @brief Occurs when the network quality changes.
@@ -223,7 +344,20 @@ export declare class VeLivePusherObserver {
223
344
  * @order 6
224
345
  */
225
346
  onNetworkQuality?(quality: VeLiveNetworkQuality): void;
226
-
347
+ /** {zh}
348
+ * @detail callback
349
+ * @brief 音量等级回调,当推流器采集的音频音量等级发生变化时,触发该回调。
350
+ * @order 7
351
+ * @param level 变化后的音量等级。详情请参见 [VeLiveAudioPowerLevel](155321#VeLiveAudioPowerLevel)。
352
+ * @param value 当前音量的分贝值(dB)。
353
+ * - -1 表示当前没有获取到对应的音量分贝值;
354
+ * - 分贝数小于 1,对应 VeLiveAudioPowerLevelSilent 级别;
355
+ * - 分贝数大于 1 小于等于 15,对应 VeLiveAudioPowerLevelQuiet 级别;
356
+ * - 分贝数大于 15 小于等于 30,对应 VeLiveAudioPowerLevelLight 级别;
357
+ * - 分贝数大于 30 小于等于 60,对应 VeLiveAudioPowerLevelNormal 级别;
358
+ * - 分贝数大于 60 小于等于 85,对应 VeLiveAudioPowerLevelLoud 级别;
359
+ * - 分贝数大于 85,对应 VeLiveAudioPowerLevelNoisy 级别。
360
+ */
227
361
  /** {en}
228
362
  * @detail callback
229
363
  * @brief Occurs when the audio volume level changes.
@@ -1,83 +1,125 @@
1
1
  export declare enum VeLivePusherErrorCode {
2
-
2
+ /** {zh}
3
+ * @brief License 验证错误,可能是由于 License 无效或过期。
4
+ *
5
+ */
3
6
  /** {en}
4
7
  * @brief SDK license error, possibly caused by an invalid or expired certificate.
5
8
  *
6
9
  */
7
10
  VeLivePusherInvalidLicenseSubErrorCode = -100,
8
-
11
+ /** {zh}
12
+ * @brief 您使用的基础版 License 暂不支持 H.265 硬件编码,请登录火山引擎控制台获取高级版 License。
13
+ *
14
+ */
9
15
  /** {en}
10
16
  * @brief The current SDK license does not support H.265.
11
17
  *
12
18
  */
13
19
  VeLivePusherInvalidLicenseUnsupportH265 = -101,
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
  VeLivePusherInvalidParameterSubErrorCode = -200,
20
-
29
+ /** {zh}
30
+ * @brief 参数错误,屏幕推流传入的 AppGroupIdentifier 错误。
31
+ *
32
+ */
21
33
  /** {en}
22
34
  * @brief Parameter error, screen capture AppGroupIdentifier parameter error.
23
35
  *
24
36
  */
25
37
  VeLivePusherInvalidParameterScreenCaptureAppGroupIdentifierSubErrorCode = -201,
26
-
38
+ /** {zh}
39
+ * @brief 视频采集类型错误,可能是由于不支持的视频采集类型或者设备不兼容。
40
+ *
41
+ */
27
42
  /** {en}
28
43
  * @brief Video capture type error, possibly caused by an unsupported video capture type or capture device.
29
44
  *
30
45
  */
31
46
  VeLivePusherVideoCaptureTypeError = -301,
32
-
47
+ /** {zh}
48
+ * @brief 视频采集权限错误,可能是由于应用没有获取到视频设备的访问权限。
49
+ *
50
+ */
33
51
  /** {en}
34
52
  * @brief Video capture permission error, possibly caused by the lack of access to the video device.
35
53
  *
36
54
  */
37
55
  VeLivePusherVideoCapturePermissionError = -302,
38
-
56
+ /** {zh}
57
+ * @brief 音频采集类型错误,可能是由于不支持的音频采集类型或者设备不兼容。
58
+ *
59
+ */
39
60
  /** {en}
40
61
  * @brief Audio capture type error, possibly caused by an unsupported audio capture type or capture device.
41
62
  *
42
63
  */
43
64
  VeLivePusherAudioCaptureTypeError = -401,
44
-
65
+ /** {zh}
66
+ * @brief 音频采集权限错误,可能是由于应用没有获取到音频设备的访问权限。
67
+ *
68
+ */
45
69
  /** {en}
46
70
  * @brief Audio capture permission error, possibly caused by the lack of access to the audio device.
47
71
  *
48
72
  */
49
73
  VeLivePusherAudioCapturePermissionError = -402,
50
-
74
+ /** {zh}
75
+ * @brief 视频编码错误,可能是由于视频编码器的配置问题或者编码过程中出现错误。
76
+ *
77
+ */
51
78
  /** {en}
52
79
  * @brief Video encoding error, possibly caused by a configuration issue with the video encoder or an error during encoding.
53
80
  *
54
81
  */
55
82
  VeLivePusherVideoEncoderSubErrorCode = -500,
56
-
83
+ /** {zh}
84
+ * @brief 音频编码错误,可能是由于音频编码器的配置问题或者编码过程中出现错误。
85
+ *
86
+ */
57
87
  /** {en}
58
88
  * @brief Audio encoding error, possibly caused by a configuration issue with the audio encoder or an error during encoding.
59
89
  *
60
90
  */
61
91
  VeLivePusherAudioEncoderSubErrorCode = -600,
62
-
92
+ /** {zh}
93
+ * @brief 网络错误,可能是由于网络连接的问题,如网络不稳定、网络延迟过高等。
94
+ *
95
+ */
63
96
  /** {en}
64
97
  * @brief Network error, which might be caused by network connection issues such as network instability or high latency.
65
98
  *
66
99
  */
67
100
  VeLivePusherTransportSubErrorCode = -700,
68
-
101
+ /** {zh}
102
+ * @brief 视频特效错误,可能是由于视频特效处理中出现的问题。
103
+ *
104
+ */
69
105
  /** {en}
70
106
  * @brief Special effects error, possibly caused by issues with video processing.
71
107
  *
72
108
  */
73
109
  VeLivePusherVideoEffectSubErrorCode = -800,
74
-
110
+ /** {zh}
111
+ * @brief 音频模块错误,可能是由于音频模块处理过程中出现的问题。
112
+ *
113
+ */
75
114
  /** {en}
76
115
  * @brief Audio device error.
77
116
  *
78
117
  */
79
118
  VeLivePusherAudioDeviceSubErrorCode = -900,
80
-
119
+ /** {zh}
120
+ * @brief 内部错误,请通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076),获取帮助。
121
+ *
122
+ */
81
123
  /** {en}
82
124
  * @brief Internal error. You can [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact the BytePlus technical support for help.
83
125
  *
@@ -85,67 +127,100 @@ export declare enum VeLivePusherErrorCode {
85
127
  VeLivePusherInternalError = -10001
86
128
  }
87
129
  export declare enum VeLivePusherCode {
88
-
130
+ /** {zh}
131
+ * @brief 无错误。
132
+ *
133
+ */
89
134
  /** {en}
90
135
  * @brief No error.
91
136
  *
92
137
  */
93
138
  VeLivePusherSuccess = 0,
94
-
139
+ /** {zh}
140
+ * @brief License 错误,可能 License 集成错误或 License 过期,请检查 License 集成方式和有效性。
141
+ *
142
+ */
95
143
  /** {en}
96
144
  * @brief SDK license error.
97
145
  *
98
146
  */
99
147
  VeLivePusherInvalidLicense = -1,
100
-
148
+ /** {zh}
149
+ * @brief 参数错误,请检查入参,并重新调用。
150
+ *
151
+ */
101
152
  /** {en}
102
153
  * @brief Parameter error.
103
154
  *
104
155
  */
105
156
  VeLivePusherInvalidParameter = -2,
106
-
157
+ /** {zh}
158
+ * @brief 视频采集错误,可能未开启设备视频采集权限,请检查权限是否获取。
159
+ *
160
+ */
107
161
  /** {en}
108
162
  * @brief Video capture error.
109
163
  *
110
164
  */
111
165
  VeLivePusherVideoCaptureError = -3,
112
-
166
+ /** {zh}
167
+ * @brief 音频采集错误,可能未开启设备麦克风采集权限,请检查权限是否获取。
168
+ *
169
+ */
113
170
  /** {en}
114
171
  * @brief Audio capture error.
115
172
  *
116
173
  */
117
174
  VeLivePusherAudioCaptureError = -4,
118
-
175
+ /** {zh}
176
+ * @brief 视频编码错误,可能配置了当前设备不支持的视频编码方式,请检查编码参数,并重新调用。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
177
+ *
178
+ */
119
179
  /** {en}
120
180
  * @brief Video encoding error.
121
181
  *
122
182
  */
123
183
  VeLivePusherVideoEncoderError = -5,
124
-
184
+ /** {zh}
185
+ * @brief 音频编码错误,可能配置了当前设备不支持的音频编码方式,请检查编码参数,并重新调用。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
186
+ *
187
+ */
125
188
  /** {en}
126
189
  * @brief Audio encoding error.
127
190
  *
128
191
  */
129
192
  VeLivePusherAudioEncoderError = -6,
130
-
193
+ /** {zh}
194
+ * @brief 网络发送错误,可能当前网络链路不通,或者开启了代理和关闭了网络权限,请检查网络后重新调用。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
195
+ *
196
+ */
131
197
  /** {en}
132
198
  * @brief Network transmission error.
133
199
  *
134
200
  */
135
201
  VeLivePusherTransportError = -7,
136
-
202
+ /** {zh}
203
+ * @brief 视频特效错误,请检查视频特效 SDK 是否已经集成并且初试化成功。检查特效资源路径是否配置正确。如果故障未排除,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
204
+ *
205
+ */
137
206
  /** {en}
138
207
  * @brief Special effects error.
139
208
  *
140
209
  */
141
210
  VeLivePusherVideoEffectError = -8,
142
-
211
+ /** {zh}
212
+ * @brief 音频模块错误,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
213
+ *
214
+ */
143
215
  /** {en}
144
216
  * @brief Audio error.
145
217
  *
146
218
  */
147
219
  VeLivePusherAudioDeviceError = -9,
148
-
220
+ /** {zh}
221
+ * @brief 其他错误类型,请联系火山引擎[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076&FlowKey=iNcpuNlwBHbovcjeWlKP)。
222
+ *
223
+ */
149
224
  /** {en}
150
225
  * @brief Other error.
151
226
  *