@byteplus/react-native-live-push 1.1.3-rc.4 → 1.2.0-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 (59) hide show
  1. package/android/build.gradle +2 -2
  2. package/android/src/main/java/com/volcengine/velive/rn/push/ClassHelper.java +9 -0
  3. package/android/src/main/java/com/volcengine/velive/rn/push/NativeVariableManager.java +5 -8
  4. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushModule.java +1 -0
  5. package/android/src/main/java/com/volcengine/velive/rn/push/mixer/MixerManager.java +1 -3
  6. package/android/src/main/java/com/volcengine/velive/rn/push/mixer/MixerView.java +33 -22
  7. package/ios/VeLiveMixerHelper.h +7 -5
  8. package/ios/VeLiveMixerHelper.m +1 -1
  9. package/ios/VeLiveMixerViewManager.m +2 -2
  10. package/lib/commonjs/index.js +23202 -20302
  11. package/lib/commonjs/typescript/android/index.d.ts +0 -3
  12. package/lib/commonjs/typescript/codegen/android/api.d.ts +190 -644
  13. package/lib/commonjs/typescript/codegen/android/callback.d.ts +234 -2
  14. package/lib/commonjs/typescript/codegen/android/errorcode.d.ts +66 -0
  15. package/lib/commonjs/typescript/codegen/android/keytype.d.ts +1014 -181
  16. package/lib/commonjs/typescript/codegen/ios/api.d.ts +890 -0
  17. package/lib/commonjs/typescript/codegen/ios/callback.d.ts +162 -0
  18. package/lib/commonjs/typescript/codegen/ios/errorcode.d.ts +101 -1
  19. package/lib/commonjs/typescript/codegen/ios/keytype.d.ts +694 -0
  20. package/lib/commonjs/typescript/codegen/pack/api.d.ts +303 -686
  21. package/lib/commonjs/typescript/codegen/pack/callback.d.ts +37 -38
  22. package/lib/commonjs/typescript/codegen/pack/errorcode.d.ts +75 -5
  23. package/lib/commonjs/typescript/codegen/pack/keytype.d.ts +1002 -298
  24. package/lib/commonjs/typescript/core/api.d.ts +2 -1
  25. package/lib/commonjs/typescript/core/pusher.d.ts +0 -3
  26. package/lib/module/index.js +23203 -20302
  27. package/lib/module/typescript/android/index.d.ts +0 -3
  28. package/lib/module/typescript/codegen/android/api.d.ts +190 -644
  29. package/lib/module/typescript/codegen/android/callback.d.ts +234 -2
  30. package/lib/module/typescript/codegen/android/errorcode.d.ts +66 -0
  31. package/lib/module/typescript/codegen/android/keytype.d.ts +1014 -181
  32. package/lib/module/typescript/codegen/ios/api.d.ts +890 -0
  33. package/lib/module/typescript/codegen/ios/callback.d.ts +162 -0
  34. package/lib/module/typescript/codegen/ios/errorcode.d.ts +101 -1
  35. package/lib/module/typescript/codegen/ios/keytype.d.ts +694 -0
  36. package/lib/module/typescript/codegen/pack/api.d.ts +303 -686
  37. package/lib/module/typescript/codegen/pack/callback.d.ts +37 -38
  38. package/lib/module/typescript/codegen/pack/errorcode.d.ts +75 -5
  39. package/lib/module/typescript/codegen/pack/keytype.d.ts +1002 -298
  40. package/lib/module/typescript/core/api.d.ts +2 -1
  41. package/lib/module/typescript/core/pusher.d.ts +0 -3
  42. package/lib/typescript/android/index.d.ts +0 -3
  43. package/lib/typescript/codegen/android/api.d.ts +190 -644
  44. package/lib/typescript/codegen/android/callback.d.ts +234 -2
  45. package/lib/typescript/codegen/android/errorcode.d.ts +66 -0
  46. package/lib/typescript/codegen/android/keytype.d.ts +1014 -181
  47. package/lib/typescript/codegen/ios/api.d.ts +890 -0
  48. package/lib/typescript/codegen/ios/callback.d.ts +162 -0
  49. package/lib/typescript/codegen/ios/errorcode.d.ts +101 -1
  50. package/lib/typescript/codegen/ios/keytype.d.ts +694 -0
  51. package/lib/typescript/codegen/pack/api.d.ts +303 -686
  52. package/lib/typescript/codegen/pack/callback.d.ts +37 -38
  53. package/lib/typescript/codegen/pack/errorcode.d.ts +75 -5
  54. package/lib/typescript/codegen/pack/keytype.d.ts +1002 -298
  55. package/lib/typescript/core/api.d.ts +2 -1
  56. package/lib/typescript/core/pusher.d.ts +0 -3
  57. package/package.json +1 -1
  58. package/react-native-velive-push.podspec +3 -3
  59. package/android/src/main/java/com/volcengine/velive/rn/push/ScreenCaptureHelper.java +0 -73
@@ -1,8 +1,8 @@
1
1
  import * as $p_a from '../android/index';
2
2
  import * as $p_i from '../ios/index';
3
3
  import { VeLivePusherObserver, VeLivePusherStatisticsObserver, VeLiveFileRecordingListener, VeLiveVideoFrameFilter, VeLiveAudioFrameFilter, VeLiveVideoFrameListener, VeLiveAudioFrameListener, VeLiveSnapshotListener, VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener } from './callback';
4
- import { VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveOrientation, VeLivePusherLogLevel, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveVideoCaptureConfiguration, VeLiveVideoEffectLicenseConfiguration, VeLiveAudioBufferType, VeLiveAudioSampleRate, VeLiveAudioChannel } from './keytype';
5
- import { View, Bitmap, Matrix, ByteBuffer } from './types';
4
+ import { VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveOrientation, VeLivePusherLogLevel, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveVideoFrame, VeLiveAudioFrame, VeLiveVideoCaptureConfiguration, VeLiveVideoEffectLicenseConfiguration } from './keytype';
5
+ import { View, Bitmap } from './types';
6
6
 
7
7
  export declare class VeLivePusher {
8
8
 
@@ -20,28 +20,18 @@ export declare class VeLivePusher {
20
20
  /** {en}
21
21
  * @detail api
22
22
  * @brief Sets the level of the output log.
23
- * @param logLevel The log level. See VeLivePusherLogLevel {@link #VeLivePusherLogLevel} for details.
24
- * @order 60
23
+ * @param logLevel The log level. See [VeLivePusherLogLevel](broadcast-sdk-for-android-type-definition#VeLivePusherLogLevel) for details.
24
+ * @order 49
25
25
  *
26
26
  */
27
27
  static setLogLevel(logLevel: VeLivePusherLogLevel): void;
28
28
 
29
- /** {en}
30
- * @platform android
31
- * @detail api
32
- * @hidden
33
- * @brief Sets log configurations.
34
- * @param config The log level. See VeLivePusherLogConfig {@link #VeLivePusherLogConfig} for details。
35
- *
36
- */
37
- static android_setLogConfig(config: $p_a.VeLivePusherLogConfig): void;
38
-
39
29
  /** {en}
40
30
  * @platform android
41
31
  * @detail api
42
32
  * @brief Sets the context of OpenGL.
43
33
  * @param context The context of OpenGL.
44
- * @order 61
34
+ * @order 50
45
35
  *
46
36
  */
47
37
  static android_setEGLContext(context: $p_a.EGLContext): void;
@@ -51,8 +41,8 @@ export declare class VeLivePusher {
51
41
 
52
42
  /** {en}
53
43
  * @detail api
54
- * @brief Stops capturing and pushing streams and destroys the pusher. Call this method after stopPush {@link #VeLivePusher#stopPush} is called.
55
- * @order 13
44
+ * @brief Stops capturing and pushing streams and destroys the pusher. Call this method after [stopPush](#VeLivePusher-stoppush) is called.
45
+ * @order 4
56
46
  *
57
47
  */
58
48
  destroy(): void;
@@ -60,11 +50,11 @@ export declare class VeLivePusher {
60
50
  /** {en}
61
51
  * @detail api
62
52
  * @brief Sets an observer to listen for live pusher events, including errors, statuses, network quality, device information, and first frame rendering.
63
- * @param observer The observer. Refer to VeLivePusherObserver {@link #VeLivePusherObserver} for details.
53
+ * @param observer The observer. Refer to [VeLivePusherObserver](broadcast-sdk-for-android-callback#VeLivePusherObserver) for details.
64
54
  * @notes <br>
65
55
  * - This method must be called after the live pusher is created;
66
56
  * - If you make multiple calls to this method, only the last call takes effect.
67
- * @order 1
57
+ * @order 2
68
58
  *
69
59
  */
70
60
  setObserver(observer: VeLivePusherObserver): void;
@@ -72,12 +62,12 @@ export declare class VeLivePusher {
72
62
  /** {en}
73
63
  * @detail api
74
64
  * @brief Sets an observer to periodically report push-stream statistics.
75
- * @param observer The observer. Refer to VeLivePusherStatisticsObserver {@link #VeLivePusherStatisticsObserver} for details.
65
+ * @param observer The observer. Refer to [VeLivePusherStatisticsObserver](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLivePusherStatisticsObserver) for details.
76
66
  * @param interval The time interval between two callbacks, in seconds. The default value is `5`.
77
67
  * @notes <br>
78
68
  * - This method must be called after the live pusher is created;
79
69
  * - If you make multiple calls to this method, only the last call takes effect.
80
- * @order 15
70
+ * @order 3
81
71
  *
82
72
  */
83
73
  setStatisticsObserver(observer: VeLivePusherStatisticsObserver, interval: number): void;
@@ -86,7 +76,7 @@ export declare class VeLivePusher {
86
76
  * @detail api
87
77
  * @brief Sets the preview for the local camera. If beauty AR is applied to the captured video or if it undergoes any other processing, the preview will display the processed video.
88
78
  * @param view The preview view.
89
- * @order 16
79
+ * @order 5
90
80
  *
91
81
  */
92
82
  setRenderView(view: View): Promise<void>;
@@ -95,6 +85,7 @@ export declare class VeLivePusher {
95
85
  * @detail api
96
86
  * @brief Sets fill mode for the local camera preview.
97
87
  * @param mode The fill mode.
88
+ * @order 6
98
89
  *
99
90
  */
100
91
  setRenderFillMode(mode: VeLivePusherRenderMode): void;
@@ -102,11 +93,11 @@ export declare class VeLivePusher {
102
93
  /** {en}
103
94
  * @detail api
104
95
  * @brief Enables or disables mirroring for the local preview and the streamed video.
105
- * @param type Mirror mode. See VeLiveVideoMirrorType {@link #VeLiveVideoMirrorType} for details.
96
+ * @param type Mirror mode. See [VeLiveVideoMirrorType](broadcast-sdk-for-android-type-definition#VeLiveVideoMirrorType) for details.
106
97
  * @param mirror Whether to enable mirroring. <br>
107
98
  * - true: Enable;
108
99
  * - false: Disable.
109
- * @order 17
100
+ * @order 7
110
101
  *
111
102
  */
112
103
  setVideoMirror(type: VeLiveVideoMirrorType, mirror: boolean): void;
@@ -115,9 +106,8 @@ export declare class VeLivePusher {
115
106
  * @detail api
116
107
  * @brief Starts video capture.
117
108
  * @notes <br>After calling this method, you can stop video capture by calling [stopVideoCapture](#VeLivePusher-stopvideocapture).
118
- * @order 18
119
- * @param type The video capture type. See VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} for details.
120
- *
109
+ * @order 8
110
+ * @param type The video capture type. See [VeLiveVideoCaptureType](broadcast-sdk-for-android-type-definition#VeLiveVideoCaptureType) for details.
121
111
  *
122
112
  */
123
113
  startVideoCapture(type: VeLiveVideoCaptureType): void;
@@ -126,7 +116,7 @@ export declare class VeLivePusher {
126
116
  * @detail api
127
117
  * @brief Stops video capture.
128
118
  * @notes <br>After calling this method, you can start video capture by calling [startVideoCapture](#VeLivePusher-startvideocapture).
129
- * @order 19
119
+ * @order 9
130
120
  *
131
121
  */
132
122
  stopVideoCapture(): void;
@@ -135,8 +125,8 @@ export declare class VeLivePusher {
135
125
  * @detail api
136
126
  * @brief Starts audio capture.
137
127
  * @notes <br>After calling this method, you can stop audio capture by calling [stopAudioCapture](#VeLivePusher-stopaudiocapture).
138
- * @order 20
139
- * @param type The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
128
+ * @order 10
129
+ * @param type The audio capture type. See [VeLiveAudioCaptureType](broadcast-sdk-for-android-type-definition#VeLiveAudioCaptureType) for details.
140
130
  *
141
131
  */
142
132
  startAudioCapture(type: VeLiveAudioCaptureType): void;
@@ -145,7 +135,7 @@ export declare class VeLivePusher {
145
135
  * @detail api
146
136
  * @brief Stops audio capture.
147
137
  * @notes <br>After calling this method, you can start audio capture by calling [startAudioCapture](#VeLivePusher-startaudiocapture).
148
- * @order 21
138
+ * @order 11
149
139
  *
150
140
  */
151
141
  stopAudioCapture(): void;
@@ -154,8 +144,8 @@ export declare class VeLivePusher {
154
144
  * @detail api
155
145
  * @brief Switches the video capture type.
156
146
  * @notes <br>This method must be called after [startVideoCapture](#VeLivePusher-startvideocapture) is called.
157
- * @order 22
158
- * @param type The video capture type. See VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} for details.
147
+ * @order 12
148
+ * @param type The video capture type. See [VeLiveVideoCaptureType](broadcast-sdk-for-android-type-definition#VeLiveVideoCaptureType) for details.
159
149
  *
160
150
  */
161
151
  switchVideoCapture(type: VeLiveVideoCaptureType): void;
@@ -164,8 +154,8 @@ export declare class VeLivePusher {
164
154
  * @detail api
165
155
  * @brief Switches audio capture type.
166
156
  * @notes <br>This method must be called after [startVideoCapture](#VeLivePusher-startvideocapture) is called.
167
- * @order 23
168
- * @param type The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
157
+ * @order 13
158
+ * @param type The audio capture type. See [VeLiveAudioCaptureType](broadcast-sdk-for-android-type-definition#VeLiveAudioCaptureType) for details.
169
159
  *
170
160
  */
171
161
  switchAudioCapture(type: VeLiveAudioCaptureType): void;
@@ -173,9 +163,8 @@ export declare class VeLivePusher {
173
163
  /** {en}
174
164
  * @detail api
175
165
  * @brief Gets the current video capture type.
176
- * @return <br>
177
- * The video capture type. See VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} for details.
178
- * @order 24
166
+ * @order 14
167
+ * @return The video capture type. See [VeLiveVideoCaptureType](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoCaptureType) for details.
179
168
  *
180
169
  */
181
170
  getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
@@ -183,9 +172,8 @@ export declare class VeLivePusher {
183
172
  /** {en}
184
173
  * @detail api
185
174
  * @brief Gets the current audio capture type.
186
- * @return <br>
187
- * The audio capture type. See VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} for details.
188
- * @order 25
175
+ * @order 15
176
+ * @return The audio capture type. See [VeLiveAudioCaptureType](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioCaptureType) for details.
189
177
  *
190
178
  */
191
179
  getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
@@ -194,7 +182,7 @@ export declare class VeLivePusher {
194
182
  * @detail api
195
183
  * @brief Sets a static image to push. When using this method, you must call startVideoCapture {@link #VeLivePusher#startVideoCapture} and set VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} to `VeLiveVideoCaptureCustomImage`.
196
184
  * @param image The static image to push.
197
- * @order 26
185
+ * @order 16
198
186
  *
199
187
  */
200
188
  updateCustomImage(image: Bitmap): Promise<void>;
@@ -205,11 +193,9 @@ export declare class VeLivePusher {
205
193
  * - Control the flashlight
206
194
  * - Set the camera zoom
207
195
  * - Set autofocus
208
- * @return <br>
209
- * The camera manager. See VeLiveCameraDevice {@link #VeLiveCameraDevice} for details.
210
- * @notes <br>
211
- * To use this method, you must first call startVideoCapture {@link #startVideoCapture} and set VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} to `VeLiveVideoCaptureFrontCamera` or `VeLiveVideoCaptureBackCamera`.
212
- * @order 27
196
+ * @notes To use this method, you must first call startVideoCapture and set [VeLiveVideoCaptureType](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureFrontCamera` or `VeLiveVideoCaptureBackCamera`.
197
+ * @order 17
198
+ * @return The camera manager. See [VeLiveCameraDevice](#VeLiveCameraDevice) for details.
213
199
  *
214
200
  */
215
201
  getCameraDevice(): VeLiveCameraDevice;
@@ -218,8 +204,8 @@ export declare class VeLivePusher {
218
204
  * @detail api
219
205
  * @brief Sets video encoding parameters for the pushed stream.
220
206
  * @notes This method can be called before or after live streaming starts.
221
- * @order 28
222
- * @param config The video encoding parameters, including the video resolution, encoding format, target bitrate, and GOP size. For details, see VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration}.
207
+ * @order 18
208
+ * @param config The video encoding parameters, including the video resolution, encoding format, target bitrate, and GOP size. For details, see [VeLiveVideoEncoderConfiguration](broadcast-sdk-for-android-type-definition#VeLiveVideoEncoderConfiguration).
223
209
  *
224
210
  */
225
211
  setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
@@ -228,9 +214,8 @@ export declare class VeLivePusher {
228
214
  * @platform android
229
215
  * @detail api
230
216
  * @brief Gets video encoding parameters for the pushed stream.
231
- * @return <br>
232
- * The video encoding parameters, including the video resolution, encoding format, target bitrate, and GOP size. For details, see VeLiveVideoEncoderConfiguration {@link #VeLiveVideoEncoderConfiguration}.
233
- * @order 29
217
+ * @order 19
218
+ * @return The video encoding parameters, including the video resolution, encoding format, target bitrate, and GOP size. For details, see [VeLiveVideoEncoderConfiguration](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLiveVideoEncoderConfiguration).
234
219
  *
235
220
  */
236
221
  android_getVideoEncoderConfiguration(): $p_a.VeLiveVideoEncoderConfiguration;
@@ -239,8 +224,8 @@ export declare class VeLivePusher {
239
224
  * @detail api
240
225
  * @brief Sets audio encoding parameters for the pushed stream.
241
226
  * @notes <br>This method must be called before calling [startPush](#VeLivePusher-startpush) or [startPushWithUrls](#VeLivePusher-startpushwithurls).
242
- * @order 30
243
- * @param config The audio encoding parameters. See [VeLiveAudioEncoderConfiguration](147521#VeLiveAudioEncoderConfiguration) for details.
227
+ * @order 20
228
+ * @param config The audio encoding parameters. See [VeLiveAudioEncoderConfiguration](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLiveAudioEncoderConfiguration) for details.
244
229
  *
245
230
  */
246
231
  setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
@@ -249,8 +234,8 @@ export declare class VeLivePusher {
249
234
  * @platform android
250
235
  * @detail api
251
236
  * @brief Gets audio encoding parameters for the pushed stream.
252
- * @return <br>The audio encoding parameters. See VeLiveAudioEncoderConfiguration for details.
253
- * @order 31
237
+ * @order 21
238
+ * @return The audio encoding parameters. See [VeLiveAudioEncoderConfiguration](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLiveAudioEncoderConfiguration) for details.
254
239
  *
255
240
  */
256
241
  android_getAudioEncoderConfiguration(): $p_a.VeLiveAudioEncoderConfiguration;
@@ -259,7 +244,7 @@ export declare class VeLivePusher {
259
244
  * @detail api
260
245
  * @brief Starts streaming.
261
246
  * @param url The push stream address.
262
- * @order 32
247
+ * @order 22
263
248
  *
264
249
  */
265
250
  startPush(url: string): void;
@@ -270,7 +255,7 @@ export declare class VeLivePusher {
270
255
  * @param urls A list of push stream addresses.
271
256
  * @notes <br>
272
257
  * When the first push stream address in the array is unavailable, the SDK will automatically switch to the subsequent addresses.
273
- * @order 33
258
+ * @order 23
274
259
  *
275
260
  */
276
261
  startPushWithUrls(urls: Array<string>): void;
@@ -280,7 +265,7 @@ export declare class VeLivePusher {
280
265
  * @brief Stops streaming.
281
266
  * @notes <br>
282
267
  * After you have stopped streaming, you can restart streaming by calling startPush {@link #startPush} or startPushWithUrls {@link #startPushWithUrls}.
283
- * @order 34
268
+ * @order 24
284
269
  *
285
270
  */
286
271
  stopPush(): void;
@@ -288,11 +273,11 @@ export declare class VeLivePusher {
288
273
  /** {en}
289
274
  * @detail api
290
275
  * @brief Checks whether the streaming is currently ongoing. You can use this method to query the status of the live pusher.
276
+ * @order 25
291
277
  * @return <br>
292
278
  * Whether the streaming is currently ongoing. <br>
293
279
  * - true: The streaming is currently ongoing;
294
280
  * - false: The streaming has stopped.
295
- * @order 35
296
281
  *
297
282
  */
298
283
  isPushing(): boolean;
@@ -304,10 +289,10 @@ export declare class VeLivePusher {
304
289
  * @param x The horizontal offset of the watermark, which represents the ratio of the distance between the left edge of the watermark and the left edge of the video to the width of the video. The value range is [0.0,1.0].
305
290
  * @param y The vertical offset of the watermark, which represents the ratio of the distance between the top edge of the watermark and the top edge of the video to the height of the video. The value range is [0.0,1.0].
306
291
  * @param scale The uniform scaling of the watermark. The value range is [0.0, 1.0].
292
+ * @order 26
307
293
  * @return <br>
308
294
  * - 0: Success;
309
295
  * - < 0: Failure.
310
- * @order 36
311
296
  *
312
297
  */
313
298
  setWatermark(image: Bitmap, x: number, y: number, scale: number): Promise<number>;
@@ -315,10 +300,10 @@ export declare class VeLivePusher {
315
300
  /** {en}
316
301
  * @detail api
317
302
  * @brief Starts local recording.
318
- * @order 37
303
+ * @order 27
319
304
  * @param path The directory for saving the recording file. You cannot leave this parameter empty.
320
- * @param config The recording configurations. See VeLiveFileRecorderConfiguration for details.
321
- * @param listener The listener for recording events. See VeLiveFileRecordingListener for details.
305
+ * @param config The recording configurations. See [VeLiveFileRecorderConfiguration](docs-broadcast-sdk-for-android-type-definition#VeLivePusherDef-VeLiveFileRecorderConfiguration) for details.
306
+ * @param listener The listener for recording events. See [VeLiveFileRecordingListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveFileRecordingListener) for details.
322
307
  *
323
308
  */
324
309
  startFileRecording(path: string, config: VeLiveFileRecorderConfiguration, listener: VeLiveFileRecordingListener): void;
@@ -327,7 +312,7 @@ export declare class VeLivePusher {
327
312
  * @detail api
328
313
  * @brief Stops local recording.
329
314
  * @notes <br>This method must be called after calling [startFileRecording](#VeLivePusher-startfilerecording).
330
- * @order 38
315
+ * @order 28
331
316
  *
332
317
  */
333
318
  stopFileRecording(): void;
@@ -337,10 +322,10 @@ export declare class VeLivePusher {
337
322
  * @brief Set advanced configurations. You can contact BytePlus technical support for more information about how to use this method.
338
323
  * @param key The JSON key.
339
324
  * @param value The JSON value.
325
+ * @order 29
340
326
  * @return <br>
341
327
  * - 0: Success;
342
328
  * - -1: Failure.
343
- * @order 39
344
329
  *
345
330
  */
346
331
  setProperty(key: string, value: Object): number;
@@ -348,13 +333,11 @@ export declare class VeLivePusher {
348
333
  /** {en}
349
334
  * @detail api
350
335
  * @brief Pushes an external video frame.
351
- * @param frame The external video frame. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
352
- * @return <br>
353
- * - 0: Success;
354
- * - < 0: Failure.
355
- * @notes <br>
356
- * To use this method, you must first call startVideoCapture {@link #startVideoCapture} and set VeLiveVideoCaptureType {@link #VeLiveVideoCaptureType} to `VeLiveVideoCaptureExternal`.
357
- * @order 40
336
+ * @param frame The external video frame. See [VeLiveVideoFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoFrame) for details.
337
+ * @notes To use this method, you must first call startVideoCapture and set [VeLiveVideoCaptureType](docs-broadcast-sdk-for-android-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureExternal`.
338
+ * @order 30
339
+ * @return - 0: Success;
340
+ * - < 0: Failure.
358
341
  *
359
342
  */
360
343
  pushExternalVideoFrame(frame: VeLiveVideoFrame): number;
@@ -362,13 +345,11 @@ export declare class VeLivePusher {
362
345
  /** {en}
363
346
  * @detail api
364
347
  * @brief Pushes an external audio frame.
365
- * @param frame The external audio frame. See VeLiveAudioFrame {@link #VeLiveAudioFrame} for details.
366
- * @return <br>
367
- * - 0: Success;
368
- * - < 0: Failure.
369
- * @notes <br>
370
- * To use this method, you must first call startAudioCapture {@link #AustartdioCapture} and set VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} to `VeLiveAudioCaptureExternal`.
371
- * @order 41
348
+ * @param frame The external audio frame. See [VeLiveAudioFrame](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioFrame) for details.
349
+ * @notes To use this method, you must first call startAudioCapture and set [VeLiveAudioCaptureType](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioCaptureType) to `VeLiveAudioCaptureExternal`.
350
+ * @order 31
351
+ * @return - 0: Success;
352
+ * - < 0: Failure.
372
353
  *
373
354
  */
374
355
  pushExternalAudioFrame(frame: VeLiveAudioFrame): number;
@@ -376,8 +357,8 @@ export declare class VeLivePusher {
376
357
  /** {en}
377
358
  * @detail api
378
359
  * @brief Sets the orientation of the pushed video frame. The default orientation is portrait.
379
- * @param orientation The orientation of the pushed video frame. See VeLiveOrientation {@link #VeLiveOrientation} for details.
380
- * @order 42
360
+ * @param orientation The orientation of the pushed video frame. See [VeLiveOrientation](broadcast-sdk-for-android-type-definition#VeLiveOrientation) for details.
361
+ * @order 32
381
362
  *
382
363
  */
383
364
  setOrientation(orientation: VeLiveOrientation): void;
@@ -385,11 +366,8 @@ export declare class VeLivePusher {
385
366
  /** {en}
386
367
  * @detail api
387
368
  * @brief Sends an SEI message through the video frame. The SEI messages are strings in JSON format.
388
- * @return <br>
389
- * - 0: Success;
390
- * - < 0: Failure.
391
369
  * @notes <br>This method must be called after calling [startPush](#VeLivePusher-startpush) or [startPushWithUrls](#VeLivePusher-startpushwithurls).
392
- * @order 43
370
+ * @order 33
393
371
  * @param key The JSON key.
394
372
  * @param value The JSON value.
395
373
  * @param repeat The number of times the message is sent. For example, if you set `repeat` to `20` and set `isKeyFrame` to `true`, the SDK will add the SEI message to 20 consecutive key frames starting from the time the method is called.
@@ -399,6 +377,9 @@ export declare class VeLivePusher {
399
377
  * @param allowsCovered Whether to allow overwriting. <br>
400
378
  * - true: Allow overwriting;
401
379
  * - false: Do not allow overwriting.
380
+ * @return <br>
381
+ * - 0: Success;
382
+ * - < 0: Failure.
402
383
  *
403
384
  */
404
385
  sendSeiMessage(key: string, value: Object, repeat: number, isKeyFrame: boolean, allowsCovered: boolean): number;
@@ -409,7 +390,7 @@ export declare class VeLivePusher {
409
390
  * @param mute Whether to mute the stream. <br>
410
391
  * - true: Mute;
411
392
  * - false: (Default) Do not mute.
412
- * @order 44
393
+ * @order 34
413
394
  *
414
395
  */
415
396
  setMute(mute: boolean): void;
@@ -417,10 +398,10 @@ export declare class VeLivePusher {
417
398
  /** {en}
418
399
  * @detail api
419
400
  * @brief Checks whether the stream is muted.
401
+ * @order 35
420
402
  * @return <br>
421
403
  * - true: The stream is muted;
422
404
  * - false: The stream is not muted.
423
- * @order 45
424
405
  *
425
406
  */
426
407
  isMute(): boolean;
@@ -433,11 +414,9 @@ export declare class VeLivePusher {
433
414
  * - Set materials
434
415
  * - Set stickers
435
416
  * - Set filters
436
- * @return <br>
437
- * The special effects manager. See VeLiveVideoEffectManager {@link #VeLiveVideoEffectManager} for details.
438
- * @notes <br>
439
- * You must first integrate the BytePlus Effects SDK before calling this method.
440
- * @order 46
417
+ * @notes You must first integrate the BytePlus Effects SDK before calling this method.
418
+ * @order 36
419
+ * @return The special effects manager. See [VeLiveVideoEffectManager](#VeLiveVideoEffectManager) for details.
441
420
  *
442
421
  */
443
422
  getVideoEffectManager(): VeLiveVideoEffectManager;
@@ -445,8 +424,8 @@ export declare class VeLivePusher {
445
424
  /** {en}
446
425
  * @detail api
447
426
  * @brief Sets custom video processing.
448
- * @order 47
449
- * @param filter The video filter. See VeLiveVideoFrameFilter for details.
427
+ * @order 37
428
+ * @param filter The video filter. See [VeLiveVideoFrameFilter](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveVideoFrameFilter) for details.
450
429
  *
451
430
  */
452
431
  setVideoFrameFilter(filter: VeLiveVideoFrameFilter): void;
@@ -454,11 +433,9 @@ export declare class VeLivePusher {
454
433
  /** {en}
455
434
  * @detail api
456
435
  * @brief Gets the audio device manager.
457
- * @return <br>
458
- * The audio device manager. See VeLiveAudioDevice {@link #VeLiveAudioDevice} for details.
459
- * @notes <br>
460
- * To use this method, you must first call startAudioCapture {@link #startAudioCapture} and set VeLiveAudioCaptureType {@link #VeLiveAudioCaptureType} to `VeLiveAudioCaptureMicrophone`.
461
- * @order 48
436
+ * @notes To use this method, you must first call startAudioCapture and set [VeLiveAudioCaptureType](docs-broadcast-sdk-for-android-type-definition#VeLiveAudioCaptureType) to `VeLiveAudioCaptureMicrophone`.
437
+ * @order 38
438
+ * @return The audio device manager. See [VeLiveAudioDevice](#VeLiveAudioDevice) for details.
462
439
  *
463
440
  */
464
441
  getAudioDevice(): VeLiveAudioDevice;
@@ -466,7 +443,7 @@ export declare class VeLivePusher {
466
443
  /** {en}
467
444
  * @detail api
468
445
  * @brief Sets custom audio processing.
469
- * @order 49
446
+ * @order 39
470
447
  * @param filter The audio filter. See VeLiveAudioFrameFilter for details.
471
448
  *
472
449
  */
@@ -475,9 +452,8 @@ export declare class VeLivePusher {
475
452
  /** {en}
476
453
  * @detail api
477
454
  * @brief Creates the media player.
478
- * @return <br>
479
- * The media player. See VeLiveMediaPlayer {@link #VeLiveMediaPlayer} for details.
480
- * @order 50
455
+ * @order 1
456
+ * @return The media player. See [VeLiveMediaPlayer](#VeLiveMediaPlayer) for details.
481
457
  *
482
458
  */
483
459
  createPlayer(): VeLiveMediaPlayer;
@@ -485,29 +461,26 @@ export declare class VeLivePusher {
485
461
  /** {en}
486
462
  * @platform android
487
463
  * @detail api
488
- * @brief Starts screen capture.
489
- * @param enableAppAudio Whether to record in-app audio data. Currently, you can only set it to `true`, which is the default value.
490
- * @param screenIntent The system screen recording permission.
491
- * @order 52
492
- *
464
+ * @brief Starts system audio capture.
465
+ * @order 41
493
466
  *
494
467
  */
495
- android_startScreenRecording(enableAppAudio: boolean, screenIntent: $p_a.Intent): void;
468
+ android_startMixSystemAudio(): void;
496
469
 
497
470
  /** {en}
498
471
  * @platform android
499
472
  * @detail api
500
- * @brief Stops screen capture.
501
- * @order 53
473
+ * @brief Stops system audio capture.
474
+ * @order 42
502
475
  *
503
476
  */
504
- android_stopScreenRecording(): void;
477
+ android_stopMixSystemAudio(): void;
505
478
 
506
479
  /** {en}
507
480
  * @platform android
508
481
  * @detail api
509
482
  * @brief Gets whether the SDK is capturing the screen at this moment.
510
- * @order 54
483
+ * @order 43
511
484
  *
512
485
  */
513
486
  android_isScreenRecording(): boolean;
@@ -515,11 +488,11 @@ export declare class VeLivePusher {
515
488
  /** {en}
516
489
  * @detail api
517
490
  * @brief Adds a video frame listener.
491
+ * @order 44
492
+ * @param listener The listener. See [VeLiveVideoFrameListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveVideoFrameListener) for details.
518
493
  * @return <br>
519
494
  * - 0: Success;
520
495
  * - < 0: Failure.
521
- * @order 55
522
- * @param listener The listener. See VeLiveVideoFrameListener for details.
523
496
  *
524
497
  */
525
498
  addVideoFrameListener(listener: VeLiveVideoFrameListener): number;
@@ -527,13 +500,13 @@ export declare class VeLivePusher {
527
500
  /** {en}
528
501
  * @detail api
529
502
  * @brief Removes the video frame listener.
503
+ * @notes <br>
504
+ * Calling this method will return a failure if the listener has not been added or has been removed.
505
+ * @order 45
506
+ * @param listener The listener. See [VeLiveVideoFrameListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveVideoFrameListener) for details.
530
507
  * @return <br>
531
508
  * - 0: Success;
532
509
  * - < 0: Failure.
533
- * @notes <br>
534
- * Calling this method will return a failure if the listener has not been added or has been removed.
535
- * @order 56
536
- * @param listener The listener. See VeLiveVideoFrameListener for details.
537
510
  *
538
511
  */
539
512
  removeVideoFrameListener(listener: VeLiveVideoFrameListener): number;
@@ -541,11 +514,11 @@ export declare class VeLivePusher {
541
514
  /** {en}
542
515
  * @detail api
543
516
  * @brief Adds an audio frame listener.
517
+ * @order 46
518
+ * @param listener The listener. See [VeLiveAudioFrameListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveAudioFrameListener) for details.
544
519
  * @return <br>
545
520
  * - 0: Success;
546
521
  * - < 0: Failure.
547
- * @order 57
548
- * @param listener The listener. See VeLiveAudioFrameListener for details.
549
522
  *
550
523
  */
551
524
  addAudioFrameListener(listener: VeLiveAudioFrameListener): number;
@@ -553,13 +526,13 @@ export declare class VeLivePusher {
553
526
  /** {en}
554
527
  * @detail api
555
528
  * @brief Removes the audio frame listener.
529
+ * @notes <br>
530
+ * Calling this method will return a failure if the listener has not been added or has been removed.
531
+ * @order 47
532
+ * @param listener The listener. See [VeLiveAudioFrameListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveAudioFrameListener) for details.
556
533
  * @return <br>
557
534
  * - 0: Success;
558
535
  * - < 0: Failure.
559
- * @notes <br>
560
- * Calling this method will return a failure if the listener has not been added or has been removed.
561
- * @order 58
562
- * @param listener The listener. See VeLiveAudioFrameListener for details.
563
536
  *
564
537
  */
565
538
  removeAudioFrameListener(listener: VeLiveAudioFrameListener): number;
@@ -567,8 +540,8 @@ export declare class VeLivePusher {
567
540
  /** {en}
568
541
  * @detail api
569
542
  * @brief Takes a screenshot.
570
- * @order 59
571
- * @param listener The listener for the screenshot. See VeLiveSnapshotListener for details.
543
+ * @order 48
544
+ * @param listener The listener for the screenshot. See [VeLiveSnapshotListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveSnapshotListener) for details.
572
545
  *
573
546
  */
574
547
  snapshot(listener: VeLiveSnapshotListener): void;
@@ -578,21 +551,45 @@ export declare class VeLivePusher {
578
551
  * @detail api
579
552
  * @param applicationGroupIdentifier iOS app group identifier.
580
553
  * @brief Starts screen capturing.
554
+ * @order 20
581
555
  */
582
556
  ios_startScreenCapture(applicationGroupIdentifier: string): void;
583
557
 
584
558
  /** {en}
585
559
  * @platform ios
586
560
  * @detail api
587
- * @brief Stops screen capturing.
561
+ * @brief Stops the screen capturing process.
562
+ * @notes <br>
563
+ * This method completely terminates the current screen capture flow and releases associated resources. After calling this method, `pauseScreenCapture` and `resumeScreenCapture` will no longer be effective.
564
+ * @order 21
588
565
  */
589
566
  ios_stopScreenCapture(): void;
590
567
 
568
+ /** {en}
569
+ * @platform ios
570
+ * @detail api
571
+ * @brief Pauses the screen capturing process.
572
+ * @notes <br>
573
+ * This method pauses the screen capture without releasing underlying resources. You can call `resumeScreenCapture` later to resume capturing. If the capture is already stopped or has not been started, calling this method has no effect.
574
+ * @order 22
575
+ */
576
+ ios_pauseScreenCapture(): void;
577
+
578
+ /** {en}
579
+ * @platform ios
580
+ * @detail api
581
+ * @brief Resumes the screen capturing process.
582
+ * @notes <br>
583
+ * After calling `pauseScreenCapture`, use this method to resume screen capture output. If the capture has already been stopped or never started, calling this method has no effect.
584
+ * @order 23
585
+ */
586
+ ios_resumeScreenCapture(): void;
587
+
591
588
  /** {en}
592
589
  * @platform ios
593
590
  * @detail api
594
591
  * @brief Initializes the live pusher.
595
- * @param config The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
592
+ * @param config The pusher configurations. See [VeLivePusherConfiguration](docs-broadcast-sdk-for-ios-type-definition#VeLivePusherConfiguration) for details.
596
593
  * @order 0
597
594
  */
598
595
  ios_initWithConfig(config: $p_i.VeLivePusherConfiguration): this;
@@ -601,9 +598,10 @@ export declare class VeLivePusher {
601
598
  * @platform ios
602
599
  * @brief Sets the observer for screen capturing events.
603
600
  * @notes Calling this method will return a failure if the listener has not been added or has been removed.
601
+ * @param observer The observer for screen capturing events. For details, refer to [VeLiveScreenCaptureStatusObserver](docs-broadcast-sdk-for-ios-callback#VeLiveScreenCaptureStatusObserver).
602
+ * @order 5
604
603
  * @return - 0: Success;
605
604
  * - <0: Failure.
606
- * @param observer The observer for screen capturing events. For details, refer to [VeLiveScreenCaptureStatusObserver](broadcast-sdk-for-ios-callback#VeLiveScreenCaptureStatusObserver).
607
605
  */
608
606
  ios_setScreenCaptureObserver(observer: $p_i.id<$p_i.VeLiveScreenCaptureStatusObserver>): number;
609
607
 
@@ -611,12 +609,13 @@ export declare class VeLivePusher {
611
609
  * @platform ios
612
610
  * @detail api
613
611
  * @brief Pushes an external encoded video frame.
612
+ * @notes
613
+ * Before calling this method, you must first call [startVideoCapture:](#VeLivePusher-startvideocapture) and set [VeLiveVideoCaptureType](docs-broadcast-sdk-for-ios-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureFrontCamera` or `VeLiveVideoCaptureExternal`.
614
+ * @order 38
615
+ * @param encodeFrame The external encoded video frame. See VeLiveVideoEncodeFrame {@link #VeLiveVideoEncodeFrame} for details.
614
616
  * @return <br>
615
617
  * - 0: Success;
616
618
  * - <0: Failure.
617
- * @notes <br>Before calling this method, you must first call startVideoCapture:{@link #VeLivePusher#startVideoCapture} and set [VeLiveVideoCaptureType](broadcast-sdk-for-ios-type-definition#VeLiveVideoCaptureType) to `VeLiveVideoCaptureFrontCamera` or `VeLiveVideoCaptureExternal`.
618
- * @order 44
619
- * @param encodeFrame The external encoded video frame. See VeLiveVideoEncodeFrame {@link #VeLiveVideoEncodeFrame} for details.
620
619
  */
621
620
  ios_pushExternalVideoEncodeFrame(encodeFrame: $p_i.VeLiveVideoEncodeFrame): number;
622
621
 
@@ -624,9 +623,9 @@ export declare class VeLivePusher {
624
623
  * @platform ios
625
624
  * @detail api
626
625
  * @brief Request to encode a new IDR frame.
627
- * @notes <br>
628
- * This method must be called after calling startPush: {@link #VeLivePusher#startPush} or startPushWithUrls: {@link #VeLivePusher#startPushWithUrls}.
629
- * @order 47
626
+ * @notes
627
+ * This method must be called after calling [startPush:](#VeLivePusher-startpush) or [startPushWithUrls:](#VeLivePusher-startpushwithurls).
628
+ * @order 49
630
629
  */
631
630
  ios_requestIDRFrame(): void;
632
631
  }
@@ -650,7 +649,7 @@ export declare class VeLiveMediaPlayer {
650
649
  * @notes <br>
651
650
  * If you make multiple calls to this method, only the last call takes effect.
652
651
  * @order 101
653
- * @param listener The observer that listens for playback statuses. For details, see VeLiveMediaPlayerListener.
652
+ * @param listener The observer that listens for playback statuses. For details, see [VeLiveMediaPlayerListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveMediaPlayerListener).
654
653
  *
655
654
  */
656
655
  setListener(listener: VeLiveMediaPlayerListener): void;
@@ -659,17 +658,17 @@ export declare class VeLiveMediaPlayer {
659
658
  * @detail api
660
659
  * @brief Sets the file path. Supported file formats include MP3, AAC, M4A, WAV.
661
660
  * @param url The file path.
661
+ * @order 102
662
662
  * @return <br>
663
663
  * - 0: Success;
664
664
  * - ≠ 0: Failure.
665
- * @order 102
666
665
  *
667
666
  */
668
667
  prepare(url: string): number;
669
668
 
670
669
  /** {en}
671
670
  * @detail api
672
- * @brief Pauses playback.
671
+ * @brief Start playback.
673
672
  * @notes <br>
674
673
  * This method must be called after you call start {@link #start} to start playback.
675
674
  * @order 103
@@ -680,12 +679,12 @@ export declare class VeLiveMediaPlayer {
680
679
  /** {en}
681
680
  * @detail api
682
681
  * @brief Stops playback.
683
- * @return <br>
684
- * - 0: Success;
685
- * - ≠ 0: Failure.
686
682
  * @notes <br>
687
683
  * This method must be called after you call start {@link #start} to start playback.
688
684
  * @order 104
685
+ * @return <br>
686
+ * - 0: Success;
687
+ * - ≠ 0: Failure.
689
688
  *
690
689
  */
691
690
  stop(): Promise<number>;
@@ -712,11 +711,11 @@ export declare class VeLiveMediaPlayer {
712
711
  /** {en}
713
712
  * @detail api
714
713
  * @brief Gets the duration of the media file.
715
- * @return <br>
716
- * - \\\\> 0: The duration of the media file, in milliseconds;
717
- * - ≤ 0: Failure.
718
714
  * @notes <br>This method must be called after you call [start](#VeLiveMediaPlayer-start) to start playback.
719
715
  * @order 107
716
+ * @return <br>
717
+ * - > 0: The duration of the media file, in milliseconds;
718
+ * - ≤ 0: Failure.
720
719
  *
721
720
  */
722
721
  getDuration(): number;
@@ -725,10 +724,10 @@ export declare class VeLiveMediaPlayer {
725
724
  * @detail api
726
725
  * @brief Sets the playback progress.
727
726
  * @param posMs The playback progress, in milliseconds.
727
+ * @order 108
728
728
  * @return <br>
729
729
  * - 0: Success;
730
730
  * - ≠ 0: Failure.
731
- * @order 108
732
731
  *
733
732
  */
734
733
  seek(posMs: number): number;
@@ -754,22 +753,13 @@ export declare class VeLiveMediaPlayer {
754
753
  */
755
754
  enableAutoEq(sourceLufs: number, targetLufs: number): void;
756
755
 
757
- /** {en}
758
- * @detail api
759
- * @brief Sets the view for rendering the video. Supports MP4 format.
760
- * @param view The view used by the media player to render video.
761
- * @order 111
762
- *
763
- */
764
- setRenderView(view: View): void;
765
-
766
756
  /** {en}
767
757
  * @detail api
768
758
  * @brief Sets the observer for audio and video frames.
769
759
  * @notes <br>
770
760
  * If you make multiple calls to this method, only the last call takes effect.
771
761
  * @order 112
772
- * @param listener The observer that listens for audio and video frames. For details, see VeLiveMediaPlayerFrameListener
762
+ * @param listener The observer that listens for audio and video frames. For details, see [VeLiveMediaPlayerFrameListener](docs-broadcast-sdk-for-android-callback#VeLivePusherDef-VeLiveMediaPlayerFrameListener)
773
763
  *
774
764
  */
775
765
  setFrameListener(listener: VeLiveMediaPlayerFrameListener): void;
@@ -803,6 +793,15 @@ export declare class VeLiveMediaPlayer {
803
793
  *
804
794
  */
805
795
  enableBGMLoop(loop: boolean): void;
796
+
797
+ /** {en}
798
+ * @platform ios
799
+ * @detail api
800
+ * @brief Sets the view for rendering the video. Supports MP4 format.
801
+ * @param view The view used by the media player to render video.
802
+ * @order 93
803
+ */
804
+ ios_setRenderView(view: $p_i.UIView): void;
806
805
  }
807
806
 
808
807
  export declare class VeLivePusherConfiguration {
@@ -810,41 +809,41 @@ export declare class VeLivePusherConfiguration {
810
809
 
811
810
  /** {en}
812
811
  * @platform ios
813
- * @brief The audio capture configurations. See VeLiveAudioCaptureConfiguration {@link #VeLiveAudioCaptureConfiguration} for details.
812
+ * @brief The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration) for details.
814
813
  */
815
- get ios_audioCaptureConfig(): $p_i.VeLiveAudioCaptureConfiguration;
816
- set ios_audioCaptureConfig(value: $p_i.VeLiveAudioCaptureConfiguration);
814
+ get audioCaptureConfig(): $p_i.VeLiveAudioCaptureConfiguration;
815
+ set audioCaptureConfig(value: $p_i.VeLiveAudioCaptureConfiguration);
817
816
 
818
817
  /** {en}
819
818
  * @platform ios
820
819
  * @brief The time interval between each attempt to reconnect, in seconds. The default value is `5`.
821
820
  */
822
- get ios_reconnectIntervalSeconds(): $p_i.int;
823
- set ios_reconnectIntervalSeconds(value: $p_i.int);
821
+ get reconnectIntervalSeconds(): $p_i.int;
822
+ set reconnectIntervalSeconds(value: $p_i.int);
824
823
 
825
824
  /** {en}
826
825
  * @platform ios
827
826
  * @brief The number of attempts to reconnect after the initial attempt fails. The default value is `3`.
828
827
  */
829
- get ios_reconnectCount(): $p_i.int;
830
- set ios_reconnectCount(value: $p_i.int);
828
+ get reconnectCount(): $p_i.int;
829
+ set reconnectCount(value: $p_i.int);
831
830
 
832
831
  /** {en}
833
832
  * @platform ios
834
833
  * @brief Advanced parameters. You can leave this parameter empty.
835
834
  */
836
- get ios_extraParameters(): $p_i.NSDictionary;
837
- set ios_extraParameters(value: $p_i.NSDictionary);
835
+ get extraParameters(): $p_i.NSDictionary;
836
+ set extraParameters(value: $p_i.NSDictionary);
838
837
  protected __init(...args: any[]): void;
839
838
  protected __new_instance(...args: any[]): any;
840
839
 
841
840
  /** {en}
842
841
  * @detail api
843
842
  * @brief Sets the video capture configurations.
844
- * @return <br>
845
- * The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
846
843
  * @order 6
847
- * @param config The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
844
+ * @param config The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration) for details.
845
+ * @return
846
+ * The pusher configurations. See [VeLivePusherConfiguration](#VeLivePusherConfiguration) for details.
848
847
  *
849
848
  */
850
849
  setVideoCaptureConfig(config: VeLiveVideoCaptureConfiguration): void;
@@ -863,9 +862,9 @@ export declare class VeLivePusherConfiguration {
863
862
  * @platform android
864
863
  * @detail api
865
864
  * @brief Gets the time interval between each attempt to reconnect.
865
+ * @order 3
866
866
  * @return <br>
867
867
  * The time interval between each attempt to reconnect, in seconds.
868
- * @order 3
869
868
  *
870
869
  */
871
870
  android_getReconnectIntervalSeconds(): number;
@@ -884,10 +883,9 @@ export declare class VeLivePusherConfiguration {
884
883
  * @platform android
885
884
  * @detail api
886
885
  * @brief Gets the number of attempts to reconnect after the initial attempt fails.
886
+ * @order 5
887
887
  * @return <br>
888
888
  * The number of attempts to reconnect after the initial attempt fails.
889
- * @order 5
890
- *
891
889
  *
892
890
  */
893
891
  android_getReconnectCount(): number;
@@ -896,8 +894,8 @@ export declare class VeLivePusherConfiguration {
896
894
  * @platform android
897
895
  * @detail api
898
896
  * @brief Gets the video capture configurations.
899
- * @return <br>The video capture configurations. See VeLiveVideoCaptureConfiguration for details.
900
897
  * @order 7
898
+ * @return The video capture configurations. See [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration) for details.
901
899
  *
902
900
  */
903
901
  android_getVideoCaptureConfig(): $p_a.VeLiveVideoCaptureConfiguration;
@@ -906,10 +904,9 @@ export declare class VeLivePusherConfiguration {
906
904
  * @platform android
907
905
  * @detail api
908
906
  * @brief Sets the audio capture configurations.
909
- * @return <br>
910
- * The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
911
907
  * @order 7
912
- * @param config The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
908
+ * @param config The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
909
+ * @return The pusher configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
913
910
  *
914
911
  */
915
912
  android_setAudioCaptureConfig(config: $p_a.VeLiveAudioCaptureConfiguration): this;
@@ -918,9 +915,8 @@ export declare class VeLivePusherConfiguration {
918
915
  * @platform android
919
916
  * @detail api
920
917
  * @brief Gets the audio capture configurations.
921
- * @return <br>The audio capture configurations. See VeLiveAudioCaptureConfiguration for details.
922
918
  * @order 8
923
- *
919
+ * @return The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration) for details.
924
920
  *
925
921
  */
926
922
  android_getAudioCaptureConfig(): $p_a.VeLiveAudioCaptureConfiguration;
@@ -930,9 +926,8 @@ export declare class VeLivePusherConfiguration {
930
926
  * @detail api
931
927
  * @brief Sets the context of the application.
932
928
  * @param context The context of the application.
933
- * @return <br>
934
- * The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
935
929
  * @order 9
930
+ * @return The pusher configurations. See [VeLivePusherConfiguration](#VeLivePusherConfiguration) for details.
936
931
  *
937
932
  */
938
933
  android_setContext(context: $p_a.Context): this;
@@ -941,10 +936,9 @@ export declare class VeLivePusherConfiguration {
941
936
  * @platform android
942
937
  * @detail api
943
938
  * @brief Gets the context of the application.
939
+ * @order 10
944
940
  * @return <br>
945
941
  * The context of the application.
946
- * @order 10
947
- *
948
942
  *
949
943
  */
950
944
  android_getContext(): $p_a.Context;
@@ -952,12 +946,10 @@ export declare class VeLivePusherConfiguration {
952
946
  /** {en}
953
947
  * @platform android
954
948
  * @detail api
955
- * @brief Sets advanced parameters. You can leave this parameter empty. If you need to use it, please contact BytePlus technical support.
949
+ * @brief Sets advanced parameters. You can leave this parameter empty. If you need to use it, please [create a ticket](https://console.byteplus.com/workorder/create?step=2&SubProductID=P00000980) to contact BytePlus technical support.
956
950
  * @param params Extension parameters.
957
- * @return <br>
958
- * The pusher configurations. See VeLivePusherConfiguration {@link #VeLivePusherConfiguration} for details.
959
951
  * @order 11
960
- *
952
+ * @return The pusher configurations. See [VeLivePusherConfiguration](#VeLivePusherConfiguration) for details.
961
953
  *
962
954
  */
963
955
  android_setExtraParameters(params: string): this;
@@ -966,10 +958,9 @@ export declare class VeLivePusherConfiguration {
966
958
  * @platform android
967
959
  * @detail api
968
960
  * @brief Gets advanced parameters.
961
+ * @order 12
969
962
  * @return <br>
970
963
  * Advanced parameters.
971
- * @order 12
972
- *
973
964
  *
974
965
  */
975
966
  android_getExtraParams(): $p_a.LiveSdkSetting;
@@ -978,330 +969,66 @@ export declare class VeLivePusherConfiguration {
978
969
  * @platform android
979
970
  * @detail api
980
971
  * @brief Creates the live pusher.
981
- * @return <br>
982
- * The live pusher. See VeLivePusher {@link #VeLivePusher} for details.
983
972
  * @order 1
984
- *
973
+ * @return The live pusher. See [VeLivePusher](docs-broadcast-sdk-for-android-api#VeLivePusher) for details.
985
974
  *
986
975
  */
987
976
  android_build(): $p_a.VeLivePusher;
988
977
  }
989
978
 
990
- export declare class VeLiveVideoFrame {
991
- constructor(width: number, height: number, pts: number, texId: number, isOes: boolean, matrix: Matrix);
992
- constructor(width: number, height: number, pts: number, byteBuffer: ByteBuffer);
993
- constructor(width: number, height: number, pts: number, data: ArrayBuffer);
994
- constructor();
995
- constructor();
979
+ export declare class VeLiveCameraDevice {
996
980
  protected _instance: any;
997
- get width(): number;
998
- set width(value: number);
999
- get height(): number;
1000
- set height(value: number);
1001
- /**
1002
- * @platform android
1003
- */
1004
- get android_ptsUs(): number;
1005
- set android_ptsUs(value: number);
1006
- get textureId(): number;
1007
- set textureId(value: number);
1008
- get data(): any;
1009
- set data(value: any);
1010
-
1011
- /** {en}
1012
- * @platform ios
1013
- * @brief The video buffer type. The default value is `VeLiveVideoBufferTypeUnknown`. See VeLiveVideoBufferType {@link #VeLiveVideoBufferType} for details.
1014
- */
1015
- get ios_bufferType(): $p_i.VeLiveVideoBufferType;
1016
- set ios_bufferType(value: $p_i.VeLiveVideoBufferType);
1017
-
1018
- /** {en}
1019
- * @platform ios
1020
- * @brief The pixel format. When `bufferType` is `VeLiveVideoBufferTypeNSData`, you must specify `pixelFormat`. See VeLivePixelFormat {@link #VeLivePixelFormat} for details.
1021
- */
1022
- get ios_pixelFormat(): $p_i.VeLivePixelFormat;
1023
- set ios_pixelFormat(value: $p_i.VeLivePixelFormat);
1024
-
1025
- /** {en}
1026
- * @platform ios
1027
- * @brief The rotation angle in a clockwise direction. See VeLiveVideoRotation {@link #VeLiveVideoRotation} for details.
1028
- */
1029
- get ios_rotation(): $p_i.VeLiveVideoRotation;
1030
- set ios_rotation(value: $p_i.VeLiveVideoRotation);
1031
-
1032
- /** {en}
1033
- * @platform ios
1034
- * @brief The timestamp of the video frame, in μs.
1035
- */
1036
- get ios_pts(): $p_i.CMTime;
1037
- set ios_pts(value: $p_i.CMTime);
1038
-
1039
- /** {en}
1040
- * @platform ios
1041
- * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypePixelBuffer`.
1042
- */
1043
- get ios_pixelBuffer(): $p_i.CVPixelBufferRef;
1044
- set ios_pixelBuffer(value: $p_i.CVPixelBufferRef);
1045
-
1046
- /** {en}
1047
- * @platform ios
1048
- * @brief The video data, when `bufferType` is `VeLiveVideoBufferTypeSampleBuffer`.
1049
- */
1050
- get ios_sampleBuffer(): $p_i.CMSampleBufferRef;
1051
- set ios_sampleBuffer(value: $p_i.CMSampleBufferRef);
1052
981
  protected __init(...args: any[]): void;
1053
982
  protected __new_instance(...args: any[]): any;
1054
983
 
1055
984
  /** {en}
1056
985
  * @platform android
1057
986
  * @detail api
1058
- * @brief Increases the reference count of the `VeLiveVideoFrame` object. Call this method to increase the reference count by 1 if you need to continue using the `VeLiveVideoFrame` object.
987
+ * @brief Gets the frame rate range supported by the camera.
988
+ * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
989
+ * @order 66
990
+ * @return <br>
991
+ * The frame rate range supported by the camera.
1059
992
  *
1060
993
  */
1061
- android_retain(): void;
994
+ android_getRealFpsRange(): Array<$p_a.int>;
1062
995
 
1063
996
  /** {en}
1064
- * @platform android
1065
997
  * @detail api
1066
- * @brief Releases the reference to the `VeLiveVideoFrame` object. Call this method to reduce the reference count by 1 when you no longer need to use the `VeLiveVideoFrame` object. When the reference count is reduced to 0, it means there is no reference to the object, and the object can be safely released or destroyed.
998
+ * @brief Enables or disables the flashlight.
999
+ * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1000
+ * @order 67
1001
+ * @param enable Whether to enable the flashlight. <br>
1002
+ * - true: Enable;
1003
+ * - false: (Default) Disable.
1004
+ * @return <br>
1005
+ * - 0: Success;
1006
+ * - ≠ 0: Failure.
1067
1007
  *
1068
1008
  */
1069
- android_release(): void;
1009
+ enableTorch(enable: boolean): number;
1070
1010
 
1071
1011
  /** {en}
1072
- * @platform android
1073
1012
  * @detail api
1074
- * @brief Gets the data type of the video.
1013
+ * @brief Sets the zoom factor of the camera.
1014
+ * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1015
+ * @order 68
1016
+ * @param ratio The zoom factor. The SDK uses the original size by default. The range of the zoom factor is [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)].
1075
1017
  * @return <br>
1076
- * The data type of the video. See VeLiveVideoBufferType {@link #VeLiveVideoBufferType} for details.
1018
+ * - 0: Success;
1019
+ * - ≠ 0: Failure.
1077
1020
  *
1078
1021
  */
1079
- android_getBufferType(): $p_a.VeLiveVideoBufferType;
1022
+ setZoomRatio(ratio: number): number;
1080
1023
 
1081
1024
  /** {en}
1082
- * @platform android
1083
1025
  * @detail api
1084
- * @brief Sets the data type of the video.
1085
- * @param bufferType The data type of the video. See VeLiveVideoBufferType {@link #VeLiveVideoBufferType} for details.
1086
- * @return <br>
1087
- * The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
1088
- *
1089
- */
1090
- android_setBufferType(bufferType: $p_a.VeLiveVideoBufferType): this;
1091
-
1092
- /** {en}
1093
- * @platform android
1094
- * @detail api
1095
- * @brief Gets the pixel format.
1096
- * @return <br>
1097
- * The pixel format. See VeLivePixelFormat {@link #VeLivePixelFormat} for details.
1098
- *
1099
- */
1100
- android_getPixelFormat(): $p_a.VeLivePixelFormat;
1101
-
1102
- /** {en}
1103
- * @platform android
1104
- * @detail api
1105
- * @brief Sets the pixel format.
1106
- * @param pixelFormat The pixel format. See VeLivePixelFormat {@link #VeLivePixelFormat} for details.
1107
- * @return <br>
1108
- * The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
1109
- *
1110
- */
1111
- android_setPixelFormat(pixelFormat: $p_a.VeLivePixelFormat): this;
1112
-
1113
- /** {en}
1114
- * @platform android
1115
- * @detail api
1116
- * @brief Gets the rotation angle in a clockwise direction.
1117
- * @return <br>
1118
- * The rotation angle in a clockwise direction. See VeLiveVideoRotation {@link #VeLiveVideoRotation} for details.
1119
- *
1120
- */
1121
- android_getRotation(): $p_a.VeLiveVideoRotation;
1122
-
1123
- /** {en}
1124
- * @platform android
1125
- * @detail api
1126
- * @brief Sets the rotation angle in a clockwise direction.
1127
- * @param rotation The rotation angle in a clockwise direction. See VeLiveVideoRotation {@link #VeLiveVideoRotation} for details.
1128
- * @return <br>
1129
- * The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
1130
- *
1131
- */
1132
- android_setRotation(rotation: $p_a.VeLiveVideoRotation): this;
1133
-
1134
- /** {en}
1135
- * @platform android
1136
- * @detail api
1137
- * @brief Gets the width of the video frame.
1138
- * @return <br>
1139
- * The width of the video frame.
1140
- *
1141
- */
1142
- android_getWidth(): number;
1143
-
1144
- /** {en}
1145
- * @platform android
1146
- * @detail api
1147
- * @brief Gets the height of the video frame.
1148
- * @return <br>
1149
- * The height of the video frame.
1150
- *
1151
- */
1152
- android_getHeight(): number;
1153
-
1154
- /** {en}
1155
- * @platform android
1156
- * @detail api
1157
- * @brief Gets the width of the rotated video frame.
1158
- * @return <br>
1159
- * The width of the rotated video frame.
1160
- *
1161
- */
1162
- android_getRotatedWidth(): number;
1163
-
1164
- /** {en}
1165
- * @platform android
1166
- * @detail api
1167
- * @brief Gets the height of the rotated video frame.
1168
- * @return <br>
1169
- * The height of the rotated video frame.
1170
- *
1171
- */
1172
- android_getRotatedHeight(): number;
1173
-
1174
- /** {en}
1175
- * @platform android
1176
- * @detail api
1177
- * @brief Gets the timestamp of the video frame.
1178
- * @return <br>
1179
- * The timestamp of the video frame, in μs.
1180
- *
1181
- */
1182
- android_getPts(): number;
1183
-
1184
- /** {en}
1185
- * @platform android
1186
- * @detail api
1187
- * @brief Gets the texture ID.
1188
- * @return <br>
1189
- * The texture ID.
1190
- *
1191
- */
1192
- android_getTextureId(): number;
1193
-
1194
- /** {en}
1195
- * @platform android
1196
- * @detail api
1197
- * @brief Gets the texture matrix.
1198
- * @return <br>
1199
- * The texture matrix.
1200
- *
1201
- */
1202
- android_getTextureMatrix(): $p_a.Matrix;
1203
-
1204
- /** {en}
1205
- * @platform android
1206
- * @detail api
1207
- * @brief Gets the video data in the format of ByteBuffer.
1208
- * @return <br>
1209
- * The video data in the format of ByteBuffer.
1210
- *
1211
- */
1212
- android_getBuffer(): $p_a.ByteBuffer;
1213
-
1214
- /** {en}
1215
- * @platform android
1216
- * @detail api
1217
- * @brief Gets the video data in the format of byte [].
1218
- * @return <br>
1219
- * The video data in the format of byte [].
1220
- *
1221
- */
1222
- android_getData(): ArrayBuffer;
1223
-
1224
- /** {en}
1225
- * @platform android
1226
- * @detail api
1227
- * @brief Gets the internal release callback.
1228
- * @return <br>
1229
- * The internal release callback.
1230
- *
1231
- */
1232
- android_getReleaseCallback(): $p_a.Runnable;
1233
-
1234
- /** {en}
1235
- * @platform android
1236
- * @detail api
1237
- * @brief Sets the internal release callback.
1238
- * @param releaseCallback The internal release callback.
1239
- * @return <br>
1240
- * The video frame object. See VeLiveVideoFrame {@link #VeLiveVideoFrame} for details.
1241
- *
1242
- */
1243
- android_setReleaseCallback(releaseCallback: $p_a.Runnable): this;
1244
-
1245
- /** {en}
1246
- * @platform ios
1247
- * @brief Triggered when the SDK has completed processing the video frame and no longer needs the memory. You can release the memory for the video frame after receiving this callback.
1248
- */
1249
- ios_releaseCallback(): void;
1250
- }
1251
-
1252
- export declare class VeLiveCameraDevice {
1253
- protected _instance: any;
1254
- protected __init(...args: any[]): void;
1255
- protected __new_instance(...args: any[]): any;
1256
-
1257
- /** {en}
1258
- * @platform android
1259
- * @detail api
1260
- * @brief Gets the frame rate range supported by the camera.
1261
- * @return <br>
1262
- * The frame rate range supported by the camera.
1263
- * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1264
- * @order 66
1265
- *
1266
- */
1267
- android_getRealFpsRange(): Array<$p_a.int>;
1268
-
1269
- /** {en}
1270
- * @detail api
1271
- * @brief Enables or disables the flashlight.
1272
- * @return <br>
1273
- * - 0: Success;
1274
- * - ≠ 0: Failure.
1275
- * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1276
- * @order 67
1277
- * @param enable Whether to enable the flashlight. <br>
1278
- * - true: Enable;
1279
- * - false: (Default) Disable.
1280
- *
1281
- */
1282
- enableTorch(enable: boolean): number;
1283
-
1284
- /** {en}
1285
- * @detail api
1286
- * @brief Sets the zoom factor of the camera.
1287
- * @return <br>
1288
- * - 0: Success;
1289
- * - ≠ 0: Failure.
1026
+ * @brief Gets the current zoom factor of the camera.
1290
1027
  * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1291
1028
  * @order 68
1292
- * @param ratio The zoom factor. The SDK uses the original size by default. The range of the zoom factor is [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)].
1293
- *
1294
- */
1295
- setZoomRatio(ratio: number): number;
1296
-
1297
- /** {en}
1298
- * @detail api
1299
- * @brief Gets the current zoom factor of the camera.
1300
1029
  * @return <br>
1301
1030
  * - ≤ 0: The camera does not support zooming;
1302
- * - \\\\> 0: The zoom factor.
1303
- * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1304
- * @order 68
1031
+ * - > 0: The zoom factor.
1305
1032
  *
1306
1033
  */
1307
1034
  getCurrentZoomRatio(): number;
@@ -1309,11 +1036,11 @@ export declare class VeLiveCameraDevice {
1309
1036
  /** {en}
1310
1037
  * @detail api
1311
1038
  * @brief Gets the maximum zoom factor of the camera.
1312
- * @return <br>
1313
- * - ≤ 0: The camera does not support zooming;
1314
- * - \\\\> 0: The maximum zoom factor.
1315
1039
  * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1316
1040
  * @order 69
1041
+ * @return <br>
1042
+ * - ≤ 0: The camera does not support zooming;
1043
+ * - > 0: The maximum zoom factor.
1317
1044
  *
1318
1045
  */
1319
1046
  getMaxZoomRatio(): number;
@@ -1321,11 +1048,11 @@ export declare class VeLiveCameraDevice {
1321
1048
  /** {en}
1322
1049
  * @detail api
1323
1050
  * @brief Gets the minimum zoom factor of the camera.
1324
- * @return <br>
1325
- * - ≤ 0: The camera does not support zooming;
1326
- * - \\\\> 0: The minimum zoom factor.
1327
1051
  * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1328
1052
  * @order 70
1053
+ * @return <br>
1054
+ * - ≤ 0: The camera does not support zooming;
1055
+ * - > 0: The minimum zoom factor.
1329
1056
  *
1330
1057
  */
1331
1058
  getMinZoomRatio(): number;
@@ -1333,11 +1060,11 @@ export declare class VeLiveCameraDevice {
1333
1060
  /** {en}
1334
1061
  * @detail api
1335
1062
  * @brief Checks whether autofocus is supported.
1063
+ * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1064
+ * @order 71
1336
1065
  * @return <br>
1337
1066
  * - true: Supported;
1338
1067
  * - false: Not supported.
1339
- * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1340
- * @order 71
1341
1068
  *
1342
1069
  */
1343
1070
  isAutoFocusEnabled(): boolean;
@@ -1345,14 +1072,14 @@ export declare class VeLiveCameraDevice {
1345
1072
  /** {en}
1346
1073
  * @detail api
1347
1074
  * @brief Enables or disables autofocus.
1348
- * @return <br>
1349
- * - 0: Success;
1350
- * - ≠ 0: Failure.
1351
1075
  * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1352
1076
  * @order 72
1353
1077
  * @param enable Whether to enable autofocus.
1354
1078
  * - true: (Default) Enable;
1355
1079
  * - false: Disable.
1080
+ * @return <br>
1081
+ * - 0: Success;
1082
+ * - ≠ 0: Failure.
1356
1083
  *
1357
1084
  */
1358
1085
  enableAutoFocus(enable: boolean): number;
@@ -1360,15 +1087,15 @@ export declare class VeLiveCameraDevice {
1360
1087
  /** {en}
1361
1088
  * @detail api
1362
1089
  * @brief Sets the focus position of the camera.
1363
- * @return <br>
1364
- * - 0: Success;
1365
- * - ≠ 0: Failure.
1366
1090
  * @notes <br>Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1367
1091
  * @order 73
1368
1092
  * @param viewW The width of the current view.
1369
1093
  * @param viewH The height of the current view.
1370
1094
  * @param x The horizontal coordinate of the focus point from the upper left corner of the current view.
1371
1095
  * @param y The vertical coordinate of the focus point from the upper left corner of the current view.
1096
+ * @return <br>
1097
+ * - 0: Success;
1098
+ * - ≠ 0: Failure.
1372
1099
  *
1373
1100
  */
1374
1101
  setFocusPosition(viewW: number, viewH: number, x: number, y: number): number;
@@ -1376,17 +1103,15 @@ export declare class VeLiveCameraDevice {
1376
1103
  /** {en}
1377
1104
  * @detail api
1378
1105
  * @brief Checks if manual exposure setting is available for the currently used camera.
1379
- * @return - YES: Available.
1380
- * - NO: Unavailable.
1381
1106
  * @notes You must call [startVideoCapture](#VeLivePusher-startvideocapture) to start SDK internal video capturing before calling this API.
1382
1107
  * @order 74
1108
+ * @return - YES: Available.
1109
+ * - NO: Unavailable.
1383
1110
  *
1384
1111
  */
1385
1112
  isExposurePositionSupported(): boolean;
1386
1113
 
1387
1114
  /** {en}
1388
- * @return - =0: Success.
1389
- * - ≠0: Failure.
1390
1115
  * @detail api
1391
1116
  * @brief Sets the manual exposure position for the currently used camera.
1392
1117
  * @notes - You must call [startVideoCapture](#VeLivePusher-startvideocapture) to start SDK internal video capturing, and use SDK internal rendering before calling this API.
@@ -1396,35 +1121,35 @@ export declare class VeLiveCameraDevice {
1396
1121
  * @param viewH The height of the current view.
1397
1122
  * @param x The horizontal coordinate of the focus point from the upper left corner of the current view.
1398
1123
  * @param y The vertical coordinate of the focus point from the upper left corner of the current view.
1124
+ * @return - =0: Success.
1125
+ * - ≠0: Failure.
1399
1126
  *
1400
1127
  */
1401
1128
  setExposurePosition(viewW: number, viewH: number, x: number, y: number): number;
1402
1129
 
1403
1130
  /** {en}
1404
- * @return - ≤0: The camera does not support exposure;
1405
- * - \\>0: The minimum exposure compensation.
1406
1131
  * @detail api
1407
1132
  * @brief Gets the minimum exposure compensation of the camera.
1408
1133
  * @notes Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1409
1134
  * @order 76
1135
+ * @return - ≤0: The camera does not support exposure;
1136
+ * - >0: The minimum exposure compensation.
1410
1137
  *
1411
1138
  */
1412
1139
  getMinExposureCompensation(): number;
1413
1140
 
1414
1141
  /** {en}
1415
- * @return - ≤0: The camera does not support exposure;
1416
- * - \\>0: The maximum exposure compensation.
1417
1142
  * @detail api
1418
1143
  * @brief Gets the maximum exposure compensation of the camera.
1419
1144
  * @notes Call this method after calling [startVideoCapture](#VeLivePusher-startvideocapture) to start camera capture.
1420
1145
  * @order 77
1146
+ * @return - ≤0: The camera does not support exposure;
1147
+ * - >0: The maximum exposure compensation.
1421
1148
  *
1422
1149
  */
1423
1150
  getMaxExposureCompensation(): number;
1424
1151
 
1425
1152
  /** {en}
1426
- * @return - =0: Success.
1427
- * - ≠0: Failure.
1428
1153
  * @detail api
1429
1154
  * @brief Sets the exposure compensation for the currently used camera.
1430
1155
  * @notes <br>
@@ -1432,6 +1157,8 @@ export declare class VeLiveCameraDevice {
1432
1157
  * - The camera exposure compensation setting will be invalid after calling [stopVideoCapture](#VeLivePusher-stopvideocapture) to stop internal capturing.
1433
1158
  * @order 78
1434
1159
  * @param value The range of the exposure compensation is [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation),[getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)], Default to 0, which means no exposure compensation.
1160
+ * @return - =0: Success.
1161
+ * - ≠0: Failure.
1435
1162
  *
1436
1163
  */
1437
1164
  setExposureCompensation(value: number): number;
@@ -1440,11 +1167,10 @@ export declare class VeLiveCameraDevice {
1440
1167
  * @platform ios
1441
1168
  * @detail api
1442
1169
  * @brief Checks whether flashlight is supported.
1443
- * @return <br>
1444
- * - YES: Supported;
1445
- * - NO: Not supported.
1446
- * @notes <br>Call this method after calling startVideoCapture:{@link #VeLivePusher#startVideoCapture} to start camera capture.
1170
+ * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
1447
1171
  * @order 49
1172
+ * @return - YES: Supported;
1173
+ * - NO: Not supported.
1448
1174
  */
1449
1175
  ios_isTorchSupported(): boolean;
1450
1176
 
@@ -1452,7 +1178,7 @@ export declare class VeLiveCameraDevice {
1452
1178
  * @platform ios
1453
1179
  * @detail api
1454
1180
  * @brief Sets camera parameters.
1455
- * @notes <br>Call this method after calling startVideoCapture:{@link #VeLivePusher#startVideoCapture} to start camera capture.
1181
+ * @notes Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
1456
1182
  * @order 64
1457
1183
  * @param parameter The parameter name (key) and the corresponding value.
1458
1184
  */
@@ -1462,11 +1188,11 @@ export declare class VeLiveCameraDevice {
1462
1188
  * @platform ios
1463
1189
  * @detail api
1464
1190
  * @brief Gets camera parameters.
1465
- * @return <br>
1466
- * The value of the camera parameter. The data type is determined by the parameter name you set when calling the method.
1467
- * @notes <br>Call this method after calling startVideoCapture:{@link #VeLivePusher#startVideoCapture} to start camera capture.
1191
+ * @notes
1192
+ * Call this method after calling [startVideoCapture:](#VeLivePusher-startvideocapture) to start camera capture.
1468
1193
  * @order 65
1469
1194
  * @param key The parameter name.
1195
+ * @return The value of the camera parameter. The data type is determined by the parameter name you set when calling the method.
1470
1196
  */
1471
1197
  ios_getParameter(key: string): $p_i.id;
1472
1198
  }
@@ -1479,11 +1205,11 @@ export declare class VeLiveVideoEffectManager {
1479
1205
  /** {en}
1480
1206
  * @detail api
1481
1207
  * @brief Initializes the special effects manager.
1208
+ * @order 89
1209
+ * @param config The special effects configurations. See VeLiveVideoEffectLicenseConfiguration for details.
1482
1210
  * @return <br>
1483
1211
  * - 0: Success;
1484
1212
  * - -1: Failure.
1485
- * @order 89
1486
- * @param config The special effects configurations. See VeLiveVideoEffectLicenseConfiguration for details.
1487
1213
  *
1488
1214
  */
1489
1215
  setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): number;
@@ -1492,9 +1218,9 @@ export declare class VeLiveVideoEffectManager {
1492
1218
  * @detail api
1493
1219
  * @brief Updates the special effects license. This method is effective only if you authenticate the license online.
1494
1220
  * @param callback The result callback.
1495
- * @notes <br>
1496
- * - Call this method after you set the video effects license by calling setupWithConfig {@link #setupWithConfig};
1497
- * - This method is an asynchronous operation.
1221
+ * @notes
1222
+ * - Call this method after you set the video effects license by calling [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig).
1223
+ * - This method is an asynchronous operation.
1498
1224
  * @order 90
1499
1225
  *
1500
1226
  */
@@ -1503,19 +1229,19 @@ export declare class VeLiveVideoEffectManager {
1503
1229
  /** {en}
1504
1230
  * @detail api
1505
1231
  * @brief Creates or destroys the special effects engine.
1506
- * @return <br>
1507
- * - 0: Success;
1508
- * - -1: Failure.
1509
- * @notes <br>
1510
- * - Call this method after calling [setupWithConfig](broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setupwithconfig) and [setAlgorithmModelPath](broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setalgorithmmodelpath) ;
1511
- * - This method does not enable or disable video special effects. Call [setComposeNodes](broadcast-sdk-for-android-api#VeLiveVideoEffectManager-setcomposenodes) after calling this method to enable video special effects;
1232
+ * @notes
1233
+ * - Call this method after calling [setupwithconfig](#VeLiveVideoEffectManager-setupwithconfig) and [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath);
1234
+ * - This method does not enable or disable video special effects. Call [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) after calling this method to enable video special effects;
1512
1235
  * - In most cases, the special effects engine will be destroyed when the effects manager is destroyed. However, if you have high performance requirements, you can call this method to manually destroy the special effects engine when you are not using special effects-related features;
1513
1236
  * - Creating or destroying the special effects engine repeatedly can result in increased processing time.
1514
1237
  * @order 92
1515
1238
  * @param enable Whether to create or destroy the special effects engine.<br>
1516
1239
  * - true: Create;
1517
1240
  * - false: (Default) Destroy.
1518
- * @param callback [VeLiveVideoEffectCallback](broadcast-sdk-for-android-callback\\#VeLiveVideoEffectCallback), the listener for special effect events.
1241
+ * @param callback [VeLiveVideoEffectCallback](docs-broadcast-sdk-for-android-callback#VeLiveVideoEffectCallback), the listener for special effect events.
1242
+ * @return <br>
1243
+ * - 0: Success;
1244
+ * - -1: Failure.
1519
1245
  *
1520
1246
  */
1521
1247
  setEnable(enable: boolean, callback: (result: number, msg: string) => void): void;
@@ -1525,12 +1251,12 @@ export declare class VeLiveVideoEffectManager {
1525
1251
  * @detail api
1526
1252
  * @brief Sets the path to the algorithm model package of the special effects.
1527
1253
  * @param path The path to the algorithm model package of the special effects.
1528
- * @return <br>
1529
- * - 0: Success;
1530
- * - -1: Failure.
1531
1254
  * @notes <br>
1532
1255
  * Call this method after you set the special effects license by calling setupWithConfig {@link #setupWithConfig}.
1533
1256
  * @order 91
1257
+ * @return <br>
1258
+ * - 0: Success;
1259
+ * - -1: Failure.
1534
1260
  *
1535
1261
  */
1536
1262
  android_setAlgorithmModelPath(path: string): number;
@@ -1539,14 +1265,14 @@ export declare class VeLiveVideoEffectManager {
1539
1265
  * @detail api
1540
1266
  * @brief Sets the special effects you want to apply to the video. You can choose effects from ComposeMakeup.bundle.
1541
1267
  * @param nodes The paths to the special effects resource.
1268
+ * @notes
1269
+ * - Call this method after calling [setEnable](#VeLiveVideoEffectManager-setenable).
1270
+ * - If you make multiple calls to this method, only the last call takes effect;
1271
+ * - To add more effects to the existing effects settings, call [appendComposeNodes](docs-broadcast-sdk-for-android-api#VeLiveVideoEffectManager-appendcomposenodes).
1272
+ * @order 93
1542
1273
  * @return <br>
1543
1274
  * - 0: Success;
1544
1275
  * - -1: Failure.
1545
- * @notes <br>
1546
- * - Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable};
1547
- * - If you make multiple calls to this method, only the last call takes effect;
1548
- * - To add more effects to the existing effects settings, call appendComposeNodes {@link #VeLiveVideoEffectManager#appendComposeNodes}.
1549
- * @order 93
1550
1276
  *
1551
1277
  */
1552
1278
  setComposeNodes(nodes: Array<string>): number;
@@ -1555,26 +1281,24 @@ export declare class VeLiveVideoEffectManager {
1555
1281
  * @detail api
1556
1282
  * @brief Adds one or more effects to the existing effects settings that you have configured by calling setComposeNodes {@link #VeLiveVideoEffectManager#setComposeNodes}.
1557
1283
  * @param nodes The paths to the special effects resource.
1284
+ * @notes Call this method after calling [setEnable](#VeLiveVideoEffectManager-setenable).
1285
+ * @order 94
1558
1286
  * @return <br>
1559
1287
  * - 0: Success;
1560
1288
  * - -1: Failure.
1561
- * @notes <br>
1562
- * - Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
1563
- * @order 94
1564
1289
  *
1565
1290
  */
1566
1291
  appendComposeNodes(nodes: Array<string>): number;
1567
1292
 
1568
1293
  /** {en}
1569
1294
  * @detail api
1570
- * @brief Removes one or more special effects resource set by the setComposeNodes{@link #VeLiveVideoEffectManager#setComposeNodes} or appendComposeNodes{@link #VeLiveVideoEffectManager#appendComposeNodes} methods.
1295
+ * @brief Removes one or more special effects resource set by the [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) or [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) methods.
1571
1296
  * @param nodes The paths to the special effects resource.
1297
+ * @notes Call this method after calling [setEnable](#VeLiveVideoEffectManager-setenable).
1298
+ * @order 94
1572
1299
  * @return <br>
1573
1300
  * - 0: Success;
1574
1301
  * - -1: Failure.
1575
- * @notes <br>
1576
- * - Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
1577
- * @order 94
1578
1302
  *
1579
1303
  */
1580
1304
  removeComposeNodes(nodes: Array<string>): number;
@@ -1585,13 +1309,13 @@ export declare class VeLiveVideoEffectManager {
1585
1309
  * @param node The path to the special effects resource.
1586
1310
  * @param key The key of the resource.
1587
1311
  * @param intensity The intensity of the effect. The value range is [0.0, 1.0].
1312
+ * @notes
1313
+ * - Call this method after calling [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) or [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes);
1314
+ * - This method is only applicable to special effects that contain the three parameters mentioned above. For effects that do not have the intensity parameter, such as stickers, the method does not have any effect.
1315
+ * @order 95
1588
1316
  * @return <br>
1589
1317
  * - 0: Success;
1590
1318
  * - -1: Failure.
1591
- * @notes <br>
1592
- * - Call this method after calling setComposeNodes {@link #VeLiveVideoEffectManager#setComposeNodes} or appendComposeNodes {@link #VeLiveVideoEffectManager#appendComposeNodes};
1593
- * - This method is only applicable to special effects that contain the three parameters mentioned above. For effects that do not have the intensity parameter, such as stickers, the method does not have any effect.
1594
- * @order 95
1595
1319
  *
1596
1320
  */
1597
1321
  updateComposerNodeIntensity(node: string, key: string, intensity: number): number;
@@ -1600,12 +1324,12 @@ export declare class VeLiveVideoEffectManager {
1600
1324
  * @detail api
1601
1325
  * @brief Sets the color filter.
1602
1326
  * @param path The absolute path to the filter resource.
1327
+ * @notes
1328
+ * Call this method after calling [setEnable](#VeLiveVideoEffectManager-setenable).
1329
+ * @order 96
1603
1330
  * @return <br>
1604
1331
  * - 0: Success;
1605
1332
  * - -1: Failure.
1606
- * @notes <br>
1607
- * Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
1608
- * @order 96
1609
1333
  *
1610
1334
  */
1611
1335
  setFilter(path: string): number;
@@ -1613,12 +1337,12 @@ export declare class VeLiveVideoEffectManager {
1613
1337
  /** {en}
1614
1338
  * @detail api
1615
1339
  * @brief Sets the intensity of the color filter.
1616
- * @return <br>
1617
- * - 0: Success;
1618
- * - -1: Failure.
1619
- * @notes <br>Call this method after calling setFilter.
1340
+ * @notes
1341
+ * Call this method after calling [setFilter](#VeLiveVideoEffectManager-setfilter).
1620
1342
  * @order 97
1621
1343
  * @param intensity The intensity. The value range is [0.0, 1.0].
1344
+ * @return - 0: Success;
1345
+ * - -1: Failure.
1622
1346
  *
1623
1347
  */
1624
1348
  updateFilterIntensity(intensity: number): number;
@@ -1627,24 +1351,24 @@ export declare class VeLiveVideoEffectManager {
1627
1351
  * @detail api
1628
1352
  * @brief Sets the sticker.
1629
1353
  * @param path The absolute path to the sticker resource.
1354
+ * @notes
1355
+ * Call this method after calling [setEnable](#VeLiveVideoEffectManager-setenable).
1356
+ * @order 98
1630
1357
  * @return <br>
1631
1358
  * - 0: Success;
1632
1359
  * - -1: Failure.
1633
- * @notes <br>
1634
- * Call this method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}.
1635
- * @order 98
1636
1360
  *
1637
1361
  */
1638
1362
  setSticker(path: string): number;
1639
1363
 
1640
1364
  /** {en}
1641
1365
  * @detail api
1642
- * @brief Advanced settings for special effects.
1366
+ * @brief Advanced functions of BytePlus Effects.
1643
1367
  * @param callback A callback function that takes a handle as an argument.
1644
1368
  * @param isGLThread Whether the callback is called in the GL thread.
1645
1369
  * @param isAsync Whether the callback is executed synchronously.
1646
- * @notes <br>
1647
- * Call the method after calling setEnable {@link #VeLiveVideoEffectManager #setEnable}. Do not perform frequent synchronization operations in the main thread.
1370
+ * @notes
1371
+ * Call the method after calling [setEnable](#VeLiveVideoEffectManager-setenable). Do not perform frequent synchronization operations in the main thread.
1648
1372
  * @order 99
1649
1373
  *
1650
1374
  */
@@ -1655,127 +1379,16 @@ export declare class VeLiveVideoEffectManager {
1655
1379
  * @detail api
1656
1380
  * @brief Sets the path to the algorithm models of the special effects.
1657
1381
  * @param path The path to the algorithm models of the special effects.
1382
+ * @notes
1383
+ * Call this method after you set the special effects license by calling [setupWithConfig:](#VeLiveVideoEffectManager-setupwithconfig).
1384
+ * @order 77
1658
1385
  * @return <br>
1659
1386
  * - 0: Success;
1660
1387
  * - -1: Failure.
1661
- * @notes <br>
1662
- * Call this method after you set the special effects license by calling setupWithConfig:{@link #VeLiveVideoEffectManager#setupWithConfig}.
1663
- * @order 77
1664
1388
  */
1665
1389
  ios_setAlgoModelPath(path: string): number;
1666
1390
  }
1667
1391
 
1668
- export declare class VeLiveAudioFrame {
1669
- constructor();
1670
- constructor(sampleRate: VeLiveAudioSampleRate, channel: VeLiveAudioChannel, pts: number, buffer: ByteBuffer);
1671
- constructor();
1672
- protected _instance: any;
1673
- get bufferType(): VeLiveAudioBufferType;
1674
- set bufferType(value: VeLiveAudioBufferType);
1675
- get sampleRate(): any;
1676
- set sampleRate(value: any);
1677
- get channels(): any;
1678
- set channels(value: any);
1679
- /**
1680
- * @platform android
1681
- */
1682
- get android_ptsUs(): any;
1683
- set android_ptsUs(value: any);
1684
- /**
1685
- * @platform android
1686
- */
1687
- get android_buffer(): any;
1688
- set android_buffer(value: any);
1689
- /**
1690
- * @platform android
1691
- */
1692
- get android_samplesPerChannel(): any;
1693
- set android_samplesPerChannel(value: any);
1694
-
1695
- /** {en}
1696
- * @platform ios
1697
- * @brief The audio frame timestamp, in μs, when `bufferType` is `VeLiveAudioBufferNSData`.
1698
- */
1699
- get ios_pts(): $p_i.CMTime;
1700
- set ios_pts(value: $p_i.CMTime);
1701
-
1702
- /** {en}
1703
- * @platform ios
1704
- * @brief The audio data, when `bufferType` is `VeLiveAudioBufferTypeSampleBuffer`.
1705
- */
1706
- get ios_sampleBuffer(): $p_i.CMSampleBufferRef;
1707
- set ios_sampleBuffer(value: $p_i.CMSampleBufferRef);
1708
-
1709
- /** {en}
1710
- * @platform ios
1711
- * @brief The audio data, when `bufferType` is `VeLiveAudioBufferTypeNSData`. The audio data is of type float32 and is stored in little-endian byte order.
1712
- */
1713
- get ios_data(): $p_i.NSData;
1714
- set ios_data(value: $p_i.NSData);
1715
- protected __init(...args: any[]): void;
1716
- protected __new_instance(...args: any[]): any;
1717
-
1718
- /** {en}
1719
- * @platform android
1720
- * @detail api
1721
- * @brief Gets the audio data type.
1722
- * @return <br>
1723
- * The audio data type. See VeLiveAudioBufferType {@link #VeLiveAudioBufferType} for details.
1724
- *
1725
- */
1726
- android_getBufferType(): $p_a.VeLiveAudioBufferType;
1727
-
1728
- /** {en}
1729
- * @platform android
1730
- * @detail api
1731
- * @brief Gets the audio sample rate.
1732
- * @return <br>
1733
- * The audio sample rate. See VeLiveAudioSampleRate {@link #VeLiveAudioSampleRate} for details.
1734
- *
1735
- */
1736
- android_getSampleRate(): $p_a.VeLiveAudioSampleRate;
1737
-
1738
- /** {en}
1739
- * @platform android
1740
- * @detail api
1741
- * @brief Gets the number of audio channels.
1742
- * @return <br>
1743
- * The number of audio channels. See VeLiveAudioChannel {@link #VeLiveAudioChannel} for details.
1744
- *
1745
- */
1746
- android_getChannels(): $p_a.VeLiveAudioChannel;
1747
-
1748
- /** {en}
1749
- * @platform android
1750
- * @detail api
1751
- * @brief Gets the audio bit depth.
1752
- * @return <br>
1753
- * The audio bit depth.
1754
- *
1755
- */
1756
- android_getSamplesPerChannel(): number;
1757
-
1758
- /** {en}
1759
- * @platform android
1760
- * @detail api
1761
- * @brief Gets the audio timestamp, in μs.
1762
- * @return <br>
1763
- * The timestamp of the audio frame, in μs.
1764
- *
1765
- */
1766
- android_getPts(): number;
1767
-
1768
- /** {en}
1769
- * @platform android
1770
- * @detail api
1771
- * @brief Gets the audio data. The audio data is of type float32 and is stored in little-endian byte order.
1772
- * @return <br>
1773
- * The audio data in the format of ByteBuffer.
1774
- *
1775
- */
1776
- android_getBuffer(): $p_a.ByteBuffer;
1777
- }
1778
-
1779
1392
  export declare class VeLiveAudioDevice {
1780
1393
  protected _instance: any;
1781
1394
  protected __init(...args: any[]): void;
@@ -1793,43 +1406,47 @@ export declare class VeLiveAudioDevice {
1793
1406
  /** {en}
1794
1407
  * @detail api
1795
1408
  * @brief Gets the current volume.
1409
+ * @order 75
1796
1410
  * @return <br>
1797
1411
  * The current volume.
1798
- * @order 75
1799
1412
  *
1800
1413
  */
1801
1414
  getVoiceLoudness(): number;
1802
1415
 
1803
1416
  /** {en}
1417
+ * @platform ios
1804
1418
  * @detail api
1805
- * @brief Checks whether in-ear monitoring is supported.
1419
+ * @brief Checks whether in-ear monitoring is supported.
1806
1420
  * @return <br>
1807
- * - true: Supported;
1808
- * - false: Not supported.
1809
- * @order 76
1810
- *
1421
+ * - YES: Supported;
1422
+ * - NO: Not supported.
1423
+ * @order 62
1811
1424
  */
1812
- isSupportHardwareEcho(): boolean;
1425
+ ios_isSupportHardwareEcho(): boolean;
1813
1426
 
1814
1427
  /** {en}
1428
+ * @platform ios
1815
1429
  * @detail api
1816
1430
  * @brief Enables or disables in-ear monitoring.
1817
1431
  * @param enable Whether to enable in-ear monitoring. <br>
1818
- * - true: Enable;
1819
- * - false: (Default) Disable.
1820
- * @order 77
1821
- *
1432
+ * - YES: Enable;
1433
+ * - NO: (Default) Disable.
1434
+ * @notes
1435
+ * Call this method after calling [startAudioCapture:](#VeLivePusher-startaudiocapture) to start audio capture.
1436
+ * @order 64
1822
1437
  */
1823
- enableEcho(enable: boolean): void;
1438
+ ios_enableEcho(enable: boolean): void;
1824
1439
 
1825
1440
  /** {en}
1441
+ * @platform ios
1826
1442
  * @detail api
1827
1443
  * @brief Checks whether in-ear monitoring is enabled.
1444
+ * @notes
1445
+ * Call this method after calling [startAudioCapture:](#VeLivePusher-startaudiocapture) to start audio capture.
1446
+ * @order 65
1828
1447
  * @return <br>
1829
- * - true: Enabled;
1830
- * - false: Disabled.
1831
- * @order 78
1832
- *
1448
+ * - YES: Enabled;
1449
+ * - NO: Disabled.
1833
1450
  */
1834
- isEnableEcho(): boolean;
1451
+ ios_isEnableEcho(): boolean;
1835
1452
  }