@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
|
@@ -3,20 +3,9 @@ import * as $p_i from '../ios/index';
|
|
|
3
3
|
import { VeLivePusherObserver, VeLivePusherStatisticsObserver, VeLiveFileRecordingListener, VeLiveVideoFrameFilter, VeLiveAudioFrameFilter, VeLiveVideoFrameListener, VeLiveAudioFrameListener, VeLiveSnapshotListener, VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener } from './callback';
|
|
4
4
|
import { VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveOrientation, VeLivePusherLogLevel, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveVideoFrame, VeLiveAudioFrame, VeLiveVideoCaptureConfiguration, VeLiveVideoEffectLicenseConfiguration } from './keytype';
|
|
5
5
|
import { View, Bitmap } from './types';
|
|
6
|
-
|
|
7
|
-
* @detail api
|
|
8
|
-
* @brief 直播推流器。
|
|
9
|
-
*/
|
|
6
|
+
|
|
10
7
|
export declare class VeLivePusher {
|
|
11
|
-
|
|
12
|
-
* @platform android
|
|
13
|
-
* @detail api
|
|
14
|
-
* @hidden
|
|
15
|
-
* @brief 获取当前 SDK 版本号。
|
|
16
|
-
* @return <br>
|
|
17
|
-
* 当前 SDK 版本号。
|
|
18
|
-
*
|
|
19
|
-
*/
|
|
8
|
+
|
|
20
9
|
/** {en}
|
|
21
10
|
* @platform android
|
|
22
11
|
* @detail api
|
|
@@ -27,13 +16,7 @@ export declare class VeLivePusher {
|
|
|
27
16
|
*
|
|
28
17
|
*/
|
|
29
18
|
static android_getVersion(): string;
|
|
30
|
-
|
|
31
|
-
* @detail api
|
|
32
|
-
* @brief 设置输出到控制台的日志等级。
|
|
33
|
-
* @order 49
|
|
34
|
-
* @param logLevel 输出的日志级别。级别详情请参见 [VeLivePusherLogLevel](147521#VeLivePusherLogLevel)。
|
|
35
|
-
*
|
|
36
|
-
*/
|
|
19
|
+
|
|
37
20
|
/** {en}
|
|
38
21
|
* @detail api
|
|
39
22
|
* @brief Sets the level of the output log.
|
|
@@ -42,14 +25,7 @@ export declare class VeLivePusher {
|
|
|
42
25
|
*
|
|
43
26
|
*/
|
|
44
27
|
static setLogLevel(logLevel: VeLivePusherLogLevel): void;
|
|
45
|
-
|
|
46
|
-
* @platform android
|
|
47
|
-
* @detail api
|
|
48
|
-
* @brief 设置 OpenGL 的上下文。
|
|
49
|
-
* @order 50
|
|
50
|
-
* @param context OpenGL 上下文。
|
|
51
|
-
*
|
|
52
|
-
*/
|
|
28
|
+
|
|
53
29
|
/** {en}
|
|
54
30
|
* @platform android
|
|
55
31
|
* @detail api
|
|
@@ -62,12 +38,7 @@ export declare class VeLivePusher {
|
|
|
62
38
|
protected _instance: any;
|
|
63
39
|
protected __init(...args: any[]): void;
|
|
64
40
|
protected __new_instance(...args: any[]): any;
|
|
65
|
-
|
|
66
|
-
* @detail api
|
|
67
|
-
* @brief 停止采集和推流,并销毁推流器。通常在调用 [stopPush](#VeLivePusher-stoppush) 结束推流后调用此方法进行清理。
|
|
68
|
-
* @order 4
|
|
69
|
-
*
|
|
70
|
-
*/
|
|
41
|
+
|
|
71
42
|
/** {en}
|
|
72
43
|
* @detail api
|
|
73
44
|
* @brief Stops capturing and pushing streams and destroys the pusher. Call this method after [stopPush](#VeLivePusher-stoppush) is called.
|
|
@@ -75,16 +46,7 @@ export declare class VeLivePusher {
|
|
|
75
46
|
*
|
|
76
47
|
*/
|
|
77
48
|
destroy(): void;
|
|
78
|
-
|
|
79
|
-
* @detail api
|
|
80
|
-
* @brief 设置推流器回调,通过设置回调,监听推流器的推流错误、状态、网络质量、设备、首帧等回调事件。
|
|
81
|
-
* @notes <br>
|
|
82
|
-
* - 需要在创建推流引擎后,调用本方法;
|
|
83
|
-
* - 重复调用本方法,仅最后一次调用生效。
|
|
84
|
-
* @order 2
|
|
85
|
-
* @param observer 推流器回调对象,详细信息请参见 [VeLivePusherObserver](147519#VeLivePusherObserver)。
|
|
86
|
-
*
|
|
87
|
-
*/
|
|
49
|
+
|
|
88
50
|
/** {en}
|
|
89
51
|
* @detail api
|
|
90
52
|
* @brief Sets an observer to listen for live pusher events, including errors, statuses, network quality, device information, and first frame rendering.
|
|
@@ -96,17 +58,7 @@ export declare class VeLivePusher {
|
|
|
96
58
|
*
|
|
97
59
|
*/
|
|
98
60
|
setObserver(observer: VeLivePusherObserver): void;
|
|
99
|
-
|
|
100
|
-
* @detail api
|
|
101
|
-
* @brief 设置推流器周期性回调,用于定期获取推流状态信息。
|
|
102
|
-
* @notes <br>
|
|
103
|
-
* - 需要在创建推流引擎后,调用本方法;
|
|
104
|
-
* - 重复调用本方法,仅最后一次调用生效。
|
|
105
|
-
* @order 3
|
|
106
|
-
* @param observer 推流器周期性回调对象,详细信息请参见 [VeLivePusherStatisticsObserver](147519#VeLivePusherDef-VeLivePusherStatisticsObserver)。
|
|
107
|
-
* @param interval 周期性回调的时间间隔,单位为 s,默认值为 5。
|
|
108
|
-
*
|
|
109
|
-
*/
|
|
61
|
+
|
|
110
62
|
/** {en}
|
|
111
63
|
* @detail api
|
|
112
64
|
* @brief Sets an observer to periodically report push-stream statistics.
|
|
@@ -119,13 +71,7 @@ export declare class VeLivePusher {
|
|
|
119
71
|
*
|
|
120
72
|
*/
|
|
121
73
|
setStatisticsObserver(observer: VeLivePusherStatisticsObserver, interval: number): void;
|
|
122
|
-
|
|
123
|
-
* @detail api
|
|
124
|
-
* @brief 设置本地摄像头预览视图。摄像头采集到的画面,经过美颜、脸形调整、滤镜等多种效果叠加之后,最终会显示到传入的 View 上。
|
|
125
|
-
* @param view 摄像头预览视图
|
|
126
|
-
* @order 5
|
|
127
|
-
*
|
|
128
|
-
*/
|
|
74
|
+
|
|
129
75
|
/** {en}
|
|
130
76
|
* @detail api
|
|
131
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.
|
|
@@ -134,13 +80,7 @@ export declare class VeLivePusher {
|
|
|
134
80
|
*
|
|
135
81
|
*/
|
|
136
82
|
setRenderView(view: View): Promise<void>;
|
|
137
|
-
|
|
138
|
-
* @detail api
|
|
139
|
-
* @brief 设置本地预览画面的填充模式。
|
|
140
|
-
* @param mode 填充模式。
|
|
141
|
-
* @order 6
|
|
142
|
-
*
|
|
143
|
-
*/
|
|
83
|
+
|
|
144
84
|
/** {en}
|
|
145
85
|
* @detail api
|
|
146
86
|
* @brief Sets fill mode for the local camera preview.
|
|
@@ -149,18 +89,7 @@ export declare class VeLivePusher {
|
|
|
149
89
|
*
|
|
150
90
|
*/
|
|
151
91
|
setRenderFillMode(mode: VeLivePusherRenderMode): void;
|
|
152
|
-
|
|
153
|
-
* @detail api
|
|
154
|
-
* @brief 开启/关闭镜像。
|
|
155
|
-
* @notes <br>
|
|
156
|
-
* 用于配置视频镜像效果,影响采集、预览和推流画面。
|
|
157
|
-
* @order 7
|
|
158
|
-
* @param type 镜像类型,详细信息请参见 [VeLiveVideoMirrorType](147521#VeLiveVideoMirrorType)。
|
|
159
|
-
* @param mirror 是否开启镜像。<br>
|
|
160
|
-
* - true:开启;
|
|
161
|
-
* - false:关闭。
|
|
162
|
-
*
|
|
163
|
-
*/
|
|
92
|
+
|
|
164
93
|
/** {en}
|
|
165
94
|
* @detail api
|
|
166
95
|
* @brief Enables or disables mirroring for the local preview and the streamed video.
|
|
@@ -172,14 +101,7 @@ export declare class VeLivePusher {
|
|
|
172
101
|
*
|
|
173
102
|
*/
|
|
174
103
|
setVideoMirror(type: VeLiveVideoMirrorType, mirror: boolean): void;
|
|
175
|
-
|
|
176
|
-
* @detail api
|
|
177
|
-
* @brief 开始视频采集。
|
|
178
|
-
* @notes <br>调用该接口后,可以通过调用接口 [stopVideoCapture](#VeLivePusher-stopvideocapture) 停止视频采集。
|
|
179
|
-
* @order 8
|
|
180
|
-
* @param type 视频采集类型,详细信息请参见 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType}
|
|
181
|
-
*
|
|
182
|
-
*/
|
|
104
|
+
|
|
183
105
|
/** {en}
|
|
184
106
|
* @detail api
|
|
185
107
|
* @brief Starts video capture.
|
|
@@ -189,13 +111,7 @@ export declare class VeLivePusher {
|
|
|
189
111
|
*
|
|
190
112
|
*/
|
|
191
113
|
startVideoCapture(type: VeLiveVideoCaptureType): void;
|
|
192
|
-
|
|
193
|
-
* @detail api
|
|
194
|
-
* @brief 停止视频采集。
|
|
195
|
-
* @notes <br>调用该接口后,可以通过调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 开始视频采集。
|
|
196
|
-
* @order 10
|
|
197
|
-
*
|
|
198
|
-
*/
|
|
114
|
+
|
|
199
115
|
/** {en}
|
|
200
116
|
* @detail api
|
|
201
117
|
* @brief Stops video capture.
|
|
@@ -204,14 +120,7 @@ export declare class VeLivePusher {
|
|
|
204
120
|
*
|
|
205
121
|
*/
|
|
206
122
|
stopVideoCapture(): void;
|
|
207
|
-
|
|
208
|
-
* @detail api
|
|
209
|
-
* @brief 开始音频采集。
|
|
210
|
-
* @notes <br>调用该接口后,可以通过调用接口 [stopAudioCapture](#VeLivePusher-stopaudiocapture) 停止音频采集。
|
|
211
|
-
* @order 9
|
|
212
|
-
* @param type 音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
|
|
213
|
-
*
|
|
214
|
-
*/
|
|
123
|
+
|
|
215
124
|
/** {en}
|
|
216
125
|
* @detail api
|
|
217
126
|
* @brief Starts audio capture.
|
|
@@ -221,13 +130,7 @@ export declare class VeLivePusher {
|
|
|
221
130
|
*
|
|
222
131
|
*/
|
|
223
132
|
startAudioCapture(type: VeLiveAudioCaptureType): void;
|
|
224
|
-
|
|
225
|
-
* @detail api
|
|
226
|
-
* @brief 停止音频采集。
|
|
227
|
-
* @notes <br>调用该接口后,可以通过调用接口 [startAudioCapture](#VeLivePusher-startaudiocapture) 开始音频采集。
|
|
228
|
-
* @order 11
|
|
229
|
-
*
|
|
230
|
-
*/
|
|
133
|
+
|
|
231
134
|
/** {en}
|
|
232
135
|
* @detail api
|
|
233
136
|
* @brief Stops audio capture.
|
|
@@ -236,14 +139,7 @@ export declare class VeLivePusher {
|
|
|
236
139
|
*
|
|
237
140
|
*/
|
|
238
141
|
stopAudioCapture(): void;
|
|
239
|
-
|
|
240
|
-
* @detail api
|
|
241
|
-
* @brief 切换视频采集类型。
|
|
242
|
-
* @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
|
|
243
|
-
* @order 12
|
|
244
|
-
* @param type 视频采集类型,详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
|
|
245
|
-
*
|
|
246
|
-
*/
|
|
142
|
+
|
|
247
143
|
/** {en}
|
|
248
144
|
* @detail api
|
|
249
145
|
* @brief Switches the video capture type.
|
|
@@ -253,14 +149,7 @@ export declare class VeLivePusher {
|
|
|
253
149
|
*
|
|
254
150
|
*/
|
|
255
151
|
switchVideoCapture(type: VeLiveVideoCaptureType): void;
|
|
256
|
-
|
|
257
|
-
* @detail api
|
|
258
|
-
* @brief 切换音频采集类型。
|
|
259
|
-
* @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
|
|
260
|
-
* @order 13
|
|
261
|
-
* @param type 音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
|
|
262
|
-
*
|
|
263
|
-
*/
|
|
152
|
+
|
|
264
153
|
/** {en}
|
|
265
154
|
* @detail api
|
|
266
155
|
* @brief Switches audio capture type.
|
|
@@ -270,13 +159,7 @@ export declare class VeLivePusher {
|
|
|
270
159
|
*
|
|
271
160
|
*/
|
|
272
161
|
switchAudioCapture(type: VeLiveAudioCaptureType): void;
|
|
273
|
-
|
|
274
|
-
* @detail api
|
|
275
|
-
* @brief 获取当前视频采集类型。
|
|
276
|
-
* @order 14
|
|
277
|
-
* @return 视频采集类型,详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
|
|
278
|
-
*
|
|
279
|
-
*/
|
|
162
|
+
|
|
280
163
|
/** {en}
|
|
281
164
|
* @detail api
|
|
282
165
|
* @brief Gets the current video capture type.
|
|
@@ -285,13 +168,7 @@ export declare class VeLivePusher {
|
|
|
285
168
|
*
|
|
286
169
|
*/
|
|
287
170
|
getCurrentVideoCaptureType(): VeLiveVideoCaptureType;
|
|
288
|
-
|
|
289
|
-
* @detail api
|
|
290
|
-
* @brief 获取当前音频采集类型。
|
|
291
|
-
* @order 15
|
|
292
|
-
* @return <br>音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
|
|
293
|
-
*
|
|
294
|
-
*/
|
|
171
|
+
|
|
295
172
|
/** {en}
|
|
296
173
|
* @detail api
|
|
297
174
|
* @brief Gets the current audio capture type.
|
|
@@ -300,13 +177,7 @@ export declare class VeLivePusher {
|
|
|
300
177
|
*
|
|
301
178
|
*/
|
|
302
179
|
getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
|
|
303
|
-
|
|
304
|
-
* @detail api
|
|
305
|
-
* @brief 自定义静态图,适用于静态图推流采集类型。使用该接口时,需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage,您可调用 [startVideoCapture](#VeLivePusher-startvideocapture) 方法,将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
|
|
306
|
-
* @order 16
|
|
307
|
-
* @param image 静态图片,用于在静态图推流采集类型下设置静态图。
|
|
308
|
-
*
|
|
309
|
-
*/
|
|
180
|
+
|
|
310
181
|
/** {en}
|
|
311
182
|
* @detail api
|
|
312
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`.
|
|
@@ -315,18 +186,7 @@ export declare class VeLivePusher {
|
|
|
315
186
|
*
|
|
316
187
|
*/
|
|
317
188
|
updateCustomImage(image: Bitmap): Promise<void>;
|
|
318
|
-
|
|
319
|
-
* @detail api
|
|
320
|
-
* @brief 获取相机设备管理对象 `VeLiveCameraDevice`。通过设备管理,您可以使用以下功能。
|
|
321
|
-
* - 控制闪光灯开关
|
|
322
|
-
* - 设置摄像头缩放比例
|
|
323
|
-
* - 设置自动对焦
|
|
324
|
-
* @notes <br>
|
|
325
|
-
* 该接口需要在 startVideoCapture{@link #startVideoCapture} 方法中设置 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。
|
|
326
|
-
* @order 17
|
|
327
|
-
* @return 相机设备管理对象 [VeLiveCameraDevice](#VeLiveCameraDevice)。
|
|
328
|
-
*
|
|
329
|
-
*/
|
|
189
|
+
|
|
330
190
|
/** {en}
|
|
331
191
|
* @detail api
|
|
332
192
|
* @brief Gets the camera manager. With the camera manager, you can do the following:
|
|
@@ -339,14 +199,7 @@ export declare class VeLivePusher {
|
|
|
339
199
|
*
|
|
340
200
|
*/
|
|
341
201
|
getCameraDevice(): VeLiveCameraDevice;
|
|
342
|
-
|
|
343
|
-
* @detail api
|
|
344
|
-
* @brief 设置推流视频编码参数。
|
|
345
|
-
* @notes 该接口可在推流开始前或开始后调用。
|
|
346
|
-
* @order 18
|
|
347
|
-
* @param config 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
|
|
348
|
-
*
|
|
349
|
-
*/
|
|
202
|
+
|
|
350
203
|
/** {en}
|
|
351
204
|
* @detail api
|
|
352
205
|
* @brief Sets video encoding parameters for the pushed stream.
|
|
@@ -356,14 +209,7 @@ export declare class VeLivePusher {
|
|
|
356
209
|
*
|
|
357
210
|
*/
|
|
358
211
|
setVideoEncoderConfiguration(config: VeLiveVideoEncoderConfiguration): void;
|
|
359
|
-
|
|
360
|
-
* @platform android
|
|
361
|
-
* @detail api
|
|
362
|
-
* @brief 获取推流视频编码参数。
|
|
363
|
-
* @order 19
|
|
364
|
-
* @return 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
|
|
365
|
-
*
|
|
366
|
-
*/
|
|
212
|
+
|
|
367
213
|
/** {en}
|
|
368
214
|
* @platform android
|
|
369
215
|
* @detail api
|
|
@@ -373,14 +219,7 @@ export declare class VeLivePusher {
|
|
|
373
219
|
*
|
|
374
220
|
*/
|
|
375
221
|
android_getVideoEncoderConfiguration(): $p_a.VeLiveVideoEncoderConfiguration;
|
|
376
|
-
|
|
377
|
-
* @detail api
|
|
378
|
-
* @brief 设置推流音频编码参数。
|
|
379
|
-
* @notes <br>该接口需要在 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之前调用。
|
|
380
|
-
* @order 20
|
|
381
|
-
* @param config 推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
|
|
382
|
-
*
|
|
383
|
-
*/
|
|
222
|
+
|
|
384
223
|
/** {en}
|
|
385
224
|
* @detail api
|
|
386
225
|
* @brief Sets audio encoding parameters for the pushed stream.
|
|
@@ -390,14 +229,7 @@ export declare class VeLivePusher {
|
|
|
390
229
|
*
|
|
391
230
|
*/
|
|
392
231
|
setAudioEncoderConfiguration(config: VeLiveAudioEncoderConfiguration): void;
|
|
393
|
-
|
|
394
|
-
* @platform android
|
|
395
|
-
* @detail api
|
|
396
|
-
* @brief 获取推流音频编码参数。
|
|
397
|
-
* @order 21
|
|
398
|
-
* @return 推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
|
|
399
|
-
*
|
|
400
|
-
*/
|
|
232
|
+
|
|
401
233
|
/** {en}
|
|
402
234
|
* @platform android
|
|
403
235
|
* @detail api
|
|
@@ -407,13 +239,7 @@ export declare class VeLivePusher {
|
|
|
407
239
|
*
|
|
408
240
|
*/
|
|
409
241
|
android_getAudioEncoderConfiguration(): $p_a.VeLiveAudioEncoderConfiguration;
|
|
410
|
-
|
|
411
|
-
* @detail api
|
|
412
|
-
* @brief 开始推流。
|
|
413
|
-
* @order 22
|
|
414
|
-
* @param url 推流地址,用于将直播流推送到目标服务器。
|
|
415
|
-
*
|
|
416
|
-
*/
|
|
242
|
+
|
|
417
243
|
/** {en}
|
|
418
244
|
* @detail api
|
|
419
245
|
* @brief Starts streaming.
|
|
@@ -422,15 +248,7 @@ export declare class VeLivePusher {
|
|
|
422
248
|
*
|
|
423
249
|
*/
|
|
424
250
|
startPush(url: string): void;
|
|
425
|
-
|
|
426
|
-
* @detail api
|
|
427
|
-
* @brief 开始推流,支持备用推流地址。
|
|
428
|
-
* @notes <br>
|
|
429
|
-
* 当主推流地址不可用时,会自动切换到备用推流地址继续推流。
|
|
430
|
-
* @order 23
|
|
431
|
-
* @param urls 推流地址列表,包含一个或多个推流地址。
|
|
432
|
-
*
|
|
433
|
-
*/
|
|
251
|
+
|
|
434
252
|
/** {en}
|
|
435
253
|
* @detail api
|
|
436
254
|
* @brief Starts streaming with one or more push stream addresses.
|
|
@@ -441,13 +259,7 @@ export declare class VeLivePusher {
|
|
|
441
259
|
*
|
|
442
260
|
*/
|
|
443
261
|
startPushWithUrls(urls: Array<string>): void;
|
|
444
|
-
|
|
445
|
-
* @detail api
|
|
446
|
-
* @brief 停止推流。
|
|
447
|
-
* @notes <br>停止推流后,可以通过调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法重新开始推流。
|
|
448
|
-
* @order 24
|
|
449
|
-
*
|
|
450
|
-
*/
|
|
262
|
+
|
|
451
263
|
/** {en}
|
|
452
264
|
* @detail api
|
|
453
265
|
* @brief Stops streaming.
|
|
@@ -457,16 +269,7 @@ export declare class VeLivePusher {
|
|
|
457
269
|
*
|
|
458
270
|
*/
|
|
459
271
|
stopPush(): void;
|
|
460
|
-
|
|
461
|
-
* @detail api
|
|
462
|
-
* @brief 当前是否正在推流中,可用来查询推流器的当前状态。
|
|
463
|
-
* @order 25
|
|
464
|
-
* @return <br>
|
|
465
|
-
* 是否正在推流。<br>
|
|
466
|
-
* - true:正在推流中;
|
|
467
|
-
* - false:已经停止推流。
|
|
468
|
-
*
|
|
469
|
-
*/
|
|
272
|
+
|
|
470
273
|
/** {en}
|
|
471
274
|
* @detail api
|
|
472
275
|
* @brief Checks whether the streaming is currently ongoing. You can use this method to query the status of the live pusher.
|
|
@@ -478,19 +281,7 @@ export declare class VeLivePusher {
|
|
|
478
281
|
*
|
|
479
282
|
*/
|
|
480
283
|
isPushing(): boolean;
|
|
481
|
-
|
|
482
|
-
* @detail api
|
|
483
|
-
* @brief 设置推流水印。
|
|
484
|
-
* @order 26
|
|
485
|
-
* @param image 水印图片。取值为 null 时,表示禁用水印。
|
|
486
|
-
* @param x 水印的水平偏移量,即水印图片相对视频流左上角的横向偏移与视频流宽度的比值,取值范围为 [0.0,1.0]。
|
|
487
|
-
* @param y 水印的垂直偏移量,即水印图片相对视频流左上角的纵向偏移与视频流高度的比值,取值范围为 [0.0,1.0]。
|
|
488
|
-
* @param scale 水印图片的缩放比例,取值范围为 [0.0,1.0]。
|
|
489
|
-
* @return <br>
|
|
490
|
-
* - 0:水印设置成功;
|
|
491
|
-
* - <0:水印设置失败。
|
|
492
|
-
*
|
|
493
|
-
*/
|
|
284
|
+
|
|
494
285
|
/** {en}
|
|
495
286
|
* @detail api
|
|
496
287
|
* @brief Sets a watermark for the pushed stream.
|
|
@@ -505,15 +296,7 @@ export declare class VeLivePusher {
|
|
|
505
296
|
*
|
|
506
297
|
*/
|
|
507
298
|
setWatermark(image: Bitmap, x: number, y: number, scale: number): Promise<number>;
|
|
508
|
-
|
|
509
|
-
* @detail api
|
|
510
|
-
* @brief 开始本地文件录制。
|
|
511
|
-
* @order 27
|
|
512
|
-
* @param path 录制文件保存路径,不能为空。
|
|
513
|
-
* @param config 文件录制设置,详情请参见 [VeLiveFileRecorderConfiguration](147521#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
|
|
514
|
-
* @param listener 本地文件录制的监听,详情请参见 [VeLiveFileRecordingListener](147519#VeLivePusherDef-VeLiveFileRecordingListener)。
|
|
515
|
-
*
|
|
516
|
-
*/
|
|
299
|
+
|
|
517
300
|
/** {en}
|
|
518
301
|
* @detail api
|
|
519
302
|
* @brief Starts local recording.
|
|
@@ -524,13 +307,7 @@ export declare class VeLivePusher {
|
|
|
524
307
|
*
|
|
525
308
|
*/
|
|
526
309
|
startFileRecording(path: string, config: VeLiveFileRecorderConfiguration, listener: VeLiveFileRecordingListener): void;
|
|
527
|
-
|
|
528
|
-
* @detail api
|
|
529
|
-
* @brief 停止本地文件录制。
|
|
530
|
-
* @notes <br>该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording) 方法之后调用。
|
|
531
|
-
* @order 28
|
|
532
|
-
*
|
|
533
|
-
*/
|
|
310
|
+
|
|
534
311
|
/** {en}
|
|
535
312
|
* @detail api
|
|
536
313
|
* @brief Stops local recording.
|
|
@@ -539,17 +316,7 @@ export declare class VeLivePusher {
|
|
|
539
316
|
*
|
|
540
317
|
*/
|
|
541
318
|
stopFileRecording(): void;
|
|
542
|
-
|
|
543
|
-
* @detail api
|
|
544
|
-
* @brief 高级配置。
|
|
545
|
-
* @order 29
|
|
546
|
-
* @param key 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Key。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
|
|
547
|
-
* @param value 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Value。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
|
|
548
|
-
* @return <br>
|
|
549
|
-
* - 0:成功;
|
|
550
|
-
* - -1:失败,参数错误。
|
|
551
|
-
*
|
|
552
|
-
*/
|
|
319
|
+
|
|
553
320
|
/** {en}
|
|
554
321
|
* @detail api
|
|
555
322
|
* @brief Set advanced configurations. You can contact BytePlus technical support for more information about how to use this method.
|
|
@@ -562,17 +329,7 @@ export declare class VeLivePusher {
|
|
|
562
329
|
*
|
|
563
330
|
*/
|
|
564
331
|
setProperty(key: string, value: Object): number;
|
|
565
|
-
|
|
566
|
-
* @detail api
|
|
567
|
-
* @brief 推送外部视频帧数据。
|
|
568
|
-
* @notes <br>
|
|
569
|
-
* 调用该接口时,需要将视频采集类型设置为 VeLiveVideoCaptureExternal,您可调用 startVideoCapture{@link #startVideoCapture} 方法,将 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 设置为 VeLiveVideoCaptureExternal。
|
|
570
|
-
* @order 30
|
|
571
|
-
* @param frame 视频帧的数据信息,详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
|
|
572
|
-
* @return - 0:成功;
|
|
573
|
-
* - <0:失败。
|
|
574
|
-
*
|
|
575
|
-
*/
|
|
332
|
+
|
|
576
333
|
/** {en}
|
|
577
334
|
* @detail api
|
|
578
335
|
* @brief Pushes an external video frame.
|
|
@@ -584,17 +341,7 @@ export declare class VeLivePusher {
|
|
|
584
341
|
*
|
|
585
342
|
*/
|
|
586
343
|
pushExternalVideoFrame(frame: VeLiveVideoFrame): number;
|
|
587
|
-
|
|
588
|
-
* @detail api
|
|
589
|
-
* @brief 推送外部音频帧数据。
|
|
590
|
-
* @notes 该接口需要在 startAudioCapture 方法中设置 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureExternal。
|
|
591
|
-
* @order 31
|
|
592
|
-
* @param frame 外部音频数据。详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
|
|
593
|
-
* @return <br>
|
|
594
|
-
* - 0:成功;
|
|
595
|
-
* - <0:失败。
|
|
596
|
-
*
|
|
597
|
-
*/
|
|
344
|
+
|
|
598
345
|
/** {en}
|
|
599
346
|
* @detail api
|
|
600
347
|
* @brief Pushes an external audio frame.
|
|
@@ -606,13 +353,7 @@ export declare class VeLivePusher {
|
|
|
606
353
|
*
|
|
607
354
|
*/
|
|
608
355
|
pushExternalAudioFrame(frame: VeLiveAudioFrame): number;
|
|
609
|
-
|
|
610
|
-
* @detail api
|
|
611
|
-
* @brief 设置推流视频帧朝向。默认为竖屏推流。
|
|
612
|
-
* @order 32
|
|
613
|
-
* @param orientation 视频帧朝向,详情请参见 [VeLiveOrientation](147521#VeLiveOrientation)。
|
|
614
|
-
*
|
|
615
|
-
*/
|
|
356
|
+
|
|
616
357
|
/** {en}
|
|
617
358
|
* @detail api
|
|
618
359
|
* @brief Sets the orientation of the pushed video frame. The default orientation is portrait.
|
|
@@ -621,25 +362,7 @@ export declare class VeLivePusher {
|
|
|
621
362
|
*
|
|
622
363
|
*/
|
|
623
364
|
setOrientation(orientation: VeLiveOrientation): void;
|
|
624
|
-
|
|
625
|
-
* @detail api
|
|
626
|
-
* @brief 通过视频帧发送 SEI 消息。
|
|
627
|
-
* @notes <br>该接口需要在调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之后调用。
|
|
628
|
-
* @order 33
|
|
629
|
-
* @param key SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Key。
|
|
630
|
-
* @param value SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Value。
|
|
631
|
-
* @param repeat 消息发送重复的次数。例如,`repeat` 取值为 20,`isKeyFrame` 取值为 YES,则会在视频帧开始的连续 20 个关键帧中添加 SEI 消息。
|
|
632
|
-
* @param isKeyFrame 是否仅在关键帧中包含 SEI 消息。<br>
|
|
633
|
-
* - true:仅在关键帧中包含;
|
|
634
|
-
* - false:所有帧中均包含。
|
|
635
|
-
* @param allowsCovered 是否允许覆盖。<br>
|
|
636
|
-
* - true:允许;
|
|
637
|
-
* - false:不允许。
|
|
638
|
-
* @return <br>
|
|
639
|
-
* - 0:成功;
|
|
640
|
-
* - <0:失败。
|
|
641
|
-
*
|
|
642
|
-
*/
|
|
365
|
+
|
|
643
366
|
/** {en}
|
|
644
367
|
* @detail api
|
|
645
368
|
* @brief Sends an SEI message through the video frame. The SEI messages are strings in JSON format.
|
|
@@ -660,15 +383,7 @@ export declare class VeLivePusher {
|
|
|
660
383
|
*
|
|
661
384
|
*/
|
|
662
385
|
sendSeiMessage(key: string, value: Object, repeat: number, isKeyFrame: boolean, allowsCovered: boolean): number;
|
|
663
|
-
|
|
664
|
-
* @detail api
|
|
665
|
-
* @brief 设置静音。
|
|
666
|
-
* @param mute 是否设置为静音。默认为正常推流。<br>
|
|
667
|
-
* - true:静音推流;
|
|
668
|
-
* - false:正常推流。
|
|
669
|
-
* @order 34
|
|
670
|
-
*
|
|
671
|
-
*/
|
|
386
|
+
|
|
672
387
|
/** {en}
|
|
673
388
|
* @detail api
|
|
674
389
|
* @brief Sets whether to mute the stream.
|
|
@@ -679,15 +394,7 @@ export declare class VeLivePusher {
|
|
|
679
394
|
*
|
|
680
395
|
*/
|
|
681
396
|
setMute(mute: boolean): void;
|
|
682
|
-
|
|
683
|
-
* @detail api
|
|
684
|
-
* @brief 当前是否是静音状态。
|
|
685
|
-
* @order 35
|
|
686
|
-
* @return <br>
|
|
687
|
-
* - true:当前是静音状态;
|
|
688
|
-
* - false:当前非静音状态。
|
|
689
|
-
*
|
|
690
|
-
*/
|
|
397
|
+
|
|
691
398
|
/** {en}
|
|
692
399
|
* @detail api
|
|
693
400
|
* @brief Checks whether the stream is muted.
|
|
@@ -698,19 +405,7 @@ export declare class VeLivePusher {
|
|
|
698
405
|
*
|
|
699
406
|
*/
|
|
700
407
|
isMute(): boolean;
|
|
701
|
-
|
|
702
|
-
* @detail api
|
|
703
|
-
* @brief 获取视频特效管理对象 `VeLiveVideoEffectManager`。通过视频特效管理,您可以使用以下功能。
|
|
704
|
-
* - 设置美颜
|
|
705
|
-
* - 设置特效
|
|
706
|
-
* - 设置素材
|
|
707
|
-
* - 设置贴图
|
|
708
|
-
* - 设置滤镜
|
|
709
|
-
* @notes 该接口需要集成智能美化特效 SDK 后才能使用。
|
|
710
|
-
* @order 36
|
|
711
|
-
* @return 视频特效管理对象 [VeLiveVideoEffectManager](#VeLiveVideoEffectManager)。
|
|
712
|
-
*
|
|
713
|
-
*/
|
|
408
|
+
|
|
714
409
|
/** {en}
|
|
715
410
|
* @detail api
|
|
716
411
|
* @brief Gets the special effects manager. With the special effects manager, you can do the following:
|
|
@@ -725,13 +420,7 @@ export declare class VeLivePusher {
|
|
|
725
420
|
*
|
|
726
421
|
*/
|
|
727
422
|
getVideoEffectManager(): VeLiveVideoEffectManager;
|
|
728
|
-
|
|
729
|
-
* @detail api
|
|
730
|
-
* @brief 自定义视频处理。
|
|
731
|
-
* @order 37
|
|
732
|
-
* @param filter 视频数据处理回调,详情请参见 [VeLiveVideoFrameFilter](147519#VeLivePusherDef-VeLiveVideoFrameFilter)。
|
|
733
|
-
*
|
|
734
|
-
*/
|
|
423
|
+
|
|
735
424
|
/** {en}
|
|
736
425
|
* @detail api
|
|
737
426
|
* @brief Sets custom video processing.
|
|
@@ -740,15 +429,7 @@ export declare class VeLivePusher {
|
|
|
740
429
|
*
|
|
741
430
|
*/
|
|
742
431
|
setVideoFrameFilter(filter: VeLiveVideoFrameFilter): void;
|
|
743
|
-
|
|
744
|
-
* @detail api
|
|
745
|
-
* @brief 获取音频模块管理对象。
|
|
746
|
-
* @notes <br>
|
|
747
|
-
* 该接口需要在 startAudioCapture{@link #startAudioCapture} 方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureMicrophone。
|
|
748
|
-
* @order 38
|
|
749
|
-
* @return 音频模块管理对象 [VeLiveAudioDevice](#VeLiveAudioDevice)。
|
|
750
|
-
*
|
|
751
|
-
*/
|
|
432
|
+
|
|
752
433
|
/** {en}
|
|
753
434
|
* @detail api
|
|
754
435
|
* @brief Gets the audio device manager.
|
|
@@ -758,13 +439,7 @@ export declare class VeLivePusher {
|
|
|
758
439
|
*
|
|
759
440
|
*/
|
|
760
441
|
getAudioDevice(): VeLiveAudioDevice;
|
|
761
|
-
|
|
762
|
-
* @detail api
|
|
763
|
-
* @brief 自定义音频处理。
|
|
764
|
-
* @order 39
|
|
765
|
-
* @param filter 音频帧滤镜对象 VeLiveAudioFrameFilter 。
|
|
766
|
-
*
|
|
767
|
-
*/
|
|
442
|
+
|
|
768
443
|
/** {en}
|
|
769
444
|
* @detail api
|
|
770
445
|
* @brief Sets custom audio processing.
|
|
@@ -773,13 +448,7 @@ export declare class VeLivePusher {
|
|
|
773
448
|
*
|
|
774
449
|
*/
|
|
775
450
|
setAudioFrameFilter(filter: VeLiveAudioFrameFilter): void;
|
|
776
|
-
|
|
777
|
-
* @detail api
|
|
778
|
-
* @brief 创建播放器。
|
|
779
|
-
* @order 1
|
|
780
|
-
* @return 播放器管理对象 [VeLiveMediaPlayer](#VeLiveMediaPlayer)。
|
|
781
|
-
*
|
|
782
|
-
*/
|
|
451
|
+
|
|
783
452
|
/** {en}
|
|
784
453
|
* @detail api
|
|
785
454
|
* @brief Creates the media player.
|
|
@@ -788,13 +457,7 @@ export declare class VeLivePusher {
|
|
|
788
457
|
*
|
|
789
458
|
*/
|
|
790
459
|
createPlayer(): VeLiveMediaPlayer;
|
|
791
|
-
|
|
792
|
-
* @platform android
|
|
793
|
-
* @detail api
|
|
794
|
-
* @brief 开始系统音频采集。
|
|
795
|
-
* @order 41
|
|
796
|
-
*
|
|
797
|
-
*/
|
|
460
|
+
|
|
798
461
|
/** {en}
|
|
799
462
|
* @platform android
|
|
800
463
|
* @detail api
|
|
@@ -803,13 +466,7 @@ export declare class VeLivePusher {
|
|
|
803
466
|
*
|
|
804
467
|
*/
|
|
805
468
|
android_startMixSystemAudio(): void;
|
|
806
|
-
|
|
807
|
-
* @platform android
|
|
808
|
-
* @detail api
|
|
809
|
-
* @brief 停止系统音频采集。
|
|
810
|
-
* @order 42
|
|
811
|
-
*
|
|
812
|
-
*/
|
|
469
|
+
|
|
813
470
|
/** {en}
|
|
814
471
|
* @platform android
|
|
815
472
|
* @detail api
|
|
@@ -818,13 +475,7 @@ export declare class VeLivePusher {
|
|
|
818
475
|
*
|
|
819
476
|
*/
|
|
820
477
|
android_stopMixSystemAudio(): void;
|
|
821
|
-
|
|
822
|
-
* @platform android
|
|
823
|
-
* @detail api
|
|
824
|
-
* @brief 获取当前是否处于屏幕采集状态。
|
|
825
|
-
* @order 43
|
|
826
|
-
*
|
|
827
|
-
*/
|
|
478
|
+
|
|
828
479
|
/** {en}
|
|
829
480
|
* @platform android
|
|
830
481
|
* @detail api
|
|
@@ -833,16 +484,7 @@ export declare class VeLivePusher {
|
|
|
833
484
|
*
|
|
834
485
|
*/
|
|
835
486
|
android_isScreenRecording(): boolean;
|
|
836
|
-
|
|
837
|
-
* @detail api
|
|
838
|
-
* @brief 添加视频帧的监听回调,用于获取推流器输出的视频帧。
|
|
839
|
-
* @order 44
|
|
840
|
-
* @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
|
|
841
|
-
* @return <br>
|
|
842
|
-
* - 0:成功;
|
|
843
|
-
* - <0:失败。
|
|
844
|
-
*
|
|
845
|
-
*/
|
|
487
|
+
|
|
846
488
|
/** {en}
|
|
847
489
|
* @detail api
|
|
848
490
|
* @brief Adds a video frame listener.
|
|
@@ -854,18 +496,7 @@ export declare class VeLivePusher {
|
|
|
854
496
|
*
|
|
855
497
|
*/
|
|
856
498
|
addVideoFrameListener(listener: VeLiveVideoFrameListener): number;
|
|
857
|
-
|
|
858
|
-
* @detail api
|
|
859
|
-
* @brief 移除已添加的视频帧监听回调。
|
|
860
|
-
* @notes <br>
|
|
861
|
-
* 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
|
|
862
|
-
* @order 45
|
|
863
|
-
* @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
|
|
864
|
-
* @return <br>
|
|
865
|
-
* - 0:成功;
|
|
866
|
-
* - <0:失败。
|
|
867
|
-
*
|
|
868
|
-
*/
|
|
499
|
+
|
|
869
500
|
/** {en}
|
|
870
501
|
* @detail api
|
|
871
502
|
* @brief Removes the video frame listener.
|
|
@@ -879,16 +510,7 @@ export declare class VeLivePusher {
|
|
|
879
510
|
*
|
|
880
511
|
*/
|
|
881
512
|
removeVideoFrameListener(listener: VeLiveVideoFrameListener): number;
|
|
882
|
-
|
|
883
|
-
* @detail api
|
|
884
|
-
* @brief 添加音频帧的监听回调,用于获取推流器输出的音频帧。
|
|
885
|
-
* @order 46
|
|
886
|
-
* @param listener 音频帧监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
|
|
887
|
-
* @return <br>
|
|
888
|
-
* - 0:成功;
|
|
889
|
-
* - <0:失败。
|
|
890
|
-
*
|
|
891
|
-
*/
|
|
513
|
+
|
|
892
514
|
/** {en}
|
|
893
515
|
* @detail api
|
|
894
516
|
* @brief Adds an audio frame listener.
|
|
@@ -900,18 +522,7 @@ export declare class VeLivePusher {
|
|
|
900
522
|
*
|
|
901
523
|
*/
|
|
902
524
|
addAudioFrameListener(listener: VeLiveAudioFrameListener): number;
|
|
903
|
-
|
|
904
|
-
* @detail api
|
|
905
|
-
* @brief 移除已添加的音频帧监听回调。
|
|
906
|
-
* @notes <br>
|
|
907
|
-
* 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
|
|
908
|
-
* @order 47
|
|
909
|
-
* @param listener 音频帧的监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
|
|
910
|
-
* @return <br>
|
|
911
|
-
* - 0:成功;
|
|
912
|
-
* - <0:失败。
|
|
913
|
-
*
|
|
914
|
-
*/
|
|
525
|
+
|
|
915
526
|
/** {en}
|
|
916
527
|
* @detail api
|
|
917
528
|
* @brief Removes the audio frame listener.
|
|
@@ -925,13 +536,7 @@ export declare class VeLivePusher {
|
|
|
925
536
|
*
|
|
926
537
|
*/
|
|
927
538
|
removeAudioFrameListener(listener: VeLiveAudioFrameListener): number;
|
|
928
|
-
|
|
929
|
-
* @detail api
|
|
930
|
-
* @brief 视频截图。
|
|
931
|
-
* @order 48
|
|
932
|
-
* @param listener 截图监听对象,详情请参见 [VeLiveSnapshotListener](147519#VeLivePusherDef-VeLiveSnapshotListener)。
|
|
933
|
-
*
|
|
934
|
-
*/
|
|
539
|
+
|
|
935
540
|
/** {en}
|
|
936
541
|
* @detail api
|
|
937
542
|
* @brief Takes a screenshot.
|
|
@@ -940,13 +545,7 @@ export declare class VeLivePusher {
|
|
|
940
545
|
*
|
|
941
546
|
*/
|
|
942
547
|
snapshot(listener: VeLiveSnapshotListener): void;
|
|
943
|
-
|
|
944
|
-
* @platform ios
|
|
945
|
-
* @detail api
|
|
946
|
-
* @param applicationGroupIdentifier iOS app group 标识符。
|
|
947
|
-
* @brief 开启屏幕采集。
|
|
948
|
-
* @order 20
|
|
949
|
-
*/
|
|
548
|
+
|
|
950
549
|
/** {en}
|
|
951
550
|
* @platform ios
|
|
952
551
|
* @detail api
|
|
@@ -955,14 +554,7 @@ export declare class VeLivePusher {
|
|
|
955
554
|
* @order 20
|
|
956
555
|
*/
|
|
957
556
|
ios_startScreenCapture(applicationGroupIdentifier: string): void;
|
|
958
|
-
|
|
959
|
-
* @platform ios
|
|
960
|
-
* @detail api
|
|
961
|
-
* @brief 停止屏幕采集。
|
|
962
|
-
* @notes <br>
|
|
963
|
-
* 该方法用于结束当前屏幕采集流程,并释放相关资源。调用本方法后,`pauseScreenCapture` 和 `resumeScreenCapture` 将不再生效。
|
|
964
|
-
* @order 21
|
|
965
|
-
*/
|
|
557
|
+
|
|
966
558
|
/** {en}
|
|
967
559
|
* @platform ios
|
|
968
560
|
* @detail api
|
|
@@ -972,14 +564,7 @@ export declare class VeLivePusher {
|
|
|
972
564
|
* @order 21
|
|
973
565
|
*/
|
|
974
566
|
ios_stopScreenCapture(): void;
|
|
975
|
-
|
|
976
|
-
* @platform ios
|
|
977
|
-
* @detail api
|
|
978
|
-
* @brief 暂停屏幕采集。
|
|
979
|
-
* @notes <br>
|
|
980
|
-
* 调用该方法后,屏幕采集将暂停输出数据,但不会销毁内部资源。您可通过 `resumeScreenCapture` 来恢复采集。如果当前采集已经停止或尚未开始,调用本方法不会产生任何效果。
|
|
981
|
-
* @order 22
|
|
982
|
-
*/
|
|
567
|
+
|
|
983
568
|
/** {en}
|
|
984
569
|
* @platform ios
|
|
985
570
|
* @detail api
|
|
@@ -989,14 +574,7 @@ export declare class VeLivePusher {
|
|
|
989
574
|
* @order 22
|
|
990
575
|
*/
|
|
991
576
|
ios_pauseScreenCapture(): void;
|
|
992
|
-
|
|
993
|
-
* @platform ios
|
|
994
|
-
* @detail api
|
|
995
|
-
* @brief 恢复屏幕采集。
|
|
996
|
-
* @notes <br>
|
|
997
|
-
* 在调用 `pauseScreenCapture` 暂停后,通过本方法可以恢复屏幕采集输出。如果屏幕采集已经停止或尚未开始,调用本方法不会产生任何效果。
|
|
998
|
-
* @order 23
|
|
999
|
-
*/
|
|
577
|
+
|
|
1000
578
|
/** {en}
|
|
1001
579
|
* @platform ios
|
|
1002
580
|
* @detail api
|
|
@@ -1006,13 +584,7 @@ export declare class VeLivePusher {
|
|
|
1006
584
|
* @order 23
|
|
1007
585
|
*/
|
|
1008
586
|
ios_resumeScreenCapture(): void;
|
|
1009
|
-
|
|
1010
|
-
* @platform ios
|
|
1011
|
-
* @detail api
|
|
1012
|
-
* @brief 初始化推流器。
|
|
1013
|
-
* @order 0
|
|
1014
|
-
* @param config 推流配置类。详细信息请参见 [VeLivePusherConfiguration](155321#VeLivePusherConfiguration)。
|
|
1015
|
-
*/
|
|
587
|
+
|
|
1016
588
|
/** {en}
|
|
1017
589
|
* @platform ios
|
|
1018
590
|
* @detail api
|
|
@@ -1021,19 +593,7 @@ export declare class VeLivePusher {
|
|
|
1021
593
|
* @order 0
|
|
1022
594
|
*/
|
|
1023
595
|
ios_initWithConfig(config: $p_i.VeLivePusherConfiguration): this;
|
|
1024
|
-
|
|
1025
|
-
* @platform ios
|
|
1026
|
-
* @detail api
|
|
1027
|
-
* @brief 添加屏幕采集的监听。
|
|
1028
|
-
* @notes <br>
|
|
1029
|
-
* 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
|
|
1030
|
-
* @param listener 屏幕采集事件监听回调,详细信息请参见 VeLiveScreenCaptureStatusObserver{@link #VeLiveScreenCaptureStatusObserver}
|
|
1031
|
-
* @param observer 录屏推流事件监听器。详情见 [VeLiveScreenCaptureStatusObserver](155319#VeLiveScreenCaptureStatusObserver)。
|
|
1032
|
-
* @order 5
|
|
1033
|
-
* @return <br>
|
|
1034
|
-
* - 0:成功;
|
|
1035
|
-
* - <0:失败。
|
|
1036
|
-
*/
|
|
596
|
+
|
|
1037
597
|
/** {en}
|
|
1038
598
|
* @platform ios
|
|
1039
599
|
* @brief Sets the observer for screen capturing events.
|
|
@@ -1044,18 +604,7 @@ export declare class VeLivePusher {
|
|
|
1044
604
|
* - <0: Failure.
|
|
1045
605
|
*/
|
|
1046
606
|
ios_setScreenCaptureObserver(observer: $p_i.id<$p_i.VeLiveScreenCaptureStatusObserver>): number;
|
|
1047
|
-
|
|
1048
|
-
* @platform ios
|
|
1049
|
-
* @detail api
|
|
1050
|
-
* @brief 推送外部视频编码数据。
|
|
1051
|
-
* @notes
|
|
1052
|
-
* 该接口需要在 [startVideoCapture:](#VeLivePusher-startvideocapture) 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureExternal。
|
|
1053
|
-
* @order 38
|
|
1054
|
-
* @param encodeFrame 视频编码帧的数据信息,详情请参见 [VeLiveVideoEncodeFrame](155321#VeLiveVideoEncodeFrame)。
|
|
1055
|
-
* @return <br>
|
|
1056
|
-
* - 0:成功;
|
|
1057
|
-
* - <0:失败。
|
|
1058
|
-
*/
|
|
607
|
+
|
|
1059
608
|
/** {en}
|
|
1060
609
|
* @platform ios
|
|
1061
610
|
* @detail api
|
|
@@ -1069,14 +618,7 @@ export declare class VeLivePusher {
|
|
|
1069
618
|
* - <0: Failure.
|
|
1070
619
|
*/
|
|
1071
620
|
ios_pushExternalVideoEncodeFrame(encodeFrame: $p_i.VeLiveVideoEncodeFrame): number;
|
|
1072
|
-
|
|
1073
|
-
* @platform ios
|
|
1074
|
-
* @detail api
|
|
1075
|
-
* @brief 强制请求 IDR 帧,发起请求以编码一个新的 IDR 帧。
|
|
1076
|
-
* @notes
|
|
1077
|
-
* 该接口需要在调用 [startPush:](#VeLivePusher-startpush) 或 [startPushWithUrls:](#VeLivePusher-startpushwithurls) 方法之后调用。
|
|
1078
|
-
* @order 49
|
|
1079
|
-
*/
|
|
621
|
+
|
|
1080
622
|
/** {en}
|
|
1081
623
|
* @platform ios
|
|
1082
624
|
* @detail api
|
|
@@ -1087,20 +629,12 @@ export declare class VeLivePusher {
|
|
|
1087
629
|
*/
|
|
1088
630
|
ios_requestIDRFrame(): void;
|
|
1089
631
|
}
|
|
1090
|
-
|
|
1091
|
-
* @detail api
|
|
1092
|
-
* @brief 媒体播放器对象。
|
|
1093
|
-
*/
|
|
632
|
+
|
|
1094
633
|
export declare class VeLiveMediaPlayer {
|
|
1095
634
|
protected _instance: any;
|
|
1096
635
|
protected __init(...args: any[]): void;
|
|
1097
636
|
protected __new_instance(...args: any[]): any;
|
|
1098
|
-
|
|
1099
|
-
* @detail api
|
|
1100
|
-
* @brief 销毁播放器实例。
|
|
1101
|
-
* @order 1
|
|
1102
|
-
*
|
|
1103
|
-
*/
|
|
637
|
+
|
|
1104
638
|
/** {en}
|
|
1105
639
|
* @detail api
|
|
1106
640
|
* @brief Destroys the media player instance.
|
|
@@ -1108,15 +642,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1108
642
|
*
|
|
1109
643
|
*/
|
|
1110
644
|
destroy(): void;
|
|
1111
|
-
|
|
1112
|
-
* @detail api
|
|
1113
|
-
* @brief 设置播放状态的监听。
|
|
1114
|
-
* @notes <br>
|
|
1115
|
-
* 重复调用本方法,仅最后一次调用生效。
|
|
1116
|
-
* @order 4
|
|
1117
|
-
* @param listener 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](147519#VeLivePusherDef-VeLiveMediaPlayerListener)。
|
|
1118
|
-
*
|
|
1119
|
-
*/
|
|
645
|
+
|
|
1120
646
|
/** {en}
|
|
1121
647
|
* @detail api
|
|
1122
648
|
* @brief Sets the observer for playback statuses.
|
|
@@ -1127,16 +653,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1127
653
|
*
|
|
1128
654
|
*/
|
|
1129
655
|
setListener(listener: VeLiveMediaPlayerListener): void;
|
|
1130
|
-
|
|
1131
|
-
* @detail api
|
|
1132
|
-
* @brief 设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
|
|
1133
|
-
* @order 2
|
|
1134
|
-
* @param url 文件路径。
|
|
1135
|
-
* @return <br>
|
|
1136
|
-
* - 0:成功;
|
|
1137
|
-
* - ≠0:失败。
|
|
1138
|
-
*
|
|
1139
|
-
*/
|
|
656
|
+
|
|
1140
657
|
/** {en}
|
|
1141
658
|
* @detail api
|
|
1142
659
|
* @brief Sets the file path. Supported file formats include MP3, AAC, M4A, WAV.
|
|
@@ -1148,14 +665,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1148
665
|
*
|
|
1149
666
|
*/
|
|
1150
667
|
prepare(url: string): number;
|
|
1151
|
-
|
|
1152
|
-
* @detail api
|
|
1153
|
-
* @brief 开始播放。
|
|
1154
|
-
* @notes <br>
|
|
1155
|
-
* 需要在调用 start{@link #start} 开始播放后,调用本方法。
|
|
1156
|
-
* @order 12
|
|
1157
|
-
*
|
|
1158
|
-
*/
|
|
668
|
+
|
|
1159
669
|
/** {en}
|
|
1160
670
|
* @detail api
|
|
1161
671
|
* @brief Start playback.
|
|
@@ -1165,17 +675,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1165
675
|
*
|
|
1166
676
|
*/
|
|
1167
677
|
start(): Promise<number>;
|
|
1168
|
-
|
|
1169
|
-
* @detail api
|
|
1170
|
-
* @brief 停止播放。
|
|
1171
|
-
* @notes <br>
|
|
1172
|
-
* 需要在调用 start{@link #start} 开始播放后,调用本方法。
|
|
1173
|
-
* @order 13
|
|
1174
|
-
* @return <br>
|
|
1175
|
-
* - 0:成功;
|
|
1176
|
-
* - ≠0:失败。
|
|
1177
|
-
*
|
|
1178
|
-
*/
|
|
678
|
+
|
|
1179
679
|
/** {en}
|
|
1180
680
|
* @detail api
|
|
1181
681
|
* @brief Stops playback.
|
|
@@ -1188,13 +688,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1188
688
|
*
|
|
1189
689
|
*/
|
|
1190
690
|
stop(): Promise<number>;
|
|
1191
|
-
|
|
1192
|
-
* @detail api
|
|
1193
|
-
* @brief 暂停播放。
|
|
1194
|
-
* @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start)[start](#VeLiveMediaPlayer-start) 开始播放后,调用本方法。
|
|
1195
|
-
* @order 14
|
|
1196
|
-
*
|
|
1197
|
-
*/
|
|
691
|
+
|
|
1198
692
|
/** {en}
|
|
1199
693
|
* @detail api
|
|
1200
694
|
* @brief Pauses playback.
|
|
@@ -1204,13 +698,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1204
698
|
*
|
|
1205
699
|
*/
|
|
1206
700
|
pause(): Promise<void>;
|
|
1207
|
-
|
|
1208
|
-
* @detail api
|
|
1209
|
-
* @brief 恢复播放。
|
|
1210
|
-
* @notes <br>需要在调用 [pause](#VeLiveMediaPlayer-pause) 暂停播放后,调用本方法。
|
|
1211
|
-
* @order 15
|
|
1212
|
-
*
|
|
1213
|
-
*/
|
|
701
|
+
|
|
1214
702
|
/** {en}
|
|
1215
703
|
* @detail api
|
|
1216
704
|
* @brief Resumes playback.
|
|
@@ -1219,16 +707,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1219
707
|
*
|
|
1220
708
|
*/
|
|
1221
709
|
resume(): Promise<void>;
|
|
1222
|
-
|
|
1223
|
-
* @detail api
|
|
1224
|
-
* @brief 获取文件的总时长,单位为 ms。
|
|
1225
|
-
* @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后,调用本方法。
|
|
1226
|
-
* @order 3
|
|
1227
|
-
* @return <br>
|
|
1228
|
-
* - >0:成功,音频文件时长;
|
|
1229
|
-
* - ≤0:失败。
|
|
1230
|
-
*
|
|
1231
|
-
*/
|
|
710
|
+
|
|
1232
711
|
/** {en}
|
|
1233
712
|
* @detail api
|
|
1234
713
|
* @brief Gets the duration of the media file.
|
|
@@ -1240,16 +719,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1240
719
|
*
|
|
1241
720
|
*/
|
|
1242
721
|
getDuration(): number;
|
|
1243
|
-
|
|
1244
|
-
* @detail api
|
|
1245
|
-
* @brief 设置播放进度。
|
|
1246
|
-
* @order 5
|
|
1247
|
-
* @param posMs 播放时间,单位为 ms。
|
|
1248
|
-
* @return <br>
|
|
1249
|
-
* - 0:成功;
|
|
1250
|
-
* - ≠0:失败。
|
|
1251
|
-
*
|
|
1252
|
-
*/
|
|
722
|
+
|
|
1253
723
|
/** {en}
|
|
1254
724
|
* @detail api
|
|
1255
725
|
* @brief Sets the playback progress.
|
|
@@ -1261,15 +731,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1261
731
|
*
|
|
1262
732
|
*/
|
|
1263
733
|
seek(posMs: number): number;
|
|
1264
|
-
|
|
1265
|
-
* @detail api
|
|
1266
|
-
* @brief 开启/关闭音频是否混音到直播流。
|
|
1267
|
-
* @param enable 开启/关闭,默认为 false。 <br>
|
|
1268
|
-
* - ture:开启;
|
|
1269
|
-
* - false:关闭。
|
|
1270
|
-
* @order 6
|
|
1271
|
-
*
|
|
1272
|
-
*/
|
|
734
|
+
|
|
1273
735
|
/** {en}
|
|
1274
736
|
* @detail api
|
|
1275
737
|
* @brief Enables or disables mixing the audio to the live stream.
|
|
@@ -1280,14 +742,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1280
742
|
*
|
|
1281
743
|
*/
|
|
1282
744
|
enableMixer(enable: boolean): void;
|
|
1283
|
-
|
|
1284
|
-
* @detail api
|
|
1285
|
-
* @brief 开启/关闭自动音量均衡。
|
|
1286
|
-
* @order 7
|
|
1287
|
-
* @param sourceLufs 源响度。
|
|
1288
|
-
* @param targetLufs 目标响度。
|
|
1289
|
-
*
|
|
1290
|
-
*/
|
|
745
|
+
|
|
1291
746
|
/** {en}
|
|
1292
747
|
* @detail api
|
|
1293
748
|
* @brief Enables or disables automatic volume equalization.
|
|
@@ -1297,15 +752,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1297
752
|
*
|
|
1298
753
|
*/
|
|
1299
754
|
enableAutoEq(sourceLufs: number, targetLufs: number): void;
|
|
1300
|
-
|
|
1301
|
-
* @detail api
|
|
1302
|
-
* @brief 设置音视频帧回调的监听。
|
|
1303
|
-
* @notes <br>
|
|
1304
|
-
* 重复调用本方法,仅最后一次调用生效。
|
|
1305
|
-
* @order 8
|
|
1306
|
-
* @param listener 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](147519#VeLivePusherDef-VeLiveMediaPlayerFrameListener)。
|
|
1307
|
-
*
|
|
1308
|
-
*/
|
|
755
|
+
|
|
1309
756
|
/** {en}
|
|
1310
757
|
* @detail api
|
|
1311
758
|
* @brief Sets the observer for audio and video frames.
|
|
@@ -1316,13 +763,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1316
763
|
*
|
|
1317
764
|
*/
|
|
1318
765
|
setFrameListener(listener: VeLiveMediaPlayerFrameListener): void;
|
|
1319
|
-
|
|
1320
|
-
* @detail api
|
|
1321
|
-
* @brief 设置播放音频的音量。
|
|
1322
|
-
* @order 9
|
|
1323
|
-
* @param volume 播放音频音量,取值范围为 [0.0,4.0]。
|
|
1324
|
-
*
|
|
1325
|
-
*/
|
|
766
|
+
|
|
1326
767
|
/** {en}
|
|
1327
768
|
* @detail api
|
|
1328
769
|
* @brief Sets the playback volume.
|
|
@@ -1330,15 +771,8 @@ export declare class VeLiveMediaPlayer {
|
|
|
1330
771
|
* @order 113
|
|
1331
772
|
*
|
|
1332
773
|
*/
|
|
1333
|
-
setBGMVolume(volume: number): void;
|
|
1334
|
-
|
|
1335
|
-
* @detail api
|
|
1336
|
-
* @brief 设置音频采集音量。
|
|
1337
|
-
* @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放背景音乐后,调用本方法。
|
|
1338
|
-
* @order 10
|
|
1339
|
-
* @param volume 音频采集音量,取值范围为 [0.0,4.0]。
|
|
1340
|
-
*
|
|
1341
|
-
*/
|
|
774
|
+
setBGMVolume(volume: number): void;
|
|
775
|
+
|
|
1342
776
|
/** {en}
|
|
1343
777
|
* @detail api
|
|
1344
778
|
* @brief Sets the audio capture volume.
|
|
@@ -1348,15 +782,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1348
782
|
*
|
|
1349
783
|
*/
|
|
1350
784
|
setVoiceVolume(volume: number): void;
|
|
1351
|
-
|
|
1352
|
-
* @detail api
|
|
1353
|
-
* @brief 设置是否循环播放。
|
|
1354
|
-
* @param loop 是否循环播放。默认为 false。<br>
|
|
1355
|
-
* - true:循环播放;
|
|
1356
|
-
* - false:不循环播放。
|
|
1357
|
-
* @order 11
|
|
1358
|
-
*
|
|
1359
|
-
*/
|
|
785
|
+
|
|
1360
786
|
/** {en}
|
|
1361
787
|
* @detail api
|
|
1362
788
|
* @brief Sets whether to loop the video.
|
|
@@ -1367,13 +793,7 @@ export declare class VeLiveMediaPlayer {
|
|
|
1367
793
|
*
|
|
1368
794
|
*/
|
|
1369
795
|
enableBGMLoop(loop: boolean): void;
|
|
1370
|
-
|
|
1371
|
-
* @platform ios
|
|
1372
|
-
* @detail api
|
|
1373
|
-
* @brief 支持 MP4 格式的视频渲染。
|
|
1374
|
-
* @param view 渲染视图。
|
|
1375
|
-
* @order 93
|
|
1376
|
-
*/
|
|
796
|
+
|
|
1377
797
|
/** {en}
|
|
1378
798
|
* @platform ios
|
|
1379
799
|
* @detail api
|
|
@@ -1383,46 +803,31 @@ export declare class VeLiveMediaPlayer {
|
|
|
1383
803
|
*/
|
|
1384
804
|
ios_setRenderView(view: $p_i.UIView): void;
|
|
1385
805
|
}
|
|
1386
|
-
|
|
1387
|
-
* @detail keytype
|
|
1388
|
-
* @brief 推流引擎初始化配置。
|
|
1389
|
-
*/
|
|
806
|
+
|
|
1390
807
|
export declare class VeLivePusherConfiguration {
|
|
1391
808
|
protected _instance: any;
|
|
1392
|
-
|
|
1393
|
-
* @platform ios
|
|
1394
|
-
* @brief 音频采集参数设置,用于调整和设置音频采集相关的参数。详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)。
|
|
1395
|
-
*/
|
|
809
|
+
|
|
1396
810
|
/** {en}
|
|
1397
811
|
* @platform ios
|
|
1398
812
|
* @brief The audio capture configurations. See [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration) for details.
|
|
1399
813
|
*/
|
|
1400
814
|
get audioCaptureConfig(): $p_i.VeLiveAudioCaptureConfiguration;
|
|
1401
815
|
set audioCaptureConfig(value: $p_i.VeLiveAudioCaptureConfiguration);
|
|
1402
|
-
|
|
1403
|
-
* @platform ios
|
|
1404
|
-
* @brief 推流失败后,尝试重连的时间间隔。单位为 s,默认值为 5。
|
|
1405
|
-
*/
|
|
816
|
+
|
|
1406
817
|
/** {en}
|
|
1407
818
|
* @platform ios
|
|
1408
819
|
* @brief The time interval between each attempt to reconnect, in seconds. The default value is `5`.
|
|
1409
820
|
*/
|
|
1410
821
|
get reconnectIntervalSeconds(): $p_i.int;
|
|
1411
822
|
set reconnectIntervalSeconds(value: $p_i.int);
|
|
1412
|
-
|
|
1413
|
-
* @platform ios
|
|
1414
|
-
* @brief 推流失败后,尝试重连的次数。默认值为 3。
|
|
1415
|
-
*/
|
|
823
|
+
|
|
1416
824
|
/** {en}
|
|
1417
825
|
* @platform ios
|
|
1418
826
|
* @brief The number of attempts to reconnect after the initial attempt fails. The default value is `3`.
|
|
1419
827
|
*/
|
|
1420
828
|
get reconnectCount(): $p_i.int;
|
|
1421
829
|
set reconnectCount(value: $p_i.int);
|
|
1422
|
-
|
|
1423
|
-
* @platform ios
|
|
1424
|
-
* @brief 设置扩展参数,用于实现某些特殊功能或配置,默认不需要设置。
|
|
1425
|
-
*/
|
|
830
|
+
|
|
1426
831
|
/** {en}
|
|
1427
832
|
* @platform ios
|
|
1428
833
|
* @brief Advanced parameters. You can leave this parameter empty.
|
|
@@ -1431,14 +836,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1431
836
|
set extraParameters(value: $p_i.NSDictionary);
|
|
1432
837
|
protected __init(...args: any[]): void;
|
|
1433
838
|
protected __new_instance(...args: any[]): any;
|
|
1434
|
-
|
|
1435
|
-
* @detail api
|
|
1436
|
-
* @brief 设置视频采集参数,用于调整和设置视频采集相关的参数。
|
|
1437
|
-
* @order 6
|
|
1438
|
-
* @param config 视频采集参数,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
|
|
1439
|
-
* @return 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
|
|
1440
|
-
*
|
|
1441
|
-
*/
|
|
839
|
+
|
|
1442
840
|
/** {en}
|
|
1443
841
|
* @detail api
|
|
1444
842
|
* @brief Sets the video capture configurations.
|
|
@@ -1449,14 +847,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1449
847
|
*
|
|
1450
848
|
*/
|
|
1451
849
|
setVideoCaptureConfig(config: VeLiveVideoCaptureConfiguration): void;
|
|
1452
|
-
|
|
1453
|
-
* @platform android
|
|
1454
|
-
* @detail api
|
|
1455
|
-
* @brief 设置推流器推流失败后尝试重连的时间间隔。
|
|
1456
|
-
* @param interval 时间间隔,单位为 s,默认值为 5
|
|
1457
|
-
* @order 2
|
|
1458
|
-
*
|
|
1459
|
-
*/
|
|
850
|
+
|
|
1460
851
|
/** {en}
|
|
1461
852
|
* @platform android
|
|
1462
853
|
* @detail api
|
|
@@ -1466,15 +857,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1466
857
|
*
|
|
1467
858
|
*/
|
|
1468
859
|
android_setReconnectIntervalSeconds(interval: number): this;
|
|
1469
|
-
|
|
1470
|
-
* @platform android
|
|
1471
|
-
* @detail api
|
|
1472
|
-
* @brief 获取推流器推流失败后尝试重连的时间间隔。
|
|
1473
|
-
* @order 3
|
|
1474
|
-
* @return <br>
|
|
1475
|
-
* 时间间隔,单位为 s。
|
|
1476
|
-
*
|
|
1477
|
-
*/
|
|
860
|
+
|
|
1478
861
|
/** {en}
|
|
1479
862
|
* @platform android
|
|
1480
863
|
* @detail api
|
|
@@ -1485,14 +868,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1485
868
|
*
|
|
1486
869
|
*/
|
|
1487
870
|
android_getReconnectIntervalSeconds(): number;
|
|
1488
|
-
|
|
1489
|
-
* @platform android
|
|
1490
|
-
* @detail api
|
|
1491
|
-
* @brief 设置推流器推流失败后尝试重连的次数。
|
|
1492
|
-
* @param maxCount 重连次数,默认值为 3
|
|
1493
|
-
* @order 4
|
|
1494
|
-
*
|
|
1495
|
-
*/
|
|
871
|
+
|
|
1496
872
|
/** {en}
|
|
1497
873
|
* @platform android
|
|
1498
874
|
* @detail api
|
|
@@ -1502,15 +878,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1502
878
|
*
|
|
1503
879
|
*/
|
|
1504
880
|
android_setReconnectCount(maxCount: number): this;
|
|
1505
|
-
|
|
1506
|
-
* @platform android
|
|
1507
|
-
* @detail api
|
|
1508
|
-
* @brief 获取推流器推流失败后尝试重连的次数。
|
|
1509
|
-
* @order 5
|
|
1510
|
-
* @return <br>
|
|
1511
|
-
* 重连次数。
|
|
1512
|
-
*
|
|
1513
|
-
*/
|
|
881
|
+
|
|
1514
882
|
/** {en}
|
|
1515
883
|
* @platform android
|
|
1516
884
|
* @detail api
|
|
@@ -1521,14 +889,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1521
889
|
*
|
|
1522
890
|
*/
|
|
1523
891
|
android_getReconnectCount(): number;
|
|
1524
|
-
|
|
1525
|
-
* @platform android
|
|
1526
|
-
* @detail api
|
|
1527
|
-
* @brief 获取视频采集参数,用于调整和设置视频采集相关的参数。
|
|
1528
|
-
* @order 7
|
|
1529
|
-
* @return 视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
|
|
1530
|
-
*
|
|
1531
|
-
*/
|
|
892
|
+
|
|
1532
893
|
/** {en}
|
|
1533
894
|
* @platform android
|
|
1534
895
|
* @detail api
|
|
@@ -1538,15 +899,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1538
899
|
*
|
|
1539
900
|
*/
|
|
1540
901
|
android_getVideoCaptureConfig(): $p_a.VeLiveVideoCaptureConfiguration;
|
|
1541
|
-
|
|
1542
|
-
* @platform android
|
|
1543
|
-
* @detail api
|
|
1544
|
-
* @brief 设置音频采集参数,用于调整和设置音频采集相关的参数。
|
|
1545
|
-
* @order 7
|
|
1546
|
-
* @param config 音频采集参数,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
|
|
1547
|
-
* @return 推流引擎初始化配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
|
|
1548
|
-
*
|
|
1549
|
-
*/
|
|
902
|
+
|
|
1550
903
|
/** {en}
|
|
1551
904
|
* @platform android
|
|
1552
905
|
* @detail api
|
|
@@ -1557,14 +910,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1557
910
|
*
|
|
1558
911
|
*/
|
|
1559
912
|
android_setAudioCaptureConfig(config: $p_a.VeLiveAudioCaptureConfiguration): this;
|
|
1560
|
-
|
|
1561
|
-
* @platform android
|
|
1562
|
-
* @detail api
|
|
1563
|
-
* @brief 获取音频采集参数,用于调整和设置音频采集相关的参数。
|
|
1564
|
-
* @order 8
|
|
1565
|
-
* @return 音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
|
|
1566
|
-
*
|
|
1567
|
-
*/
|
|
913
|
+
|
|
1568
914
|
/** {en}
|
|
1569
915
|
* @platform android
|
|
1570
916
|
* @detail api
|
|
@@ -1574,15 +920,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1574
920
|
*
|
|
1575
921
|
*/
|
|
1576
922
|
android_getAudioCaptureConfig(): $p_a.VeLiveAudioCaptureConfiguration;
|
|
1577
|
-
|
|
1578
|
-
* @platform android
|
|
1579
|
-
* @detail api
|
|
1580
|
-
* @brief 设置应用上下文。
|
|
1581
|
-
* @order 9
|
|
1582
|
-
* @param context 应用上下文。
|
|
1583
|
-
* @return 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
|
|
1584
|
-
*
|
|
1585
|
-
*/
|
|
923
|
+
|
|
1586
924
|
/** {en}
|
|
1587
925
|
* @platform android
|
|
1588
926
|
* @detail api
|
|
@@ -1593,15 +931,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1593
931
|
*
|
|
1594
932
|
*/
|
|
1595
933
|
android_setContext(context: $p_a.Context): this;
|
|
1596
|
-
|
|
1597
|
-
* @platform android
|
|
1598
|
-
* @detail api
|
|
1599
|
-
* @brief 获取应用上下文。
|
|
1600
|
-
* @order 10
|
|
1601
|
-
* @return <br>
|
|
1602
|
-
* 应用上下文。
|
|
1603
|
-
*
|
|
1604
|
-
*/
|
|
934
|
+
|
|
1605
935
|
/** {en}
|
|
1606
936
|
* @platform android
|
|
1607
937
|
* @detail api
|
|
@@ -1612,16 +942,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1612
942
|
*
|
|
1613
943
|
*/
|
|
1614
944
|
android_getContext(): $p_a.Context;
|
|
1615
|
-
|
|
1616
|
-
* @platform android
|
|
1617
|
-
* @detail api
|
|
1618
|
-
* @brief 设置扩展参数,默认不需要设置。如果需要使用,您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
|
|
1619
|
-
* @order 11
|
|
1620
|
-
* @param params 扩展参数。
|
|
1621
|
-
* @return
|
|
1622
|
-
* 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
|
|
1623
|
-
*
|
|
1624
|
-
*/
|
|
945
|
+
|
|
1625
946
|
/** {en}
|
|
1626
947
|
* @platform android
|
|
1627
948
|
* @detail api
|
|
@@ -1632,15 +953,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1632
953
|
*
|
|
1633
954
|
*/
|
|
1634
955
|
android_setExtraParameters(params: string): this;
|
|
1635
|
-
|
|
1636
|
-
* @platform android
|
|
1637
|
-
* @detail api
|
|
1638
|
-
* @brief 获取扩展参数。
|
|
1639
|
-
* @order 12
|
|
1640
|
-
* @return <br>
|
|
1641
|
-
* 扩展参数。
|
|
1642
|
-
*
|
|
1643
|
-
*/
|
|
956
|
+
|
|
1644
957
|
/** {en}
|
|
1645
958
|
* @platform android
|
|
1646
959
|
* @detail api
|
|
@@ -1651,14 +964,7 @@ export declare class VeLivePusherConfiguration {
|
|
|
1651
964
|
*
|
|
1652
965
|
*/
|
|
1653
966
|
android_getExtraParams(): $p_a.LiveSdkSetting;
|
|
1654
|
-
|
|
1655
|
-
* @platform android
|
|
1656
|
-
* @detail api
|
|
1657
|
-
* @brief 构造推流引擎。
|
|
1658
|
-
* @order 1
|
|
1659
|
-
* @return 推流引擎,详情请参见 [VeLivePusher](147517#VeLivePusher)。
|
|
1660
|
-
*
|
|
1661
|
-
*/
|
|
967
|
+
|
|
1662
968
|
/** {en}
|
|
1663
969
|
* @platform android
|
|
1664
970
|
* @detail api
|
|
@@ -1669,24 +975,12 @@ export declare class VeLivePusherConfiguration {
|
|
|
1669
975
|
*/
|
|
1670
976
|
android_build(): $p_a.VeLivePusher;
|
|
1671
977
|
}
|
|
1672
|
-
|
|
1673
|
-
* @detail api
|
|
1674
|
-
* @brief 相机设备管理对象。
|
|
1675
|
-
*/
|
|
978
|
+
|
|
1676
979
|
export declare class VeLiveCameraDevice {
|
|
1677
980
|
protected _instance: any;
|
|
1678
981
|
protected __init(...args: any[]): void;
|
|
1679
982
|
protected __new_instance(...args: any[]): any;
|
|
1680
|
-
|
|
1681
|
-
* @platform android
|
|
1682
|
-
* @detail api
|
|
1683
|
-
* @brief 获取相机支持帧率范围。
|
|
1684
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1685
|
-
* @order 3
|
|
1686
|
-
* @return <br>
|
|
1687
|
-
* 相机支持帧率范围。
|
|
1688
|
-
*
|
|
1689
|
-
*/
|
|
983
|
+
|
|
1690
984
|
/** {en}
|
|
1691
985
|
* @platform android
|
|
1692
986
|
* @detail api
|
|
@@ -1698,19 +992,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1698
992
|
*
|
|
1699
993
|
*/
|
|
1700
994
|
android_getRealFpsRange(): Array<$p_a.int>;
|
|
1701
|
-
|
|
1702
|
-
* @detail api
|
|
1703
|
-
* @brief 开启/关闭闪光灯。
|
|
1704
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1705
|
-
* @order 8
|
|
1706
|
-
* @param enable 是否开启闪光灯。默认为 false。 <br>
|
|
1707
|
-
* - true:开启;
|
|
1708
|
-
* - false:关闭。
|
|
1709
|
-
* @return <br>
|
|
1710
|
-
* - 0:开启/关闭成功;
|
|
1711
|
-
* - ≠0:开启/关闭失败。
|
|
1712
|
-
*
|
|
1713
|
-
*/
|
|
995
|
+
|
|
1714
996
|
/** {en}
|
|
1715
997
|
* @detail api
|
|
1716
998
|
* @brief Enables or disables the flashlight.
|
|
@@ -1725,17 +1007,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1725
1007
|
*
|
|
1726
1008
|
*/
|
|
1727
1009
|
enableTorch(enable: boolean): number;
|
|
1728
|
-
|
|
1729
|
-
* @detail api
|
|
1730
|
-
* @brief 设置摄像头的缩放倍数。
|
|
1731
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1732
|
-
* @order 5
|
|
1733
|
-
* @param ratio 缩放倍数。默认为原尺寸。缩放倍数的取值范围为 [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)]。
|
|
1734
|
-
* @return <br>
|
|
1735
|
-
* - 0:缩放成功;
|
|
1736
|
-
* - ≠0:缩放失败。
|
|
1737
|
-
*
|
|
1738
|
-
*/
|
|
1010
|
+
|
|
1739
1011
|
/** {en}
|
|
1740
1012
|
* @detail api
|
|
1741
1013
|
* @brief Sets the zoom factor of the camera.
|
|
@@ -1748,16 +1020,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1748
1020
|
*
|
|
1749
1021
|
*/
|
|
1750
1022
|
setZoomRatio(ratio: number): number;
|
|
1751
|
-
|
|
1752
|
-
* @detail api
|
|
1753
|
-
* @brief 获取摄像头当前的缩放倍数。
|
|
1754
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1755
|
-
* @order 4
|
|
1756
|
-
* @return <br>
|
|
1757
|
-
* - ≤0:表示不支持缩放;
|
|
1758
|
-
* - >0:支持缩放,数值表示当前缩放倍数。
|
|
1759
|
-
*
|
|
1760
|
-
*/
|
|
1023
|
+
|
|
1761
1024
|
/** {en}
|
|
1762
1025
|
* @detail api
|
|
1763
1026
|
* @brief Gets the current zoom factor of the camera.
|
|
@@ -1769,16 +1032,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1769
1032
|
*
|
|
1770
1033
|
*/
|
|
1771
1034
|
getCurrentZoomRatio(): number;
|
|
1772
|
-
|
|
1773
|
-
* @detail api
|
|
1774
|
-
* @brief 获取摄像头的最大缩放倍数。
|
|
1775
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1776
|
-
* @order 6
|
|
1777
|
-
* @return <br>
|
|
1778
|
-
* - ≤0:表示不支持缩放;
|
|
1779
|
-
* - >0:支持缩放,数值表示最大缩放倍数。
|
|
1780
|
-
*
|
|
1781
|
-
*/
|
|
1035
|
+
|
|
1782
1036
|
/** {en}
|
|
1783
1037
|
* @detail api
|
|
1784
1038
|
* @brief Gets the maximum zoom factor of the camera.
|
|
@@ -1790,16 +1044,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1790
1044
|
*
|
|
1791
1045
|
*/
|
|
1792
1046
|
getMaxZoomRatio(): number;
|
|
1793
|
-
|
|
1794
|
-
* @detail api
|
|
1795
|
-
* @brief 获取摄像头的最小缩放倍数。
|
|
1796
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1797
|
-
* @order 7
|
|
1798
|
-
* @return <br>
|
|
1799
|
-
* - ≤0:表示不支持缩放;
|
|
1800
|
-
* - >0:支持缩放,数值表示最小缩放倍数。
|
|
1801
|
-
*
|
|
1802
|
-
*/
|
|
1047
|
+
|
|
1803
1048
|
/** {en}
|
|
1804
1049
|
* @detail api
|
|
1805
1050
|
* @brief Gets the minimum zoom factor of the camera.
|
|
@@ -1811,16 +1056,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1811
1056
|
*
|
|
1812
1057
|
*/
|
|
1813
1058
|
getMinZoomRatio(): number;
|
|
1814
|
-
|
|
1815
|
-
* @detail api
|
|
1816
|
-
* @brief 是否支持自动对焦。
|
|
1817
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1818
|
-
* @order 9
|
|
1819
|
-
* @return <br>
|
|
1820
|
-
* - true:支持;
|
|
1821
|
-
* - false:不支持。
|
|
1822
|
-
*
|
|
1823
|
-
*/
|
|
1059
|
+
|
|
1824
1060
|
/** {en}
|
|
1825
1061
|
* @detail api
|
|
1826
1062
|
* @brief Checks whether autofocus is supported.
|
|
@@ -1832,19 +1068,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1832
1068
|
*
|
|
1833
1069
|
*/
|
|
1834
1070
|
isAutoFocusEnabled(): boolean;
|
|
1835
|
-
|
|
1836
|
-
* @detail api
|
|
1837
|
-
* @brief 开启/关闭自动对焦功能。
|
|
1838
|
-
* @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1839
|
-
* @order 10
|
|
1840
|
-
* @param enable 是否开启自动对焦,默认为 true。
|
|
1841
|
-
* - true:开启;
|
|
1842
|
-
* - false:关闭。
|
|
1843
|
-
* @return <br>
|
|
1844
|
-
* - 0:开启/关闭成功;
|
|
1845
|
-
* - ≠0:开启/关闭失败。
|
|
1846
|
-
*
|
|
1847
|
-
*/
|
|
1071
|
+
|
|
1848
1072
|
/** {en}
|
|
1849
1073
|
* @detail api
|
|
1850
1074
|
* @brief Enables or disables autofocus.
|
|
@@ -1859,20 +1083,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1859
1083
|
*
|
|
1860
1084
|
*/
|
|
1861
1085
|
enableAutoFocus(enable: boolean): number;
|
|
1862
|
-
|
|
1863
|
-
* @detail api
|
|
1864
|
-
* @brief 设置摄像头的对焦位置。
|
|
1865
|
-
* @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1866
|
-
* @order 11
|
|
1867
|
-
* @param viewW 当前视图宽度。
|
|
1868
|
-
* @param viewH 当前视图高度。
|
|
1869
|
-
* @param x 以左上角为原点,对焦点距当前视图的横向坐标值。
|
|
1870
|
-
* @param y 以左上角为原点,对焦点距当前视图的纵向坐标值。
|
|
1871
|
-
* @return <br>
|
|
1872
|
-
* - 0:设置成功;
|
|
1873
|
-
* - ≠0:设置失败。
|
|
1874
|
-
*
|
|
1875
|
-
*/
|
|
1086
|
+
|
|
1876
1087
|
/** {en}
|
|
1877
1088
|
* @detail api
|
|
1878
1089
|
* @brief Sets the focus position of the camera.
|
|
@@ -1888,15 +1099,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1888
1099
|
*
|
|
1889
1100
|
*/
|
|
1890
1101
|
setFocusPosition(viewW: number, viewH: number, x: number, y: number): number;
|
|
1891
|
-
|
|
1892
|
-
* @detail api
|
|
1893
|
-
* @brief 检查当前使用的摄像头是否支持手动设置曝光点。
|
|
1894
|
-
* @notes 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时,才能检查曝光点设置能力。
|
|
1895
|
-
* @order 12
|
|
1896
|
-
* @return - YES:支持;
|
|
1897
|
-
* - NO:不支持。
|
|
1898
|
-
*
|
|
1899
|
-
*/
|
|
1102
|
+
|
|
1900
1103
|
/** {en}
|
|
1901
1104
|
* @detail api
|
|
1902
1105
|
* @brief Checks if manual exposure setting is available for the currently used camera.
|
|
@@ -1907,20 +1110,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1907
1110
|
*
|
|
1908
1111
|
*/
|
|
1909
1112
|
isExposurePositionSupported(): boolean;
|
|
1910
|
-
|
|
1911
|
-
* @detail api
|
|
1912
|
-
* @brief 设置当前使用的摄像头的曝光点。
|
|
1913
|
-
* @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集,并且使用 SDK 内部渲染时,才能设置曝光点;
|
|
1914
|
-
* - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后,设置的曝光点失效。
|
|
1915
|
-
* @order 13
|
|
1916
|
-
* @param viewW 当前视图宽度。
|
|
1917
|
-
* @param viewH 当前视图高度。
|
|
1918
|
-
* @param x 以左上角为原点,对焦点距当前视图的横向坐标值。
|
|
1919
|
-
* @param y 以左上角为原点,对焦点距当前视图的纵向坐标值。
|
|
1920
|
-
* @return - =0:成功;
|
|
1921
|
-
* - ≠0:失败。
|
|
1922
|
-
*
|
|
1923
|
-
*/
|
|
1113
|
+
|
|
1924
1114
|
/** {en}
|
|
1925
1115
|
* @detail api
|
|
1926
1116
|
* @brief Sets the manual exposure position for the currently used camera.
|
|
@@ -1936,15 +1126,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1936
1126
|
*
|
|
1937
1127
|
*/
|
|
1938
1128
|
setExposurePosition(viewW: number, viewH: number, x: number, y: number): number;
|
|
1939
|
-
|
|
1940
|
-
* @detail api
|
|
1941
|
-
* @brief 获取摄像头的最小曝光补偿值。
|
|
1942
|
-
* @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1943
|
-
* @order 14
|
|
1944
|
-
* @return - ≤0:表示不支持曝光补偿;
|
|
1945
|
-
* - >0:支持曝光补偿,数值表示最小曝光补偿。
|
|
1946
|
-
*
|
|
1947
|
-
*/
|
|
1129
|
+
|
|
1948
1130
|
/** {en}
|
|
1949
1131
|
* @detail api
|
|
1950
1132
|
* @brief Gets the minimum exposure compensation of the camera.
|
|
@@ -1955,15 +1137,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1955
1137
|
*
|
|
1956
1138
|
*/
|
|
1957
1139
|
getMinExposureCompensation(): number;
|
|
1958
|
-
|
|
1959
|
-
* @detail api
|
|
1960
|
-
* @brief 获取摄像头的最大曝光补偿值。
|
|
1961
|
-
* @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
1962
|
-
* @order 15
|
|
1963
|
-
* @return - ≤0:表示不支持曝光补偿;
|
|
1964
|
-
* - >0:支持曝光补偿,数值表示最大曝光补偿。
|
|
1965
|
-
*
|
|
1966
|
-
*/
|
|
1140
|
+
|
|
1967
1141
|
/** {en}
|
|
1968
1142
|
* @detail api
|
|
1969
1143
|
* @brief Gets the maximum exposure compensation of the camera.
|
|
@@ -1974,17 +1148,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1974
1148
|
*
|
|
1975
1149
|
*/
|
|
1976
1150
|
getMaxExposureCompensation(): number;
|
|
1977
|
-
|
|
1978
|
-
* @detail api
|
|
1979
|
-
* @brief 设置当前使用的摄像头的曝光补偿。
|
|
1980
|
-
* @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时,才能设置曝光补偿。
|
|
1981
|
-
* - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后,设置的曝光补偿失效。
|
|
1982
|
-
* @order 16
|
|
1983
|
-
* @param value 曝光补偿值,取值范围 [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation),[getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)],0 为系统默认值,表示没有曝光补偿。
|
|
1984
|
-
* @return - =0:设置成功;
|
|
1985
|
-
* - ≠0:设置失败。
|
|
1986
|
-
*
|
|
1987
|
-
*/
|
|
1151
|
+
|
|
1988
1152
|
/** {en}
|
|
1989
1153
|
* @detail api
|
|
1990
1154
|
* @brief Sets the exposure compensation for the currently used camera.
|
|
@@ -1998,16 +1162,7 @@ export declare class VeLiveCameraDevice {
|
|
|
1998
1162
|
*
|
|
1999
1163
|
*/
|
|
2000
1164
|
setExposureCompensation(value: number): number;
|
|
2001
|
-
|
|
2002
|
-
* @platform ios
|
|
2003
|
-
* @detail api
|
|
2004
|
-
* @brief 是否支持闪光灯。
|
|
2005
|
-
* @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
2006
|
-
* @order 49
|
|
2007
|
-
* @return <br>
|
|
2008
|
-
* - YES:支持;
|
|
2009
|
-
* - NO:不支持。
|
|
2010
|
-
*/
|
|
1165
|
+
|
|
2011
1166
|
/** {en}
|
|
2012
1167
|
* @platform ios
|
|
2013
1168
|
* @detail api
|
|
@@ -2018,14 +1173,7 @@ export declare class VeLiveCameraDevice {
|
|
|
2018
1173
|
* - NO: Not supported.
|
|
2019
1174
|
*/
|
|
2020
1175
|
ios_isTorchSupported(): boolean;
|
|
2021
|
-
|
|
2022
|
-
* @platform ios
|
|
2023
|
-
* @detail api
|
|
2024
|
-
* @brief 设置相机参数。
|
|
2025
|
-
* @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
2026
|
-
* @order 64
|
|
2027
|
-
* @param parameter 相机参数字典,包含要设置的参数名称(键)和对应的值
|
|
2028
|
-
*/
|
|
1176
|
+
|
|
2029
1177
|
/** {en}
|
|
2030
1178
|
* @platform ios
|
|
2031
1179
|
* @detail api
|
|
@@ -2035,16 +1183,7 @@ export declare class VeLiveCameraDevice {
|
|
|
2035
1183
|
* @param parameter The parameter name (key) and the corresponding value.
|
|
2036
1184
|
*/
|
|
2037
1185
|
ios_setParameter(parameter: $p_i.NSDictionary): void;
|
|
2038
|
-
|
|
2039
|
-
* @platform ios
|
|
2040
|
-
* @detail api
|
|
2041
|
-
* @brief 获取相机参数。
|
|
2042
|
-
* @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
|
|
2043
|
-
* @order 65
|
|
2044
|
-
* @param key 需要获取的相机参数的名称。
|
|
2045
|
-
* @return <br>
|
|
2046
|
-
* 相机参数的值,具体类型需要根据参数名称确定。
|
|
2047
|
-
*/
|
|
1186
|
+
|
|
2048
1187
|
/** {en}
|
|
2049
1188
|
* @platform ios
|
|
2050
1189
|
* @detail api
|
|
@@ -2057,24 +1196,12 @@ export declare class VeLiveCameraDevice {
|
|
|
2057
1196
|
*/
|
|
2058
1197
|
ios_getParameter(key: string): $p_i.id;
|
|
2059
1198
|
}
|
|
2060
|
-
|
|
2061
|
-
* @detail api
|
|
2062
|
-
* @brief 视频特效管理对象。用于管理和设置视频特效,包括美颜、美形、美体、美妆、滤镜等。
|
|
2063
|
-
*/
|
|
1199
|
+
|
|
2064
1200
|
export declare class VeLiveVideoEffectManager {
|
|
2065
1201
|
protected _instance: any;
|
|
2066
1202
|
protected __init(...args: any[]): void;
|
|
2067
1203
|
protected __new_instance(...args: any[]): any;
|
|
2068
|
-
|
|
2069
|
-
* @detail api
|
|
2070
|
-
* @brief 视频特效许可证配置,用于初始化视频特效管理对象。
|
|
2071
|
-
* @order 89
|
|
2072
|
-
* @param config 特效初始化配置,详情请参见 [VeLiveVideoEffectLicenseConfiguration](147521#VeLivePusherDef-VeLiveVideoEffectLicenseConfiguration)。
|
|
2073
|
-
* @return <br>
|
|
2074
|
-
* - 0:调用成功;
|
|
2075
|
-
* - -1:调用失败。
|
|
2076
|
-
*
|
|
2077
|
-
*/
|
|
1204
|
+
|
|
2078
1205
|
/** {en}
|
|
2079
1206
|
* @detail api
|
|
2080
1207
|
* @brief Initializes the special effects manager.
|
|
@@ -2086,15 +1213,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2086
1213
|
*
|
|
2087
1214
|
*/
|
|
2088
1215
|
setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): number;
|
|
2089
|
-
|
|
2090
|
-
* @detail api
|
|
2091
|
-
* @brief 如果您使用在线 License 认证方式,在许可证过期后,可调用该方法更新 License;
|
|
2092
|
-
* @notes - 需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用;
|
|
2093
|
-
* - 本方法为异步操作。
|
|
2094
|
-
* @order 90
|
|
2095
|
-
* @param callback 结果回调信息
|
|
2096
|
-
*
|
|
2097
|
-
*/
|
|
1216
|
+
|
|
2098
1217
|
/** {en}
|
|
2099
1218
|
* @detail api
|
|
2100
1219
|
* @brief Updates the special effects license. This method is effective only if you authenticate the license online.
|
|
@@ -2106,22 +1225,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2106
1225
|
*
|
|
2107
1226
|
*/
|
|
2108
1227
|
updateLicense(callback: (result: number, message: string) => void): void;
|
|
2109
|
-
|
|
2110
|
-
* @detail api
|
|
2111
|
-
* @brief 创建/销毁特效引擎。
|
|
2112
|
-
* @notes - 该方法需要在调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 和 [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath) 后调用;
|
|
2113
|
-
* - 该方法不直接开启/关闭视频特效,您需要在调用该方法后,调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 开启视频特效;
|
|
2114
|
-
* - 通用场景下,特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求,也可以在不使用特效相关功能时,调用该方法销毁特效引擎;
|
|
2115
|
-
* - 如果重复创建/销毁特效引擎,会产生时间消耗。
|
|
2116
|
-
* @order 92
|
|
2117
|
-
* @param enable 是否创建特效引擎。默认为 false。 <br>
|
|
2118
|
-
* - true:创建;
|
|
2119
|
-
* - false:销毁。
|
|
2120
|
-
* @param callback 视频特效回调 [VeLiveVideoEffectCallback](147519#VeLivePusherDef-VeLiveVideoEffectCallback)。
|
|
2121
|
-
* @return - 0:成功;
|
|
2122
|
-
* - -1:失败。
|
|
2123
|
-
*
|
|
2124
|
-
*/
|
|
1228
|
+
|
|
2125
1229
|
/** {en}
|
|
2126
1230
|
* @detail api
|
|
2127
1231
|
* @brief Creates or destroys the special effects engine.
|
|
@@ -2141,18 +1245,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2141
1245
|
*
|
|
2142
1246
|
*/
|
|
2143
1247
|
setEnable(enable: boolean, callback: (result: number, msg: string) => void): void;
|
|
2144
|
-
|
|
2145
|
-
* @platform android
|
|
2146
|
-
* @detail api
|
|
2147
|
-
* @brief 设置特效算法模型包的路径。
|
|
2148
|
-
* @notes <br>需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用。
|
|
2149
|
-
* @order 91
|
|
2150
|
-
* @param path 特效算法模型包的路径
|
|
2151
|
-
* @return <br>
|
|
2152
|
-
* - 0:调用成功;
|
|
2153
|
-
* - -1:调用失败。
|
|
2154
|
-
*
|
|
2155
|
-
*/
|
|
1248
|
+
|
|
2156
1249
|
/** {en}
|
|
2157
1250
|
* @platform android
|
|
2158
1251
|
* @detail api
|
|
@@ -2167,20 +1260,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2167
1260
|
*
|
|
2168
1261
|
*/
|
|
2169
1262
|
android_setAlgorithmModelPath(path: string): number;
|
|
2170
|
-
|
|
2171
|
-
* @detail api
|
|
2172
|
-
* @brief 设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能,包括美颜、美形、美体、美妆等。
|
|
2173
|
-
* @notes <br>
|
|
2174
|
-
* - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法;
|
|
2175
|
-
* - 重复调用本方法,仅最后一次调用生效;
|
|
2176
|
-
* - 如果需要在当前的视频特效组合中叠加特效,可调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 方法。
|
|
2177
|
-
* @order 93
|
|
2178
|
-
* @param nodes 视频特效素材包路径数组
|
|
2179
|
-
* @return <br>
|
|
2180
|
-
* - 0:调用成功;
|
|
2181
|
-
* - -1:调用失败。
|
|
2182
|
-
*
|
|
2183
|
-
*/
|
|
1263
|
+
|
|
2184
1264
|
/** {en}
|
|
2185
1265
|
* @detail api
|
|
2186
1266
|
* @brief Sets the special effects you want to apply to the video. You can choose effects from ComposeMakeup.bundle.
|
|
@@ -2196,17 +1276,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2196
1276
|
*
|
|
2197
1277
|
*/
|
|
2198
1278
|
setComposeNodes(nodes: Array<string>): number;
|
|
2199
|
-
|
|
2200
|
-
* @detail api
|
|
2201
|
-
* @brief 在已有的视频特效组合上,叠加视频特效素材包,您可以调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合。
|
|
2202
|
-
* @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
|
|
2203
|
-
* @order 94
|
|
2204
|
-
* @param nodes 视频特效素材包路径数组
|
|
2205
|
-
* @return <br>
|
|
2206
|
-
* - 0:调用成功;
|
|
2207
|
-
* - -1:调用失败。
|
|
2208
|
-
*
|
|
2209
|
-
*/
|
|
1279
|
+
|
|
2210
1280
|
/** {en}
|
|
2211
1281
|
* @detail api
|
|
2212
1282
|
* @brief Adds one or more effects to the existing effects settings that you have configured by calling setComposeNodes {@link #VeLiveVideoEffectManager#setComposeNodes}.
|
|
@@ -2219,17 +1289,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2219
1289
|
*
|
|
2220
1290
|
*/
|
|
2221
1291
|
appendComposeNodes(nodes: Array<string>): number;
|
|
2222
|
-
|
|
2223
|
-
* @detail api
|
|
2224
|
-
* @brief 调用本方法,可移除调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 和 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 设置的视频特效资源。
|
|
2225
|
-
* @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
|
|
2226
|
-
* @order 94
|
|
2227
|
-
* @param nodes 视频特效素材包路径数组
|
|
2228
|
-
* @return <br>
|
|
2229
|
-
* - 0:调用成功;
|
|
2230
|
-
* - -1:调用失败。
|
|
2231
|
-
*
|
|
2232
|
-
*/
|
|
1292
|
+
|
|
2233
1293
|
/** {en}
|
|
2234
1294
|
* @detail api
|
|
2235
1295
|
* @brief Removes one or more special effects resource set by the [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) or [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) methods.
|
|
@@ -2242,21 +1302,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2242
1302
|
*
|
|
2243
1303
|
*/
|
|
2244
1304
|
removeComposeNodes(nodes: Array<string>): number;
|
|
2245
|
-
|
|
2246
|
-
* @detail api
|
|
2247
|
-
* @brief 设置视频特效强度。
|
|
2248
|
-
* @notes <br>
|
|
2249
|
-
* - 需要在调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合或调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 叠加视频特效素材包后,调用本方法;
|
|
2250
|
-
* - 该方法仅适用于同时含有上述三个参数的特效资源,对于没有强度参数的特效(如贴纸),该方法无效。
|
|
2251
|
-
* @order 95
|
|
2252
|
-
* @param node 视频特效素材包路径
|
|
2253
|
-
* @param key 需要设置的素材 key 名称
|
|
2254
|
-
* @param intensity 需要设置的强度值。取值范围为 [0.0,1.0]
|
|
2255
|
-
* @return <br>
|
|
2256
|
-
* - 0:调用成功;
|
|
2257
|
-
* - -1:调用失败。
|
|
2258
|
-
*
|
|
2259
|
-
*/
|
|
1305
|
+
|
|
2260
1306
|
/** {en}
|
|
2261
1307
|
* @detail api
|
|
2262
1308
|
* @brief Sets the intensity of a special effect.
|
|
@@ -2273,17 +1319,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2273
1319
|
*
|
|
2274
1320
|
*/
|
|
2275
1321
|
updateComposerNodeIntensity(node: string, key: string, intensity: number): number;
|
|
2276
|
-
|
|
2277
|
-
* @detail api
|
|
2278
|
-
* @brief 设置颜色滤镜。
|
|
2279
|
-
* @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法。
|
|
2280
|
-
* @order 96
|
|
2281
|
-
* @param path 滤镜资源包绝对路径
|
|
2282
|
-
* @return <br>
|
|
2283
|
-
* - 0:调用成功;
|
|
2284
|
-
* - -1:调用失败。
|
|
2285
|
-
*
|
|
2286
|
-
*/
|
|
1322
|
+
|
|
2287
1323
|
/** {en}
|
|
2288
1324
|
* @detail api
|
|
2289
1325
|
* @brief Sets the color filter.
|
|
@@ -2297,16 +1333,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2297
1333
|
*
|
|
2298
1334
|
*/
|
|
2299
1335
|
setFilter(path: string): number;
|
|
2300
|
-
|
|
2301
|
-
* @detail api
|
|
2302
|
-
* @brief 设置已启用的颜色滤镜强度。
|
|
2303
|
-
* @notes <br>请在调用 [setFilter](#VeLiveVideoEffectManager-setfilter) 设置颜色滤镜后调用。
|
|
2304
|
-
* @order 97
|
|
2305
|
-
* @param intensity 滤镜强度,取值范围为 [0.0,1.0]。
|
|
2306
|
-
* @return - 0:调用成功;
|
|
2307
|
-
* - -1:调用失败。
|
|
2308
|
-
*
|
|
2309
|
-
*/
|
|
1336
|
+
|
|
2310
1337
|
/** {en}
|
|
2311
1338
|
* @detail api
|
|
2312
1339
|
* @brief Sets the intensity of the color filter.
|
|
@@ -2319,17 +1346,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2319
1346
|
*
|
|
2320
1347
|
*/
|
|
2321
1348
|
updateFilterIntensity(intensity: number): number;
|
|
2322
|
-
|
|
2323
|
-
* @detail api
|
|
2324
|
-
* @brief 设置贴纸特效。
|
|
2325
|
-
* @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法。
|
|
2326
|
-
* @order 98
|
|
2327
|
-
* @param path 贴纸素材包的绝对路径
|
|
2328
|
-
* @return <br>
|
|
2329
|
-
* - 0:调用成功;
|
|
2330
|
-
* - -1:调用失败。
|
|
2331
|
-
*
|
|
2332
|
-
*/
|
|
1349
|
+
|
|
2333
1350
|
/** {en}
|
|
2334
1351
|
* @detail api
|
|
2335
1352
|
* @brief Sets the sticker.
|
|
@@ -2343,16 +1360,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2343
1360
|
*
|
|
2344
1361
|
*/
|
|
2345
1362
|
setSticker(path: string): number;
|
|
2346
|
-
|
|
2347
|
-
* @detail api
|
|
2348
|
-
* @brief 智能美化特效的高级功能。
|
|
2349
|
-
* @notes 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法,不要在主线程中频繁执行同步操作。
|
|
2350
|
-
* @order 99
|
|
2351
|
-
* @param callback 将 handle 作为参数的回调函数。
|
|
2352
|
-
* @param isGLThread 是否在 GL 线程回调 callback。
|
|
2353
|
-
* @param isAsync 是否同步执行 callback。
|
|
2354
|
-
*
|
|
2355
|
-
*/
|
|
1363
|
+
|
|
2356
1364
|
/** {en}
|
|
2357
1365
|
* @detail api
|
|
2358
1366
|
* @brief Advanced functions of BytePlus Effects.
|
|
@@ -2365,18 +1373,7 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2365
1373
|
*
|
|
2366
1374
|
*/
|
|
2367
1375
|
setAdvancedFeature(callback: (handle: void) => void, isGLThread: boolean, isAsync: boolean): number;
|
|
2368
|
-
|
|
2369
|
-
* @platform ios
|
|
2370
|
-
* @detail api
|
|
2371
|
-
* @brief 设置特效算法模型包的路径。
|
|
2372
|
-
* @notes <br>
|
|
2373
|
-
* 需要通过调用 setupWithConfig:{@link #VeLiveVideoEffectManager#setupWithConfig} 设置视频特效许可证后调用。
|
|
2374
|
-
* @order 4
|
|
2375
|
-
* @param path 特效算法模型包的路径。
|
|
2376
|
-
* @return <br>
|
|
2377
|
-
* - 0:调用成功;
|
|
2378
|
-
* - -1:调用失败。
|
|
2379
|
-
*/
|
|
1376
|
+
|
|
2380
1377
|
/** {en}
|
|
2381
1378
|
* @platform ios
|
|
2382
1379
|
* @detail api
|
|
@@ -2391,21 +1388,12 @@ export declare class VeLiveVideoEffectManager {
|
|
|
2391
1388
|
*/
|
|
2392
1389
|
ios_setAlgoModelPath(path: string): number;
|
|
2393
1390
|
}
|
|
2394
|
-
|
|
2395
|
-
* @detail api
|
|
2396
|
-
* @brief 音频设备管理类。该类提供了用于管理和控制音频设备,包括设置音量、获取当前音量的方法。
|
|
2397
|
-
*/
|
|
1391
|
+
|
|
2398
1392
|
export declare class VeLiveAudioDevice {
|
|
2399
1393
|
protected _instance: any;
|
|
2400
1394
|
protected __init(...args: any[]): void;
|
|
2401
1395
|
protected __new_instance(...args: any[]): any;
|
|
2402
|
-
|
|
2403
|
-
* @detail api
|
|
2404
|
-
* @brief 设置音量响度。
|
|
2405
|
-
* @order 74
|
|
2406
|
-
* @param level 音量响度等级,取值范围为 [0.0,4.0]。
|
|
2407
|
-
*
|
|
2408
|
-
*/
|
|
1396
|
+
|
|
2409
1397
|
/** {en}
|
|
2410
1398
|
* @detail api
|
|
2411
1399
|
* @brief Sets the volume.
|
|
@@ -2414,14 +1402,7 @@ export declare class VeLiveAudioDevice {
|
|
|
2414
1402
|
*
|
|
2415
1403
|
*/
|
|
2416
1404
|
setVoiceLoudness(level: number): void;
|
|
2417
|
-
|
|
2418
|
-
* @detail api
|
|
2419
|
-
* @brief 获取当前音量响度。
|
|
2420
|
-
* @order 75
|
|
2421
|
-
* @return <br>
|
|
2422
|
-
* 当前音量响度等级。
|
|
2423
|
-
*
|
|
2424
|
-
*/
|
|
1405
|
+
|
|
2425
1406
|
/** {en}
|
|
2426
1407
|
* @detail api
|
|
2427
1408
|
* @brief Gets the current volume.
|
|
@@ -2431,15 +1412,7 @@ export declare class VeLiveAudioDevice {
|
|
|
2431
1412
|
*
|
|
2432
1413
|
*/
|
|
2433
1414
|
getVoiceLoudness(): number;
|
|
2434
|
-
|
|
2435
|
-
* @platform ios
|
|
2436
|
-
* @detail api
|
|
2437
|
-
* @brief 查询是否支持硬件耳返。
|
|
2438
|
-
* @return <br>
|
|
2439
|
-
* - YES:支持;
|
|
2440
|
-
* - NO:不支持。
|
|
2441
|
-
* @order 62
|
|
2442
|
-
*/
|
|
1415
|
+
|
|
2443
1416
|
/** {en}
|
|
2444
1417
|
* @platform ios
|
|
2445
1418
|
* @detail api
|
|
@@ -2450,17 +1423,7 @@ export declare class VeLiveAudioDevice {
|
|
|
2450
1423
|
* @order 62
|
|
2451
1424
|
*/
|
|
2452
1425
|
ios_isSupportHardwareEcho(): boolean;
|
|
2453
|
-
|
|
2454
|
-
* @platform ios
|
|
2455
|
-
* @detail api
|
|
2456
|
-
* @brief 是否开启耳返功能。
|
|
2457
|
-
* @param enable 耳返功能开关。默认值为 NO。<br>
|
|
2458
|
-
* - YES:开启;
|
|
2459
|
-
* - NO:关闭。
|
|
2460
|
-
* @notes
|
|
2461
|
-
* 需要在调用 [startAudioCapture:](#VeLivePusher-startaudiocapture) 启动音频采集后,调用本方法。
|
|
2462
|
-
* @order 64
|
|
2463
|
-
*/
|
|
1426
|
+
|
|
2464
1427
|
/** {en}
|
|
2465
1428
|
* @platform ios
|
|
2466
1429
|
* @detail api
|
|
@@ -2473,17 +1436,7 @@ export declare class VeLiveAudioDevice {
|
|
|
2473
1436
|
* @order 64
|
|
2474
1437
|
*/
|
|
2475
1438
|
ios_enableEcho(enable: boolean): void;
|
|
2476
|
-
|
|
2477
|
-
* @platform ios
|
|
2478
|
-
* @detail api
|
|
2479
|
-
* @brief 获取当前耳返开启状态。
|
|
2480
|
-
* @notes
|
|
2481
|
-
* 需要在调用 [startAudioCapture:](#VeLivePusher-startaudiocapture) 启动音频采集后,调用本方法。
|
|
2482
|
-
* @order 65
|
|
2483
|
-
* @return <br>
|
|
2484
|
-
* - YES:开启;
|
|
2485
|
-
* - NO:关闭。
|
|
2486
|
-
*/
|
|
1439
|
+
|
|
2487
1440
|
/** {en}
|
|
2488
1441
|
* @platform ios
|
|
2489
1442
|
* @detail api
|