@volcengine/react-native-live-push 1.1.3-rc.1 → 1.2.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/android/build.gradle +2 -2
  2. package/android/src/main/java/com/volcengine/velive/rn/push/ClassHelper.java +9 -0
  3. package/android/src/main/java/com/volcengine/velive/rn/push/NativeVariableManager.java +5 -8
  4. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushModule.java +14 -2
  5. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushPackage.java +16 -13
  6. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushView.java +16 -0
  7. package/android/src/main/java/com/volcengine/velive/rn/push/VeLivePushViewManager.java +7 -2
  8. package/android/src/main/java/com/volcengine/velive/rn/push/mixer/MixerManager.java +410 -0
  9. package/android/src/main/java/com/volcengine/velive/rn/push/mixer/MixerView.java +434 -0
  10. package/android/src/main/java/com/volcengine/velive/rn/push/mixer/MixerViewManager.java +79 -0
  11. package/android/src/main/java/com/volcengine/velive/rn/push/mixer/TextureMgr.java +168 -0
  12. package/android/src/main/java/com/volcengine/velive/rn/push/mixer/YuvHelper.java +165 -0
  13. package/ios/VeLiveMixerHelper.h +46 -0
  14. package/ios/VeLiveMixerHelper.m +620 -0
  15. package/ios/VeLiveMixerView.h +69 -0
  16. package/ios/VeLiveMixerView.m +600 -0
  17. package/ios/VeLiveMixerViewManager.m +92 -0
  18. package/lib/commonjs/index.js +22698 -20359
  19. package/lib/commonjs/typescript/android/index.d.ts +44 -0
  20. package/lib/commonjs/typescript/codegen/android/api.d.ts +1068 -0
  21. package/lib/commonjs/typescript/codegen/android/callback.d.ts +333 -0
  22. package/lib/commonjs/typescript/codegen/android/errorcode.d.ts +92 -0
  23. package/lib/commonjs/typescript/codegen/android/index.d.ts +5 -0
  24. package/lib/commonjs/typescript/codegen/android/keytype.d.ts +1693 -0
  25. package/lib/commonjs/typescript/codegen/android/types.d.ts +33 -0
  26. package/lib/commonjs/typescript/codegen/ios/api.d.ts +1125 -0
  27. package/lib/commonjs/typescript/codegen/ios/callback.d.ts +242 -0
  28. package/lib/commonjs/typescript/codegen/ios/errorcode.d.ts +154 -0
  29. package/lib/commonjs/typescript/codegen/ios/external.d.ts +1 -0
  30. package/lib/commonjs/typescript/codegen/ios/index.d.ts +6 -0
  31. package/lib/commonjs/typescript/codegen/ios/keytype.d.ts +1154 -0
  32. package/lib/commonjs/typescript/codegen/ios/types.d.ts +46 -0
  33. package/lib/commonjs/typescript/codegen/pack/api.d.ts +1470 -0
  34. package/lib/commonjs/typescript/codegen/pack/callback.d.ts +446 -0
  35. package/lib/commonjs/typescript/codegen/pack/errorcode.d.ts +109 -0
  36. package/lib/commonjs/typescript/codegen/pack/index.d.ts +5 -0
  37. package/lib/commonjs/typescript/codegen/pack/keytype.d.ts +2248 -0
  38. package/lib/commonjs/typescript/codegen/pack/types.d.ts +68 -0
  39. package/lib/commonjs/typescript/codegen/type-shim.d.ts +6 -0
  40. package/lib/commonjs/typescript/component.d.ts +15 -0
  41. package/lib/commonjs/typescript/core/api.d.ts +18 -0
  42. package/lib/commonjs/typescript/core/callback.d.ts +2 -0
  43. package/lib/commonjs/typescript/core/env.d.ts +29 -0
  44. package/lib/commonjs/typescript/core/errorcode.d.ts +2 -0
  45. package/lib/commonjs/typescript/core/index.d.ts +6 -0
  46. package/lib/commonjs/typescript/core/keytype.d.ts +18 -0
  47. package/lib/commonjs/typescript/core/mixer.d.ts +26 -0
  48. package/lib/commonjs/typescript/core/pusher.d.ts +13 -0
  49. package/lib/commonjs/typescript/index.d.ts +3 -0
  50. package/lib/commonjs/typescript/ios/extends.d.ts +41 -0
  51. package/lib/commonjs/typescript/platforms/android/extends.d.ts +8 -0
  52. package/lib/commonjs/typescript/platforms/android/helper.d.ts +8 -0
  53. package/lib/commonjs/typescript/platforms/android/mixer.d.ts +8 -0
  54. package/lib/commonjs/typescript/platforms/ios/extends.d.ts +17 -0
  55. package/lib/commonjs/typescript/platforms/ios/helper.d.ts +8 -0
  56. package/lib/commonjs/typescript/platforms/ios/mixer.d.ts +9 -0
  57. package/lib/commonjs/typescript/runtime.d.ts +1 -0
  58. package/lib/commonjs/typescript/view/MixView.d.ts +52 -0
  59. package/lib/commonjs/typescript/view/VeImageView.d.ts +19 -0
  60. package/lib/commonjs/typescript/view/VeTextView.d.ts +7 -0
  61. package/lib/commonjs/typescript/view/VeView.d.ts +7 -0
  62. package/lib/commonjs/typescript/view/VeWebView.d.ts +7 -0
  63. package/lib/commonjs/typescript/view/index.d.ts +5 -0
  64. package/lib/module/index.js +22695 -20360
  65. package/lib/module/typescript/android/index.d.ts +44 -0
  66. package/lib/module/typescript/codegen/android/api.d.ts +1068 -0
  67. package/lib/module/typescript/codegen/android/callback.d.ts +333 -0
  68. package/lib/module/typescript/codegen/android/errorcode.d.ts +92 -0
  69. package/lib/module/typescript/codegen/android/index.d.ts +5 -0
  70. package/lib/module/typescript/codegen/android/keytype.d.ts +1693 -0
  71. package/lib/module/typescript/codegen/android/types.d.ts +33 -0
  72. package/lib/module/typescript/codegen/ios/api.d.ts +1125 -0
  73. package/lib/module/typescript/codegen/ios/callback.d.ts +242 -0
  74. package/lib/module/typescript/codegen/ios/errorcode.d.ts +154 -0
  75. package/lib/module/typescript/codegen/ios/external.d.ts +1 -0
  76. package/lib/module/typescript/codegen/ios/index.d.ts +6 -0
  77. package/lib/module/typescript/codegen/ios/keytype.d.ts +1154 -0
  78. package/lib/module/typescript/codegen/ios/types.d.ts +46 -0
  79. package/lib/module/typescript/codegen/pack/api.d.ts +1470 -0
  80. package/lib/module/typescript/codegen/pack/callback.d.ts +446 -0
  81. package/lib/module/typescript/codegen/pack/errorcode.d.ts +109 -0
  82. package/lib/module/typescript/codegen/pack/index.d.ts +5 -0
  83. package/lib/module/typescript/codegen/pack/keytype.d.ts +2248 -0
  84. package/lib/module/typescript/codegen/pack/types.d.ts +68 -0
  85. package/lib/module/typescript/codegen/type-shim.d.ts +6 -0
  86. package/lib/module/typescript/component.d.ts +15 -0
  87. package/lib/module/typescript/core/api.d.ts +18 -0
  88. package/lib/module/typescript/core/callback.d.ts +2 -0
  89. package/lib/module/typescript/core/env.d.ts +29 -0
  90. package/lib/module/typescript/core/errorcode.d.ts +2 -0
  91. package/lib/module/typescript/core/index.d.ts +6 -0
  92. package/lib/module/typescript/core/keytype.d.ts +18 -0
  93. package/lib/module/typescript/core/mixer.d.ts +26 -0
  94. package/lib/module/typescript/core/pusher.d.ts +13 -0
  95. package/lib/module/typescript/index.d.ts +3 -0
  96. package/lib/module/typescript/ios/extends.d.ts +41 -0
  97. package/lib/module/typescript/platforms/android/extends.d.ts +8 -0
  98. package/lib/module/typescript/platforms/android/helper.d.ts +8 -0
  99. package/lib/module/typescript/platforms/android/mixer.d.ts +8 -0
  100. package/lib/module/typescript/platforms/ios/extends.d.ts +17 -0
  101. package/lib/module/typescript/platforms/ios/helper.d.ts +8 -0
  102. package/lib/module/typescript/platforms/ios/mixer.d.ts +9 -0
  103. package/lib/module/typescript/runtime.d.ts +1 -0
  104. package/lib/module/typescript/view/MixView.d.ts +52 -0
  105. package/lib/module/typescript/view/VeImageView.d.ts +19 -0
  106. package/lib/module/typescript/view/VeTextView.d.ts +7 -0
  107. package/lib/module/typescript/view/VeView.d.ts +7 -0
  108. package/lib/module/typescript/view/VeWebView.d.ts +7 -0
  109. package/lib/module/typescript/view/index.d.ts +5 -0
  110. package/lib/typescript/android/index.d.ts +0 -3
  111. package/lib/typescript/codegen/android/api.d.ts +194 -762
  112. package/lib/typescript/codegen/android/callback.d.ts +85 -48
  113. package/lib/typescript/codegen/android/errorcode.d.ts +30 -0
  114. package/lib/typescript/codegen/android/keytype.d.ts +514 -122
  115. package/lib/typescript/codegen/ios/api.d.ts +380 -351
  116. package/lib/typescript/codegen/ios/callback.d.ts +33 -6
  117. package/lib/typescript/codegen/ios/errorcode.d.ts +52 -2
  118. package/lib/typescript/codegen/ios/keytype.d.ts +313 -35
  119. package/lib/typescript/codegen/pack/api.d.ts +302 -821
  120. package/lib/typescript/codegen/pack/callback.d.ts +54 -49
  121. package/lib/typescript/codegen/pack/errorcode.d.ts +38 -5
  122. package/lib/typescript/codegen/pack/keytype.d.ts +672 -228
  123. package/lib/typescript/core/api.d.ts +18 -2
  124. package/lib/typescript/core/keytype.d.ts +16 -0
  125. package/lib/typescript/core/mixer.d.ts +26 -0
  126. package/lib/typescript/core/pusher.d.ts +0 -3
  127. package/lib/typescript/index.d.ts +1 -0
  128. package/lib/typescript/platforms/android/extends.d.ts +8 -0
  129. package/lib/typescript/platforms/android/mixer.d.ts +8 -0
  130. package/lib/typescript/platforms/ios/mixer.d.ts +9 -0
  131. package/lib/typescript/view/MixView.d.ts +52 -0
  132. package/lib/typescript/view/VeImageView.d.ts +19 -0
  133. package/lib/typescript/view/VeTextView.d.ts +7 -0
  134. package/lib/typescript/view/VeView.d.ts +7 -0
  135. package/lib/typescript/view/VeWebView.d.ts +7 -0
  136. package/lib/typescript/view/index.d.ts +5 -0
  137. package/package.json +1 -1
  138. package/react-native-velive-push.podspec +3 -3
  139. package/android/src/main/java/com/volcengine/velive/rn/push/ScreenCaptureHelper.java +0 -73
@@ -1,8 +1,8 @@
1
1
  import * as $p_a from '../android/index';
2
2
  import * as $p_i from '../ios/index';
3
3
  import { VeLivePusherObserver, VeLivePusherStatisticsObserver, VeLiveFileRecordingListener, VeLiveVideoFrameFilter, VeLiveAudioFrameFilter, VeLiveVideoFrameListener, VeLiveAudioFrameListener, VeLiveSnapshotListener, VeLiveMediaPlayerListener, VeLiveMediaPlayerFrameListener } from './callback';
4
- import { VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveOrientation, VeLivePusherLogLevel, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveVideoCaptureConfiguration, VeLiveVideoEffectLicenseConfiguration, VeLiveStreamMixDescription, VeLiveAudioBufferType, VeLiveAudioSampleRate, VeLiveAudioChannel } from './keytype';
5
- import { View, Bitmap, Matrix, ByteBuffer } from './types';
4
+ import { VeLivePusherRenderMode, VeLiveVideoMirrorType, VeLiveVideoCaptureType, VeLiveAudioCaptureType, VeLiveOrientation, VeLivePusherLogLevel, VeLiveVideoEncoderConfiguration, VeLiveAudioEncoderConfiguration, VeLiveFileRecorderConfiguration, VeLiveVideoFrame, VeLiveAudioFrame, VeLiveVideoCaptureConfiguration, VeLiveVideoEffectLicenseConfiguration } from './keytype';
5
+ import { View, Bitmap } from './types';
6
6
  /** {zh}
7
7
  * @detail api
8
8
  * @brief 直播推流器。
@@ -22,27 +22,17 @@ export declare class VeLivePusher {
22
22
  /** {zh}
23
23
  * @detail api
24
24
  * @brief 设置输出到控制台的日志等级。
25
- * @order 60
25
+ * @order 49
26
26
  * @param logLevel 输出的日志级别。级别详情请参见 [VeLivePusherLogLevel](147521#VeLivePusherLogLevel)。
27
27
  *
28
28
  */
29
29
 
30
30
  static setLogLevel(logLevel: VeLivePusherLogLevel): void;
31
- /** {zh}
32
- * @platform android
33
- * @detail api
34
- * @hidden
35
- * @brief 设置日志控制。
36
- * @param config 输出的日志控制,详情请参见 [VeLivePusherLogConfig](147521#VeLivePusherLogConfig)。
37
- *
38
- */
39
-
40
- static android_setLogConfig(config: $p_a.VeLivePusherLogConfig): void;
41
31
  /** {zh}
42
32
  * @platform android
43
33
  * @detail api
44
34
  * @brief 设置 OpenGL 的上下文。
45
- * @order 61
35
+ * @order 50
46
36
  * @param context OpenGL 上下文。
47
37
  *
48
38
  */
@@ -54,7 +44,7 @@ export declare class VeLivePusher {
54
44
  /** {zh}
55
45
  * @detail api
56
46
  * @brief 停止采集和推流,并销毁推流器。通常在调用 [stopPush](#VeLivePusher-stoppush) 结束推流后调用此方法进行清理。
57
- * @order 13
47
+ * @order 4
58
48
  *
59
49
  */
60
50
 
@@ -65,7 +55,7 @@ export declare class VeLivePusher {
65
55
  * @notes <br>
66
56
  * - 需要在创建推流引擎后,调用本方法;
67
57
  * - 重复调用本方法,仅最后一次调用生效。
68
- * @order 14
58
+ * @order 2
69
59
  * @param observer 推流器回调对象,详细信息请参见 [VeLivePusherObserver](147519#VeLivePusherObserver)。
70
60
  *
71
61
  */
@@ -77,8 +67,8 @@ export declare class VeLivePusher {
77
67
  * @notes <br>
78
68
  * - 需要在创建推流引擎后,调用本方法;
79
69
  * - 重复调用本方法,仅最后一次调用生效。
80
- * @order 15
81
- * @param observer 推流器周期性回调对象,详细信息请参见 [VeLivePusherStatisticsObserver](147519#VeLivePusherStatisticsObserver)。
70
+ * @order 3
71
+ * @param observer 推流器周期性回调对象,详细信息请参见 [VeLivePusherStatisticsObserver](147519#VeLivePusherDef-VeLivePusherStatisticsObserver)。
82
72
  * @param interval 周期性回调的时间间隔,单位为 s,默认值为 5。
83
73
  *
84
74
  */
@@ -88,7 +78,7 @@ export declare class VeLivePusher {
88
78
  * @detail api
89
79
  * @brief 设置本地摄像头预览视图。摄像头采集到的画面,经过美颜、脸形调整、滤镜等多种效果叠加之后,最终会显示到传入的 View 上。
90
80
  * @param view 摄像头预览视图
91
- * @order 16
81
+ * @order 5
92
82
  *
93
83
  */
94
84
 
@@ -97,6 +87,7 @@ export declare class VeLivePusher {
97
87
  * @detail api
98
88
  * @brief 设置本地预览画面的填充模式。
99
89
  * @param mode 填充模式。
90
+ * @order 6
100
91
  *
101
92
  */
102
93
 
@@ -106,7 +97,7 @@ export declare class VeLivePusher {
106
97
  * @brief 开启/关闭镜像。
107
98
  * @notes <br>
108
99
  * 用于配置视频镜像效果,影响采集、预览和推流画面。
109
- * @order 17
100
+ * @order 7
110
101
  * @param type 镜像类型,详细信息请参见 [VeLiveVideoMirrorType](147521#VeLiveVideoMirrorType)。
111
102
  * @param mirror 是否开启镜像。<br>
112
103
  * - true:开启;
@@ -119,10 +110,9 @@ export declare class VeLivePusher {
119
110
  * @detail api
120
111
  * @brief 开始视频采集。
121
112
  * @notes <br>调用该接口后,可以通过调用接口 [stopVideoCapture](#VeLivePusher-stopvideocapture) 停止视频采集。
122
- * @order 18
113
+ * @order 8
123
114
  * @param type 视频采集类型,详细信息请参见 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType}
124
115
  *
125
- *
126
116
  */
127
117
 
128
118
  startVideoCapture(type: VeLiveVideoCaptureType): void;
@@ -130,7 +120,7 @@ export declare class VeLivePusher {
130
120
  * @detail api
131
121
  * @brief 停止视频采集。
132
122
  * @notes <br>调用该接口后,可以通过调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 开始视频采集。
133
- * @order 19
123
+ * @order 10
134
124
  *
135
125
  */
136
126
 
@@ -139,7 +129,7 @@ export declare class VeLivePusher {
139
129
  * @detail api
140
130
  * @brief 开始音频采集。
141
131
  * @notes <br>调用该接口后,可以通过调用接口 [stopAudioCapture](#VeLivePusher-stopaudiocapture) 停止音频采集。
142
- * @order 20
132
+ * @order 9
143
133
  * @param type 音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
144
134
  *
145
135
  */
@@ -149,7 +139,7 @@ export declare class VeLivePusher {
149
139
  * @detail api
150
140
  * @brief 停止音频采集。
151
141
  * @notes <br>调用该接口后,可以通过调用接口 [startAudioCapture](#VeLivePusher-startaudiocapture) 开始音频采集。
152
- * @order 21
142
+ * @order 11
153
143
  *
154
144
  */
155
145
 
@@ -158,7 +148,7 @@ export declare class VeLivePusher {
158
148
  * @detail api
159
149
  * @brief 切换视频采集类型。
160
150
  * @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
161
- * @order 22
151
+ * @order 12
162
152
  * @param type 视频采集类型,详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
163
153
  *
164
154
  */
@@ -168,7 +158,7 @@ export declare class VeLivePusher {
168
158
  * @detail api
169
159
  * @brief 切换音频采集类型。
170
160
  * @notes <br>该接口必须在调用接口 [startVideoCapture](#VeLivePusher-startvideocapture) 后调用才能生效。
171
- * @order 23
161
+ * @order 13
172
162
  * @param type 音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
173
163
  *
174
164
  */
@@ -177,8 +167,8 @@ export declare class VeLivePusher {
177
167
  /** {zh}
178
168
  * @detail api
179
169
  * @brief 获取当前视频采集类型。
180
- * @return <br>视频采集类型,详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
181
- * @order 24
170
+ * @order 14
171
+ * @return 视频采集类型,详细信息请参见 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType)。
182
172
  *
183
173
  */
184
174
 
@@ -186,17 +176,16 @@ export declare class VeLivePusher {
186
176
  /** {zh}
187
177
  * @detail api
188
178
  * @brief 获取当前音频采集类型。
179
+ * @order 15
189
180
  * @return <br>音频采集类型,详细信息请参见 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType)。
190
- * @order 25
191
181
  *
192
182
  */
193
183
 
194
184
  getCurrentAudioCaptureType(): VeLiveAudioCaptureType;
195
185
  /** {zh}
196
186
  * @detail api
197
- * @brief 自定义静态图,适用于静态图推流采集类型。
198
- * @notes <br>使用该接口时,需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage,您可调用 [startVideoCapture](#VeLivePusher-startvideocapture) 方法,将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
199
- * @order 26
187
+ * @brief 自定义静态图,适用于静态图推流采集类型。使用该接口时,需要将视频采集类型设置为 VeLiveVideoCaptureCustomImage,您可调用 [startVideoCapture](#VeLivePusher-startvideocapture) 方法,将 [VeLiveVideoCaptureType](147521#VeLiveVideoCaptureType) 设置为 VeLiveVideoCaptureCustomImage。
188
+ * @order 16
200
189
  * @param image 静态图片,用于在静态图推流采集类型下设置静态图。
201
190
  *
202
191
  */
@@ -208,11 +197,10 @@ export declare class VeLivePusher {
208
197
  * - 控制闪光灯开关
209
198
  * - 设置摄像头缩放比例
210
199
  * - 设置自动对焦
211
- * @return <br>
212
- * 相机设备管理对象 VeLiveCameraDevice{@link #VeLiveCameraDevice}。
213
200
  * @notes <br>
214
201
  * 该接口需要在 startVideoCapture{@link #startVideoCapture} 方法中设置 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureBackCamera。
215
- * @order 27
202
+ * @order 17
203
+ * @return 相机设备管理对象 [VeLiveCameraDevice](#VeLiveCameraDevice)。
216
204
  *
217
205
  */
218
206
 
@@ -221,8 +209,8 @@ export declare class VeLivePusher {
221
209
  * @detail api
222
210
  * @brief 设置推流视频编码参数。
223
211
  * @notes 该接口可在推流开始前或开始后调用。
224
- * @order 28
225
- * @param config 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}
212
+ * @order 18
213
+ * @param config 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
226
214
  *
227
215
  */
228
216
 
@@ -231,9 +219,8 @@ export declare class VeLivePusher {
231
219
  * @platform android
232
220
  * @detail api
233
221
  * @brief 获取推流视频编码参数。
234
- * @return <br>
235
- * 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}
236
- * @order 29
222
+ * @order 19
223
+ * @return 推流视频参数,支持设置推流视频分辨率、编码格式、目标码率和视频 GOP 大小等信息。详情请参见 [VeLiveVideoEncoderConfiguration](147521#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
237
224
  *
238
225
  */
239
226
 
@@ -242,8 +229,8 @@ export declare class VeLivePusher {
242
229
  * @detail api
243
230
  * @brief 设置推流音频编码参数。
244
231
  * @notes <br>该接口需要在 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之前调用。
245
- * @order 30
246
- * @param config 推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLiveAudioEncoderConfiguration)。
232
+ * @order 20
233
+ * @param config 推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
247
234
  *
248
235
  */
249
236
 
@@ -252,8 +239,8 @@ export declare class VeLivePusher {
252
239
  * @platform android
253
240
  * @detail api
254
241
  * @brief 获取推流音频编码参数。
255
- * @return <br>推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLiveAudioEncoderConfiguration)。
256
- * @order 31
242
+ * @order 21
243
+ * @return 推流音频编码参数,详情请参见 [VeLiveAudioEncoderConfiguration](147521#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
257
244
  *
258
245
  */
259
246
 
@@ -261,7 +248,7 @@ export declare class VeLivePusher {
261
248
  /** {zh}
262
249
  * @detail api
263
250
  * @brief 开始推流。
264
- * @order 32
251
+ * @order 22
265
252
  * @param url 推流地址,用于将直播流推送到目标服务器。
266
253
  *
267
254
  */
@@ -272,7 +259,7 @@ export declare class VeLivePusher {
272
259
  * @brief 开始推流,支持备用推流地址。
273
260
  * @notes <br>
274
261
  * 当主推流地址不可用时,会自动切换到备用推流地址继续推流。
275
- * @order 33
262
+ * @order 23
276
263
  * @param urls 推流地址列表,包含一个或多个推流地址。
277
264
  *
278
265
  */
@@ -282,7 +269,7 @@ export declare class VeLivePusher {
282
269
  * @detail api
283
270
  * @brief 停止推流。
284
271
  * @notes <br>停止推流后,可以通过调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法重新开始推流。
285
- * @order 34
272
+ * @order 24
286
273
  *
287
274
  */
288
275
 
@@ -290,11 +277,11 @@ export declare class VeLivePusher {
290
277
  /** {zh}
291
278
  * @detail api
292
279
  * @brief 当前是否正在推流中,可用来查询推流器的当前状态。
280
+ * @order 25
293
281
  * @return <br>
294
282
  * 是否正在推流。<br>
295
283
  * - true:正在推流中;
296
284
  * - false:已经停止推流。
297
- * @order 35
298
285
  *
299
286
  */
300
287
 
@@ -302,14 +289,14 @@ export declare class VeLivePusher {
302
289
  /** {zh}
303
290
  * @detail api
304
291
  * @brief 设置推流水印。
305
- * @return <br>
306
- * - 0:水印设置成功;
307
- * - <0:水印设置失败。
308
- * @order 36
292
+ * @order 26
309
293
  * @param image 水印图片。取值为 null 时,表示禁用水印。
310
294
  * @param x 水印的水平偏移量,即水印图片相对视频流左上角的横向偏移与视频流宽度的比值,取值范围为 [0.0,1.0]。
311
295
  * @param y 水印的垂直偏移量,即水印图片相对视频流左上角的纵向偏移与视频流高度的比值,取值范围为 [0.0,1.0]。
312
296
  * @param scale 水印图片的缩放比例,取值范围为 [0.0,1.0]。
297
+ * @return <br>
298
+ * - 0:水印设置成功;
299
+ * - <0:水印设置失败。
313
300
  *
314
301
  */
315
302
 
@@ -317,10 +304,10 @@ export declare class VeLivePusher {
317
304
  /** {zh}
318
305
  * @detail api
319
306
  * @brief 开始本地文件录制。
320
- * @order 37
307
+ * @order 27
321
308
  * @param path 录制文件保存路径,不能为空。
322
- * @param config 文件录制设置,详情请参见 [VeLiveFileRecorderConfiguration](147521#VeLiveFileRecorderConfiguration)。
323
- * @param listener 本地文件录制的监听,详情请参见 [VeLiveFileRecordingListener](147519#VeLiveFileRecordingListener)
309
+ * @param config 文件录制设置,详情请参见 [VeLiveFileRecorderConfiguration](147521#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
310
+ * @param listener 本地文件录制的监听,详情请参见 [VeLiveFileRecordingListener](147519#VeLivePusherDef-VeLiveFileRecordingListener)。
324
311
  *
325
312
  */
326
313
 
@@ -329,7 +316,7 @@ export declare class VeLivePusher {
329
316
  * @detail api
330
317
  * @brief 停止本地文件录制。
331
318
  * @notes <br>该接口需要在 [startFileRecording](#VeLivePusher-startfilerecording) 方法之后调用。
332
- * @order 38
319
+ * @order 28
333
320
  *
334
321
  */
335
322
 
@@ -337,12 +324,12 @@ export declare class VeLivePusher {
337
324
  /** {zh}
338
325
  * @detail api
339
326
  * @brief 高级配置。
327
+ * @order 29
328
+ * @param key 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Key。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
329
+ * @param value 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Value。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
340
330
  * @return <br>
341
331
  * - 0:成功;
342
332
  * - -1:失败,参数错误。
343
- * @order 39
344
- * @param key 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Key。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
345
- * @param value 推流高级配置为 JSON 格式的字符串,此参数为 JSON 结构中的 Value。您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076),了解配置方法。
346
333
  *
347
334
  */
348
335
 
@@ -350,13 +337,12 @@ export declare class VeLivePusher {
350
337
  /** {zh}
351
338
  * @detail api
352
339
  * @brief 推送外部视频帧数据。
353
- * @return <br>
354
- * - 0:成功;
355
- * - <0:失败。
356
340
  * @notes <br>
357
341
  * 调用该接口时,需要将视频采集类型设置为 VeLiveVideoCaptureExternal,您可调用 startVideoCapture{@link #startVideoCapture} 方法,将 VeLiveVideoCaptureType{@link #VeLiveVideoCaptureType} 设置为 VeLiveVideoCaptureExternal。
358
- * @order 40
359
- * @param frame 视频帧的数据信息,详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame)。
342
+ * @order 30
343
+ * @param frame 视频帧的数据信息,详情请参见 [VeLiveVideoFrame](147521#VeLiveVideoFrame)。
344
+ * @return - 0:成功;
345
+ * - <0:失败。
360
346
  *
361
347
  */
362
348
 
@@ -364,13 +350,12 @@ export declare class VeLivePusher {
364
350
  /** {zh}
365
351
  * @detail api
366
352
  * @brief 推送外部音频帧数据。
353
+ * @notes 该接口需要在 startAudioCapture 方法中设置 [VeLiveAudioCaptureType](147521#VeLiveAudioCaptureType) 为 VeLiveAudioCaptureExternal。
354
+ * @order 31
355
+ * @param frame 外部音频数据。详情请参见 [VeLiveAudioFrame](147521#VeLiveAudioFrame)。
367
356
  * @return <br>
368
357
  * - 0:成功;
369
358
  * - <0:失败。
370
- * @notes <br>
371
- * 该接口需要在 startAudioCapture{@link #startAudioCapture} 方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureExternal。
372
- * @order 41
373
- * @param frame 外部音频数据。详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame)。
374
359
  *
375
360
  */
376
361
 
@@ -378,7 +363,7 @@ export declare class VeLivePusher {
378
363
  /** {zh}
379
364
  * @detail api
380
365
  * @brief 设置推流视频帧朝向。默认为竖屏推流。
381
- * @order 42
366
+ * @order 32
382
367
  * @param orientation 视频帧朝向,详情请参见 [VeLiveOrientation](147521#VeLiveOrientation)。
383
368
  *
384
369
  */
@@ -387,11 +372,8 @@ export declare class VeLivePusher {
387
372
  /** {zh}
388
373
  * @detail api
389
374
  * @brief 通过视频帧发送 SEI 消息。
390
- * @return <br>
391
- * - 0:成功;
392
- * - <0:失败。
393
375
  * @notes <br>该接口需要在调用 [startPush](#VeLivePusher-startpush) 或 [startPushWithUrls](#VeLivePusher-startpushwithurls) 方法之后调用。
394
- * @order 43
376
+ * @order 33
395
377
  * @param key SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Key。
396
378
  * @param value SEI 消息为 JSON 格式的字符串。此参数为 JSON 结构中的 Value。
397
379
  * @param repeat 消息发送重复的次数。例如,`repeat` 取值为 20,`isKeyFrame` 取值为 YES,则会在视频帧开始的连续 20 个关键帧中添加 SEI 消息。
@@ -401,6 +383,9 @@ export declare class VeLivePusher {
401
383
  * @param allowsCovered 是否允许覆盖。<br>
402
384
  * - true:允许;
403
385
  * - false:不允许。
386
+ * @return <br>
387
+ * - 0:成功;
388
+ * - <0:失败。
404
389
  *
405
390
  */
406
391
 
@@ -411,7 +396,7 @@ export declare class VeLivePusher {
411
396
  * @param mute 是否设置为静音。默认为正常推流。<br>
412
397
  * - true:静音推流;
413
398
  * - false:正常推流。
414
- * @order 44
399
+ * @order 34
415
400
  *
416
401
  */
417
402
 
@@ -419,10 +404,10 @@ export declare class VeLivePusher {
419
404
  /** {zh}
420
405
  * @detail api
421
406
  * @brief 当前是否是静音状态。
407
+ * @order 35
422
408
  * @return <br>
423
409
  * - true:当前是静音状态;
424
410
  * - false:当前非静音状态。
425
- * @order 45
426
411
  *
427
412
  */
428
413
 
@@ -435,11 +420,9 @@ export declare class VeLivePusher {
435
420
  * - 设置素材
436
421
  * - 设置贴图
437
422
  * - 设置滤镜
438
- * @return <br>
439
- * 视频特效管理对象 VeLiveVideoEffectManager{@link #VeLiveVideoEffectManager}。
440
- * @notes <br>
441
- * 该接口需要集成美颜特效 CV SDK 后才能使用。
442
- * @order 46
423
+ * @notes 该接口需要集成智能美化特效 SDK 后才能使用。
424
+ * @order 36
425
+ * @return 视频特效管理对象 [VeLiveVideoEffectManager](#VeLiveVideoEffectManager)。
443
426
  *
444
427
  */
445
428
 
@@ -447,8 +430,8 @@ export declare class VeLivePusher {
447
430
  /** {zh}
448
431
  * @detail api
449
432
  * @brief 自定义视频处理。
450
- * @order 47
451
- * @param filter 视频数据处理回调,详情请参见 [VeLiveVideoFrameFilter](147519#VeLiveVideoFrameFilter)。
433
+ * @order 37
434
+ * @param filter 视频数据处理回调,详情请参见 [VeLiveVideoFrameFilter](147519#VeLivePusherDef-VeLiveVideoFrameFilter)。
452
435
  *
453
436
  */
454
437
 
@@ -456,11 +439,10 @@ export declare class VeLivePusher {
456
439
  /** {zh}
457
440
  * @detail api
458
441
  * @brief 获取音频模块管理对象。
459
- * @return <br>
460
- * 音频模块管理对象 VeLiveAudioDevice{@link #VeLiveAudioDevice}。
461
442
  * @notes <br>
462
443
  * 该接口需要在 startAudioCapture{@link #startAudioCapture} 方法中设置 VeLiveAudioCaptureType{@link #VeLiveAudioCaptureType} 为 VeLiveAudioCaptureMicrophone。
463
- * @order 48
444
+ * @order 38
445
+ * @return 音频模块管理对象 [VeLiveAudioDevice](#VeLiveAudioDevice)。
464
446
  *
465
447
  */
466
448
 
@@ -468,7 +450,7 @@ export declare class VeLivePusher {
468
450
  /** {zh}
469
451
  * @detail api
470
452
  * @brief 自定义音频处理。
471
- * @order 49
453
+ * @order 39
472
454
  * @param filter 音频帧滤镜对象 VeLiveAudioFrameFilter 。
473
455
  *
474
456
  */
@@ -477,48 +459,35 @@ export declare class VeLivePusher {
477
459
  /** {zh}
478
460
  * @detail api
479
461
  * @brief 创建播放器。
480
- * @return <br>
481
- * 播放器管理对象 VeLiveMediaPlayer{@link #VeLiveMediaPlayer}
482
- * @order 50
462
+ * @order 1
463
+ * @return 播放器管理对象 [VeLiveMediaPlayer](#VeLiveMediaPlayer)
483
464
  *
484
465
  */
485
466
 
486
467
  createPlayer(): VeLiveMediaPlayer;
487
- /** {zh}
488
- * @detail api
489
- * @brief 获取混流管理对象。
490
- * @return <br>
491
- * 混流管理对象 VeLiveMixerManager{@link #VeLiveMixerManager}。
492
- * @order 51
493
- *
494
- */
495
-
496
- getMixerManager(): VeLiveMixerManager;
497
468
  /** {zh}
498
469
  * @platform android
499
470
  * @detail api
500
- * @brief 开始屏幕采集。
501
- * @order 52
502
- * @param enableAppAudio 是否支持应用内音频数据,默认为 true,该参数暂不支持修改。
503
- * @param screenIntent 系统屏幕录制权限。
471
+ * @brief 开始系统音频采集。
472
+ * @order 41
504
473
  *
505
474
  */
506
475
 
507
- android_startScreenRecording(enableAppAudio: boolean, screenIntent: $p_a.Intent): void;
476
+ android_startMixSystemAudio(): void;
508
477
  /** {zh}
509
478
  * @platform android
510
479
  * @detail api
511
- * @brief 停止屏幕采集。
512
- * @order 53
480
+ * @brief 停止系统音频采集。
481
+ * @order 42
513
482
  *
514
483
  */
515
484
 
516
- android_stopScreenRecording(): void;
485
+ android_stopMixSystemAudio(): void;
517
486
  /** {zh}
518
487
  * @platform android
519
488
  * @detail api
520
489
  * @brief 获取当前是否处于屏幕采集状态。
521
- * @order 54
490
+ * @order 43
522
491
  *
523
492
  */
524
493
 
@@ -526,11 +495,11 @@ export declare class VeLivePusher {
526
495
  /** {zh}
527
496
  * @detail api
528
497
  * @brief 添加视频帧的监听回调,用于获取推流器输出的视频帧。
498
+ * @order 44
499
+ * @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
529
500
  * @return <br>
530
501
  * - 0:成功;
531
502
  * - <0:失败。
532
- * @order 55
533
- * @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLiveVideoFrameListener)。
534
503
  *
535
504
  */
536
505
 
@@ -538,13 +507,13 @@ export declare class VeLivePusher {
538
507
  /** {zh}
539
508
  * @detail api
540
509
  * @brief 移除已添加的视频帧监听回调。
510
+ * @notes <br>
511
+ * 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
512
+ * @order 45
513
+ * @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLivePusherDef-VeLiveVideoFrameListener)。
541
514
  * @return <br>
542
515
  * - 0:成功;
543
516
  * - <0:失败。
544
- * @notes <br>
545
- * 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
546
- * @order 56
547
- * @param listener 视频帧的监听回调,详细信息请参见 [VeLiveVideoFrameListener](147519#VeLiveVideoFrameListener)。
548
517
  *
549
518
  */
550
519
 
@@ -552,11 +521,11 @@ export declare class VeLivePusher {
552
521
  /** {zh}
553
522
  * @detail api
554
523
  * @brief 添加音频帧的监听回调,用于获取推流器输出的音频帧。
524
+ * @order 46
525
+ * @param listener 音频帧监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
555
526
  * @return <br>
556
527
  * - 0:成功;
557
528
  * - <0:失败。
558
- * @order 57
559
- * @param listener 音频帧监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLiveAudioFrameListener)。
560
529
  *
561
530
  */
562
531
 
@@ -564,13 +533,13 @@ export declare class VeLivePusher {
564
533
  /** {zh}
565
534
  * @detail api
566
535
  * @brief 移除已添加的音频帧监听回调。
536
+ * @notes <br>
537
+ * 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
538
+ * @order 47
539
+ * @param listener 音频帧的监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLivePusherDef-VeLiveAudioFrameListener)。
567
540
  * @return <br>
568
541
  * - 0:成功;
569
542
  * - <0:失败。
570
- * @notes <br>
571
- * 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
572
- * @order 58
573
- * @param listener 音频帧的监听回调,详细信息请参见 [VeLiveAudioFrameListener](147519#VeLiveAudioFrameListener) 。
574
543
  *
575
544
  */
576
545
 
@@ -578,8 +547,8 @@ export declare class VeLivePusher {
578
547
  /** {zh}
579
548
  * @detail api
580
549
  * @brief 视频截图。
581
- * @order 59
582
- * @param listener 截图监听对象,详情请参见 [VeLiveSnapshotListener](147519#VeLiveSnapshotListener)。
550
+ * @order 48
551
+ * @param listener 截图监听对象,详情请参见 [VeLiveSnapshotListener](147519#VeLivePusherDef-VeLiveSnapshotListener)。
583
552
  *
584
553
  */
585
554
 
@@ -589,22 +558,46 @@ export declare class VeLivePusher {
589
558
  * @detail api
590
559
  * @param applicationGroupIdentifier iOS app group 标识符。
591
560
  * @brief 开启屏幕采集。
561
+ * @order 20
592
562
  */
593
563
 
594
564
  ios_startScreenCapture(applicationGroupIdentifier: string): void;
595
565
  /** {zh}
596
566
  * @platform ios
597
567
  * @detail api
598
- * @brief 关闭屏幕采集。
568
+ * @brief 停止屏幕采集。
569
+ * @notes <br>
570
+ * 该方法用于结束当前屏幕采集流程,并释放相关资源。调用本方法后,`pauseScreenCapture` 和 `resumeScreenCapture` 将不再生效。
571
+ * @order 21
599
572
  */
600
573
 
601
574
  ios_stopScreenCapture(): void;
575
+ /** {zh}
576
+ * @platform ios
577
+ * @detail api
578
+ * @brief 暂停屏幕采集。
579
+ * @notes <br>
580
+ * 调用该方法后,屏幕采集将暂停输出数据,但不会销毁内部资源。您可通过 `resumeScreenCapture` 来恢复采集。如果当前采集已经停止或尚未开始,调用本方法不会产生任何效果。
581
+ * @order 22
582
+ */
583
+
584
+ ios_pauseScreenCapture(): void;
585
+ /** {zh}
586
+ * @platform ios
587
+ * @detail api
588
+ * @brief 恢复屏幕采集。
589
+ * @notes <br>
590
+ * 在调用 `pauseScreenCapture` 暂停后,通过本方法可以恢复屏幕采集输出。如果屏幕采集已经停止或尚未开始,调用本方法不会产生任何效果。
591
+ * @order 23
592
+ */
593
+
594
+ ios_resumeScreenCapture(): void;
602
595
  /** {zh}
603
596
  * @platform ios
604
597
  * @detail api
605
598
  * @brief 初始化推流器。
606
599
  * @order 0
607
- * @param config 推流配置类。详细信息请参见 [VeLivePusherConfiguration](155321#VeLivePusherConfiguration)。
600
+ * @param config 推流配置类。详细信息请参见 [VeLivePusherConfiguration](155321#VeLivePusherConfiguration)。
608
601
  */
609
602
 
610
603
  ios_initWithConfig(config: $p_i.VeLivePusherConfiguration): this;
@@ -612,13 +605,14 @@ export declare class VeLivePusher {
612
605
  * @platform ios
613
606
  * @detail api
614
607
  * @brief 添加屏幕采集的监听。
615
- * @return <br>
616
- * - 0:成功;
617
- * - <0:失败。
618
608
  * @notes <br>
619
609
  * 如果没有添加过此监听回调或者监听回调已被移除,调用此方法将返回失败。
620
610
  * @param listener 屏幕采集事件监听回调,详细信息请参见 VeLiveScreenCaptureStatusObserver{@link #VeLiveScreenCaptureStatusObserver}
621
611
  * @param observer 录屏推流事件监听器。详情见 [VeLiveScreenCaptureStatusObserver](155319#VeLiveScreenCaptureStatusObserver)。
612
+ * @order 5
613
+ * @return <br>
614
+ * - 0:成功;
615
+ * - <0:失败。
622
616
  */
623
617
 
624
618
  ios_setScreenCaptureObserver(observer: $p_i.id<$p_i.VeLiveScreenCaptureStatusObserver>): number;
@@ -626,12 +620,13 @@ export declare class VeLivePusher {
626
620
  * @platform ios
627
621
  * @detail api
628
622
  * @brief 推送外部视频编码数据。
623
+ * @notes
624
+ * 该接口需要在 [startVideoCapture:](#VeLivePusher-startvideocapture) 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureExternal。
625
+ * @order 38
626
+ * @param encodeFrame 视频编码帧的数据信息,详情请参见 [VeLiveVideoEncodeFrame](155321#VeLiveVideoEncodeFrame)。
629
627
  * @return <br>
630
628
  * - 0:成功;
631
629
  * - <0:失败。
632
- * @notes <br>该接口需要在 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 方法中设置 [VeLiveVideoCaptureType](155321#VeLiveVideoCaptureType) 为 VeLiveVideoCaptureFrontCamera 或 VeLiveVideoCaptureExternal。
633
- * @order 44
634
- * @param encodeFrame 视频编码帧的数据信息,详情请参见 [VeLiveVideoEncodeFrame](155321#VeLiveVideoEncodeFrame)。
635
630
  */
636
631
 
637
632
  ios_pushExternalVideoEncodeFrame(encodeFrame: $p_i.VeLiveVideoEncodeFrame): number;
@@ -639,9 +634,9 @@ export declare class VeLivePusher {
639
634
  * @platform ios
640
635
  * @detail api
641
636
  * @brief 强制请求 IDR 帧,发起请求以编码一个新的 IDR 帧。
642
- * @notes <br>
643
- * 该接口需要在调用 startPush:{@link #VeLivePusher#startPush} 或 startPushWithUrls:{@link #VeLivePusher#startPushWithUrls} 方法之后调用。
644
- * @order 47
637
+ * @notes
638
+ * 该接口需要在调用 [startPush:](#VeLivePusher-startpush)[startPushWithUrls:](#VeLivePusher-startpushwithurls) 方法之后调用。
639
+ * @order 49
645
640
  */
646
641
 
647
642
  ios_requestIDRFrame(): void;
@@ -657,7 +652,7 @@ export declare class VeLiveMediaPlayer {
657
652
  /** {zh}
658
653
  * @detail api
659
654
  * @brief 销毁播放器实例。
660
- * @order 100
655
+ * @order 1
661
656
  *
662
657
  */
663
658
 
@@ -667,8 +662,8 @@ export declare class VeLiveMediaPlayer {
667
662
  * @brief 设置播放状态的监听。
668
663
  * @notes <br>
669
664
  * 重复调用本方法,仅最后一次调用生效。
670
- * @order 101
671
- * @param listener 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](147519#VeLiveMediaPlayerListener)。
665
+ * @order 4
666
+ * @param listener 播放状态监听。详情请参见 [VeLiveMediaPlayerListener](147519#VeLivePusherDef-VeLiveMediaPlayerListener)。
672
667
  *
673
668
  */
674
669
 
@@ -676,21 +671,21 @@ export declare class VeLiveMediaPlayer {
676
671
  /** {zh}
677
672
  * @detail api
678
673
  * @brief 设置文件路径。支持的文件格式包括 MP3、AAC、M4A、WAV。
674
+ * @order 2
675
+ * @param url 文件路径。
679
676
  * @return <br>
680
677
  * - 0:成功;
681
678
  * - ≠0:失败。
682
- * @order 102
683
- * @param url 文件路径。
684
679
  *
685
680
  */
686
681
 
687
682
  prepare(url: string): number;
688
683
  /** {zh}
689
684
  * @detail api
690
- * @brief 暂停播放。
685
+ * @brief 开始播放。
691
686
  * @notes <br>
692
687
  * 需要在调用 start{@link #start} 开始播放后,调用本方法。
693
- * @order 103
688
+ * @order 12
694
689
  *
695
690
  */
696
691
 
@@ -698,12 +693,12 @@ export declare class VeLiveMediaPlayer {
698
693
  /** {zh}
699
694
  * @detail api
700
695
  * @brief 停止播放。
696
+ * @notes <br>
697
+ * 需要在调用 start{@link #start} 开始播放后,调用本方法。
698
+ * @order 13
701
699
  * @return <br>
702
700
  * - 0:成功;
703
701
  * - ≠0:失败。
704
- * @notes <br>
705
- * 需要在调用 start{@link #start} 开始播放后,调用本方法。
706
- * @order 104
707
702
  *
708
703
  */
709
704
 
@@ -712,7 +707,7 @@ export declare class VeLiveMediaPlayer {
712
707
  * @detail api
713
708
  * @brief 暂停播放。
714
709
  * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start)[start](#VeLiveMediaPlayer-start) 开始播放后,调用本方法。
715
- * @order 105
710
+ * @order 14
716
711
  *
717
712
  */
718
713
 
@@ -721,7 +716,7 @@ export declare class VeLiveMediaPlayer {
721
716
  * @detail api
722
717
  * @brief 恢复播放。
723
718
  * @notes <br>需要在调用 [pause](#VeLiveMediaPlayer-pause) 暂停播放后,调用本方法。
724
- * @order 106
719
+ * @order 15
725
720
  *
726
721
  */
727
722
 
@@ -729,11 +724,11 @@ export declare class VeLiveMediaPlayer {
729
724
  /** {zh}
730
725
  * @detail api
731
726
  * @brief 获取文件的总时长,单位为 ms。
727
+ * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后,调用本方法。
728
+ * @order 3
732
729
  * @return <br>
733
- * - \\\\>0:成功,音频文件时长;
730
+ * - >0:成功,音频文件时长;
734
731
  * - ≤0:失败。
735
- * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放后,调用本方法。
736
- * @order 107
737
732
  *
738
733
  */
739
734
 
@@ -741,11 +736,11 @@ export declare class VeLiveMediaPlayer {
741
736
  /** {zh}
742
737
  * @detail api
743
738
  * @brief 设置播放进度。
739
+ * @order 5
740
+ * @param posMs 播放时间,单位为 ms。
744
741
  * @return <br>
745
742
  * - 0:成功;
746
743
  * - ≠0:失败。
747
- * @order 108
748
- * @param posMs 播放时间,单位为 ms。
749
744
  *
750
745
  */
751
746
 
@@ -756,7 +751,7 @@ export declare class VeLiveMediaPlayer {
756
751
  * @param enable 开启/关闭,默认为 false。 <br>
757
752
  * - ture:开启;
758
753
  * - false:关闭。
759
- * @order 109
754
+ * @order 6
760
755
  *
761
756
  */
762
757
 
@@ -764,29 +759,20 @@ export declare class VeLiveMediaPlayer {
764
759
  /** {zh}
765
760
  * @detail api
766
761
  * @brief 开启/关闭自动音量均衡。
767
- * @order 110
762
+ * @order 7
768
763
  * @param sourceLufs 源响度。
769
764
  * @param targetLufs 目标响度。
770
765
  *
771
766
  */
772
767
 
773
768
  enableAutoEq(sourceLufs: number, targetLufs: number): void;
774
- /** {zh}
775
- * @detail api
776
- * @brief 支持 MP4 格式的视频渲染。
777
- * @order 111
778
- * @param view 渲染视图。
779
- *
780
- */
781
-
782
- setRenderView(view: View): void;
783
769
  /** {zh}
784
770
  * @detail api
785
771
  * @brief 设置音视频帧回调的监听。
786
772
  * @notes <br>
787
773
  * 重复调用本方法,仅最后一次调用生效。
788
- * @order 112
789
- * @param listener 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](147519#VeLiveMediaPlayerFrameListener)。
774
+ * @order 8
775
+ * @param listener 音视频帧回调监听。详情请参见 [VeLiveMediaPlayerFrameListener](147519#VeLivePusherDef-VeLiveMediaPlayerFrameListener)。
790
776
  *
791
777
  */
792
778
 
@@ -794,7 +780,7 @@ export declare class VeLiveMediaPlayer {
794
780
  /** {zh}
795
781
  * @detail api
796
782
  * @brief 设置播放音频的音量。
797
- * @order 113
783
+ * @order 9
798
784
  * @param volume 播放音频音量,取值范围为 [0.0,4.0]。
799
785
  *
800
786
  */
@@ -804,7 +790,7 @@ export declare class VeLiveMediaPlayer {
804
790
  * @detail api
805
791
  * @brief 设置音频采集音量。
806
792
  * @notes <br>需要在调用 [start](#VeLiveMediaPlayer-start) 开始播放背景音乐后,调用本方法。
807
- * @order 114
793
+ * @order 10
808
794
  * @param volume 音频采集音量,取值范围为 [0.0,4.0]。
809
795
  *
810
796
  */
@@ -816,55 +802,63 @@ export declare class VeLiveMediaPlayer {
816
802
  * @param loop 是否循环播放。默认为 false。<br>
817
803
  * - true:循环播放;
818
804
  * - false:不循环播放。
819
- * @order 115
805
+ * @order 11
820
806
  *
821
807
  */
822
808
 
823
809
  enableBGMLoop(loop: boolean): void;
810
+ /** {zh}
811
+ * @platform ios
812
+ * @detail api
813
+ * @brief 支持 MP4 格式的视频渲染。
814
+ * @param view 渲染视图。
815
+ * @order 93
816
+ */
817
+
818
+ ios_setRenderView(view: $p_i.UIView): void;
824
819
  }
825
820
  /** {zh}
826
- * @detail api
821
+ * @detail keytype
827
822
  * @brief 推流引擎初始化配置。
828
823
  */
829
824
  export declare class VeLivePusherConfiguration {
830
825
  protected _instance: any;
831
826
  /** {zh}
832
827
  * @platform ios
833
- * @brief 音频采集参数设置,用于调整和设置音频采集相关的参数。详情请参见 VeLiveAudioCaptureConfiguration{@link #VeLiveAudioCaptureConfiguration}
828
+ * @brief 音频采集参数设置,用于调整和设置音频采集相关的参数。详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)
834
829
  */
835
830
 
836
- get ios_audioCaptureConfig(): $p_i.VeLiveAudioCaptureConfiguration;
837
- set ios_audioCaptureConfig(value: $p_i.VeLiveAudioCaptureConfiguration);
831
+ get audioCaptureConfig(): $p_i.VeLiveAudioCaptureConfiguration;
832
+ set audioCaptureConfig(value: $p_i.VeLiveAudioCaptureConfiguration);
838
833
  /** {zh}
839
834
  * @platform ios
840
835
  * @brief 推流失败后,尝试重连的时间间隔。单位为 s,默认值为 5。
841
836
  */
842
837
 
843
- get ios_reconnectIntervalSeconds(): $p_i.int;
844
- set ios_reconnectIntervalSeconds(value: $p_i.int);
838
+ get reconnectIntervalSeconds(): $p_i.int;
839
+ set reconnectIntervalSeconds(value: $p_i.int);
845
840
  /** {zh}
846
841
  * @platform ios
847
842
  * @brief 推流失败后,尝试重连的次数。默认值为 3。
848
843
  */
849
844
 
850
- get ios_reconnectCount(): $p_i.int;
851
- set ios_reconnectCount(value: $p_i.int);
845
+ get reconnectCount(): $p_i.int;
846
+ set reconnectCount(value: $p_i.int);
852
847
  /** {zh}
853
848
  * @platform ios
854
849
  * @brief 设置扩展参数,用于实现某些特殊功能或配置,默认不需要设置。
855
850
  */
856
851
 
857
- get ios_extraParameters(): $p_i.NSDictionary;
858
- set ios_extraParameters(value: $p_i.NSDictionary);
852
+ get extraParameters(): $p_i.NSDictionary;
853
+ set extraParameters(value: $p_i.NSDictionary);
859
854
  protected __init(...args: any[]): void;
860
855
  protected __new_instance(...args: any[]): any;
861
856
  /** {zh}
862
857
  * @detail api
863
858
  * @brief 设置视频采集参数,用于调整和设置视频采集相关的参数。
864
- * @return <br>
865
- * 推流引擎初始化配置对象,详情请参见 VeLivePusherConfiguration{@link #VeLivePusherConfiguration}。
866
859
  * @order 6
867
- * @param config 视频采集参数,详情请参见 [VeLiveVideoCaptureConfiguration](147521#VeLiveVideoCaptureConfiguration)。
860
+ * @param config 视频采集参数,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
861
+ * @return 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
868
862
  *
869
863
  */
870
864
 
@@ -883,9 +877,9 @@ export declare class VeLivePusherConfiguration {
883
877
  * @platform android
884
878
  * @detail api
885
879
  * @brief 获取推流器推流失败后尝试重连的时间间隔。
880
+ * @order 3
886
881
  * @return <br>
887
882
  * 时间间隔,单位为 s。
888
- * @order 3
889
883
  *
890
884
  */
891
885
 
@@ -904,9 +898,9 @@ export declare class VeLivePusherConfiguration {
904
898
  * @platform android
905
899
  * @detail api
906
900
  * @brief 获取推流器推流失败后尝试重连的次数。
901
+ * @order 5
907
902
  * @return <br>
908
903
  * 重连次数。
909
- * @order 5
910
904
  *
911
905
  */
912
906
 
@@ -915,8 +909,8 @@ export declare class VeLivePusherConfiguration {
915
909
  * @platform android
916
910
  * @detail api
917
911
  * @brief 获取视频采集参数,用于调整和设置视频采集相关的参数。
918
- * @return <br>视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](147521#VeLiveVideoCaptureConfiguration)。
919
912
  * @order 7
913
+ * @return 视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
920
914
  *
921
915
  */
922
916
 
@@ -925,10 +919,9 @@ export declare class VeLivePusherConfiguration {
925
919
  * @platform android
926
920
  * @detail api
927
921
  * @brief 设置音频采集参数,用于调整和设置音频采集相关的参数。
928
- * @return <br>
929
- * 推流引擎初始化配置对象,详情请参见 VeLivePusherConfiguration{@link #VeLivePusherConfiguration}。
930
922
  * @order 7
931
- * @param config 音频采集参数,详情请参见 [VeLiveAudioCaptureConfiguration](147521#VeLiveAudioCaptureConfiguration)。
923
+ * @param config 音频采集参数,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
924
+ * @return 推流引擎初始化配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
932
925
  *
933
926
  */
934
927
 
@@ -937,8 +930,8 @@ export declare class VeLivePusherConfiguration {
937
930
  * @platform android
938
931
  * @detail api
939
932
  * @brief 获取音频采集参数,用于调整和设置音频采集相关的参数。
940
- * @return <br>音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](147521#VeLiveAudioCaptureConfiguration)。
941
933
  * @order 8
934
+ * @return 音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
942
935
  *
943
936
  */
944
937
 
@@ -947,10 +940,9 @@ export declare class VeLivePusherConfiguration {
947
940
  * @platform android
948
941
  * @detail api
949
942
  * @brief 设置应用上下文。
950
- * @return <br>
951
- * 推流引擎初始化配置对象,详情请参见 VeLivePusherConfiguration{@link #VeLivePusherConfiguration}。
952
943
  * @order 9
953
944
  * @param context 应用上下文。
945
+ * @return 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
954
946
  *
955
947
  */
956
948
 
@@ -959,9 +951,9 @@ export declare class VeLivePusherConfiguration {
959
951
  * @platform android
960
952
  * @detail api
961
953
  * @brief 获取应用上下文。
954
+ * @order 10
962
955
  * @return <br>
963
956
  * 应用上下文。
964
- * @order 10
965
957
  *
966
958
  */
967
959
 
@@ -970,10 +962,10 @@ export declare class VeLivePusherConfiguration {
970
962
  * @platform android
971
963
  * @detail api
972
964
  * @brief 设置扩展参数,默认不需要设置。如果需要使用,您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
973
- * @return <br>
974
- * 推流引擎初始化配置对象,详情请参见 VeLivePusherConfiguration{@link #VeLivePusherConfiguration}。
975
965
  * @order 11
976
- * @param params 扩展参数
966
+ * @param params 扩展参数。
967
+ * @return
968
+ * 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
977
969
  *
978
970
  */
979
971
 
@@ -982,9 +974,9 @@ export declare class VeLivePusherConfiguration {
982
974
  * @platform android
983
975
  * @detail api
984
976
  * @brief 获取扩展参数。
977
+ * @order 12
985
978
  * @return <br>
986
979
  * 扩展参数。
987
- * @order 12
988
980
  *
989
981
  */
990
982
 
@@ -993,9 +985,8 @@ export declare class VeLivePusherConfiguration {
993
985
  * @platform android
994
986
  * @detail api
995
987
  * @brief 构造推流引擎。
996
- * @return <br>
997
- * 推流引擎,详情请参见 VeLivePusher{@link #VeLivePusher}。
998
988
  * @order 1
989
+ * @return 推流引擎,详情请参见 [VeLivePusher](147517#VeLivePusher)。
999
990
  *
1000
991
  */
1001
992
 
@@ -1003,299 +994,35 @@ export declare class VeLivePusherConfiguration {
1003
994
  }
1004
995
  /** {zh}
1005
996
  * @detail api
1006
- * @brief 视频帧的数据信息。
997
+ * @brief 相机设备管理对象。
1007
998
  */
1008
- export declare class VeLiveVideoFrame {
1009
- constructor(width: number, height: number, pts: number, texId: number, isOes: boolean, matrix: Matrix);
1010
- constructor(width: number, height: number, pts: number, byteBuffer: ByteBuffer);
1011
- constructor(width: number, height: number, pts: number, data: ArrayBuffer);
1012
- constructor();
1013
- constructor();
999
+ export declare class VeLiveCameraDevice {
1014
1000
  protected _instance: any;
1015
- get width(): number;
1016
- set width(value: number);
1017
- get height(): number;
1018
- set height(value: number);
1019
- /**
1020
- * @platform android
1021
- */
1022
- get android_ptsUs(): number;
1023
- set android_ptsUs(value: number);
1024
- get textureId(): number;
1025
- set textureId(value: number);
1026
- get data(): any;
1027
- set data(value: any);
1028
- /** {zh}
1029
- * @platform ios
1030
- * @brief 视频数据包装格式。默认值为 VeLiveVideoBufferTypeUnknown,详情请参见 VeLiveVideoBufferType{@link #VeLiveVideoBufferType}。
1031
- */
1032
-
1033
- get ios_bufferType(): $p_i.VeLiveVideoBufferType;
1034
- set ios_bufferType(value: $p_i.VeLiveVideoBufferType);
1035
- /** {zh}
1036
- * @platform ios
1037
- * @brief 视频帧像素格式。bufferType 为 VeLiveVideoBufferTypeNSData 时,需要指定数据格式。详情请参见 VeLivePixelFormat{@link #VeLivePixelFormat}。
1038
- */
1039
-
1040
- get ios_pixelFormat(): $p_i.VeLivePixelFormat;
1041
- set ios_pixelFormat(value: $p_i.VeLivePixelFormat);
1042
- /** {zh}
1043
- * @platform ios
1044
- * @brief 视频帧顺时针旋转角度。详情请参见 VeLiveVideoRotation{@link #VeLiveVideoRotation}。
1045
- */
1046
-
1047
- get ios_rotation(): $p_i.VeLiveVideoRotation;
1048
- set ios_rotation(value: $p_i.VeLiveVideoRotation);
1049
- /** {zh}
1050
- * @platform ios
1051
- * @brief 视频帧时间戳,单位为 μs。
1052
- */
1053
-
1054
- get ios_pts(): $p_i.CMTime;
1055
- set ios_pts(value: $p_i.CMTime);
1056
- /** {zh}
1057
- * @platform ios
1058
- * @brief `bufferType` 为 `VeLiveVideoBufferTypePixelBuffer` 时的视频数据。
1059
- */
1060
-
1061
- get ios_pixelBuffer(): $p_i.CVPixelBufferRef;
1062
- set ios_pixelBuffer(value: $p_i.CVPixelBufferRef);
1063
- /** {zh}
1064
- * @platform ios
1065
- * @brief `bufferType` 为 `VeLiveVideoBufferTypeSampleBuffer` 时的视频数据。
1066
- */
1067
-
1068
- get ios_sampleBuffer(): $p_i.CMSampleBufferRef;
1069
- set ios_sampleBuffer(value: $p_i.CMSampleBufferRef);
1070
1001
  protected __init(...args: any[]): void;
1071
1002
  protected __new_instance(...args: any[]): any;
1072
1003
  /** {zh}
1073
1004
  * @platform android
1074
1005
  * @detail api
1075
- * @brief 增加 VeLiveVideoFrame 对象的引用计数。当您需要继续使用 VeLiveVideoFrame 对象时,请调用此方法将引用计数增加 1。
1006
+ * @brief 获取相机支持帧率范围。
1007
+ * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1008
+ * @order 3
1009
+ * @return <br>
1010
+ * 相机支持帧率范围。
1076
1011
  *
1077
1012
  */
1078
1013
 
1079
- android_retain(): void;
1080
- /** {zh}
1081
- * @platform android
1082
- * @detail api
1083
- * @brief 释放对 VeLiveVideoFrame 对象的引用。在您不再需要使用 VeLiveVideoFrame 对象时,应调用此方法将引用计数减少 1。当引用计数减少到零,表示不再有引用指向该对象,可以安全地释放或销毁该对象。
1084
- *
1085
- */
1086
-
1087
- android_release(): void;
1088
- /** {zh}
1089
- * @platform android
1090
- * @detail api
1091
- * @brief 获取视频数据类型。
1092
- * @return 视频数据类型,详情请参见 [VeLiveVideoBufferType](147521#VeLiveVideoBufferType)。
1093
- *
1094
- */
1095
-
1096
- android_getBufferType(): $p_a.VeLiveVideoBufferType;
1097
- /** {zh}
1098
- * @platform android
1099
- * @detail api
1100
- * @brief 设置视频数据类型。
1101
- * @param bufferType 视频数据类型,详情请参见 VeLiveVideoBufferType{@link #VeLiveVideoBufferType}
1102
- * @return <br>
1103
- * 视频帧对象,详情请参见 VeLiveVideoFrame{@link #VeLiveVideoFrame}。
1104
- *
1105
- */
1106
-
1107
- android_setBufferType(bufferType: $p_a.VeLiveVideoBufferType): this;
1108
- /** {zh}
1109
- * @platform android
1110
- * @detail api
1111
- * @brief 获取视频像素格式。
1112
- * @return <br>
1113
- * 视频像素格式,详情请参见 VeLivePixelFormat{@link #VeLivePixelFormat}。
1114
- *
1115
- */
1116
-
1117
- android_getPixelFormat(): $p_a.VeLivePixelFormat;
1118
- /** {zh}
1119
- * @platform android
1120
- * @detail api
1121
- * @brief 设置视频像素格式。
1122
- * @param pixelFormat 视频像素格式,详情请参见 VeLivePixelFormat{@link #VeLivePixelFormat}
1123
- * @return <br>
1124
- * 视频帧对象,详情请参见 VeLiveVideoFrame{@link #VeLiveVideoFrame}。
1125
- *
1126
- */
1127
-
1128
- android_setPixelFormat(pixelFormat: $p_a.VeLivePixelFormat): this;
1129
- /** {zh}
1130
- * @platform android
1131
- * @detail api
1132
- * @brief 获取视频帧旋转角度。
1133
- * @return <br>
1134
- * 视频帧旋转角度,详情请参见 VeLiveVideoRotation{@link #VeLiveVideoRotation}。
1135
- *
1136
- */
1137
-
1138
- android_getRotation(): $p_a.VeLiveVideoRotation;
1139
- /** {zh}
1140
- * @platform android
1141
- * @detail api
1142
- * @brief 设置视频帧旋转角度。
1143
- * @param rotation 视频帧旋转角度,详情请参见 VeLiveVideoRotation{@link #VeLiveVideoRotation}
1144
- * @return <br>
1145
- * 视频帧对象,详情请参见 VeLiveVideoFrame{@link #VeLiveVideoFrame}。
1146
- *
1147
- */
1148
-
1149
- android_setRotation(rotation: $p_a.VeLiveVideoRotation): this;
1150
- /** {zh}
1151
- * @platform android
1152
- * @detail api
1153
- * @brief 获取视频帧宽度。
1154
- * @return <br>
1155
- * 视频帧宽度。
1156
- *
1157
- */
1158
-
1159
- android_getWidth(): number;
1160
- /** {zh}
1161
- * @platform android
1162
- * @detail api
1163
- * @brief 获取视频帧高度。
1164
- * @return <br>
1165
- * 视频帧高度。
1166
- *
1167
- */
1168
-
1169
- android_getHeight(): number;
1170
- /** {zh}
1171
- * @platform android
1172
- * @detail api
1173
- * @brief 获取带旋转角度的视频帧宽度。
1174
- * @return <br>
1175
- * 带旋转角度的视频帧宽度。
1176
- *
1177
- */
1178
-
1179
- android_getRotatedWidth(): number;
1180
- /** {zh}
1181
- * @platform android
1182
- * @detail api
1183
- * @brief 获取带旋转角度的视频帧高度。
1184
- * @return <br>
1185
- * 带旋转角度的视频帧高度。
1186
- *
1187
- */
1188
-
1189
- android_getRotatedHeight(): number;
1190
- /** {zh}
1191
- * @platform android
1192
- * @detail api
1193
- * @brief 获取视频帧时间戳。
1194
- * @return <br>
1195
- * 视频帧时间戳,单位为 μs。
1196
- *
1197
- */
1198
-
1199
- android_getPts(): number;
1200
- /** {zh}
1201
- * @platform android
1202
- * @detail api
1203
- * @brief 获取视频帧纹理 ID。
1204
- * @return <br>
1205
- * 视频帧纹理 ID。
1206
- *
1207
- */
1208
-
1209
- android_getTextureId(): number;
1210
- /** {zh}
1211
- * @platform android
1212
- * @detail api
1213
- * @brief 获取视频帧纹理矩阵。
1214
- * @return <br>
1215
- * 视频帧纹理矩阵。
1216
- *
1217
- */
1218
-
1219
- android_getTextureMatrix(): $p_a.Matrix;
1220
- /** {zh}
1221
- * @platform android
1222
- * @detail api
1223
- * @brief 获取 ByteBuffer 格式的视频数据。
1224
- * @return <br>
1225
- * ByteBuffer 格式的视频数据。
1226
- *
1227
- */
1228
-
1229
- android_getBuffer(): $p_a.ByteBuffer;
1230
- /** {zh}
1231
- * @platform android
1232
- * @detail api
1233
- * @brief 获取 byte[] 格式的视频数据。
1234
- * @return <br>
1235
- * byte[] 格式的视频数据。
1236
- *
1237
- */
1238
-
1239
- android_getData(): ArrayBuffer;
1240
- /** {zh}
1241
- * @platform android
1242
- * @detail api
1243
- * @brief 获取视频帧内部销毁回调。
1244
- * @return <br>
1245
- * 视频帧内部销毁回调。
1246
- *
1247
- */
1248
-
1249
- android_getReleaseCallback(): $p_a.Runnable;
1250
- /** {zh}
1251
- * @platform android
1252
- * @detail api
1253
- * @brief 设置视频帧内部销毁回调。
1254
- * @param releaseCallback 视频帧内部销毁回调
1255
- * @return <br>
1256
- * 视频帧对象,详情请参见 VeLiveVideoFrame{@link #VeLiveVideoFrame}。
1257
- *
1258
- */
1259
-
1260
- android_setReleaseCallback(releaseCallback: $p_a.Runnable): this;
1261
- /** {zh}
1262
- * @platform ios
1263
- * @brief 释放回调函数,用于在 SDK 内部处理完 VideoFrame 后通知外部释放相关资源。此回调主要用于 SDK 外部为 VideoFrame 申请内存,以便 SDK 内部使用。但无法预知内部何时使用完毕。
1264
- */
1265
-
1266
- ios_releaseCallback(): void;
1267
- }
1268
- /** {zh}
1269
- * @detail api
1270
- * @brief 相机设备管理对象。
1271
- */
1272
- export declare class VeLiveCameraDevice {
1273
- protected _instance: any;
1274
- protected __init(...args: any[]): void;
1275
- protected __new_instance(...args: any[]): any;
1276
- /** {zh}
1277
- * @platform android
1278
- * @detail api
1279
- * @brief 获取相机支持帧率范围。
1280
- * @return <br>
1281
- * 相机支持帧率范围。
1282
- * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1283
- * @order 66
1284
- *
1285
- */
1286
-
1287
- android_getRealFpsRange(): Array<$p_a.int>;
1014
+ android_getRealFpsRange(): Array<$p_a.int>;
1288
1015
  /** {zh}
1289
1016
  * @detail api
1290
1017
  * @brief 开启/关闭闪光灯。
1291
- * @return <br>
1292
- * - 0:开启/关闭成功;
1293
- * - ≠0:开启/关闭失败。
1294
1018
  * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1295
- * @order 67
1019
+ * @order 8
1296
1020
  * @param enable 是否开启闪光灯。默认为 false。 <br>
1297
1021
  * - true:开启;
1298
1022
  * - false:关闭。
1023
+ * @return <br>
1024
+ * - 0:开启/关闭成功;
1025
+ * - ≠0:开启/关闭失败。
1299
1026
  *
1300
1027
  */
1301
1028
 
@@ -1303,12 +1030,12 @@ export declare class VeLiveCameraDevice {
1303
1030
  /** {zh}
1304
1031
  * @detail api
1305
1032
  * @brief 设置摄像头的缩放倍数。
1033
+ * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1034
+ * @order 5
1035
+ * @param ratio 缩放倍数。默认为原尺寸。缩放倍数的取值范围为 [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)]。
1306
1036
  * @return <br>
1307
1037
  * - 0:缩放成功;
1308
1038
  * - ≠0:缩放失败。
1309
- * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1310
- * @order 68
1311
- * @param ratio 缩放倍数。默认为原尺寸。缩放倍数的取值范围为 [[getMinZoomRatio](#VeLiveCameraDevice-getminzoomratio),[getMaxZoomRatio](#VeLiveCameraDevice-getmaxzoomratio)]。
1312
1039
  *
1313
1040
  */
1314
1041
 
@@ -1316,11 +1043,11 @@ export declare class VeLiveCameraDevice {
1316
1043
  /** {zh}
1317
1044
  * @detail api
1318
1045
  * @brief 获取摄像头当前的缩放倍数。
1046
+ * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1047
+ * @order 4
1319
1048
  * @return <br>
1320
1049
  * - ≤0:表示不支持缩放;
1321
- * - \\>0:支持缩放,数值表示当前缩放倍数。
1322
- * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1323
- * @order 68
1050
+ * - >0:支持缩放,数值表示当前缩放倍数。
1324
1051
  *
1325
1052
  */
1326
1053
 
@@ -1328,11 +1055,11 @@ export declare class VeLiveCameraDevice {
1328
1055
  /** {zh}
1329
1056
  * @detail api
1330
1057
  * @brief 获取摄像头的最大缩放倍数。
1058
+ * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1059
+ * @order 6
1331
1060
  * @return <br>
1332
1061
  * - ≤0:表示不支持缩放;
1333
- * - \\>0:支持缩放,数值表示最大缩放倍数。
1334
- * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1335
- * @order 69
1062
+ * - >0:支持缩放,数值表示最大缩放倍数。
1336
1063
  *
1337
1064
  */
1338
1065
 
@@ -1340,11 +1067,11 @@ export declare class VeLiveCameraDevice {
1340
1067
  /** {zh}
1341
1068
  * @detail api
1342
1069
  * @brief 获取摄像头的最小缩放倍数。
1070
+ * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1071
+ * @order 7
1343
1072
  * @return <br>
1344
1073
  * - ≤0:表示不支持缩放;
1345
- * - \\>0:支持缩放,数值表示最小缩放倍数。
1346
- * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1347
- * @order 70
1074
+ * - >0:支持缩放,数值表示最小缩放倍数。
1348
1075
  *
1349
1076
  */
1350
1077
 
@@ -1352,11 +1079,11 @@ export declare class VeLiveCameraDevice {
1352
1079
  /** {zh}
1353
1080
  * @detail api
1354
1081
  * @brief 是否支持自动对焦。
1082
+ * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1083
+ * @order 9
1355
1084
  * @return <br>
1356
1085
  * - true:支持;
1357
1086
  * - false:不支持。
1358
- * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1359
- * @order 71
1360
1087
  *
1361
1088
  */
1362
1089
 
@@ -1364,14 +1091,14 @@ export declare class VeLiveCameraDevice {
1364
1091
  /** {zh}
1365
1092
  * @detail api
1366
1093
  * @brief 开启/关闭自动对焦功能。
1367
- * @return <br>
1368
- * - 0:开启/关闭成功;
1369
- * - ≠0:开启/关闭失败。
1370
1094
  * @notes <br>需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1371
- * @order 72
1095
+ * @order 10
1372
1096
  * @param enable 是否开启自动对焦,默认为 true。
1373
1097
  * - true:开启;
1374
1098
  * - false:关闭。
1099
+ * @return <br>
1100
+ * - 0:开启/关闭成功;
1101
+ * - ≠0:开启/关闭失败。
1375
1102
  *
1376
1103
  */
1377
1104
 
@@ -1379,15 +1106,15 @@ export declare class VeLiveCameraDevice {
1379
1106
  /** {zh}
1380
1107
  * @detail api
1381
1108
  * @brief 设置摄像头的对焦位置。
1382
- * @return <br>
1383
- * - 0:设置成功;
1384
- * - ≠0:设置失败。
1385
1109
  * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1386
- * @order 73
1110
+ * @order 11
1387
1111
  * @param viewW 当前视图宽度。
1388
1112
  * @param viewH 当前视图高度。
1389
1113
  * @param x 以左上角为原点,对焦点距当前视图的横向坐标值。
1390
1114
  * @param y 以左上角为原点,对焦点距当前视图的纵向坐标值。
1115
+ * @return <br>
1116
+ * - 0:设置成功;
1117
+ * - ≠0:设置失败。
1391
1118
  *
1392
1119
  */
1393
1120
 
@@ -1395,10 +1122,10 @@ export declare class VeLiveCameraDevice {
1395
1122
  /** {zh}
1396
1123
  * @detail api
1397
1124
  * @brief 检查当前使用的摄像头是否支持手动设置曝光点。
1125
+ * @notes 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时,才能检查曝光点设置能力。
1126
+ * @order 12
1398
1127
  * @return - YES:支持;
1399
1128
  * - NO:不支持。
1400
- * @notes 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时,才能检查曝光点设置能力。
1401
- * @order 74
1402
1129
  *
1403
1130
  */
1404
1131
 
@@ -1406,15 +1133,15 @@ export declare class VeLiveCameraDevice {
1406
1133
  /** {zh}
1407
1134
  * @detail api
1408
1135
  * @brief 设置当前使用的摄像头的曝光点。
1409
- * @return - =0:成功;
1410
- * - ≠0:失败。
1411
1136
  * @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集,并且使用 SDK 内部渲染时,才能设置曝光点;
1412
1137
  * - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后,设置的曝光点失效。
1413
- * @order 75
1138
+ * @order 13
1414
1139
  * @param viewW 当前视图宽度。
1415
1140
  * @param viewH 当前视图高度。
1416
1141
  * @param x 以左上角为原点,对焦点距当前视图的横向坐标值。
1417
1142
  * @param y 以左上角为原点,对焦点距当前视图的纵向坐标值。
1143
+ * @return - =0:成功;
1144
+ * - ≠0:失败。
1418
1145
  *
1419
1146
  */
1420
1147
 
@@ -1422,10 +1149,10 @@ export declare class VeLiveCameraDevice {
1422
1149
  /** {zh}
1423
1150
  * @detail api
1424
1151
  * @brief 获取摄像头的最小曝光补偿值。
1425
- * @return - ≤0:表示不支持曝光补偿;
1426
- * - \\>0:支持曝光补偿,数值表示最小曝光补偿。
1427
1152
  * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1428
- * @order 76
1153
+ * @order 14
1154
+ * @return - ≤0:表示不支持曝光补偿;
1155
+ * - >0:支持曝光补偿,数值表示最小曝光补偿。
1429
1156
  *
1430
1157
  */
1431
1158
 
@@ -1433,10 +1160,10 @@ export declare class VeLiveCameraDevice {
1433
1160
  /** {zh}
1434
1161
  * @detail api
1435
1162
  * @brief 获取摄像头的最大曝光补偿值。
1436
- * @return - ≤0:表示不支持曝光补偿;
1437
- * - \\>0:支持曝光补偿,数值表示最大曝光补偿。
1438
1163
  * @notes 需要在调用 [startVideoCapture](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1439
- * @order 77
1164
+ * @order 15
1165
+ * @return - ≤0:表示不支持曝光补偿;
1166
+ * - >0:支持曝光补偿,数值表示最大曝光补偿。
1440
1167
  *
1441
1168
  */
1442
1169
 
@@ -1444,12 +1171,12 @@ export declare class VeLiveCameraDevice {
1444
1171
  /** {zh}
1445
1172
  * @detail api
1446
1173
  * @brief 设置当前使用的摄像头的曝光补偿。
1447
- * @return - =0:设置成功;
1448
- * - ≠0:设置失败。
1449
1174
  * @notes - 必须已调用 [startVideoCapture](#VeLivePusher-startvideocapture) 使用 SDK 内部采集模块进行视频采集时,才能设置曝光补偿。
1450
1175
  * - 调用 [stopVideoCapture](#VeLivePusher-stopvideocapture) 关闭内部采集后,设置的曝光补偿失效。
1451
- * @order 78
1176
+ * @order 16
1452
1177
  * @param value 曝光补偿值,取值范围 [[getMinExposureCompensation](#VeLiveCameraDevice-getminexposurecompensation),[getMaxExposureCompensation](#VeLiveCameraDevice-getmaxexposurecompensation)],0 为系统默认值,表示没有曝光补偿。
1178
+ * @return - =0:设置成功;
1179
+ * - ≠0:设置失败。
1453
1180
  *
1454
1181
  */
1455
1182
 
@@ -1458,11 +1185,11 @@ export declare class VeLiveCameraDevice {
1458
1185
  * @platform ios
1459
1186
  * @detail api
1460
1187
  * @brief 是否支持闪光灯。
1188
+ * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1189
+ * @order 49
1461
1190
  * @return <br>
1462
1191
  * - YES:支持;
1463
1192
  * - NO:不支持。
1464
- * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后,调用本方法。
1465
- * @order 49
1466
1193
  */
1467
1194
 
1468
1195
  ios_isTorchSupported(): boolean;
@@ -1470,7 +1197,7 @@ export declare class VeLiveCameraDevice {
1470
1197
  * @platform ios
1471
1198
  * @detail api
1472
1199
  * @brief 设置相机参数。
1473
- * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后,调用本方法。
1200
+ * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1474
1201
  * @order 64
1475
1202
  * @param parameter 相机参数字典,包含要设置的参数名称(键)和对应的值
1476
1203
  */
@@ -1480,11 +1207,11 @@ export declare class VeLiveCameraDevice {
1480
1207
  * @platform ios
1481
1208
  * @detail api
1482
1209
  * @brief 获取相机参数。
1483
- * @return <br>
1484
- * 相机参数的值,具体类型需要根据参数名称确定。
1485
- * @notes <br>需要在调用 startVideoCapture:{@link #VeLivePusher#startVideoCapture} 启动相机采集后,调用本方法。
1210
+ * @notes 需要在调用 [startVideoCapture:](#VeLivePusher-startvideocapture) 启动相机采集后,调用本方法。
1486
1211
  * @order 65
1487
1212
  * @param key 需要获取的相机参数的名称。
1213
+ * @return <br>
1214
+ * 相机参数的值,具体类型需要根据参数名称确定。
1488
1215
  */
1489
1216
 
1490
1217
  ios_getParameter(key: string): $p_i.id;
@@ -1500,20 +1227,19 @@ export declare class VeLiveVideoEffectManager {
1500
1227
  /** {zh}
1501
1228
  * @detail api
1502
1229
  * @brief 视频特效许可证配置,用于初始化视频特效管理对象。
1230
+ * @order 89
1231
+ * @param config 特效初始化配置,详情请参见 [VeLiveVideoEffectLicenseConfiguration](147521#VeLivePusherDef-VeLiveVideoEffectLicenseConfiguration)。
1503
1232
  * @return <br>
1504
1233
  * - 0:调用成功;
1505
1234
  * - -1:调用失败。
1506
- * @order 89
1507
- * @param config 特效初始化配置,详情请参见 [VeLiveVideoEffectLicenseConfiguration](147521#VeLiveVideoEffectLicenseConfiguration)。
1508
1235
  *
1509
1236
  */
1510
1237
 
1511
1238
  setupWithConfig(config: VeLiveVideoEffectLicenseConfiguration): number;
1512
1239
  /** {zh}
1513
1240
  * @detail api
1514
- * @brief 更新在线 License。本方法仅对在线 License 有效。
1241
+ * @brief 如果您使用在线 License 认证方式,在许可证过期后,可调用该方法更新 License
1515
1242
  * @notes - 需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用;
1516
- * - 如果您使用在线 License 认证方式,在许可证过期后,可调用该方法更新 License;
1517
1243
  * - 本方法为异步操作。
1518
1244
  * @order 90
1519
1245
  * @param callback 结果回调信息
@@ -1524,11 +1250,7 @@ export declare class VeLiveVideoEffectManager {
1524
1250
  /** {zh}
1525
1251
  * @detail api
1526
1252
  * @brief 创建/销毁特效引擎。
1527
- * @return <br>
1528
- * - 0:成功;
1529
- * - -1:失败。
1530
- * @notes <br>
1531
- * - 该方法需要在调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 和 [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath) 后调用;
1253
+ * @notes - 该方法需要在调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 和 [setAlgorithmModelPath](#VeLiveVideoEffectManager-setalgorithmmodelpath) 后调用;
1532
1254
  * - 该方法不直接开启/关闭视频特效,您需要在调用该方法后,调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 开启视频特效;
1533
1255
  * - 通用场景下,特效引擎会随 EffectManager 销毁而销毁。如果您对性能有较高要求,也可以在不使用特效相关功能时,调用该方法销毁特效引擎;
1534
1256
  * - 如果重复创建/销毁特效引擎,会产生时间消耗。
@@ -1536,7 +1258,9 @@ export declare class VeLiveVideoEffectManager {
1536
1258
  * @param enable 是否创建特效引擎。默认为 false。 <br>
1537
1259
  * - true:创建;
1538
1260
  * - false:销毁。
1539
- * @param callback 视频特效回调 [VeLiveVideoEffectCallback](147519#velivevideoeffectcallback)。
1261
+ * @param callback 视频特效回调 [VeLiveVideoEffectCallback](147519#VeLivePusherDef-VeLiveVideoEffectCallback)。
1262
+ * @return - 0:成功;
1263
+ * - -1:失败。
1540
1264
  *
1541
1265
  */
1542
1266
 
@@ -1545,12 +1269,12 @@ export declare class VeLiveVideoEffectManager {
1545
1269
  * @platform android
1546
1270
  * @detail api
1547
1271
  * @brief 设置特效算法模型包的路径。
1548
- * @return <br>
1549
- * - 0:调用成功;
1550
- * - -1:调用失败。
1551
1272
  * @notes <br>需要通过调用 [setupWithConfig](#VeLiveVideoEffectManager-setupwithconfig) 设置视频特效许可证后调用。
1552
1273
  * @order 91
1553
1274
  * @param path 特效算法模型包的路径
1275
+ * @return <br>
1276
+ * - 0:调用成功;
1277
+ * - -1:调用失败。
1554
1278
  *
1555
1279
  */
1556
1280
 
@@ -1558,45 +1282,41 @@ export declare class VeLiveVideoEffectManager {
1558
1282
  /** {zh}
1559
1283
  * @detail api
1560
1284
  * @brief 设置视频特效组合。支持设置 ComposeMakeup.bundle 中的功能,包括美颜、美形、美体、美妆等。
1561
- * @return <br>
1562
- * - 0:调用成功;
1563
- * - -1:调用失败。
1564
1285
  * @notes <br>
1565
1286
  * - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法;
1566
1287
  * - 重复调用本方法,仅最后一次调用生效;
1567
1288
  * - 如果需要在当前的视频特效组合中叠加特效,可调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 方法。
1568
1289
  * @order 93
1569
1290
  * @param nodes 视频特效素材包路径数组
1291
+ * @return <br>
1292
+ * - 0:调用成功;
1293
+ * - -1:调用失败。
1570
1294
  *
1571
1295
  */
1572
1296
 
1573
1297
  setComposeNodes(nodes: Array<string>): number;
1574
1298
  /** {zh}
1575
1299
  * @detail api
1576
- * @brief 在已有的视频特效组合上,叠加视频特效素材包。
1300
+ * @brief 在已有的视频特效组合上,叠加视频特效素材包,您可以调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合。
1301
+ * @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
1302
+ * @order 94
1303
+ * @param nodes 视频特效素材包路径数组
1577
1304
  * @return <br>
1578
1305
  * - 0:调用成功;
1579
1306
  * - -1:调用失败。
1580
- * @notes <br>
1581
- * - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
1582
- * - 调用本方法,会在 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置的视频特效组合的基础上叠加特效。
1583
- * @order 94
1584
- * @param nodes 视频特效素材包路径数组
1585
1307
  *
1586
1308
  */
1587
1309
 
1588
1310
  appendComposeNodes(nodes: Array<string>): number;
1589
1311
  /** {zh}
1590
1312
  * @detail api
1591
- * @brief 移除指定的视频特效资源。
1313
+ * @brief 调用本方法,可移除调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 和 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 设置的视频特效资源。
1314
+ * @notes 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
1315
+ * @order 94
1316
+ * @param nodes 视频特效素材包路径数组
1592
1317
  * @return <br>
1593
1318
  * - 0:调用成功;
1594
1319
  * - -1:调用失败。
1595
- * @notes <br>
1596
- * - 需要在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 创建特效引擎后,调用本方法。
1597
- * - 调用本方法,可移除调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 和 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 设置的视频特效资源。
1598
- * @order 94
1599
- * @param nodes 视频特效素材包路径数组
1600
1320
  *
1601
1321
  */
1602
1322
 
@@ -1604,9 +1324,6 @@ export declare class VeLiveVideoEffectManager {
1604
1324
  /** {zh}
1605
1325
  * @detail api
1606
1326
  * @brief 设置视频特效强度。
1607
- * @return <br>
1608
- * - 0:调用成功;
1609
- * - -1:调用失败。
1610
1327
  * @notes <br>
1611
1328
  * - 需要在调用 [setComposeNodes](#VeLiveVideoEffectManager-setcomposenodes) 设置视频特效组合或调用 [appendComposeNodes](#VeLiveVideoEffectManager-appendcomposenodes) 叠加视频特效素材包后,调用本方法;
1612
1329
  * - 该方法仅适用于同时含有上述三个参数的特效资源,对于没有强度参数的特效(如贴纸),该方法无效。
@@ -1614,6 +1331,9 @@ export declare class VeLiveVideoEffectManager {
1614
1331
  * @param node 视频特效素材包路径
1615
1332
  * @param key 需要设置的素材 key 名称
1616
1333
  * @param intensity 需要设置的强度值。取值范围为 [0.0,1.0]
1334
+ * @return <br>
1335
+ * - 0:调用成功;
1336
+ * - -1:调用失败。
1617
1337
  *
1618
1338
  */
1619
1339
 
@@ -1621,12 +1341,12 @@ export declare class VeLiveVideoEffectManager {
1621
1341
  /** {zh}
1622
1342
  * @detail api
1623
1343
  * @brief 设置颜色滤镜。
1624
- * @return <br>
1625
- * - 0:调用成功;
1626
- * - -1:调用失败。
1627
1344
  * @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法。
1628
1345
  * @order 96
1629
1346
  * @param path 滤镜资源包绝对路径
1347
+ * @return <br>
1348
+ * - 0:调用成功;
1349
+ * - -1:调用失败。
1630
1350
  *
1631
1351
  */
1632
1352
 
@@ -1634,12 +1354,11 @@ export declare class VeLiveVideoEffectManager {
1634
1354
  /** {zh}
1635
1355
  * @detail api
1636
1356
  * @brief 设置已启用的颜色滤镜强度。
1637
- * @return <br>
1638
- * - 0:调用成功;
1639
- * - -1:调用失败。
1640
1357
  * @notes <br>请在调用 [setFilter](#VeLiveVideoEffectManager-setfilter) 设置颜色滤镜后调用。
1641
1358
  * @order 97
1642
1359
  * @param intensity 滤镜强度,取值范围为 [0.0,1.0]。
1360
+ * @return - 0:调用成功;
1361
+ * - -1:调用失败。
1643
1362
  *
1644
1363
  */
1645
1364
 
@@ -1647,22 +1366,22 @@ export declare class VeLiveVideoEffectManager {
1647
1366
  /** {zh}
1648
1367
  * @detail api
1649
1368
  * @brief 设置贴纸特效。
1650
- * @return <br>
1651
- * - 0:调用成功;
1652
- * - -1:调用失败。
1653
1369
  * @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法。
1654
1370
  * @order 98
1655
1371
  * @param path 贴纸素材包的绝对路径
1372
+ * @return <br>
1373
+ * - 0:调用成功;
1374
+ * - -1:调用失败。
1656
1375
  *
1657
1376
  */
1658
1377
 
1659
1378
  setSticker(path: string): number;
1660
1379
  /** {zh}
1661
1380
  * @detail api
1662
- * @brief CV 高级接口。
1663
- * @notes <br>请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法,不要在主线程中频繁执行同步操作。
1381
+ * @brief 智能美化特效的高级功能。
1382
+ * @notes 请在调用 [setEnable](#VeLiveVideoEffectManager-setenable) 开启视频特效后,调用该方法,不要在主线程中频繁执行同步操作。
1664
1383
  * @order 99
1665
- * @param callback 回调 CV 的 handle。
1384
+ * @param callback handle 作为参数的回调函数。
1666
1385
  * @param isGLThread 是否在 GL 线程回调 callback。
1667
1386
  * @param isAsync 是否同步执行 callback。
1668
1387
  *
@@ -1673,262 +1392,20 @@ export declare class VeLiveVideoEffectManager {
1673
1392
  * @platform ios
1674
1393
  * @detail api
1675
1394
  * @brief 设置特效算法模型包的路径。
1676
- * @return <br>
1677
- * - 0:调用成功;
1678
- * - -1:调用失败。
1679
1395
  * @notes <br>
1680
1396
  * 需要通过调用 setupWithConfig:{@link #VeLiveVideoEffectManager#setupWithConfig} 设置视频特效许可证后调用。
1681
- * @order 77
1397
+ * @order 4
1682
1398
  * @param path 特效算法模型包的路径。
1683
- */
1684
-
1685
- ios_setAlgoModelPath(path: string): number;
1686
- }
1687
- /** {zh}
1688
- * @detail api
1689
- * @brief 音视频混流器管理对象。支持添加/移除音视频流、发送自定义音视频帧、更新混流布局等。
1690
- */
1691
- export declare class VeLiveMixerManager {
1692
- protected _instance: any;
1693
- protected __init(...args: any[]): void;
1694
- protected __new_instance(...args: any[]): any;
1695
- /** {zh}
1696
- * @detail api
1697
- * @brief 添加一路需要混流的视频流到混流器中。
1698
- * @return <br>
1699
- * 视频流 ID。
1700
- * @order 79
1701
- *
1702
- */
1703
-
1704
- addVideoStream(): number;
1705
- /** {zh}
1706
- * @platform android
1707
- * @detail api
1708
- * @brief 添加一路音频流到混流器中,并指定混流类型。
1709
- * @return <br>
1710
- * 音频流 ID。
1711
- * @order 81
1712
- * @param type 混流类型,详情请参见 [VeLiveAudioMixType](147521#VeLiveAudioMixType) 。
1713
- *
1714
- */
1715
-
1716
- android_addAudioStream_type(type: $p_a.VeLiveAudioMixType): number;
1717
- /** {zh}
1718
- * @detail api
1719
- * @brief 获取主路视频流 ID。
1720
- * @order 83
1721
- *
1722
- */
1723
-
1724
- getOriginVideoStream(): number;
1725
- /** {zh}
1726
- * @detail api
1727
- * @brief 获取主路音频流 ID。
1728
- * @order 84
1729
- *
1730
- */
1731
-
1732
- getOriginAudioStream(): number;
1733
- /** {zh}
1734
- * @platform android
1735
- * @detail api
1736
- * @brief 获取主路屏幕流 ID。
1737
- * @order 85
1738
- *
1739
- */
1740
-
1741
- android_getOriginScreenStream(): number;
1742
- /** {zh}
1743
- * @platform android
1744
- * @detail api
1745
- * @brief 获取主路系统音频流 ID。
1746
- * @order 86
1747
- *
1748
- */
1749
-
1750
- android_getOriginSystemAudioStream(): number;
1751
- /** {zh}
1752
- * @detail api
1753
- * @brief 发送指定混流 ID 的自定义视频帧数据。
1754
- * @order 87
1755
- * @param frame 自定义的视频帧,详情请参见 [VeLiveVideoFrame](147517#VeLiveVideoFrame) 。
1756
- * @param streamId 需要混流的视频流 ID。
1757
- *
1758
- */
1759
-
1760
- sendCustomVideoFrame(frame: VeLiveVideoFrame, streamId: number): void;
1761
- /** {zh}
1762
- * @detail api
1763
- * @brief 发送指定混流 ID 的自定义音频帧数据。
1764
- * @order 88
1765
- * @param frame 自定义的音频帧,详情请参见 [VeLiveAudioFrame](147517#VeLiveAudioFrame) 。
1766
- * @param streamId 混流的音频流 ID。
1767
- *
1768
- */
1769
-
1770
- sendCustomAudioFrame(frame: VeLiveAudioFrame, streamId: number): void;
1771
- /** {zh}
1772
- * @detail api
1773
- * @brief 更新音视频混流的布局。
1774
- * @param mixDescription 新的音视频混流布局,详情请参见 [VeLiveStreamMixDescription](147521#VeLiveStreamMixDescription)。
1775
- *
1776
- */
1777
-
1778
- updateStreamMixDescription(mixDescription: VeLiveStreamMixDescription): void;
1779
- /** {zh}
1780
- * @detail api
1781
- * @brief 从混流器中移除一路非主路的视频流。
1782
- * @order 80
1783
- * @param streamId 需要移除的非主路视频流 ID。
1784
- *
1785
- */
1786
-
1787
- removeVideoStream(streamId: number): void;
1788
- /** {zh}
1789
- * @detail api
1790
- * @brief 从混流器中移除一路非主路的音频流。
1791
- * @order 82
1792
- * @param streamId 需要移除的非主路音频流 ID。
1793
- *
1794
- */
1795
-
1796
- removeAudioStream(streamId: number): void;
1797
- /** {zh}
1798
- * @platform ios
1799
- * @detail api
1800
- * @brief 设置指定混流音频的音量。当你将 VeLiveAudioMixType{@link #VeLiveAudioMixType} 设置为 `VeLiveAudioMixPlayAndPush` 时,该方法同时控制该路音频在拉流端和本地的播放音量。
1801
- * @order 70
1802
- * @param streamId 非主路音频流 ID。
1803
- * @param volume 音量大小,范围为 [0.0,4.0]。
1804
- */
1805
-
1806
- ios_setAudioStream(streamId: number, volume: number): void;
1807
- /** {zh}
1808
- * @platform ios
1809
- * @detail api
1810
- * @brief 获取屏幕推流App音频流 ID。
1811
- */
1812
-
1813
- ios_getAppAudioStream(): number;
1814
- }
1815
- /** {zh}
1816
- * @detail api
1817
- * @brief 音频帧的数据信息。
1818
- */
1819
- export declare class VeLiveAudioFrame {
1820
- constructor();
1821
- constructor(sampleRate: VeLiveAudioSampleRate, channel: VeLiveAudioChannel, pts: number, buffer: ByteBuffer);
1822
- constructor();
1823
- protected _instance: any;
1824
- get bufferType(): VeLiveAudioBufferType;
1825
- set bufferType(value: VeLiveAudioBufferType);
1826
- get sampleRate(): any;
1827
- set sampleRate(value: any);
1828
- get channels(): any;
1829
- set channels(value: any);
1830
- /**
1831
- * @platform android
1832
- */
1833
- get android_ptsUs(): any;
1834
- set android_ptsUs(value: any);
1835
- /**
1836
- * @platform android
1837
- */
1838
- get android_buffer(): any;
1839
- set android_buffer(value: any);
1840
- /**
1841
- * @platform android
1842
- */
1843
- get android_samplesPerChannel(): any;
1844
- set android_samplesPerChannel(value: any);
1845
- /** {zh}
1846
- * @platform ios
1847
- * @brief 当 bufferType 取值为 `VeLiveAudioBufferNSData` 时的音频帧时间戳,单位为 μs。
1848
- */
1849
-
1850
- get ios_pts(): $p_i.CMTime;
1851
- set ios_pts(value: $p_i.CMTime);
1852
- /** {zh}
1853
- * @platform ios
1854
- * @brief 当 bufferType 取值为 `VeLiveAudioBufferTypeSampleBuffer` 时的音频数据。
1855
- */
1856
-
1857
- get ios_sampleBuffer(): $p_i.CMSampleBufferRef;
1858
- set ios_sampleBuffer(value: $p_i.CMSampleBufferRef);
1859
- /** {zh}
1860
- * @platform ios
1861
- * @brief 当 bufferType 取值为 `VeLiveAudioBufferTypeNSData` 时的音频数据。音频帧数据为 float32 格式小端字节序存储。
1862
- */
1863
-
1864
- get ios_data(): $p_i.NSData;
1865
- set ios_data(value: $p_i.NSData);
1866
- protected __init(...args: any[]): void;
1867
- protected __new_instance(...args: any[]): any;
1868
- /** {zh}
1869
- * @platform android
1870
- * @detail api
1871
- * @brief 获取音频数据类型。
1872
- * @return <br>
1873
- * 音频数据类型,详情请参见 VeLiveAudioBufferType{@link #VeLiveAudioBufferType}。
1874
- *
1875
- */
1876
-
1877
- android_getBufferType(): $p_a.VeLiveAudioBufferType;
1878
- /** {zh}
1879
- * @platform android
1880
- * @detail api
1881
- * @brief 获取音频采样率。
1882
- * @return <br>
1883
- * 音频采样率,详情请参见 VeLiveAudioSampleRate{@link #VeLiveAudioSampleRate}。
1884
- *
1885
- */
1886
-
1887
- android_getSampleRate(): $p_a.VeLiveAudioSampleRate;
1888
- /** {zh}
1889
- * @platform android
1890
- * @detail api
1891
- * @brief 获取音频声道数。
1892
1399
  * @return <br>
1893
- * 音频声道数,详情请参见 VeLiveAudioChannel{@link #VeLiveAudioChannel}。
1894
- *
1895
- */
1896
-
1897
- android_getChannels(): $p_a.VeLiveAudioChannel;
1898
- /** {zh}
1899
- * @platform android
1900
- * @detail api
1901
- * @brief 获取音频位深度。
1902
- * @return <br>
1903
- * 音频位深度。
1904
- *
1905
- */
1906
-
1907
- android_getSamplesPerChannel(): number;
1908
- /** {zh}
1909
- * @platform android
1910
- * @detail api
1911
- * @brief 获取音频时间戳,单位为 μs。
1912
- * @return <br>
1913
- * 音频时间戳,单位为 μs。
1914
- *
1915
- */
1916
-
1917
- android_getPts(): number;
1918
- /** {zh}
1919
- * @platform android
1920
- * @detail api
1921
- * @brief 获取音频数据。音频帧数据为 float32 格式小端字节序存储。
1922
- * @return <br>
1923
- * 格式为 ByteBuffer 的音频数据。
1924
- *
1400
+ * - 0:调用成功;
1401
+ * - -1:调用失败。
1925
1402
  */
1926
1403
 
1927
- android_getBuffer(): $p_a.ByteBuffer;
1404
+ ios_setAlgoModelPath(path: string): number;
1928
1405
  }
1929
1406
  /** {zh}
1930
1407
  * @detail api
1931
- * @brief 音频设备管理类。该类提供了用于管理和控制音频设备,包括设置音量、获取当前音量、检查硬件耳返支持情况、开启或关闭耳返的方法。
1408
+ * @brief 音频设备管理类。该类提供了用于管理和控制音频设备,包括设置音量、获取当前音量的方法。
1932
1409
  */
1933
1410
  export declare class VeLiveAudioDevice {
1934
1411
  protected _instance: any;
@@ -1946,44 +1423,48 @@ export declare class VeLiveAudioDevice {
1946
1423
  /** {zh}
1947
1424
  * @detail api
1948
1425
  * @brief 获取当前音量响度。
1426
+ * @order 75
1949
1427
  * @return <br>
1950
1428
  * 当前音量响度等级。
1951
- * @order 75
1952
1429
  *
1953
1430
  */
1954
1431
 
1955
1432
  getVoiceLoudness(): number;
1956
1433
  /** {zh}
1434
+ * @platform ios
1957
1435
  * @detail api
1958
1436
  * @brief 查询是否支持硬件耳返。
1959
1437
  * @return <br>
1960
- * - true:支持;
1961
- * - false:不支持。
1962
- * @order 76
1963
- *
1438
+ * - YES:支持;
1439
+ * - NO:不支持。
1440
+ * @order 62
1964
1441
  */
1965
1442
 
1966
- isSupportHardwareEcho(): boolean;
1443
+ ios_isSupportHardwareEcho(): boolean;
1967
1444
  /** {zh}
1445
+ * @platform ios
1968
1446
  * @detail api
1969
1447
  * @brief 是否开启耳返功能。
1970
- * @param enable 耳返功能开关。默认值为 false。<br>
1971
- * - true:开启;
1972
- * - false:关闭。
1973
- * @order 77
1974
- *
1448
+ * @param enable 耳返功能开关。默认值为 NO。<br>
1449
+ * - YES:开启;
1450
+ * - NO:关闭。
1451
+ * @notes
1452
+ * 需要在调用 [startAudioCapture:](#VeLivePusher-startaudiocapture) 启动音频采集后,调用本方法。
1453
+ * @order 64
1975
1454
  */
1976
1455
 
1977
- enableEcho(enable: boolean): void;
1456
+ ios_enableEcho(enable: boolean): void;
1978
1457
  /** {zh}
1458
+ * @platform ios
1979
1459
  * @detail api
1980
1460
  * @brief 获取当前耳返开启状态。
1461
+ * @notes
1462
+ * 需要在调用 [startAudioCapture:](#VeLivePusher-startaudiocapture) 启动音频采集后,调用本方法。
1463
+ * @order 65
1981
1464
  * @return <br>
1982
- * - true:开启;
1983
- * - false:关闭。
1984
- * @order 78
1985
- *
1465
+ * - YES:开启;
1466
+ * - NO:关闭。
1986
1467
  */
1987
1468
 
1988
- isEnableEcho(): boolean;
1469
+ ios_isEnableEcho(): boolean;
1989
1470
  }