@byteplus/react-native-live-push 1.5.1-rc.3 → 1.5.2-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/commonjs/index.js +2 -2
- package/lib/commonjs/typescript/codegen/android/api.d.ts +93 -869
- package/lib/commonjs/typescript/codegen/android/callback.d.ts +31 -243
- package/lib/commonjs/typescript/codegen/android/errorcode.d.ts +15 -60
- package/lib/commonjs/typescript/codegen/android/keytype.d.ts +219 -1173
- package/lib/commonjs/typescript/codegen/ios/api.d.ts +102 -899
- package/lib/commonjs/typescript/codegen/ios/callback.d.ts +28 -162
- package/lib/commonjs/typescript/codegen/ios/errorcode.d.ts +25 -100
- package/lib/commonjs/typescript/codegen/ios/keytype.d.ts +180 -692
- package/lib/commonjs/typescript/codegen/pack/api.d.ts +133 -1180
- package/lib/commonjs/typescript/codegen/pack/callback.d.ts +35 -243
- package/lib/commonjs/typescript/codegen/pack/errorcode.d.ts +16 -69
- package/lib/commonjs/typescript/codegen/pack/keytype.d.ts +271 -1460
- package/lib/commonjs/typescript/core/api.d.ts +1 -8
- package/lib/commonjs/typescript/core/effect.d.ts +1 -5
- package/lib/module/index.js +2 -2
- package/lib/module/typescript/codegen/android/api.d.ts +93 -869
- package/lib/module/typescript/codegen/android/callback.d.ts +31 -243
- package/lib/module/typescript/codegen/android/errorcode.d.ts +15 -60
- package/lib/module/typescript/codegen/android/keytype.d.ts +219 -1173
- package/lib/module/typescript/codegen/ios/api.d.ts +102 -899
- package/lib/module/typescript/codegen/ios/callback.d.ts +28 -162
- package/lib/module/typescript/codegen/ios/errorcode.d.ts +25 -100
- package/lib/module/typescript/codegen/ios/keytype.d.ts +180 -692
- package/lib/module/typescript/codegen/pack/api.d.ts +133 -1180
- package/lib/module/typescript/codegen/pack/callback.d.ts +35 -243
- package/lib/module/typescript/codegen/pack/errorcode.d.ts +16 -69
- package/lib/module/typescript/codegen/pack/keytype.d.ts +271 -1460
- package/lib/module/typescript/core/api.d.ts +1 -8
- package/lib/module/typescript/core/effect.d.ts +1 -5
- package/lib/typescript/codegen/android/api.d.ts +93 -869
- package/lib/typescript/codegen/android/callback.d.ts +31 -243
- package/lib/typescript/codegen/android/errorcode.d.ts +15 -60
- package/lib/typescript/codegen/android/keytype.d.ts +219 -1173
- package/lib/typescript/codegen/ios/api.d.ts +102 -899
- package/lib/typescript/codegen/ios/callback.d.ts +28 -162
- package/lib/typescript/codegen/ios/errorcode.d.ts +25 -100
- package/lib/typescript/codegen/ios/keytype.d.ts +180 -692
- package/lib/typescript/codegen/pack/api.d.ts +133 -1180
- package/lib/typescript/codegen/pack/callback.d.ts +35 -243
- package/lib/typescript/codegen/pack/errorcode.d.ts +16 -69
- package/lib/typescript/codegen/pack/keytype.d.ts +271 -1460
- package/lib/typescript/core/api.d.ts +1 -8
- package/lib/typescript/core/effect.d.ts +1 -5
- package/package.json +1 -1
- package/lib/commonjs/typescript/core/logger.d.ts +0 -1
- package/lib/commonjs/typescript/platforms/android/AppLogWrapper.d.ts +0 -8
- package/lib/commonjs/typescript/platforms/ios/RangersAppLog.d.ts +0 -4
- package/lib/module/typescript/core/logger.d.ts +0 -1
- package/lib/module/typescript/platforms/android/AppLogWrapper.d.ts +0 -8
- package/lib/module/typescript/platforms/ios/RangersAppLog.d.ts +0 -4
- package/lib/typescript/core/logger.d.ts +0 -1
- package/lib/typescript/platforms/android/AppLogWrapper.d.ts +0 -8
- package/lib/typescript/platforms/ios/RangersAppLog.d.ts +0 -4
|
@@ -2,15 +2,7 @@ import { int, float, String, EGLContext, View, Bitmap, long } from './types';
|
|
|
2
2
|
import { VeLiveVideoEffectLicenseConfiguration, VeLivePusherLogLevel, VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveVideoFrame, VeLiveAudioFrame, VeLiveOrientation } from './keytype';
|
|
3
3
|
import { VeLiveVideoEffectCallback, VeLiveVideoEffectHandleCallback, VeLivePusherObserver, VeLivePusherStatisticsObserver, VeLiveFileRecordingListener, VeLiveVideoFrameFilter, VeLiveAudioFrameFilter, VeLiveVideoFrameListener, VeLiveAudioFrameListener, VeLiveSnapshotListener, VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener } from './callback';
|
|
4
4
|
export declare class VeLiveCameraDevice {
|
|
5
|
-
|
|
6
|
-
* @detail api
|
|
7
|
-
* @brief 获取相机支持帧率范围。
|
|
8
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
9
|
-
* @order 3
|
|
10
|
-
* @return <br>
|
|
11
|
-
* 相机支持帧率范围。
|
|
12
|
-
*
|
|
13
|
-
*/
|
|
5
|
+
|
|
14
6
|
/** {en}
|
|
15
7
|
* @detail api
|
|
16
8
|
* @brief Gets the frame rate range supported by the camera.
|
|
@@ -21,19 +13,7 @@ export declare class VeLiveCameraDevice {
|
|
|
21
13
|
*
|
|
22
14
|
*/
|
|
23
15
|
getRealFpsRange(): Array<int>;
|
|
24
|
-
|
|
25
|
-
* @detail api
|
|
26
|
-
* @brief 开启/关闭闪光灯。
|
|
27
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
28
|
-
* @order 8
|
|
29
|
-
* @param enable 是否开启闪光灯。默认为 false。 <br>
|
|
30
|
-
* - true:开启;
|
|
31
|
-
* - false:关闭。
|
|
32
|
-
* @return <br>
|
|
33
|
-
* - 0:开启/关闭成功;
|
|
34
|
-
* - ≠0:开启/关闭失败。
|
|
35
|
-
*
|
|
36
|
-
*/
|
|
16
|
+
|
|
37
17
|
/** {en}
|
|
38
18
|
* @detail api
|
|
39
19
|
* @brief Enables or disables the flashlight.
|
|
@@ -48,17 +28,7 @@ export declare class VeLiveCameraDevice {
|
|
|
48
28
|
*
|
|
49
29
|
*/
|
|
50
30
|
enableTorch(enable: boolean): int;
|
|
51
|
-
|
|
52
|
-
* @detail api
|
|
53
|
-
* @brief 设置摄像头的缩放倍数。
|
|
54
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
55
|
-
* @order 5
|
|
56
|
-
* @param ratio 缩放倍数。默认为原尺寸。缩放倍数的取值范围为 [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)]。
|
|
57
|
-
* @return <br>
|
|
58
|
-
* - 0:缩放成功;
|
|
59
|
-
* - ≠0:缩放失败。
|
|
60
|
-
*
|
|
61
|
-
*/
|
|
31
|
+
|
|
62
32
|
/** {en}
|
|
63
33
|
* @detail api
|
|
64
34
|
* @brief Sets the zoom factor of the camera.
|
|
@@ -71,16 +41,7 @@ export declare class VeLiveCameraDevice {
|
|
|
71
41
|
*
|
|
72
42
|
*/
|
|
73
43
|
setZoomRatio(ratio: float): int;
|
|
74
|
-
|
|
75
|
-
* @detail api
|
|
76
|
-
* @brief 获取摄像头当前的缩放倍数。
|
|
77
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
78
|
-
* @order 4
|
|
79
|
-
* @return <br>
|
|
80
|
-
* - ≤0:表示不支持缩放;
|
|
81
|
-
* - >0:支持缩放,数值表示当前缩放倍数。
|
|
82
|
-
*
|
|
83
|
-
*/
|
|
44
|
+
|
|
84
45
|
/** {en}
|
|
85
46
|
* @detail api
|
|
86
47
|
* @brief Gets the current zoom factor of the camera.
|
|
@@ -92,16 +53,7 @@ export declare class VeLiveCameraDevice {
|
|
|
92
53
|
*
|
|
93
54
|
*/
|
|
94
55
|
getCurrentZoomRatio(): float;
|
|
95
|
-
|
|
96
|
-
* @detail api
|
|
97
|
-
* @brief 获取摄像头的最大缩放倍数。
|
|
98
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
99
|
-
* @order 6
|
|
100
|
-
* @return <br>
|
|
101
|
-
* - ≤0:表示不支持缩放;
|
|
102
|
-
* - >0:支持缩放,数值表示最大缩放倍数。
|
|
103
|
-
*
|
|
104
|
-
*/
|
|
56
|
+
|
|
105
57
|
/** {en}
|
|
106
58
|
* @detail api
|
|
107
59
|
* @brief Gets the maximum zoom factor of the camera.
|
|
@@ -113,16 +65,7 @@ export declare class VeLiveCameraDevice {
|
|
|
113
65
|
*
|
|
114
66
|
*/
|
|
115
67
|
getMaxZoomRatio(): float;
|
|
116
|
-
|
|
117
|
-
* @detail api
|
|
118
|
-
* @brief 获取摄像头的最小缩放倍数。
|
|
119
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
120
|
-
* @order 7
|
|
121
|
-
* @return <br>
|
|
122
|
-
* - ≤0:表示不支持缩放;
|
|
123
|
-
* - >0:支持缩放,数值表示最小缩放倍数。
|
|
124
|
-
*
|
|
125
|
-
*/
|
|
68
|
+
|
|
126
69
|
/** {en}
|
|
127
70
|
* @detail api
|
|
128
71
|
* @brief Gets the minimum zoom factor of the camera.
|
|
@@ -134,16 +77,7 @@ export declare class VeLiveCameraDevice {
|
|
|
134
77
|
*
|
|
135
78
|
*/
|
|
136
79
|
getMinZoomRatio(): float;
|
|
137
|
-
|
|
138
|
-
* @detail api
|
|
139
|
-
* @brief 是否支持自动对焦。
|
|
140
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
141
|
-
* @order 9
|
|
142
|
-
* @return <br>
|
|
143
|
-
* - true:支持;
|
|
144
|
-
* - false:不支持。
|
|
145
|
-
*
|
|
146
|
-
*/
|
|
80
|
+
|
|
147
81
|
/** {en}
|
|
148
82
|
* @detail api
|
|
149
83
|
* @brief Checks whether autofocus is supported.
|
|
@@ -155,19 +89,7 @@ export declare class VeLiveCameraDevice {
|
|
|
155
89
|
*
|
|
156
90
|
*/
|
|
157
91
|
isAutoFocusEnabled(): boolean;
|
|
158
|
-
|
|
159
|
-
* @detail api
|
|
160
|
-
* @brief 开启/关闭自动对焦功能。
|
|
161
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
162
|
-
* @order 10
|
|
163
|
-
* @param enable 是否开启自动对焦,默认为 true。
|
|
164
|
-
* - true:开启;
|
|
165
|
-
* - false:关闭。
|
|
166
|
-
* @return <br>
|
|
167
|
-
* - 0:开启/关闭成功;
|
|
168
|
-
* - ≠0:开启/关闭失败。
|
|
169
|
-
*
|
|
170
|
-
*/
|
|
92
|
+
|
|
171
93
|
/** {en}
|
|
172
94
|
* @detail api
|
|
173
95
|
* @brief Enables or disables autofocus.
|
|
@@ -182,20 +104,7 @@ export declare class VeLiveCameraDevice {
|
|
|
182
104
|
*
|
|
183
105
|
*/
|
|
184
106
|
enableAutoFocus(enable: boolean): int;
|
|
185
|
-
|
|
186
|
-
* @detail api
|
|
187
|
-
* @brief 设置摄像头的对焦位置。
|
|
188
|
-
* @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
189
|
-
* @order 11
|
|
190
|
-
* @param viewW 当前视图宽度。
|
|
191
|
-
* @param viewH 当前视图高度。
|
|
192
|
-
* @param x 以左上角为原点,对焦点距当前视图的横向坐标值。
|
|
193
|
-
* @param y 以左上角为原点,对焦点距当前视图的纵向坐标值。
|
|
194
|
-
* @return <br>
|
|
195
|
-
* - 0:设置成功;
|
|
196
|
-
* - ≠0:设置失败。
|
|
197
|
-
*
|
|
198
|
-
*/
|
|
107
|
+
|
|
199
108
|
/** {en}
|
|
200
109
|
* @detail api
|
|
201
110
|
* @brief Sets the focus position of the camera.
|
|
@@ -211,15 +120,7 @@ export declare class VeLiveCameraDevice {
|
|
|
211
120
|
*
|
|
212
121
|
*/
|
|
213
122
|
setFocusPosition(viewW: int, viewH: int, x: int, y: int): int;
|
|
214
|
-
|
|
215
|
-
* @detail api
|
|
216
|
-
* @brief 检查当前使用的摄像头是否支持手动设置曝光点。
|
|
217
|
-
* @notes 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时,才能检查曝光点设置能力。
|
|
218
|
-
* @order 12
|
|
219
|
-
* @return - YES:支持;
|
|
220
|
-
* - NO:不支持。
|
|
221
|
-
*
|
|
222
|
-
*/
|
|
123
|
+
|
|
223
124
|
/** {en}
|
|
224
125
|
* @detail api
|
|
225
126
|
* @brief Checks if manual exposure setting is available for the currently used camera.
|
|
@@ -230,20 +131,7 @@ export declare class VeLiveCameraDevice {
|
|
|
230
131
|
*
|
|
231
132
|
*/
|
|
232
133
|
isExposurePositionSupported(): boolean;
|
|
233
|
-
|
|
234
|
-
* @detail api
|
|
235
|
-
* @brief 设置当前使用的摄像头的曝光点。
|
|
236
|
-
* @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集,并且使用 SDK 内部渲染时,才能设置曝光点;
|
|
237
|
-
* - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后,设置的曝光点失效。
|
|
238
|
-
* @order 13
|
|
239
|
-
* @param viewW 当前视图宽度。
|
|
240
|
-
* @param viewH 当前视图高度。
|
|
241
|
-
* @param x 以左上角为原点,对焦点距当前视图的横向坐标值。
|
|
242
|
-
* @param y 以左上角为原点,对焦点距当前视图的纵向坐标值。
|
|
243
|
-
* @return - =0:成功;
|
|
244
|
-
* - ≠0:失败。
|
|
245
|
-
*
|
|
246
|
-
*/
|
|
134
|
+
|
|
247
135
|
/** {en}
|
|
248
136
|
* @detail api
|
|
249
137
|
* @brief Sets the manual exposure position for the currently used camera.
|
|
@@ -259,15 +147,7 @@ export declare class VeLiveCameraDevice {
|
|
|
259
147
|
*
|
|
260
148
|
*/
|
|
261
149
|
setExposurePosition(viewW: int, viewH: int, x: int, y: int): int;
|
|
262
|
-
|
|
263
|
-
* @detail api
|
|
264
|
-
* @brief 获取摄像头的最小曝光补偿值。
|
|
265
|
-
* @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
266
|
-
* @order 14
|
|
267
|
-
* @return - ≤0:表示不支持曝光补偿;
|
|
268
|
-
* - >0:支持曝光补偿,数值表示最小曝光补偿。
|
|
269
|
-
*
|
|
270
|
-
*/
|
|
150
|
+
|
|
271
151
|
/** {en}
|
|
272
152
|
* @detail api
|
|
273
153
|
* @brief Gets the minimum exposure compensation of the camera.
|
|
@@ -278,15 +158,7 @@ export declare class VeLiveCameraDevice {
|
|
|
278
158
|
*
|
|
279
159
|
*/
|
|
280
160
|
getMinExposureCompensation(): float;
|
|
281
|
-
|
|
282
|
-
* @detail api
|
|
283
|
-
* @brief 获取摄像头的最大曝光补偿值。
|
|
284
|
-
* @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
285
|
-
* @order 15
|
|
286
|
-
* @return - ≤0:表示不支持曝光补偿;
|
|
287
|
-
* - >0:支持曝光补偿,数值表示最大曝光补偿。
|
|
288
|
-
*
|
|
289
|
-
*/
|
|
161
|
+
|
|
290
162
|
/** {en}
|
|
291
163
|
* @detail api
|
|
292
164
|
* @brief Gets the maximum exposure compensation of the camera.
|
|
@@ -297,17 +169,7 @@ export declare class VeLiveCameraDevice {
|
|
|
297
169
|
*
|
|
298
170
|
*/
|
|
299
171
|
getMaxExposureCompensation(): float;
|
|
300
|
-
|
|
301
|
-
* @detail api
|
|
302
|
-
* @brief 设置当前使用的摄像头的曝光补偿。
|
|
303
|
-
* @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时,才能设置曝光补偿。
|
|
304
|
-
* - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后,设置的曝光补偿失效。
|
|
305
|
-
* @order 16
|
|
306
|
-
* @param value 曝光补偿值,取值范围 [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation),[getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)],0 为系统默认值,表示没有曝光补偿。
|
|
307
|
-
* @return - =0:设置成功;
|
|
308
|
-
* - ≠0:设置失败。
|
|
309
|
-
*
|
|
310
|
-
*/
|
|
172
|
+
|
|
311
173
|
/** {en}
|
|
312
174
|
* @detail api
|
|
313
175
|
* @brief Sets the exposure compensation for the currently used camera.
|
|
@@ -323,16 +185,7 @@ export declare class VeLiveCameraDevice {
|
|
|
323
185
|
setExposureCompensation(value: float): int;
|
|
324
186
|
}
|
|
325
187
|
export declare class VeLiveVideoEffectManager {
|
|
326
|
-
|
|
327
|
-
* @detail api
|
|
328
|
-
* @brief 视频特效许可证配置,用于初始化视频特效管理对象。
|
|
329
|
-
* @order 89
|
|
330
|
-
* @param config 特效初始化配置,详情请参见 [VeLiveVideoEffectLicenseConfiguration](147521#VeLivePusherDef-VeLiveVideoEffectLicenseConfiguration)。
|
|
331
|
-
* @return <br>
|
|
332
|
-
* - 0:调用成功;
|
|
333
|
-
* - -1:调用失败。
|
|
334
|
-
*
|
|
335
|
-
*/
|
|
188
|
+
|
|
336
189
|
/** {en}
|
|
337
190
|
* @detail api
|
|
338
191
|
* @brief Initializes the special effects manager.
|
|
@@ -344,15 +197,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
344
197
|
*
|
|
345
198
|
*/
|
|
346
199
|
setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): int;
|
|
347
|
-
|
|
348
|
-
* @detail api
|
|
349
|
-
* @brief 如果您使用在线 License 认证方式,在许可证过期后,可调用该方法更新 License;
|
|
350
|
-
* @notes - 需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用;
|
|
351
|
-
* - 本方法为异步操作。
|
|
352
|
-
* @order 90
|
|
353
|
-
* @param callback 结果回调信息
|
|
354
|
-
*
|
|
355
|
-
*/
|
|
200
|
+
|
|
356
201
|
/** {en}
|
|
357
202
|
* @detail api
|
|
358
203
|
* @brief Updates the special effects license. This method is effective only if you authenticate the license online.
|
|
@@ -364,22 +209,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
364
209
|
*
|
|
365
210
|
*/
|
|
366
211
|
updateLicense(callback: VeLiveVideoEffectCallback): void;
|
|
367
|
-
|
|
368
|
-
* @detail api
|
|
369
|
-
* @brief 创建/销毁特效引擎。
|
|
370
|
-
* @notes - 该方法需要在调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 和 [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath) 后调用;
|
|
371
|
-
* - 该方法不直接开启/关闭视频特效,您需要在调用该方法后,调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 开启视频特效;
|
|
372
|
-
* - 通用场景下,特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求,也可以在不使用特效相关功能时,调用该方法销毁特效引擎;
|
|
373
|
-
* - 如果重复创建/销毁特效引擎,会产生时间消耗。
|
|
374
|
-
* @order 92
|
|
375
|
-
* @param enable 是否创建特效引擎。默认为 false。 <br>
|
|
376
|
-
* - true:创建;
|
|
377
|
-
* - false:销毁。
|
|
378
|
-
* @param callback 视频特效回调 [VeLiveVideoEffectCallback](147519#VeLivePusherDef-VeLiveVideoEffectCallback)。
|
|
379
|
-
* @return - 0:成功;
|
|
380
|
-
* - -1:失败。
|
|
381
|
-
*
|
|
382
|
-
*/
|
|
212
|
+
|
|
383
213
|
/** {en}
|
|
384
214
|
* @detail api
|
|
385
215
|
* @brief Creates or destroys the special effects engine.
|
|
@@ -399,17 +229,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
399
229
|
*
|
|
400
230
|
*/
|
|
401
231
|
setEnable(enable: boolean, callback: VeLiveVideoEffectCallback): void;
|
|
402
|
-
|
|
403
|
-
* @detail api
|
|
404
|
-
* @brief 设置特效算法模型包的路径。
|
|
405
|
-
* @notes <br>需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用。
|
|
406
|
-
* @order 91
|
|
407
|
-
* @param path 特效算法模型包的路径
|
|
408
|
-
* @return <br>
|
|
409
|
-
* - 0:调用成功;
|
|
410
|
-
* - -1:调用失败。
|
|
411
|
-
*
|
|
412
|
-
*/
|
|
232
|
+
|
|
413
233
|
/** {en}
|
|
414
234
|
* @detail api
|
|
415
235
|
* @brief Sets the path to the algorithm model package of the special effects.
|
|
@@ -423,20 +243,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
423
243
|
*
|
|
424
244
|
*/
|
|
425
245
|
setAlgorithmModelPath(path: String): int;
|
|
426
|
-
|
|
427
|
-
* @detail api
|
|
428
|
-
* @brief 设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能,包括美颜、美形、美体、美妆等。
|
|
429
|
-
* @notes <br>
|
|
430
|
-
* - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法;
|
|
431
|
-
* - 重复调用本方法,仅最后一次调用生效;
|
|
432
|
-
* - 如果需要在当前的视频特效组合中叠加特效,可调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 方法。
|
|
433
|
-
* @order 93
|
|
434
|
-
* @param nodes 视频特效素材包路径数组
|
|
435
|
-
* @return <br>
|
|
436
|
-
* - 0:调用成功;
|
|
437
|
-
* - -1:调用失败。
|
|
438
|
-
*
|
|
439
|
-
*/
|
|
246
|
+
|
|
440
247
|
/** {en}
|
|
441
248
|
* @detail api
|
|
442
249
|
* @brief Sets the special effects you want to apply to the video. You can choose effects from ComposeMakeup.bundle.
|
|
@@ -452,17 +259,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
452
259
|
*
|
|
453
260
|
*/
|
|
454
261
|
setComposeNodes(nodes: Array<String>): int;
|
|
455
|
-
|
|
456
|
-
* @detail api
|
|
457
|
-
* @brief 在已有的视频特效组合上,叠加视频特效素材包,您可以调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合。
|
|
458
|
-
* @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
|
|
459
|
-
* @order 94
|
|
460
|
-
* @param nodes 视频特效素材包路径数组
|
|
461
|
-
* @return <br>
|
|
462
|
-
* - 0:调用成功;
|
|
463
|
-
* - -1:调用失败。
|
|
464
|
-
*
|
|
465
|
-
*/
|
|
262
|
+
|
|
466
263
|
/** {en}
|
|
467
264
|
* @detail api
|
|
468
265
|
* @brief Adds one or more effects to the existing effects settings that you have configured by calling setComposeNodes {@link #VeLiveVideoEffectManager#setComposeNodes}.
|
|
@@ -475,17 +272,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
475
272
|
*
|
|
476
273
|
*/
|
|
477
274
|
appendComposeNodes(nodes: Array<String>): int;
|
|
478
|
-
|
|
479
|
-
* @detail api
|
|
480
|
-
* @brief 调用本方法,可移除调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 和 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 设置的视频特效资源。
|
|
481
|
-
* @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
|
|
482
|
-
* @order 94
|
|
483
|
-
* @param nodes 视频特效素材包路径数组
|
|
484
|
-
* @return <br>
|
|
485
|
-
* - 0:调用成功;
|
|
486
|
-
* - -1:调用失败。
|
|
487
|
-
*
|
|
488
|
-
*/
|
|
275
|
+
|
|
489
276
|
/** {en}
|
|
490
277
|
* @detail api
|
|
491
278
|
* @brief Removes one or more special effects resource set by the [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) or [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) methods.
|
|
@@ -498,21 +285,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
498
285
|
*
|
|
499
286
|
*/
|
|
500
287
|
removeComposeNodes(nodes: Array<String>): int;
|
|
501
|
-
|
|
502
|
-
* @detail api
|
|
503
|
-
* @brief 设置视频特效强度。
|
|
504
|
-
* @notes <br>
|
|
505
|
-
* - 需要在调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合或调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 叠加视频特效素材包后,调用本方法;
|
|
506
|
-
* - 该方法仅适用于同时含有上述三个参数的特效资源,对于没有强度参数的特效(如贴纸),该方法无效。
|
|
507
|
-
* @order 95
|
|
508
|
-
* @param node 视频特效素材包路径
|
|
509
|
-
* @param key 需要设置的素材 key 名称
|
|
510
|
-
* @param intensity 需要设置的强度值。取值范围为 [0.0,1.0]
|
|
511
|
-
* @return <br>
|
|
512
|
-
* - 0:调用成功;
|
|
513
|
-
* - -1:调用失败。
|
|
514
|
-
*
|
|
515
|
-
*/
|
|
288
|
+
|
|
516
289
|
/** {en}
|
|
517
290
|
* @detail api
|
|
518
291
|
* @brief Sets the intensity of a special effect.
|
|
@@ -529,17 +302,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
529
302
|
*
|
|
530
303
|
*/
|
|
531
304
|
updateComposerNodeIntensity(node: String, key: String, intensity: float): int;
|
|
532
|
-
|
|
533
|
-
* @detail api
|
|
534
|
-
* @brief 设置颜色滤镜。
|
|
535
|
-
* @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法。
|
|
536
|
-
* @order 96
|
|
537
|
-
* @param path 滤镜资源包绝对路径
|
|
538
|
-
* @return <br>
|
|
539
|
-
* - 0:调用成功;
|
|
540
|
-
* - -1:调用失败。
|
|
541
|
-
*
|
|
542
|
-
*/
|
|
305
|
+
|
|
543
306
|
/** {en}
|
|
544
307
|
* @detail api
|
|
545
308
|
* @brief Sets the color filter.
|
|
@@ -553,16 +316,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
553
316
|
*
|
|
554
317
|
*/
|
|
555
318
|
setFilter(path: String): int;
|
|
556
|
-
|
|
557
|
-
* @detail api
|
|
558
|
-
* @brief 设置已启用的颜色滤镜强度。
|
|
559
|
-
* @notes <br>请在调用 [setFilter](#VeLiveVideoEffectManager-setfilter) 设置颜色滤镜后调用。
|
|
560
|
-
* @order 97
|
|
561
|
-
* @param intensity 滤镜强度,取值范围为 [0.0,1.0]。
|
|
562
|
-
* @return - 0:调用成功;
|
|
563
|
-
* - -1:调用失败。
|
|
564
|
-
*
|
|
565
|
-
*/
|
|
319
|
+
|
|
566
320
|
/** {en}
|
|
567
321
|
* @detail api
|
|
568
322
|
* @brief Sets the intensity of the color filter.
|
|
@@ -575,17 +329,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
575
329
|
*
|
|
576
330
|
*/
|
|
577
331
|
updateFilterIntensity(intensity: float): int;
|
|
578
|
-
|
|
579
|
-
* @detail api
|
|
580
|
-
* @brief 设置贴纸特效。
|
|
581
|
-
* @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法。
|
|
582
|
-
* @order 98
|
|
583
|
-
* @param path 贴纸素材包的绝对路径
|
|
584
|
-
* @return <br>
|
|
585
|
-
* - 0:调用成功;
|
|
586
|
-
* - -1:调用失败。
|
|
587
|
-
*
|
|
588
|
-
*/
|
|
332
|
+
|
|
589
333
|
/** {en}
|
|
590
334
|
* @detail api
|
|
591
335
|
* @brief Sets the sticker.
|
|
@@ -599,16 +343,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
599
343
|
*
|
|
600
344
|
*/
|
|
601
345
|
setSticker(path: String): int;
|
|
602
|
-
|
|
603
|
-
* @detail api
|
|
604
|
-
* @brief 智能美化特效的高级功能。
|
|
605
|
-
* @notes 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法,不要在主线程中频繁执行同步操作。
|
|
606
|
-
* @order 99
|
|
607
|
-
* @param callback 将 handle 作为参数的回调函数。
|
|
608
|
-
* @param isGLThread 是否在 GL 线程回调 callback。
|
|
609
|
-
* @param isAsync 是否同步执行 callback。
|
|
610
|
-
*
|
|
611
|
-
*/
|
|
346
|
+
|
|
612
347
|
/** {en}
|
|
613
348
|
* @detail api
|
|
614
349
|
* @brief Advanced functions of BytePlus Effects.
|
|
@@ -623,14 +358,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
623
358
|
setAdvancedFeature(callback: VeLiveVideoEffectHandleCallback, isGLThread: boolean, isAsync: boolean): int;
|
|
624
359
|
}
|
|
625
360
|
export declare class VeLivePusher {
|
|
626
|
-
|
|
627
|
-
* @detail api
|
|
628
|
-
* @hidden
|
|
629
|
-
* @brief 获取当前 SDK 版本号。
|
|
630
|
-
* @return <br>
|
|
631
|
-
* 当前 SDK 版本号。
|
|
632
|
-
*
|
|
633
|
-
*/
|
|
361
|
+
|
|
634
362
|
/** {en}
|
|
635
363
|
* @detail api
|
|
636
364
|
* @hidden
|
|
@@ -640,13 +368,7 @@ export declare class VeLivePusher {
|
|
|
640
368
|
*
|
|
641
369
|
*/
|
|
642
370
|
static getVersion(): String;
|
|
643
|
-
|
|
644
|
-
* @detail api
|
|
645
|
-
* @brief 设置输出到控制台的日志等级。
|
|
646
|
-
* @order 49
|
|
647
|
-
* @param logLevel 输出的日志级别。级别详情请参见 [VeLivePusherLogLevel](147521#VeLivePusherLogLevel)。
|
|
648
|
-
*
|
|
649
|
-
*/
|
|
371
|
+
|
|
650
372
|
/** {en}
|
|
651
373
|
* @detail api
|
|
652
374
|
* @brief Sets the level of the output log.
|
|
@@ -655,13 +377,7 @@ export declare class VeLivePusher {
|
|
|
655
377
|
*
|
|
656
378
|
*/
|
|
657
379
|
static setLogLevel(logLevel: VeLivePusherLogLevel): void;
|
|
658
|
-
|
|
659
|
-
* @detail api
|
|
660
|
-
* @brief 设置 OpenGL 的上下文。
|
|
661
|
-
* @order 50
|
|
662
|
-
* @param context OpenGL 上下文。
|
|
663
|
-
*
|
|
664
|
-
*/
|
|
380
|
+
|
|
665
381
|
/** {en}
|
|
666
382
|
* @detail api
|
|
667
383
|
* @brief Sets the context of OpenGL.
|
|
@@ -670,12 +386,7 @@ export declare class VeLivePusher {
|
|
|
670
386
|
*
|
|
671
387
|
*/
|
|
672
388
|
static setEGLContext(context: EGLContext): void;
|
|
673
|
-
|
|
674
|
-
* @detail api
|
|
675
|
-
* @brief 停止采集和推流,并销毁推流器。通常在调用 [stopPush](#VeLivePusher-stoppush) 结束推流后调用此方法进行清理。
|
|
676
|
-
* @order 4
|
|
677
|
-
*
|
|
678
|
-
*/
|
|
389
|
+
|
|
679
390
|
/** {en}
|
|
680
391
|
* @detail api
|
|
681
392
|
* @brief Stops capturing and pushing streams and destroys the pusher. Call this method after [stopPush](#VeLivePusher-stoppush) is called.
|
|
@@ -683,16 +394,7 @@ export declare class VeLivePusher {
|
|
|
683
394
|
*
|
|
684
395
|
*/
|
|
685
396
|
release(): void;
|
|
686
|
-
|
|
687
|
-
* @detail api
|
|
688
|
-
* @brief 设置推流器回调,通过设置回调,监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
|
|
689
|
-
* @notes <br>
|
|
690
|
-
* - 需要在创建推流引擎后,调用本方法;
|
|
691
|
-
* - 重复调用本方法,仅最后一次调用生效。
|
|
692
|
-
* @order 2
|
|
693
|
-
* @param observer 推流器回调对象,详细信息请参见 [VeLivePusherObserver](147519#VeLivePusherObserver)。
|
|
694
|
-
*
|
|
695
|
-
*/
|
|
397
|
+
|
|
696
398
|
/** {en}
|
|
697
399
|
* @detail api
|
|
698
400
|
* @brief Sets an observer to listen for live pusher events, including errors, statuses, network quality, device information, and first frame rendering.
|
|
@@ -704,17 +406,7 @@ export declare class VeLivePusher {
|
|
|
704
406
|
*
|
|
705
407
|
*/
|
|
706
408
|
setObserver(observer: VeLivePusherObserver): void;
|
|
707
|
-
|
|
708
|
-
* @detail api
|
|
709
|
-
* @brief 设置推流器周期性回调,用于定期获取推流状态信息。
|
|
710
|
-
* @notes <br>
|
|
711
|
-
* - 需要在创建推流引擎后,调用本方法;
|
|
712
|
-
* - 重复调用本方法,仅最后一次调用生效。
|
|
713
|
-
* @order 3
|
|
714
|
-
* @param observer 推流器周期性回调对象,详细信息请参见 [VeLivePusherStatisticsObserver](147519#VeLivePusherDef-VeLivePusherStatisticsObserver)。
|
|
715
|
-
* @param interval 周期性回调的时间间隔,单位为 s,默认值为 5。
|
|
716
|
-
*
|
|
717
|
-
*/
|
|
409
|
+
|
|
718
410
|
/** {en}
|
|
719
411
|
* @detail api
|
|
720
412
|
* @brief Sets an observer to periodically report push-stream statistics.
|
|
@@ -727,13 +419,7 @@ export declare class VeLivePusher {
|
|
|
727
419
|
*
|
|
728
420
|
*/
|
|
729
421
|
setStatisticsObserver(observer: VeLivePusherStatisticsObserver, interval: int): void;
|
|
730
|
-
|
|
731
|
-
* @detail api
|
|
732
|
-
* @brief 设置本地摄像头预览视图。摄像头采集到的画面,经过美颜、脸形调整、滤镜等多种效果叠加之后,最终会显示到传入的 View 上。
|
|
733
|
-
* @param view 摄像头预览视图
|
|
734
|
-
* @order 5
|
|
735
|
-
*
|
|
736
|
-
*/
|
|
422
|
+
|
|
737
423
|
/** {en}
|
|
738
424
|
* @detail api
|
|
739
425
|
* @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.
|
|
@@ -742,13 +428,7 @@ export declare class VeLivePusher {
|
|
|
742
428
|
*
|
|
743
429
|
*/
|
|
744
430
|
setRenderView(view: View): Promise<void>;
|
|
745
|
-
|
|
746
|
-
* @detail api
|
|
747
|
-
* @brief 设置本地预览画面的填充模式。
|
|
748
|
-
* @param mode 填充模式。
|
|
749
|
-
* @order 6
|
|
750
|
-
*
|
|
751
|
-
*/
|
|
431
|
+
|
|
752
432
|
/** {en}
|
|
753
433
|
* @detail api
|
|
754
434
|
* @brief Sets fill mode for the local camera preview.
|
|
@@ -757,18 +437,7 @@ export declare class VeLivePusher {
|
|
|
757
437
|
*
|
|
758
438
|
*/
|
|
759
439
|
setRenderFillMode(mode: VeLivePusherRenderMode): void;
|
|
760
|
-
|
|
761
|
-
* @detail api
|
|
762
|
-
* @brief 开启/关闭镜像。
|
|
763
|
-
* @notes <br>
|
|
764
|
-
* 用于配置视频镜像效果,影响采集、预览和推流画面。
|
|
765
|
-
* @order 7
|
|
766
|
-
* @param type 镜像类型,详细信息请参见 [VeLiveVideoMirrorType](147521#VeLiveVideoMirrorType)。
|
|
767
|
-
* @param mirror 是否开启镜像。<br>
|
|
768
|
-
* - true:开启;
|
|
769
|
-
* - false:关闭。
|
|
770
|
-
*
|
|
771
|
-
*/
|
|
440
|
+
|
|
772
441
|
/** {en}
|
|
773
442
|
* @detail api
|
|
774
443
|
* @brief Enables or disables mirroring for the local preview and the streamed video.
|
|
@@ -780,14 +449,7 @@ export declare class VeLivePusher {
|
|
|
780
449
|
*
|
|
781
450
|
*/
|
|
782
451
|
setVideoMirror(type: VeLiveVideoMirrorType, mirror: boolean): void;
|
|
783
|
-
|
|
784
|
-
* @detail api
|
|
785
|
-
* @brief 开始视频采集。
|
|
786
|
-
* @notes <br>调用该接口后,可以通过调用接口 [stopVideoCapture](#VeLivePusher-stopvideocapture) 停止视频采集。
|
|
787
|
-
* @order 8
|
|
788
|
-
* @param type 视频采集类型,详细信息请参见 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType}
|
|
789
|
-
*
|
|
790
|
-
*/
|
|
452
|
+
|
|
791
453
|
/** {en}
|
|
792
454
|
* @detail api
|
|
793
455
|
* @brief Starts video capture.
|
|
@@ -797,13 +459,7 @@ export declare class VeLivePusher {
|
|
|
797
459
|
*
|
|
798
460
|
*/
|
|
799
461
|
startVideoCapture(type: VeLiveVideoCaptureType): void;
|
|
800
|
-
|
|
801
|
-
* @detail api
|
|
802
|
-
* @brief 停止视频采集。
|
|
803
|
-
* @notes <br>调用该接口后,可以通过调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 开始视频采集。
|
|
804
|
-
* @order 10
|
|
805
|
-
*
|
|
806
|
-
*/
|
|
462
|
+
|
|
807
463
|
/** {en}
|
|
808
464
|
* @detail api
|
|
809
465
|
* @brief Stops video capture.
|
|
@@ -812,14 +468,7 @@ export declare class VeLivePusher {
|
|
|
812
468
|
*
|
|
813
469
|
*/
|
|
814
470
|
stopVideoCapture(): void;
|
|
815
|
-
|
|
816
|
-
* @detail api
|
|
817
|
-
* @brief 开始音频采集。
|
|
818
|
-
* @notes <br>调用该接口后,可以通过调用接口 [stopAudioCapture](#VeLivePusher-stopaudiocapture) 停止音频采集。
|
|
819
|
-
* @order 9
|
|
820
|
-
* @param type 音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
|
|
821
|
-
*
|
|
822
|
-
*/
|
|
471
|
+
|
|
823
472
|
/** {en}
|
|
824
473
|
* @detail api
|
|
825
474
|
* @brief Starts audio capture.
|
|
@@ -829,13 +478,7 @@ export declare class VeLivePusher {
|
|
|
829
478
|
*
|
|
830
479
|
*/
|
|
831
480
|
startAudioCapture(type: VeLiveAudioCaptureType): void;
|
|
832
|
-
|
|
833
|
-
* @detail api
|
|
834
|
-
* @brief 停止音频采集。
|
|
835
|
-
* @notes <br>调用该接口后,可以通过调用接口 [startAudioCapture](#VeLivePusher-startaudiocapture) 开始音频采集。
|
|
836
|
-
* @order 11
|
|
837
|
-
*
|
|
838
|
-
*/
|
|
481
|
+
|
|
839
482
|
/** {en}
|
|
840
483
|
* @detail api
|
|
841
484
|
* @brief Stops audio capture.
|
|
@@ -844,14 +487,7 @@ export declare class VeLivePusher {
|
|
|
844
487
|
*
|
|
845
488
|
*/
|
|
846
489
|
stopAudioCapture(): void;
|
|
847
|
-
|
|
848
|
-
* @detail api
|
|
849
|
-
* @brief 切换视频采集类型。
|
|
850
|
-
* @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
|
|
851
|
-
* @order 12
|
|
852
|
-
* @param type 视频采集类型,详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
|
|
853
|
-
*
|
|
854
|
-
*/
|
|
490
|
+
|
|
855
491
|
/** {en}
|
|
856
492
|
* @detail api
|
|
857
493
|
* @brief Switches the video capture type.
|
|
@@ -861,14 +497,7 @@ export declare class VeLivePusher {
|
|
|
861
497
|
*
|
|
862
498
|
*/
|
|
863
499
|
switchVideoCapture(type: VeLiveVideoCaptureType): void;
|
|
864
|
-
|
|
865
|
-
* @detail api
|
|
866
|
-
* @brief 切换音频采集类型。
|
|
867
|
-
* @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
|
|
868
|
-
* @order 13
|
|
869
|
-
* @param type 音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
|
|
870
|
-
*
|
|
871
|
-
*/
|
|
500
|
+
|
|
872
501
|
/** {en}
|
|
873
502
|
* @detail api
|
|
874
503
|
* @brief Switches audio capture type.
|
|
@@ -878,13 +507,7 @@ export declare class VeLivePusher {
|
|
|
878
507
|
*
|
|
879
508
|
*/
|
|
880
509
|
switchAudioCapture(type: VeLiveAudioCaptureType): void;
|
|
881
|
-
|
|
882
|
-
* @detail api
|
|
883
|
-
* @brief 获取当前视频采集类型。
|
|
884
|
-
* @order 14
|
|
885
|
-
* @return 视频采集类型,详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
|
|
886
|
-
*
|
|
887
|
-
*/
|
|
510
|
+
|
|
888
511
|
/** {en}
|
|
889
512
|
* @detail api
|
|
890
513
|
* @brief Gets the current video capture type.
|
|
@@ -893,13 +516,7 @@ export declare class VeLivePusher {
|
|
|
893
516
|
*
|
|
894
517
|
*/
|
|
895
518
|
getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
|
|
896
|
-
|
|
897
|
-
* @detail api
|
|
898
|
-
* @brief 获取当前音频采集类型。
|
|
899
|
-
* @order 15
|
|
900
|
-
* @return <br>音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
|
|
901
|
-
*
|
|
902
|
-
*/
|
|
519
|
+
|
|
903
520
|
/** {en}
|
|
904
521
|
* @detail api
|
|
905
522
|
* @brief Gets the current audio capture type.
|
|
@@ -908,13 +525,7 @@ export declare class VeLivePusher {
|
|
|
908
525
|
*
|
|
909
526
|
*/
|
|
910
527
|
getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
|
|
911
|
-
|
|
912
|
-
* @detail api
|
|
913
|
-
* @brief 自定义静态图,适用于静态图推流采集类型。使用该接口时,需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage,您可调用 [startVideoCapture](#VeLivePusher-startvideocapture) 方法,将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
|
|
914
|
-
* @order 16
|
|
915
|
-
* @param image 静态图片,用于在静态图推流采集类型下设置静态图。
|
|
916
|
-
*
|
|
917
|
-
*/
|
|
528
|
+
|
|
918
529
|
/** {en}
|
|
919
530
|
* @detail api
|
|
920
531
|
* @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`.
|
|
@@ -923,18 +534,7 @@ export declare class VeLivePusher {
|
|
|
923
534
|
*
|
|
924
535
|
*/
|
|
925
536
|
updateCustomImage(image: Bitmap): Promise<void>;
|
|
926
|
-
|
|
927
|
-
* @detail api
|
|
928
|
-
* @brief 获取相机设备管理对象 `VeLiveCameraDevice`。通过设备管理,您可以使用以下功能。
|
|
929
|
-
* - 控制闪光灯开关
|
|
930
|
-
* - 设置摄像头缩放比例
|
|
931
|
-
* - 设置自动对焦
|
|
932
|
-
* @notes <br>
|
|
933
|
-
* 该接口需要在 startVideoCapture{@link #startVideoCapture} 方法中设置 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。
|
|
934
|
-
* @order 17
|
|
935
|
-
* @return 相机设备管理对象 [VeLiveCameraDevice](#VeLiveCameraDevice)。
|
|
936
|
-
*
|
|
937
|
-
*/
|
|
537
|
+
|
|
938
538
|
/** {en}
|
|
939
539
|
* @detail api
|
|
940
540
|
* @brief Gets the camera manager. With the camera manager, you can do the following:
|
|
@@ -947,14 +547,7 @@ export declare class VeLivePusher {
|
|
|
947
547
|
*
|
|
948
548
|
*/
|
|
949
549
|
getCameraDevice(): VeLiveCameraDevice;
|
|
950
|
-
|
|
951
|
-
* @detail api
|
|
952
|
-
* @brief 设置推流视频编码参数。
|
|
953
|
-
* @notes 该接口可在推流开始前或开始后调用。
|
|
954
|
-
* @order 18
|
|
955
|
-
* @param config 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
|
|
956
|
-
*
|
|
957
|
-
*/
|
|
550
|
+
|
|
958
551
|
/** {en}
|
|
959
552
|
* @detail api
|
|
960
553
|
* @brief Sets video encoding parameters for the pushed stream.
|
|
@@ -964,13 +557,7 @@ export declare class VeLivePusher {
|
|
|
964
557
|
*
|
|
965
558
|
*/
|
|
966
559
|
setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
|
|
967
|
-
|
|
968
|
-
* @detail api
|
|
969
|
-
* @brief 获取推流视频编码参数。
|
|
970
|
-
* @order 19
|
|
971
|
-
* @return 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
|
|
972
|
-
*
|
|
973
|
-
*/
|
|
560
|
+
|
|
974
561
|
/** {en}
|
|
975
562
|
* @detail api
|
|
976
563
|
* @brief Gets video encoding parameters for the pushed stream.
|
|
@@ -979,14 +566,7 @@ export declare class VeLivePusher {
|
|
|
979
566
|
*
|
|
980
567
|
*/
|
|
981
568
|
getVideoEncoderConfiguration(): VeLiveVideoEncoderConfiguration;
|
|
982
|
-
|
|
983
|
-
* @detail api
|
|
984
|
-
* @brief 设置推流音频编码参数。
|
|
985
|
-
* @notes <br>该接口需要在 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之前调用。
|
|
986
|
-
* @order 20
|
|
987
|
-
* @param config 推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
|
|
988
|
-
*
|
|
989
|
-
*/
|
|
569
|
+
|
|
990
570
|
/** {en}
|
|
991
571
|
* @detail api
|
|
992
572
|
* @brief Sets audio encoding parameters for the pushed stream.
|
|
@@ -996,13 +576,7 @@ export declare class VeLivePusher {
|
|
|
996
576
|
*
|
|
997
577
|
*/
|
|
998
578
|
setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
|
|
999
|
-
|
|
1000
|
-
* @detail api
|
|
1001
|
-
* @brief 获取推流音频编码参数。
|
|
1002
|
-
* @order 21
|
|
1003
|
-
* @return 推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
|
|
1004
|
-
*
|
|
1005
|
-
*/
|
|
579
|
+
|
|
1006
580
|
/** {en}
|
|
1007
581
|
* @detail api
|
|
1008
582
|
* @brief Gets audio encoding parameters for the pushed stream.
|
|
@@ -1011,13 +585,7 @@ export declare class VeLivePusher {
|
|
|
1011
585
|
*
|
|
1012
586
|
*/
|
|
1013
587
|
getAudioEncoderConfiguration(): VeLiveAudioEncoderConfiguration;
|
|
1014
|
-
|
|
1015
|
-
* @detail api
|
|
1016
|
-
* @brief 开始推流。
|
|
1017
|
-
* @order 22
|
|
1018
|
-
* @param url 推流地址,用于将直播流推送到目标服务器。
|
|
1019
|
-
*
|
|
1020
|
-
*/
|
|
588
|
+
|
|
1021
589
|
/** {en}
|
|
1022
590
|
* @detail api
|
|
1023
591
|
* @brief Starts streaming.
|
|
@@ -1026,15 +594,7 @@ export declare class VeLivePusher {
|
|
|
1026
594
|
*
|
|
1027
595
|
*/
|
|
1028
596
|
startPush(url: String): void;
|
|
1029
|
-
|
|
1030
|
-
* @detail api
|
|
1031
|
-
* @brief 开始推流,支持备用推流地址。
|
|
1032
|
-
* @notes <br>
|
|
1033
|
-
* 当主推流地址不可用时,会自动切换到备用推流地址继续推流。
|
|
1034
|
-
* @order 23
|
|
1035
|
-
* @param urls 推流地址列表,包含一个或多个推流地址。
|
|
1036
|
-
*
|
|
1037
|
-
*/
|
|
597
|
+
|
|
1038
598
|
/** {en}
|
|
1039
599
|
* @detail api
|
|
1040
600
|
* @brief Starts streaming with one or more push stream addresses.
|
|
@@ -1045,13 +605,7 @@ export declare class VeLivePusher {
|
|
|
1045
605
|
*
|
|
1046
606
|
*/
|
|
1047
607
|
startPushWithUrls(urls: Array<String>): void;
|
|
1048
|
-
|
|
1049
|
-
* @detail api
|
|
1050
|
-
* @brief 停止推流。
|
|
1051
|
-
* @notes <br>停止推流后,可以通过调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法重新开始推流。
|
|
1052
|
-
* @order 24
|
|
1053
|
-
*
|
|
1054
|
-
*/
|
|
608
|
+
|
|
1055
609
|
/** {en}
|
|
1056
610
|
* @detail api
|
|
1057
611
|
* @brief Stops streaming.
|
|
@@ -1061,16 +615,7 @@ export declare class VeLivePusher {
|
|
|
1061
615
|
*
|
|
1062
616
|
*/
|
|
1063
617
|
stopPush(): void;
|
|
1064
|
-
|
|
1065
|
-
* @detail api
|
|
1066
|
-
* @brief 当前是否正在推流中,可用来查询推流器的当前状态。
|
|
1067
|
-
* @order 25
|
|
1068
|
-
* @return <br>
|
|
1069
|
-
* 是否正在推流。<br>
|
|
1070
|
-
* - true:正在推流中;
|
|
1071
|
-
* - false:已经停止推流。
|
|
1072
|
-
*
|
|
1073
|
-
*/
|
|
618
|
+
|
|
1074
619
|
/** {en}
|
|
1075
620
|
* @detail api
|
|
1076
621
|
* @brief Checks whether the streaming is currently ongoing. You can use this method to query the status of the live pusher.
|
|
@@ -1082,19 +627,7 @@ export declare class VeLivePusher {
|
|
|
1082
627
|
*
|
|
1083
628
|
*/
|
|
1084
629
|
isPushing(): boolean;
|
|
1085
|
-
|
|
1086
|
-
* @detail api
|
|
1087
|
-
* @brief 设置推流水印。
|
|
1088
|
-
* @order 26
|
|
1089
|
-
* @param image 水印图片。取值为 null 时,表示禁用水印。
|
|
1090
|
-
* @param x 水印的水平偏移量,即水印图片相对视频流左上角的横向偏移与视频流宽度的比值,取值范围为 [0.0,1.0]。
|
|
1091
|
-
* @param y 水印的垂直偏移量,即水印图片相对视频流左上角的纵向偏移与视频流高度的比值,取值范围为 [0.0,1.0]。
|
|
1092
|
-
* @param scale 水印图片的缩放比例,取值范围为 [0.0,1.0]。
|
|
1093
|
-
* @return <br>
|
|
1094
|
-
* - 0:水印设置成功;
|
|
1095
|
-
* - <0:水印设置失败。
|
|
1096
|
-
*
|
|
1097
|
-
*/
|
|
630
|
+
|
|
1098
631
|
/** {en}
|
|
1099
632
|
* @detail api
|
|
1100
633
|
* @brief Sets a watermark for the pushed stream.
|
|
@@ -1109,15 +642,7 @@ export declare class VeLivePusher {
|
|
|
1109
642
|
*
|
|
1110
643
|
*/
|
|
1111
644
|
setWatermark(image: Bitmap, x: float, y: float, scale: float): Promise<int>;
|
|
1112
|
-
|
|
1113
|
-
* @detail api
|
|
1114
|
-
* @brief 开始本地文件录制。
|
|
1115
|
-
* @order 27
|
|
1116
|
-
* @param path 录制文件保存路径,不能为空。
|
|
1117
|
-
* @param config 文件录制设置,详情请参见 [VeLiveFileRecorderConfiguration](147521#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
|
|
1118
|
-
* @param listener 本地文件录制的监听,详情请参见 [VeLiveFileRecordingListener](147519#VeLivePusherDef-VeLiveFileRecordingListener)。
|
|
1119
|
-
*
|
|
1120
|
-
*/
|
|
645
|
+
|
|
1121
646
|
/** {en}
|
|
1122
647
|
* @detail api
|
|
1123
648
|
* @brief Starts local recording.
|
|
@@ -1128,13 +653,7 @@ export declare class VeLivePusher {
|
|
|
1128
653
|
*
|
|
1129
654
|
*/
|
|
1130
655
|
startFileRecording(path: String, config: VeLiveFileRecorderConfiguration, listener: VeLiveFileRecordingListener): void;
|
|
1131
|
-
|
|
1132
|
-
* @detail api
|
|
1133
|
-
* @brief 停止本地文件录制。
|
|
1134
|
-
* @notes <br>该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording) 方法之后调用。
|
|
1135
|
-
* @order 28
|
|
1136
|
-
*
|
|
1137
|
-
*/
|
|
656
|
+
|
|
1138
657
|
/** {en}
|
|
1139
658
|
* @detail api
|
|
1140
659
|
* @brief Stops local recording.
|
|
@@ -1143,17 +662,7 @@ export declare class VeLivePusher {
|
|
|
1143
662
|
*
|
|
1144
663
|
*/
|
|
1145
664
|
stopFileRecording(): void;
|
|
1146
|
-
|
|
1147
|
-
* @detail api
|
|
1148
|
-
* @brief 高级配置。
|
|
1149
|
-
* @order 29
|
|
1150
|
-
* @param key 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Key。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
|
|
1151
|
-
* @param value 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Value。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
|
|
1152
|
-
* @return <br>
|
|
1153
|
-
* - 0:成功;
|
|
1154
|
-
* - -1:失败,参数错误。
|
|
1155
|
-
*
|
|
1156
|
-
*/
|
|
665
|
+
|
|
1157
666
|
/** {en}
|
|
1158
667
|
* @detail api
|
|
1159
668
|
* @brief Set advanced configurations. You can contact BytePlus technical support for more information about how to use this method.
|
|
@@ -1166,17 +675,7 @@ export declare class VeLivePusher {
|
|
|
1166
675
|
*
|
|
1167
676
|
*/
|
|
1168
677
|
setProperty(key: String, value: Object): int;
|
|
1169
|
-
|
|
1170
|
-
* @detail api
|
|
1171
|
-
* @brief 推送外部视频帧数据。
|
|
1172
|
-
* @notes <br>
|
|
1173
|
-
* 调用该接口时,需要将视频采集类型设置为 VeLiveVideoCaptureExternal,您可调用 startVideoCapture{@link #startVideoCapture} 方法,将 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 设置为 VeLiveVideoCaptureExternal。
|
|
1174
|
-
* @order 30
|
|
1175
|
-
* @param frame 视频帧的数据信息,详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
|
|
1176
|
-
* @return - 0:成功;
|
|
1177
|
-
* - <0:失败。
|
|
1178
|
-
*
|
|
1179
|
-
*/
|
|
678
|
+
|
|
1180
679
|
/** {en}
|
|
1181
680
|
* @detail api
|
|
1182
681
|
* @brief Pushes an external video frame.
|
|
@@ -1188,17 +687,7 @@ export declare class VeLivePusher {
|
|
|
1188
687
|
*
|
|
1189
688
|
*/
|
|
1190
689
|
pushExternalVideoFrame(frame: VeLiveVideoFrame): int;
|
|
1191
|
-
|
|
1192
|
-
* @detail api
|
|
1193
|
-
* @brief 推送外部音频帧数据。
|
|
1194
|
-
* @notes 该接口需要在 startAudioCapture 方法中设置 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureExternal。
|
|
1195
|
-
* @order 31
|
|
1196
|
-
* @param frame 外部音频数据。详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
|
|
1197
|
-
* @return <br>
|
|
1198
|
-
* - 0:成功;
|
|
1199
|
-
* - <0:失败。
|
|
1200
|
-
*
|
|
1201
|
-
*/
|
|
690
|
+
|
|
1202
691
|
/** {en}
|
|
1203
692
|
* @detail api
|
|
1204
693
|
* @brief Pushes an external audio frame.
|
|
@@ -1210,13 +699,7 @@ export declare class VeLivePusher {
|
|
|
1210
699
|
*
|
|
1211
700
|
*/
|
|
1212
701
|
pushExternalAudioFrame(frame: VeLiveAudioFrame): int;
|
|
1213
|
-
|
|
1214
|
-
* @detail api
|
|
1215
|
-
* @brief 设置推流视频帧朝向。默认为竖屏推流。
|
|
1216
|
-
* @order 32
|
|
1217
|
-
* @param orientation 视频帧朝向,详情请参见 [VeLiveOrientation](147521#VeLiveOrientation)。
|
|
1218
|
-
*
|
|
1219
|
-
*/
|
|
702
|
+
|
|
1220
703
|
/** {en}
|
|
1221
704
|
* @detail api
|
|
1222
705
|
* @brief Sets the orientation of the pushed video frame. The default orientation is portrait.
|
|
@@ -1225,25 +708,7 @@ export declare class VeLivePusher {
|
|
|
1225
708
|
*
|
|
1226
709
|
*/
|
|
1227
710
|
setOrientation(orientation: VeLiveOrientation): void;
|
|
1228
|
-
|
|
1229
|
-
* @detail api
|
|
1230
|
-
* @brief 通过视频帧发送 SEI 消息。
|
|
1231
|
-
* @notes <br>该接口需要在调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之后调用。
|
|
1232
|
-
* @order 33
|
|
1233
|
-
* @param key SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Key。
|
|
1234
|
-
* @param value SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Value。
|
|
1235
|
-
* @param repeat 消息发送重复的次数。例如,`repeat` 取值为 20,`isKeyFrame` 取值为 YES,则会在视频帧开始的连续 20 个关键帧中添加 SEI 消息。
|
|
1236
|
-
* @param isKeyFrame 是否仅在关键帧中包含 SEI 消息。<br>
|
|
1237
|
-
* - true:仅在关键帧中包含;
|
|
1238
|
-
* - false:所有帧中均包含。
|
|
1239
|
-
* @param allowsCovered 是否允许覆盖。<br>
|
|
1240
|
-
* - true:允许;
|
|
1241
|
-
* - false:不允许。
|
|
1242
|
-
* @return <br>
|
|
1243
|
-
* - 0:成功;
|
|
1244
|
-
* - <0:失败。
|
|
1245
|
-
*
|
|
1246
|
-
*/
|
|
711
|
+
|
|
1247
712
|
/** {en}
|
|
1248
713
|
* @detail api
|
|
1249
714
|
* @brief Sends an SEI message through the video frame. The SEI messages are strings in JSON format.
|
|
@@ -1264,15 +729,7 @@ export declare class VeLivePusher {
|
|
|
1264
729
|
*
|
|
1265
730
|
*/
|
|
1266
731
|
sendSeiMessage(key: String, value: Object, repeat: int, isKeyFrame: boolean, allowsCovered: boolean): int;
|
|
1267
|
-
|
|
1268
|
-
* @detail api
|
|
1269
|
-
* @brief 设置静音。
|
|
1270
|
-
* @param mute 是否设置为静音。默认为正常推流。<br>
|
|
1271
|
-
* - true:静音推流;
|
|
1272
|
-
* - false:正常推流。
|
|
1273
|
-
* @order 34
|
|
1274
|
-
*
|
|
1275
|
-
*/
|
|
732
|
+
|
|
1276
733
|
/** {en}
|
|
1277
734
|
* @detail api
|
|
1278
735
|
* @brief Sets whether to mute the stream.
|
|
@@ -1283,15 +740,7 @@ export declare class VeLivePusher {
|
|
|
1283
740
|
*
|
|
1284
741
|
*/
|
|
1285
742
|
setMute(mute: boolean): void;
|
|
1286
|
-
|
|
1287
|
-
* @detail api
|
|
1288
|
-
* @brief 当前是否是静音状态。
|
|
1289
|
-
* @order 35
|
|
1290
|
-
* @return <br>
|
|
1291
|
-
* - true:当前是静音状态;
|
|
1292
|
-
* - false:当前非静音状态。
|
|
1293
|
-
*
|
|
1294
|
-
*/
|
|
743
|
+
|
|
1295
744
|
/** {en}
|
|
1296
745
|
* @detail api
|
|
1297
746
|
* @brief Checks whether the stream is muted.
|
|
@@ -1302,19 +751,7 @@ export declare class VeLivePusher {
|
|
|
1302
751
|
*
|
|
1303
752
|
*/
|
|
1304
753
|
isMute(): boolean;
|
|
1305
|
-
|
|
1306
|
-
* @detail api
|
|
1307
|
-
* @brief 获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理,您可以使用以下功能。
|
|
1308
|
-
* - 设置美颜
|
|
1309
|
-
* - 设置特效
|
|
1310
|
-
* - 设置素材
|
|
1311
|
-
* - 设置贴图
|
|
1312
|
-
* - 设置滤镜
|
|
1313
|
-
* @notes 该接口需要集成智能美化特效 SDK 后才能使用。
|
|
1314
|
-
* @order 36
|
|
1315
|
-
* @return 视频特效管理对象 [VeLiveVideoEffectManager](#VeLiveVideoEffectManager)。
|
|
1316
|
-
*
|
|
1317
|
-
*/
|
|
754
|
+
|
|
1318
755
|
/** {en}
|
|
1319
756
|
* @detail api
|
|
1320
757
|
* @brief Gets the special effects manager. With the special effects manager, you can do the following:
|
|
@@ -1329,13 +766,7 @@ export declare class VeLivePusher {
|
|
|
1329
766
|
*
|
|
1330
767
|
*/
|
|
1331
768
|
getVideoEffectManager(): VeLiveVideoEffectManager;
|
|
1332
|
-
|
|
1333
|
-
* @detail api
|
|
1334
|
-
* @brief 自定义视频处理。
|
|
1335
|
-
* @order 37
|
|
1336
|
-
* @param filter 视频数据处理回调,详情请参见 [VeLiveVideoFrameFilter](147519#VeLivePusherDef-VeLiveVideoFrameFilter)。
|
|
1337
|
-
*
|
|
1338
|
-
*/
|
|
769
|
+
|
|
1339
770
|
/** {en}
|
|
1340
771
|
* @detail api
|
|
1341
772
|
* @brief Sets custom video processing.
|
|
@@ -1344,15 +775,7 @@ export declare class VeLivePusher {
|
|
|
1344
775
|
*
|
|
1345
776
|
*/
|
|
1346
777
|
setVideoFrameFilter(filter: VeLiveVideoFrameFilter): void;
|
|
1347
|
-
|
|
1348
|
-
* @detail api
|
|
1349
|
-
* @brief 获取音频模块管理对象。
|
|
1350
|
-
* @notes <br>
|
|
1351
|
-
* 该接口需要在 startAudioCapture{@link #startAudioCapture} 方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureMicrophone。
|
|
1352
|
-
* @order 38
|
|
1353
|
-
* @return 音频模块管理对象 [VeLiveAudioDevice](#VeLiveAudioDevice)。
|
|
1354
|
-
*
|
|
1355
|
-
*/
|
|
778
|
+
|
|
1356
779
|
/** {en}
|
|
1357
780
|
* @detail api
|
|
1358
781
|
* @brief Gets the audio device manager.
|
|
@@ -1362,13 +785,7 @@ export declare class VeLivePusher {
|
|
|
1362
785
|
*
|
|
1363
786
|
*/
|
|
1364
787
|
getAudioDevice(): VeLiveAudioDevice;
|
|
1365
|
-
|
|
1366
|
-
* @detail api
|
|
1367
|
-
* @brief 自定义音频处理。
|
|
1368
|
-
* @order 39
|
|
1369
|
-
* @param filter 音频帧滤镜对象 VeLiveAudioFrameFilter 。
|
|
1370
|
-
*
|
|
1371
|
-
*/
|
|
788
|
+
|
|
1372
789
|
/** {en}
|
|
1373
790
|
* @detail api
|
|
1374
791
|
* @brief Sets custom audio processing.
|
|
@@ -1377,13 +794,7 @@ export declare class VeLivePusher {
|
|
|
1377
794
|
*
|
|
1378
795
|
*/
|
|
1379
796
|
setAudioFrameFilter(filter: VeLiveAudioFrameFilter): void;
|
|
1380
|
-
|
|
1381
|
-
* @detail api
|
|
1382
|
-
* @brief 创建播放器。
|
|
1383
|
-
* @order 1
|
|
1384
|
-
* @return 播放器管理对象 [VeLiveMediaPlayer](#VeLiveMediaPlayer)。
|
|
1385
|
-
*
|
|
1386
|
-
*/
|
|
797
|
+
|
|
1387
798
|
/** {en}
|
|
1388
799
|
* @detail api
|
|
1389
800
|
* @brief Creates the media player.
|
|
@@ -1392,12 +803,7 @@ export declare class VeLivePusher {
|
|
|
1392
803
|
*
|
|
1393
804
|
*/
|
|
1394
805
|
createPlayer(): VeLiveMediaPlayer;
|
|
1395
|
-
|
|
1396
|
-
* @detail api
|
|
1397
|
-
* @brief 开始系统音频采集。
|
|
1398
|
-
* @order 41
|
|
1399
|
-
*
|
|
1400
|
-
*/
|
|
806
|
+
|
|
1401
807
|
/** {en}
|
|
1402
808
|
* @detail api
|
|
1403
809
|
* @brief Starts system audio capture.
|
|
@@ -1405,12 +811,7 @@ export declare class VeLivePusher {
|
|
|
1405
811
|
*
|
|
1406
812
|
*/
|
|
1407
813
|
startMixSystemAudio(): void;
|
|
1408
|
-
|
|
1409
|
-
* @detail api
|
|
1410
|
-
* @brief 停止系统音频采集。
|
|
1411
|
-
* @order 42
|
|
1412
|
-
*
|
|
1413
|
-
*/
|
|
814
|
+
|
|
1414
815
|
/** {en}
|
|
1415
816
|
* @detail api
|
|
1416
817
|
* @brief Stops system audio capture.
|
|
@@ -1418,12 +819,7 @@ export declare class VeLivePusher {
|
|
|
1418
819
|
*
|
|
1419
820
|
*/
|
|
1420
821
|
stopMixSystemAudio(): void;
|
|
1421
|
-
|
|
1422
|
-
* @detail api
|
|
1423
|
-
* @brief 获取当前是否处于屏幕采集状态。
|
|
1424
|
-
* @order 43
|
|
1425
|
-
*
|
|
1426
|
-
*/
|
|
822
|
+
|
|
1427
823
|
/** {en}
|
|
1428
824
|
* @detail api
|
|
1429
825
|
* @brief Gets whether the SDK is capturing the screen at this moment.
|
|
@@ -1431,16 +827,7 @@ export declare class VeLivePusher {
|
|
|
1431
827
|
*
|
|
1432
828
|
*/
|
|
1433
829
|
isScreenRecording(): boolean;
|
|
1434
|
-
|
|
1435
|
-
* @detail api
|
|
1436
|
-
* @brief 添加视频帧的监听回调,用于获取推流器输出的视频帧。
|
|
1437
|
-
* @order 44
|
|
1438
|
-
* @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
|
|
1439
|
-
* @return <br>
|
|
1440
|
-
* - 0:成功;
|
|
1441
|
-
* - <0:失败。
|
|
1442
|
-
*
|
|
1443
|
-
*/
|
|
830
|
+
|
|
1444
831
|
/** {en}
|
|
1445
832
|
* @detail api
|
|
1446
833
|
* @brief Adds a video frame listener.
|
|
@@ -1452,18 +839,7 @@ export declare class VeLivePusher {
|
|
|
1452
839
|
*
|
|
1453
840
|
*/
|
|
1454
841
|
addVideoFrameListener(listener: VeLiveVideoFrameListener): int;
|
|
1455
|
-
|
|
1456
|
-
* @detail api
|
|
1457
|
-
* @brief 移除已添加的视频帧监听回调。
|
|
1458
|
-
* @notes <br>
|
|
1459
|
-
* 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
|
|
1460
|
-
* @order 45
|
|
1461
|
-
* @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
|
|
1462
|
-
* @return <br>
|
|
1463
|
-
* - 0:成功;
|
|
1464
|
-
* - <0:失败。
|
|
1465
|
-
*
|
|
1466
|
-
*/
|
|
842
|
+
|
|
1467
843
|
/** {en}
|
|
1468
844
|
* @detail api
|
|
1469
845
|
* @brief Removes the video frame listener.
|
|
@@ -1477,16 +853,7 @@ export declare class VeLivePusher {
|
|
|
1477
853
|
*
|
|
1478
854
|
*/
|
|
1479
855
|
removeVideoFrameListener(listener: VeLiveVideoFrameListener): int;
|
|
1480
|
-
|
|
1481
|
-
* @detail api
|
|
1482
|
-
* @brief 添加音频帧的监听回调,用于获取推流器输出的音频帧。
|
|
1483
|
-
* @order 46
|
|
1484
|
-
* @param listener 音频帧监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
|
|
1485
|
-
* @return <br>
|
|
1486
|
-
* - 0:成功;
|
|
1487
|
-
* - <0:失败。
|
|
1488
|
-
*
|
|
1489
|
-
*/
|
|
856
|
+
|
|
1490
857
|
/** {en}
|
|
1491
858
|
* @detail api
|
|
1492
859
|
* @brief Adds an audio frame listener.
|
|
@@ -1498,18 +865,7 @@ export declare class VeLivePusher {
|
|
|
1498
865
|
*
|
|
1499
866
|
*/
|
|
1500
867
|
addAudioFrameListener(listener: VeLiveAudioFrameListener): int;
|
|
1501
|
-
|
|
1502
|
-
* @detail api
|
|
1503
|
-
* @brief 移除已添加的音频帧监听回调。
|
|
1504
|
-
* @notes <br>
|
|
1505
|
-
* 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
|
|
1506
|
-
* @order 47
|
|
1507
|
-
* @param listener 音频帧的监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
|
|
1508
|
-
* @return <br>
|
|
1509
|
-
* - 0:成功;
|
|
1510
|
-
* - <0:失败。
|
|
1511
|
-
*
|
|
1512
|
-
*/
|
|
868
|
+
|
|
1513
869
|
/** {en}
|
|
1514
870
|
* @detail api
|
|
1515
871
|
* @brief Removes the audio frame listener.
|
|
@@ -1523,13 +879,7 @@ export declare class VeLivePusher {
|
|
|
1523
879
|
*
|
|
1524
880
|
*/
|
|
1525
881
|
removeAudioFrameListener(listener: VeLiveAudioFrameListener): int;
|
|
1526
|
-
|
|
1527
|
-
* @detail api
|
|
1528
|
-
* @brief 视频截图。
|
|
1529
|
-
* @order 48
|
|
1530
|
-
* @param listener 截图监听对象,详情请参见 [VeLiveSnapshotListener](147519#VeLivePusherDef-VeLiveSnapshotListener)。
|
|
1531
|
-
*
|
|
1532
|
-
*/
|
|
882
|
+
|
|
1533
883
|
/** {en}
|
|
1534
884
|
* @detail api
|
|
1535
885
|
* @brief Takes a screenshot.
|
|
@@ -1540,12 +890,7 @@ export declare class VeLivePusher {
|
|
|
1540
890
|
snapshot(listener: VeLiveSnapshotListener): void;
|
|
1541
891
|
}
|
|
1542
892
|
export declare class VeLiveMediaPlayer {
|
|
1543
|
-
|
|
1544
|
-
* @detail api
|
|
1545
|
-
* @brief 销毁播放器实例。
|
|
1546
|
-
* @order 1
|
|
1547
|
-
*
|
|
1548
|
-
*/
|
|
893
|
+
|
|
1549
894
|
/** {en}
|
|
1550
895
|
* @detail api
|
|
1551
896
|
* @brief Destroys the media player instance.
|
|
@@ -1553,15 +898,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1553
898
|
*
|
|
1554
899
|
*/
|
|
1555
900
|
release(): void;
|
|
1556
|
-
|
|
1557
|
-
* @detail api
|
|
1558
|
-
* @brief 设置播放状态的监听。
|
|
1559
|
-
* @notes <br>
|
|
1560
|
-
* 重复调用本方法,仅最后一次调用生效。
|
|
1561
|
-
* @order 4
|
|
1562
|
-
* @param listener 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](147519#VeLivePusherDef-VeLiveMediaPlayerListener)。
|
|
1563
|
-
*
|
|
1564
|
-
*/
|
|
901
|
+
|
|
1565
902
|
/** {en}
|
|
1566
903
|
* @detail api
|
|
1567
904
|
* @brief Sets the observer for playback statuses.
|
|
@@ -1572,16 +909,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1572
909
|
*
|
|
1573
910
|
*/
|
|
1574
911
|
setListener(listener: VeLiveMediaPlayerListener): void;
|
|
1575
|
-
|
|
1576
|
-
* @detail api
|
|
1577
|
-
* @brief 设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
|
|
1578
|
-
* @order 2
|
|
1579
|
-
* @param url 文件路径。
|
|
1580
|
-
* @return <br>
|
|
1581
|
-
* - 0:成功;
|
|
1582
|
-
* - ≠0:失败。
|
|
1583
|
-
*
|
|
1584
|
-
*/
|
|
912
|
+
|
|
1585
913
|
/** {en}
|
|
1586
914
|
* @detail api
|
|
1587
915
|
* @brief Sets the file path. Supported file formats include MP3, AAC, M4A, WAV.
|
|
@@ -1593,14 +921,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1593
921
|
*
|
|
1594
922
|
*/
|
|
1595
923
|
prepare(url: String): int;
|
|
1596
|
-
|
|
1597
|
-
* @detail api
|
|
1598
|
-
* @brief 开始播放。
|
|
1599
|
-
* @notes <br>
|
|
1600
|
-
* 需要在调用 start{@link #start} 开始播放后,调用本方法。
|
|
1601
|
-
* @order 12
|
|
1602
|
-
*
|
|
1603
|
-
*/
|
|
924
|
+
|
|
1604
925
|
/** {en}
|
|
1605
926
|
* @detail api
|
|
1606
927
|
* @brief Start playback.
|
|
@@ -1610,17 +931,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1610
931
|
*
|
|
1611
932
|
*/
|
|
1612
933
|
start(): int;
|
|
1613
|
-
|
|
1614
|
-
* @detail api
|
|
1615
|
-
* @brief 停止播放。
|
|
1616
|
-
* @notes <br>
|
|
1617
|
-
* 需要在调用 start{@link #start} 开始播放后,调用本方法。
|
|
1618
|
-
* @order 13
|
|
1619
|
-
* @return <br>
|
|
1620
|
-
* - 0:成功;
|
|
1621
|
-
* - ≠0:失败。
|
|
1622
|
-
*
|
|
1623
|
-
*/
|
|
934
|
+
|
|
1624
935
|
/** {en}
|
|
1625
936
|
* @detail api
|
|
1626
937
|
* @brief Stops playback.
|
|
@@ -1633,13 +944,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1633
944
|
*
|
|
1634
945
|
*/
|
|
1635
946
|
stop(): int;
|
|
1636
|
-
|
|
1637
|
-
* @detail api
|
|
1638
|
-
* @brief 暂停播放。
|
|
1639
|
-
* @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start)[start](#VeLiveMediaPlayer-start) 开始播放后,调用本方法。
|
|
1640
|
-
* @order 14
|
|
1641
|
-
*
|
|
1642
|
-
*/
|
|
947
|
+
|
|
1643
948
|
/** {en}
|
|
1644
949
|
* @detail api
|
|
1645
950
|
* @brief Pauses playback.
|
|
@@ -1649,13 +954,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1649
954
|
*
|
|
1650
955
|
*/
|
|
1651
956
|
pause(): void;
|
|
1652
|
-
|
|
1653
|
-
* @detail api
|
|
1654
|
-
* @brief 恢复播放。
|
|
1655
|
-
* @notes <br>需要在调用 [pause](#VeLiveMediaPlayer-pause) 暂停播放后,调用本方法。
|
|
1656
|
-
* @order 15
|
|
1657
|
-
*
|
|
1658
|
-
*/
|
|
957
|
+
|
|
1659
958
|
/** {en}
|
|
1660
959
|
* @detail api
|
|
1661
960
|
* @brief Resumes playback.
|
|
@@ -1664,16 +963,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1664
963
|
*
|
|
1665
964
|
*/
|
|
1666
965
|
resume(): void;
|
|
1667
|
-
|
|
1668
|
-
* @detail api
|
|
1669
|
-
* @brief 获取文件的总时长,单位为 ms。
|
|
1670
|
-
* @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后,调用本方法。
|
|
1671
|
-
* @order 3
|
|
1672
|
-
* @return <br>
|
|
1673
|
-
* - >0:成功,音频文件时长;
|
|
1674
|
-
* - ≤0:失败。
|
|
1675
|
-
*
|
|
1676
|
-
*/
|
|
966
|
+
|
|
1677
967
|
/** {en}
|
|
1678
968
|
* @detail api
|
|
1679
969
|
* @brief Gets the duration of the media file.
|
|
@@ -1685,16 +975,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1685
975
|
*
|
|
1686
976
|
*/
|
|
1687
977
|
getDuration(): long;
|
|
1688
|
-
|
|
1689
|
-
* @detail api
|
|
1690
|
-
* @brief 设置播放进度。
|
|
1691
|
-
* @order 5
|
|
1692
|
-
* @param posMs 播放时间,单位为 ms。
|
|
1693
|
-
* @return <br>
|
|
1694
|
-
* - 0:成功;
|
|
1695
|
-
* - ≠0:失败。
|
|
1696
|
-
*
|
|
1697
|
-
*/
|
|
978
|
+
|
|
1698
979
|
/** {en}
|
|
1699
980
|
* @detail api
|
|
1700
981
|
* @brief Sets the playback progress.
|
|
@@ -1706,15 +987,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1706
987
|
*
|
|
1707
988
|
*/
|
|
1708
989
|
seek(posMs: long): int;
|
|
1709
|
-
|
|
1710
|
-
* @detail api
|
|
1711
|
-
* @brief 开启/关闭音频是否混音到直播流。
|
|
1712
|
-
* @param enable 开启/关闭,默认为 false。 <br>
|
|
1713
|
-
* - ture:开启;
|
|
1714
|
-
* - false:关闭。
|
|
1715
|
-
* @order 6
|
|
1716
|
-
*
|
|
1717
|
-
*/
|
|
990
|
+
|
|
1718
991
|
/** {en}
|
|
1719
992
|
* @detail api
|
|
1720
993
|
* @brief Enables or disables mixing the audio to the live stream.
|
|
@@ -1725,14 +998,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1725
998
|
*
|
|
1726
999
|
*/
|
|
1727
1000
|
enableMixer(enable: boolean): void;
|
|
1728
|
-
|
|
1729
|
-
* @detail api
|
|
1730
|
-
* @brief 开启/关闭自动音量均衡。
|
|
1731
|
-
* @order 7
|
|
1732
|
-
* @param sourceLufs 源响度。
|
|
1733
|
-
* @param targetLufs 目标响度。
|
|
1734
|
-
*
|
|
1735
|
-
*/
|
|
1001
|
+
|
|
1736
1002
|
/** {en}
|
|
1737
1003
|
* @detail api
|
|
1738
1004
|
* @brief Enables or disables automatic volume equalization.
|
|
@@ -1742,15 +1008,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1742
1008
|
*
|
|
1743
1009
|
*/
|
|
1744
1010
|
enableAutoEq(sourceLufs: float, targetLufs: float): void;
|
|
1745
|
-
|
|
1746
|
-
* @detail api
|
|
1747
|
-
* @brief 设置音视频帧回调的监听。
|
|
1748
|
-
* @notes <br>
|
|
1749
|
-
* 重复调用本方法,仅最后一次调用生效。
|
|
1750
|
-
* @order 8
|
|
1751
|
-
* @param listener 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](147519#VeLivePusherDef-VeLiveMediaPlayerFrameListener)。
|
|
1752
|
-
*
|
|
1753
|
-
*/
|
|
1011
|
+
|
|
1754
1012
|
/** {en}
|
|
1755
1013
|
* @detail api
|
|
1756
1014
|
* @brief Sets the observer for audio and video frames.
|
|
@@ -1761,13 +1019,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1761
1019
|
*
|
|
1762
1020
|
*/
|
|
1763
1021
|
setFrameListener(listener: VeLiveMediaPlayerFrameListener): void;
|
|
1764
|
-
|
|
1765
|
-
* @detail api
|
|
1766
|
-
* @brief 设置播放音频的音量。
|
|
1767
|
-
* @order 9
|
|
1768
|
-
* @param volume 播放音频音量,取值范围为 [0.0,4.0]。
|
|
1769
|
-
*
|
|
1770
|
-
*/
|
|
1022
|
+
|
|
1771
1023
|
/** {en}
|
|
1772
1024
|
* @detail api
|
|
1773
1025
|
* @brief Sets the playback volume.
|
|
@@ -1776,14 +1028,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1776
1028
|
*
|
|
1777
1029
|
*/
|
|
1778
1030
|
setBGMVolume(volume: float): void;
|
|
1779
|
-
|
|
1780
|
-
* @detail api
|
|
1781
|
-
* @brief 设置音频采集音量。
|
|
1782
|
-
* @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放背景音乐后,调用本方法。
|
|
1783
|
-
* @order 10
|
|
1784
|
-
* @param volume 音频采集音量,取值范围为 [0.0,4.0]。
|
|
1785
|
-
*
|
|
1786
|
-
*/
|
|
1031
|
+
|
|
1787
1032
|
/** {en}
|
|
1788
1033
|
* @detail api
|
|
1789
1034
|
* @brief Sets the audio capture volume.
|
|
@@ -1793,15 +1038,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1793
1038
|
*
|
|
1794
1039
|
*/
|
|
1795
1040
|
setVoiceVolume(volume: float): void;
|
|
1796
|
-
|
|
1797
|
-
* @detail api
|
|
1798
|
-
* @brief 设置是否循环播放。
|
|
1799
|
-
* @param loop 是否循环播放。默认为 false。<br>
|
|
1800
|
-
* - true:循环播放;
|
|
1801
|
-
* - false:不循环播放。
|
|
1802
|
-
* @order 11
|
|
1803
|
-
*
|
|
1804
|
-
*/
|
|
1041
|
+
|
|
1805
1042
|
/** {en}
|
|
1806
1043
|
* @detail api
|
|
1807
1044
|
* @brief Sets whether to loop the video.
|
|
@@ -1814,13 +1051,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1814
1051
|
enableBGMLoop(loop: boolean): void;
|
|
1815
1052
|
}
|
|
1816
1053
|
export declare class VeLiveAudioDevice {
|
|
1817
|
-
|
|
1818
|
-
* @detail api
|
|
1819
|
-
* @brief 设置音量响度。
|
|
1820
|
-
* @order 74
|
|
1821
|
-
* @param level 音量响度等级,取值范围为 [0.0,4.0]。
|
|
1822
|
-
*
|
|
1823
|
-
*/
|
|
1054
|
+
|
|
1824
1055
|
/** {en}
|
|
1825
1056
|
* @detail api
|
|
1826
1057
|
* @brief Sets the volume.
|
|
@@ -1829,14 +1060,7 @@ export declare class VeLiveAudioDevice {
|
|
|
1829
1060
|
*
|
|
1830
1061
|
*/
|
|
1831
1062
|
setVoiceLoudness(level: float): void;
|
|
1832
|
-
|
|
1833
|
-
* @detail api
|
|
1834
|
-
* @brief 获取当前音量响度。
|
|
1835
|
-
* @order 75
|
|
1836
|
-
* @return <br>
|
|
1837
|
-
* 当前音量响度等级。
|
|
1838
|
-
*
|
|
1839
|
-
*/
|
|
1063
|
+
|
|
1840
1064
|
/** {en}
|
|
1841
1065
|
* @detail api
|
|
1842
1066
|
* @brief Gets the current volume.
|