@volcengine/react-native-live-push 1.1.3-rc.0 → 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,10 +1,10 @@
1
- import { int, double, String, ArrayList, float, long } from './types';
1
+ import { int, long, Matrix, ByteBuffer, Runnable, double, String, ArrayList, float, Context, LiveSdkSetting } from './types';
2
+ import { VeLivePusher } from './api';
2
3
  export declare class VeLiveVideoEncoderConfiguration {
3
4
  /** {zh}
4
5
  * @detail api
5
6
  * @brief 获取推流视频分辨率。
6
- * @return <br>
7
- * 推流视频分辨率 VeLiveVideoResolution{@link #VeLiveVideoResolution}。
7
+ * @return 推流视频分辨率 [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution)。
8
8
  *
9
9
  */
10
10
 
@@ -12,9 +12,8 @@ export declare class VeLiveVideoEncoderConfiguration {
12
12
  /** {zh}
13
13
  * @detail api
14
14
  * @brief 设置推流视频分辨率。
15
- * @param resolution 推流视频分辨率,默认值为 VeLiveVideoResolution720P,详情请参见 VeLiveVideoResolution{@link #VeLiveVideoResolution}
16
- * @return <br>
17
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
15
+ * @param resolution 推流视频分辨率,默认值为 VeLiveVideoResolution720P,详情请参见 [VeLiveVideoResolution](#VeLivePusherDef-VeLiveVideoResolution)。
16
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
18
17
  *
19
18
  */
20
19
 
@@ -22,8 +21,7 @@ export declare class VeLiveVideoEncoderConfiguration {
22
21
  /** {zh}
23
22
  * @detail api
24
23
  * @brief 获取推流视频编码格式。
25
- * @return <br>
26
- * 推流视频编码格式,详情请参见 VeLiveVideoCodec{@link #VeLiveVideoCodec}。
24
+ * @return 推流视频编码格式,详情请参见 [VeLiveVideoCodec](#VeLiveVideoCodec)。
27
25
  *
28
26
  */
29
27
 
@@ -31,8 +29,8 @@ export declare class VeLiveVideoEncoderConfiguration {
31
29
  /** {zh}
32
30
  * @detail api
33
31
  * @brief 设置推流视频编码格式。
34
- * @return 推流视频编码参数,详见 [VeLiveVideoEncoderConfiguration](147521#velivevideoencoderconfiguration)。
35
- * @param codec <br>推流视频编码格式,详情请参见 [VeLiveVideoCodec](147521#VeLiveVideoCodec)
32
+ * @param codec 推流视频编码格式,详情请参见 [VeLiveVideoCodec](#VeLiveVideoCodec)
33
+ * @return 推流视频编码参数,详见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
36
34
  *
37
35
  */
38
36
 
@@ -50,8 +48,7 @@ export declare class VeLiveVideoEncoderConfiguration {
50
48
  * @detail api
51
49
  * @brief 设置推流视频编码码率。
52
50
  * @param bitrate 推流视频编码码率,单位为 kbps,默认值由 `resolution` 参数值决定。
53
- * @return <br>
54
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
51
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
55
52
  *
56
53
  */
57
54
 
@@ -69,8 +66,7 @@ export declare class VeLiveVideoEncoderConfiguration {
69
66
  * @detail api
70
67
  * @brief 设置推流视频编码最小码率。
71
68
  * @param minBitrate 推流视频编码最小码率,单位为 kbps,默认值由 `resolution` 参数值决定;如果开启自适应码率,推流 SDK 根据网络情况进行编码码率自适应调整的最小码率
72
- * @return <br>
73
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
69
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
74
70
  *
75
71
  */
76
72
 
@@ -87,9 +83,9 @@ export declare class VeLiveVideoEncoderConfiguration {
87
83
  /** {zh}
88
84
  * @detail api
89
85
  * @brief 设置推流视频编码最大码率。
90
- * @return <br>
91
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
92
86
  * @param maxBitrate 推流视频编码最大码率,单位为 kbps,默认值由 `resolution` 参数值决定;如果开启自适应码率,推流 SDK 根据网络情况进行编码码率自适应调整的最大码率。
87
+ * @return
88
+ * 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
93
89
  *
94
90
  */
95
91
 
@@ -107,8 +103,7 @@ export declare class VeLiveVideoEncoderConfiguration {
107
103
  * @detail api
108
104
  * @brief 设置推流视频编码 GOP。
109
105
  * @param gopSize 视频 GOP 大小,单位为 s,默认值为 2
110
- * @return <br>
111
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
106
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
112
107
  *
113
108
  */
114
109
 
@@ -116,8 +111,7 @@ export declare class VeLiveVideoEncoderConfiguration {
116
111
  /** {zh}
117
112
  * @detail api
118
113
  * @brief 获取推流视频编码帧率。
119
- * @return <br>
120
- * 推流视频编码帧率。
114
+ * @return 推流视频编码帧率。
121
115
  *
122
116
  */
123
117
 
@@ -126,8 +120,7 @@ export declare class VeLiveVideoEncoderConfiguration {
126
120
  * @detail api
127
121
  * @brief 设置推流视频编码帧率。
128
122
  * @param fps 视频编码帧率,单位为 fps,默认值为 15
129
- * @return <br>
130
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
123
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
131
124
  *
132
125
  */
133
126
 
@@ -135,8 +128,7 @@ export declare class VeLiveVideoEncoderConfiguration {
135
128
  /** {zh}
136
129
  * @detail api
137
130
  * @brief 获取是否开启 B 帧。
138
- * @return <br>
139
- * 是否开启B帧。<br>
131
+ * @return 是否开启B帧。<br/>
140
132
  * - true:B 帧开启;
141
133
  * - false:B 帧关闭。
142
134
  *
@@ -149,8 +141,7 @@ export declare class VeLiveVideoEncoderConfiguration {
149
141
  * @param enableBFrame 是否开启 B 帧。默认为 false。 <br>
150
142
  * - true:开启;
151
143
  * - false:关闭。
152
- * @return <br>
153
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
144
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
154
145
  *
155
146
  */
156
147
 
@@ -172,28 +163,195 @@ export declare class VeLiveVideoEncoderConfiguration {
172
163
  * @param enableAccelerate 是否开启硬件编码。默认值为 true。 <br>
173
164
  * - true:开启;
174
165
  * - false:关闭。
175
- * @return <br>
176
- * 推流视频编码参数配置对象,详情请参见 VeLiveVideoEncoderConfiguration{@link #VeLiveVideoEncoderConfiguration}。
166
+ * @return 推流视频编码参数配置对象,详情请参见 [VeLiveVideoEncoderConfiguration](#VeLivePusherDef-VeLiveVideoEncoderConfiguration)。
177
167
  *
178
168
  */
179
169
 
180
170
  setEnableAccelerate(enableAccelerate: boolean): this;
181
171
  }
172
+ export declare class VeLiveVideoFrame {
173
+ constructor(width: int, height: int, pts: long, data: ArrayBuffer);
174
+ /** {zh}
175
+ * @detail api
176
+ * @brief 增加 VeLiveVideoFrame 对象的引用计数。当您需要继续使用 VeLiveVideoFrame 对象时,请调用此方法将引用计数增加 1。
177
+ *
178
+ */
179
+
180
+ retain(): void;
181
+ /** {zh}
182
+ * @detail api
183
+ * @brief 释放对 VeLiveVideoFrame 对象的引用。在您不再需要使用 VeLiveVideoFrame 对象时,应调用此方法将引用计数减少 1。当引用计数减少到零,表示不再有引用指向该对象,可以安全地释放或销毁该对象。
184
+ *
185
+ */
186
+
187
+ release(): void;
188
+ /** {zh}
189
+ * @detail api
190
+ * @brief 获取视频数据类型。
191
+ * @return 视频数据类型,详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
192
+ *
193
+ */
194
+
195
+ getBufferType(): VeLiveVideoBufferType;
196
+ /** {zh}
197
+ * @detail api
198
+ * @brief 设置视频数据类型。
199
+ * @param bufferType 视频数据类型,详情请参见 [VeLiveVideoBufferType](#VeLiveVideoBufferType)。
200
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
201
+ *
202
+ */
203
+
204
+ setBufferType(bufferType: VeLiveVideoBufferType): this;
205
+ /** {zh}
206
+ * @detail api
207
+ * @brief 获取视频像素格式。
208
+ * @return 视频像素格式,详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
209
+ *
210
+ */
211
+
212
+ getPixelFormat(): VeLivePixelFormat;
213
+ /** {zh}
214
+ * @detail api
215
+ * @brief 设置视频像素格式。
216
+ * @param pixelFormat 视频像素格式,详情请参见 [VeLivePixelFormat](#VeLivePixelFormat)。
217
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
218
+ *
219
+ */
220
+
221
+ setPixelFormat(pixelFormat: VeLivePixelFormat): this;
222
+ /** {zh}
223
+ * @detail api
224
+ * @brief 获取视频帧旋转角度。
225
+ * @return 视频帧旋转角度,详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
226
+ *
227
+ */
228
+
229
+ getRotation(): VeLiveVideoRotation;
230
+ /** {zh}
231
+ * @detail api
232
+ * @brief 设置视频帧旋转角度。
233
+ * @param rotation 视频帧旋转角度,详情请参见 [VeLiveVideoRotation](#VeLiveVideoRotation)。
234
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
235
+ *
236
+ */
237
+
238
+ setRotation(rotation: VeLiveVideoRotation): this;
239
+ /** {zh}
240
+ * @detail api
241
+ * @brief 获取视频帧宽度。
242
+ * @return <br>
243
+ * 视频帧宽度。
244
+ *
245
+ */
246
+
247
+ getWidth(): int;
248
+ /** {zh}
249
+ * @detail api
250
+ * @brief 获取视频帧高度。
251
+ * @return <br>
252
+ * 视频帧高度。
253
+ *
254
+ */
255
+
256
+ getHeight(): int;
257
+ /** {zh}
258
+ * @detail api
259
+ * @brief 获取带旋转角度的视频帧宽度。
260
+ * @return <br>
261
+ * 带旋转角度的视频帧宽度。
262
+ *
263
+ */
264
+
265
+ getRotatedWidth(): int;
266
+ /** {zh}
267
+ * @detail api
268
+ * @brief 获取带旋转角度的视频帧高度。
269
+ * @return <br>
270
+ * 带旋转角度的视频帧高度。
271
+ *
272
+ */
273
+
274
+ getRotatedHeight(): int;
275
+ /** {zh}
276
+ * @detail api
277
+ * @brief 获取视频帧时间戳。
278
+ * @return <br>
279
+ * 视频帧时间戳,单位为 μs。
280
+ *
281
+ */
282
+
283
+ getPts(): long;
284
+ /** {zh}
285
+ * @detail api
286
+ * @brief 获取视频帧纹理 ID。
287
+ * @return <br>
288
+ * 视频帧纹理 ID。
289
+ *
290
+ */
291
+
292
+ getTextureId(): int;
293
+ /** {zh}
294
+ * @detail api
295
+ * @brief 获取视频帧纹理矩阵。
296
+ * @return 视频帧纹理矩阵。
297
+ *
298
+ */
299
+
300
+ getTextureMatrix(): Matrix;
301
+ /** {zh}
302
+ * @detail api
303
+ * @brief 获取 ByteBuffer 格式的视频数据。
304
+ * @return <br>
305
+ * ByteBuffer 格式的视频数据。
306
+ *
307
+ */
308
+
309
+ getBuffer(): ByteBuffer;
310
+ /** {zh}
311
+ * @detail api
312
+ * @brief 获取 byte[] 格式的视频数据。
313
+ * @return byte[] 格式的视频数据。
314
+ *
315
+ */
316
+
317
+ getData(): ArrayBuffer;
318
+ /** {zh}
319
+ * @detail api
320
+ * @brief 获取视频帧内部销毁回调。
321
+ * @return <br>
322
+ * 视频帧内部销毁回调。
323
+ *
324
+ */
325
+
326
+ getReleaseCallback(): Runnable;
327
+ /** {zh}
328
+ * @detail api
329
+ * @brief 设置视频帧内部销毁回调。
330
+ * @param releaseCallback 视频帧内部销毁回调
331
+ * @return 视频帧对象,详情请参见 [VeLiveVideoFrame](#VeLiveVideoFrame)。
332
+ *
333
+ */
334
+
335
+ setReleaseCallback(releaseCallback: Runnable): this;
336
+ }
182
337
  export declare enum VeLiveAudioCodec {
183
338
  /** {zh}
184
339
  * @brief FDKAAC 编码。
185
340
  *
186
341
  */
342
+
187
343
  VeLiveAudioCodecFdkAAC = 0,
188
344
  /** {zh}
189
345
  * @brief Mediacodec AAC 编码。
190
346
  *
191
347
  */
348
+
192
349
  VeLiveAudioCodecMediaCodecAAC = 1,
193
350
  /** {zh}
194
351
  * @brief FFMPEG AAC 编码。
195
352
  *
196
353
  */
354
+
197
355
  VeLiveAudioCodecFFmpegAAC = 2
198
356
  }
199
357
  export declare enum VeLiveVideoCodec {
@@ -201,11 +359,13 @@ export declare enum VeLiveVideoCodec {
201
359
  * @brief 使用 H.264 视频编码。
202
360
  *
203
361
  */
362
+
204
363
  VeLiveVideoCodecH264 = 0,
205
364
  /** {zh}
206
365
  * @brief 使用火山引擎自研 ByteVC1 视频编码。
207
366
  *
208
367
  */
368
+
209
369
  VeLiveVideoCodecByteVC1 = 1
210
370
  }
211
371
  export declare class VeLivePusherStatistics {
@@ -213,81 +373,97 @@ export declare class VeLivePusherStatistics {
213
373
  * @brief 视频编码宽度,单位为 px。
214
374
  *
215
375
  */
376
+
216
377
  encodeWidth: int;
217
378
  /** {zh}
218
379
  * @brief 视频编码高度,单位为 px。
219
380
  *
220
381
  */
382
+
221
383
  encodeHeight: int;
222
384
  /** {zh}
223
385
  * @brief 视频采集宽度,单位为 px。
224
386
  *
225
387
  */
388
+
226
389
  captureWidth: int;
227
390
  /** {zh}
228
391
  * @brief 视频采集高度,单位为 px。
229
392
  *
230
393
  */
394
+
231
395
  captureHeight: int;
232
396
  /** {zh}
233
397
  * @brief 视频采集帧率,单位为 fps。
234
398
  *
235
399
  */
400
+
236
401
  captureFps: double;
237
402
  /** {zh}
238
403
  * @brief 视频编码帧率,单位为 fps。
239
404
  *
240
405
  */
406
+
241
407
  encodeFps: double;
242
408
  /** {zh}
243
409
  * @brief 视频发送帧率,可用展示实时帧率,单位为 fps。
244
410
  *
245
411
  */
412
+
246
413
  transportFps: double;
247
414
  /** {zh}
248
415
  * @brief 视频推流帧率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的帧率,单位为 fps。
249
416
  *
250
417
  */
418
+
251
419
  fps: int;
252
420
  /** {zh}
253
421
  * @brief 视频推流码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的码率,单位为 kbps。
254
422
  *
255
423
  */
424
+
256
425
  videoBitrate: int;
257
426
  /** {zh}
258
427
  * @brief 视频推流最小码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最小码率,单位为 kbps。
259
428
  *
260
429
  */
430
+
261
431
  minVideoBitrate: int;
262
432
  /** {zh}
263
433
  * @brief 视频推流最大码率,即您通过 [setVideoEncoderConfiguration](147517#VeLivePusher-setvideoencoderconfiguration) 方法设置的最大码率,单位为 kbps。
264
434
  *
265
435
  */
436
+
266
437
  maxVideoBitrate: int;
267
438
  /** {zh}
268
439
  * @brief 视频编码码率,单位为 kbps。
269
440
  *
270
441
  */
442
+
271
443
  encodeVideoBitrate: double;
272
444
  /** {zh}
273
445
  * @brief 视频发送码率,可用于展示实时码率,单位为 kbps。
274
446
  *
275
447
  */
448
+
276
449
  transportVideoBitrate: double;
277
450
  /** {zh}
278
451
  * @brief 音频编码码率,单位为 kbps。
279
452
  *
280
453
  */
454
+
281
455
  encodeAudioBitrate: double;
282
456
  /** {zh}
283
457
  * @brief 推流地址。
284
458
  *
285
459
  */
460
+
286
461
  url: String;
287
462
  /** {zh}
288
463
  * @brief 视频编码格式。
289
464
  *
290
465
  */
466
+
291
467
  codec: String;
292
468
  }
293
469
  export declare enum VeLivePusherRenderMode {
@@ -295,16 +471,19 @@ export declare enum VeLivePusherRenderMode {
295
471
  * @brief 视频帧自适应画布。视频帧非等比缩放,直至画布被填满。在此过程中,视频帧的长宽比例可能会发生变化。
296
472
  *
297
473
  */
474
+
298
475
  VeLivePusherRenderModeFill = 0,
299
476
  /** {zh}
300
477
  * @brief 视频帧内容全部显示优先。视频尺寸等比缩放,优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时,会把窗口未被填满的区域填充成背景颜色。
301
478
  *
302
479
  */
480
+
303
481
  VeLivePusherRenderModeFit = 1,
304
482
  /** {zh}
305
483
  * @brief 视窗填满优先。视频帧等比缩放,直至视窗被视频填满。如果视频帧长宽比例与视窗不同,视频帧的多出部分将无法显示。
306
484
  *
307
485
  */
486
+
308
487
  VeLivePusherRenderModeHidden = 2
309
488
  }
310
489
  export declare enum VeLiveVideoEffectLicenseType {
@@ -312,11 +491,13 @@ export declare enum VeLiveVideoEffectLicenseType {
312
491
  * @brief 离线认证视频特效许可证。
313
492
  *
314
493
  */
494
+
315
495
  VeLiveVideoEffectLicenseTypeOffLine = 0,
316
496
  /** {zh}
317
497
  * @brief 在线认证视频特效许可证。
318
498
  *
319
499
  */
500
+
320
501
  VeLiveVideoEffectLicenseTypeOnLine = 1
321
502
  }
322
503
  export declare enum VeLiveAudioBufferType {
@@ -324,11 +505,13 @@ export declare enum VeLiveAudioBufferType {
324
505
  * @brief 未知的音频数据类型。
325
506
  *
326
507
  */
508
+
327
509
  VeLiveAudioBufferTypeUnknown = 0,
328
510
  /** {zh}
329
511
  * @brief ByteBuffer 音频数据类型。
330
512
  *
331
513
  */
514
+
332
515
  VeLiveAudioBufferTypeByteBuffer = 1
333
516
  }
334
517
  export declare enum VeLiveAudioChannel {
@@ -336,11 +519,13 @@ export declare enum VeLiveAudioChannel {
336
519
  * @brief 单声道,适用于语音通信,节省带宽。
337
520
  *
338
521
  */
522
+
339
523
  VeLiveAudioChannelMono = 1,
340
524
  /** {zh}
341
525
  * @brief 立体声,适用于音乐播放,提供更丰富的音频体验。
342
526
  *
343
527
  */
528
+
344
529
  VeLiveAudioChannelStereo = 2
345
530
  }
346
531
  export declare enum VeLiveFirstFrameType {
@@ -348,21 +533,25 @@ export declare enum VeLiveFirstFrameType {
348
533
  * @brief 视频/音频采集首帧,采集首帧是从音频设备或视频设备(如麦克风、摄像头)获取的第一帧数据。
349
534
  *
350
535
  */
536
+
351
537
  VeLiveFirstCaptureFrame = 0,
352
538
  /** {zh}
353
539
  * @brief 视频渲染首帧,渲染首帧是在渲染过程中在屏幕上显示的第一帧视频数据。
354
540
  *
355
541
  */
542
+
356
543
  VeLiveFirstRenderFrame = 1,
357
544
  /** {zh}
358
545
  * @brief 视频/音频编码完成首帧,编码完成首帧是编码为某种特定格式的第一帧数据。
359
546
  *
360
547
  */
548
+
361
549
  VeLiveFirstEncodedFrame = 2,
362
550
  /** {zh}
363
551
  * @brief 视频/音频发送首帧,发送首帧是在发送过程中,通过网络传输的第一帧数据。
364
552
  *
365
553
  */
554
+
366
555
  VeLiveFirstSendFrame = 3
367
556
  }
368
557
  export declare enum VeLiveVideoCaptureType {
@@ -370,41 +559,49 @@ export declare enum VeLiveVideoCaptureType {
370
559
  * @brief 使用前置摄像头进行视频采集。
371
560
  *
372
561
  */
562
+
373
563
  VeLiveVideoCaptureFrontCamera = 0,
374
564
  /** {zh}
375
565
  * @brief 使用后置摄像头进行视频采集。
376
566
  *
377
567
  */
568
+
378
569
  VeLiveVideoCaptureBackCamera = 1,
379
570
  /** {zh}
380
571
  * @brief 使用设备的双摄进行视频采集。
381
572
  *
382
573
  */
574
+
383
575
  VeLiveVideoCaptureDualCamera = 2,
384
576
  /** {zh}
385
577
  * @brief 使用屏幕采集。
386
578
  *
387
579
  */
580
+
388
581
  VeLiveVideoCaptureScreen = 3,
389
582
  /** {zh}
390
583
  * @brief 使用外部设备或源进行视频采集。
391
584
  *
392
585
  */
586
+
393
587
  VeLiveVideoCaptureExternal = 4,
394
588
  /** {zh}
395
589
  * @brief 使用指定的静态图片作为视频源。
396
590
  *
397
591
  */
592
+
398
593
  VeLiveVideoCaptureCustomImage = 5,
399
594
  /** {zh}
400
595
  * @brief 使用最近采集的一帧图像重复作为视频源。
401
596
  *
402
597
  */
598
+
403
599
  VeLiveVideoCaptureLastFrame = 6,
404
600
  /** {zh}
405
601
  * @brief 使用黑色帧作为视频源,一般用于调试或特殊需求。
406
602
  *
407
603
  */
604
+
408
605
  VeLiveVideoCaptureDummyFrame = 7
409
606
  }
410
607
  export declare enum VeLiveVideoProfile {
@@ -412,26 +609,31 @@ export declare enum VeLiveVideoProfile {
412
609
  * @brief 未知的视频配置类型。
413
610
  *
414
611
  */
612
+
415
613
  VeLiveVideoProfileUnknown = 0,
416
614
  /** {zh}
417
615
  * @brief H.264 编码配置,使用 Baseline 级别。
418
616
  *
419
617
  */
618
+
420
619
  VeLiveVideoProfileH264Baseline = 1,
421
620
  /** {zh}
422
621
  * @brief H.264 编码配置,使用 Main 级别。
423
622
  *
424
623
  */
624
+
425
625
  VeLiveVideoProfileH264Main = 2,
426
626
  /** {zh}
427
627
  * @brief H.264 编码配置,使用 High 级别。
428
628
  *
429
629
  */
630
+
430
631
  VeLiveVideoProfileH264High = 3,
431
632
  /** {zh}
432
633
  * @brief ByteVC1 编码配置,使用 Main 级别。
433
634
  *
434
635
  */
636
+
435
637
  VeLiveVideoProfileByteVC1Main = 4
436
638
  }
437
639
  export declare enum VeLiveVideoRotation {
@@ -439,21 +641,25 @@ export declare enum VeLiveVideoRotation {
439
641
  * @brief 不旋转。
440
642
  *
441
643
  */
644
+
442
645
  VeLiveVideoRotation0 = 0,
443
646
  /** {zh}
444
647
  * @brief 顺时针旋转 90 度。
445
648
  *
446
649
  */
650
+
447
651
  VeLiveVideoRotation90 = 90,
448
652
  /** {zh}
449
653
  * @brief 顺时针旋转 180 度。
450
654
  *
451
655
  */
656
+
452
657
  VeLiveVideoRotation180 = 180,
453
658
  /** {zh}
454
659
  * @brief 顺时针旋转 270 度。
455
660
  *
456
661
  */
662
+
457
663
  VeLiveVideoRotation270 = 270
458
664
  }
459
665
  export declare enum VeLiveVideoFrameSource {
@@ -461,11 +667,13 @@ export declare enum VeLiveVideoFrameSource {
461
667
  * @brief 采集到的原始视频帧。这是从设备的摄像头或其他视频输入源获取的视频帧。
462
668
  *
463
669
  */
670
+
464
671
  VeLiveVideoFrameSourceCapture = 1,
465
672
  /** {zh}
466
673
  * @brief 编码前的视频帧。这是通过各种处理(例如滤镜、旋转等)后,准备进行编码的视频帧。
467
674
  *
468
675
  */
676
+
469
677
  VeLiveVideoFrameSourcePreEncode = "1 << 1"
470
678
  }
471
679
  export declare enum VeLiveAudioProfile {
@@ -473,16 +681,19 @@ export declare enum VeLiveAudioProfile {
473
681
  * @brief LC-AAC 编码方式。
474
682
  *
475
683
  */
684
+
476
685
  VeLiveAudioAACProfileLC = 0,
477
686
  /** {zh}
478
687
  * @brief HEv1-AAC 编码方式。
479
688
  *
480
689
  */
690
+
481
691
  VeLiveAudioAACProfileHEv1 = 1,
482
692
  /** {zh}
483
693
  * @brief HEv2-AAC 编码方式。
484
694
  *
485
695
  */
696
+
486
697
  VeLiveAudioAACProfileHEv2 = 2
487
698
  }
488
699
  export declare enum VeLiveVideoBufferType {
@@ -490,29 +701,32 @@ export declare enum VeLiveVideoBufferType {
490
701
  * @brief 未知视频数据类型,当未指定输入视频数据的格式时,会默认为此类型。
491
702
  *
492
703
  */
704
+
493
705
  VeLiveVideoBufferTypeUnknown = 0,
494
706
  /** {zh}
495
707
  * @brief 视频数据类型为 OpenGL 纹理。
496
708
  *
497
709
  */
710
+
498
711
  VeLiveVideoBufferTypeTexture = 1,
499
712
  /** {zh}
500
713
  * @brief 视频数据类型为 ByteBuffer 类型。
501
714
  *
502
715
  */
716
+
503
717
  VeLiveVideoBufferTypeByteBuffer = 2,
504
718
  /** {zh}
505
719
  * @brief 视频数据类型为 ByteArray 类型。
506
720
  *
507
721
  */
722
+
508
723
  VeLiveVideoBufferTypeByteArray = 3
509
724
  }
510
725
  export declare class VeLiveAudioCaptureConfiguration {
511
726
  /** {zh}
512
727
  * @detail api
513
728
  * @brief 获取采集音频采样率。
514
- * @return <br>
515
- * 音频采样率,详情请参见 VeLiveAudioSampleRate{@link #VeLiveAudioSampleRate}。
729
+ * @return 音频采样率,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
516
730
  *
517
731
  */
518
732
 
@@ -520,8 +734,8 @@ export declare class VeLiveAudioCaptureConfiguration {
520
734
  /** {zh}
521
735
  * @detail api
522
736
  * @brief 设置采集音频采样率。
523
- * @return <br>推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)
524
- * @param sampleRate 音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。
737
+ * @param sampleRate 音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)
738
+ * @return 推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
525
739
  *
526
740
  */
527
741
 
@@ -529,8 +743,7 @@ export declare class VeLiveAudioCaptureConfiguration {
529
743
  /** {zh}
530
744
  * @detail api
531
745
  * @brief 获取采集音频声道数。
532
- * @return <br>
533
- * 音频声道数,详情请参见 VeLiveAudioChannel{@link #VeLiveAudioChannel}。
746
+ * @return 音频声道数,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
534
747
  *
535
748
  */
536
749
 
@@ -538,8 +751,8 @@ export declare class VeLiveAudioCaptureConfiguration {
538
751
  /** {zh}
539
752
  * @detail api
540
753
  * @brief 设置采集音频声道数。
541
- * @return <br>推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLiveAudioCaptureConfiguration)
542
- * @param channel 音频声道数,默认值为 VeLiveAudioChannelStereo,详情请参见 VeLiveAudioChannel{@link #VeLiveAudioChannel}
754
+ * @param channel 音频声道数,默认值为 VeLiveAudioChannelStereo,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)
755
+ * @return 推流音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
543
756
  *
544
757
  */
545
758
 
@@ -547,19 +760,22 @@ export declare class VeLiveAudioCaptureConfiguration {
547
760
  }
548
761
  export declare class VeLiveStreamMixDescription {
549
762
  /** {zh}
550
- * @brief 视频混流布局设置的数组,其中每个元素代表一路视频流的布局。详情请参见 VeLiveMixVideoLayout{@link #VeLiveMixVideoLayout}
763
+ * @brief 视频混流布局设置的数组,其中每个元素代表一路视频流的布局。详情请参见 [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout)
551
764
  *
552
765
  */
766
+
553
767
  mixVideoStreams: ArrayList<VeLiveMixVideoLayout>;
554
768
  /** {zh}
555
- * @brief 音频混流设置的数组,其中每个元素代表一路音频流的。详情请参见 [VeLiveMixAudioLayout](#VeLiveMixAudioLayout)。
769
+ * @brief 音频混流设置的数组,其中每个元素代表一路音频流的。详情请参见 [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout)。
556
770
  *
557
771
  */
772
+
558
773
  mixAudioStreams: ArrayList<VeLiveMixAudioLayout>;
559
774
  /** {zh}
560
775
  * @brief 视频混流画布的背景色设置,采用 #RRGGBB 格式。
561
776
  *
562
777
  */
778
+
563
779
  backgroundColor: String;
564
780
  }
565
781
  export declare enum VeLiveAudioSampleRate {
@@ -567,26 +783,31 @@ export declare enum VeLiveAudioSampleRate {
567
783
  * @brief 8k 采样。
568
784
  *
569
785
  */
786
+
570
787
  VeLiveAudioSampleRate8000 = 8000,
571
788
  /** {zh}
572
789
  * @brief 16k 采样。
573
790
  *
574
791
  */
792
+
575
793
  VeLiveAudioSampleRate16000 = 16000,
576
794
  /** {zh}
577
795
  * @brief 32k 采样。
578
796
  *
579
797
  */
798
+
580
799
  VeLiveAudioSampleRate32000 = 32000,
581
800
  /** {zh}
582
801
  * @brief 44.1k 采样。
583
802
  *
584
803
  */
804
+
585
805
  VeLiveAudioSampleRate44100 = 44100,
586
806
  /** {zh}
587
807
  * @brief 48k 采样。
588
808
  *
589
809
  */
810
+
590
811
  VeLiveAudioSampleRate48000 = 48000
591
812
  }
592
813
  export declare enum VeLiveAudioPowerLevel {
@@ -594,39 +815,44 @@ export declare enum VeLiveAudioPowerLevel {
594
815
  * @brief 无声,音量 ≤1db。
595
816
  *
596
817
  */
818
+
597
819
  VeLiveAudioPowerLevelSilent = 0,
598
820
  /** {zh}
599
821
  * @brief 安静,音量 15db 以下。
600
822
  *
601
823
  */
824
+
602
825
  VeLiveAudioPowerLevelQuiet = 1,
603
826
  /** {zh}
604
827
  * @brief 轻声,接近耳语音量,音量为 16db~30db 之间。
605
828
  *
606
829
  */
830
+
607
831
  VeLiveAudioPowerLevelLight = 2,
608
832
  /** {zh}
609
833
  * @brief 正常,音量适宜,类似正常对话的音量,音量为 30db~60db 之间。
610
834
  *
611
835
  */
836
+
612
837
  VeLiveAudioPowerLevelNormal = 3,
613
838
  /** {zh}
614
839
  * @brief 较大,音量较高,类似咖啡馆、餐厅的环境噪音,音量为 61db~85db 之间。
615
840
  *
616
841
  */
842
+
617
843
  VeLiveAudioPowerLevelLoud = 4,
618
844
  /** {zh}
619
845
  * @brief 吵闹,音量极高,类似于繁忙的街道或者是音乐会现场,音量超过 85db。
620
846
  *
621
847
  */
848
+
622
849
  VeLiveAudioPowerLevelNoise = 5
623
850
  }
624
851
  export declare class VeLiveVideoCaptureConfiguration {
625
852
  /** {zh}
626
853
  * @detail api
627
854
  * @brief 获取采集视频宽度。
628
- * @return <br>
629
- * 采集视频宽度。
855
+ * @return 采集视频宽度。
630
856
  *
631
857
  */
632
858
 
@@ -634,8 +860,8 @@ export declare class VeLiveVideoCaptureConfiguration {
634
860
  /** {zh}
635
861
  * @detail api
636
862
  * @brief 设置采集视频宽度。
637
- * @return <br>推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
638
863
  * @param width 采集视频宽度,默认值为 720。
864
+ * @return 推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
639
865
  *
640
866
  */
641
867
 
@@ -652,8 +878,8 @@ export declare class VeLiveVideoCaptureConfiguration {
652
878
  /** {zh}
653
879
  * @detail api
654
880
  * @brief 设置采集视频高度。
655
- * @return <br>推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
656
881
  * @param height 采集视频高度,默认值为 1280。
882
+ * @return 推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
657
883
  *
658
884
  */
659
885
 
@@ -670,8 +896,8 @@ export declare class VeLiveVideoCaptureConfiguration {
670
896
  /** {zh}
671
897
  * @detail api
672
898
  * @brief 设置采集视频帧率。
673
- * @return <br>推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLiveVideoCaptureConfiguration)。
674
899
  * @param fps 采集视频帧率,默认值为 15。
900
+ * @return 推流视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
675
901
  *
676
902
  */
677
903
 
@@ -682,31 +908,37 @@ export declare enum VeLivePixelFormat {
682
908
  * @brief 未知格式。
683
909
  *
684
910
  */
911
+
685
912
  VeLivePixelFormatUnknown = 0,
686
913
  /** {zh}
687
914
  * @brief I420 格式。
688
915
  *
689
916
  */
917
+
690
918
  VeLivePixelFormatI420 = 1,
691
919
  /** {zh}
692
920
  * @brief NV12 格式。
693
921
  *
694
922
  */
923
+
695
924
  VeLivePixelFormatNV12 = 2,
696
925
  /** {zh}
697
926
  * @brief NV21 格式。
698
927
  *
699
928
  */
929
+
700
930
  VeLivePixelFormatNV21 = 3,
701
931
  /** {zh}
702
932
  * @brief 2D 纹理格式。
703
933
  *
704
934
  */
935
+
705
936
  VeLivePixelFormat2DTexture = 4,
706
937
  /** {zh}
707
938
  * @brief OES 纹理格式。
708
939
  *
709
940
  */
941
+
710
942
  VeLivePixelFormatOesTexture = 5
711
943
  }
712
944
  export declare enum VeLivePusherStatus {
@@ -714,36 +946,43 @@ export declare enum VeLivePusherStatus {
714
946
  * @brief 初始状态。
715
947
  *
716
948
  */
949
+
717
950
  VeLivePushStatusNone = 0,
718
951
  /** {zh}
719
952
  * @brief 正在连接服务器。
720
953
  *
721
954
  */
955
+
722
956
  VeLivePushStatusConnecting = 1,
723
957
  /** {zh}
724
958
  * @brief 连接服务器成功。
725
959
  *
726
960
  */
961
+
727
962
  VeLivePushStatusConnectSuccess = 2,
728
963
  /** {zh}
729
964
  * @brief 重连服务器中。
730
965
  *
731
966
  */
967
+
732
968
  VeLivePushStatusReconnecting = 3,
733
969
  /** {zh}
734
970
  * @brief 推流连接被终止。
735
971
  *
736
972
  */
973
+
737
974
  VeLivePushStatusConnectStop = 4,
738
975
  /** {zh}
739
976
  * @brief 推流连接失败。
740
977
  *
741
978
  */
979
+
742
980
  VeLivePushStatusConnectError = 5,
743
981
  /** {zh}
744
982
  * @brief 与服务器断开连接。
745
983
  *
746
984
  */
985
+
747
986
  VeLivePushStatusDisconnected = 6
748
987
  }
749
988
  export declare enum VeLiveVideoResolution {
@@ -757,6 +996,7 @@ export declare enum VeLiveVideoResolution {
757
996
  * - 最大码率:800kbps
758
997
  *
759
998
  */
999
+
760
1000
  VeLiveVideoResolution360P = "VeLiveVideoResolution360P",
761
1001
  /** {zh}
762
1002
  * @brief 480P 分辨率。档位详细配置如下所示。
@@ -768,6 +1008,7 @@ export declare enum VeLiveVideoResolution {
768
1008
  * - 最大码率:1266kbps
769
1009
  *
770
1010
  */
1011
+
771
1012
  VeLiveVideoResolution480P = "VeLiveVideoResolution480P",
772
1013
  /** {zh}
773
1014
  * @brief 540P 分辨率。档位详细配置如下所示。
@@ -779,6 +1020,7 @@ export declare enum VeLiveVideoResolution {
779
1020
  * - 最大码率:1520kbps
780
1021
  *
781
1022
  */
1023
+
782
1024
  VeLiveVideoResolution540P = "VeLiveVideoResolution540P",
783
1025
  /** {zh}
784
1026
  * @brief 720P 分辨率。档位详细配置如下所示。
@@ -790,6 +1032,7 @@ export declare enum VeLiveVideoResolution {
790
1032
  * - 最大码率:1900kbps
791
1033
  *
792
1034
  */
1035
+
793
1036
  VeLiveVideoResolution720P = "VeLiveVideoResolution720P",
794
1037
  /** {zh}
795
1038
  * @brief 1080P 分辨率。档位详细配置如下所示。
@@ -801,28 +1044,86 @@ export declare enum VeLiveVideoResolution {
801
1044
  * - 最大码率:3800kbps
802
1045
  *
803
1046
  */
1047
+
804
1048
  VeLiveVideoResolution1080P = "VeLiveVideoResolution1080P"
805
1049
  }
1050
+ export declare class VeLiveAudioFrame {
1051
+ constructor();
1052
+ /** {zh}
1053
+ * @detail api
1054
+ * @brief 获取音频数据类型。
1055
+ * @return 音频数据类型,详情请参见 [VeLiveAudioBufferType](#VeLiveAudioBufferType)。
1056
+ *
1057
+ */
1058
+
1059
+ getBufferType(): VeLiveAudioBufferType;
1060
+ /** {zh}
1061
+ * @detail api
1062
+ * @brief 获取音频采样率。
1063
+ * @return 音频采样率,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
1064
+ *
1065
+ */
1066
+
1067
+ getSampleRate(): VeLiveAudioSampleRate;
1068
+ /** {zh}
1069
+ * @detail api
1070
+ * @brief 获取音频声道数。
1071
+ * @return 音频声道数,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
1072
+ *
1073
+ */
1074
+
1075
+ getChannels(): VeLiveAudioChannel;
1076
+ /** {zh}
1077
+ * @detail api
1078
+ * @brief 获取每个声道的采样点数。
1079
+ * @return 采样点数。
1080
+ *
1081
+ */
1082
+
1083
+ getSamplesPerChannel(): int;
1084
+ /** {zh}
1085
+ * @detail api
1086
+ * @brief 获取音频时间戳,单位为 μs。
1087
+ * @return <br>
1088
+ * 音频时间戳,单位为 μs。
1089
+ *
1090
+ */
1091
+
1092
+ getPts(): long;
1093
+ /** {zh}
1094
+ * @detail api
1095
+ * @brief 获取音频数据。音频帧数据为小端字节序存储。
1096
+ * @return <br>
1097
+ * 格式为 ByteBuffer 的音频数据。
1098
+ *
1099
+ */
1100
+
1101
+ getBuffer(): ByteBuffer;
1102
+ }
806
1103
  export declare enum VeLiveNetworkQuality {
807
1104
  /** {zh}
808
1105
  * @brief 未查询到网络状态。
809
1106
  *
810
1107
  */
1108
+
811
1109
  VeLiveNetworkQualityUnknown = 0,
812
1110
  /** {zh}
813
1111
  * @brief 网络差。
814
1112
  *
815
1113
  */
1114
+
816
1115
  VeLiveNetworkQualityBad = 1,
817
1116
  /** {zh}
818
1117
  * @brief 网络一般。
819
1118
  *
820
1119
  */
1120
+
821
1121
  VeLiveNetworkQualityPoor = 2,
822
1122
  /** {zh}
823
1123
  * @brief 网络状态佳。
824
1124
  *
825
1125
  */
1126
+
826
1127
  VeLiveNetworkQualityGood = 3
827
1128
  }
828
1129
  export declare enum VeLivePusherLogLevel {
@@ -830,31 +1131,37 @@ export declare enum VeLivePusherLogLevel {
830
1131
  * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
831
1132
  *
832
1133
  */
1134
+
833
1135
  VeLiveLogLevelVerbose = 0,
834
1136
  /** {zh}
835
1137
  * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
836
1138
  *
837
1139
  */
1140
+
838
1141
  VeLiveLogLevelDebug = 1,
839
1142
  /** {zh}
840
1143
  * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
841
1144
  *
842
1145
  */
1146
+
843
1147
  VeLiveLogLevelInfo = 2,
844
1148
  /** {zh}
845
1149
  * @brief 输出 WARNING 和 ERROR 级别的日志。
846
1150
  *
847
1151
  */
1152
+
848
1153
  VeLiveLogLevelWarn = 3,
849
1154
  /** {zh}
850
1155
  * @brief 输出 ERROR 级别的日志。
851
1156
  *
852
1157
  */
1158
+
853
1159
  VeLiveLogLevelError = 4,
854
1160
  /** {zh}
855
1161
  * @brief 关闭日志。
856
1162
  *
857
1163
  */
1164
+
858
1165
  VeLiveLogLevelNone = 5
859
1166
  }
860
1167
  export declare enum VeLiveAudioBitDepth {
@@ -862,6 +1169,7 @@ export declare enum VeLiveAudioBitDepth {
862
1169
  * @brief 16bit 位深度。
863
1170
  *
864
1171
  */
1172
+
865
1173
  VeLiveAudioBitDepth16 = 16
866
1174
  }
867
1175
  export declare class VeLiveMixAudioLayout {
@@ -869,119 +1177,185 @@ export declare class VeLiveMixAudioLayout {
869
1177
  * @brief 音频流 ID,唯一标识,用于区分不同的音频流。
870
1178
  *
871
1179
  */
1180
+
872
1181
  streamId: int;
873
1182
  /** {zh}
874
1183
  * @detail api
875
- * @brief 混流音频的音量,范围为 [0.0,4.0]。当您将 [VeLiveAudioMixType](147521#VeLiveAudioMixType) 设置为 `VeLiveAudioMixPlayAndPush` 时,该变量同时控制混流音频在拉流端和本地的播放音量。
1184
+ * @brief 混流音频的音量,范围为 [0.0,4.0]。当您将 [VeLiveAudioMixType](#VeLiveAudioMixType) 设置为 `VeLiveAudioMixPlayAndPush` 时,该变量同时控制混流音频在拉流端和本地的播放音量。
876
1185
  *
877
1186
  */
1187
+
878
1188
  volume: float;
879
1189
  /** {zh}
880
1190
  * @detail api
881
1191
  * @brief 更新音频混流设置。
882
- * @param other 新的音频混流设置,详情请参见 [VeLiveMixAudioLayout](#VeLiveMixAudioLayout)。
1192
+ * @param other 新的音频混流设置,详情请参见 [VeLiveMixAudioLayout](#VeLivePusherDef-VeLiveMixAudioLayout)。
883
1193
  *
884
1194
  */
885
1195
 
886
1196
  update(other: VeLiveMixAudioLayout): void;
887
1197
  }
888
- export declare enum VeLiveOrientation {
1198
+ export declare class VeLivePusherConfiguration {
889
1199
  /** {zh}
890
- * @brief 横屏模式。
1200
+ * @detail api
1201
+ * @brief 设置推流器推流失败后尝试重连的时间间隔。
1202
+ * @param interval 时间间隔,单位为 s,默认值为 5
1203
+ * @order 2
891
1204
  *
892
1205
  */
893
- VeLiveOrientationLandscape = 0,
1206
+
1207
+ setReconnectIntervalSeconds(interval: int): this;
894
1208
  /** {zh}
895
- * @brief 竖屏模式。
1209
+ * @detail api
1210
+ * @brief 获取推流器推流失败后尝试重连的时间间隔。
1211
+ * @order 3
1212
+ * @return <br>
1213
+ * 时间间隔,单位为 s。
896
1214
  *
897
1215
  */
898
- VeLiveOrientationPortrait = 1
899
- }
900
- export declare enum VeLiveVideoMirrorType {
1216
+
1217
+ getReconnectIntervalSeconds(): int;
901
1218
  /** {zh}
902
- * @brief 对采集画面的镜像控制。开启时,预览和推流画面都会呈现为镜像状态。
1219
+ * @detail api
1220
+ * @brief 设置推流器推流失败后尝试重连的次数。
1221
+ * @param maxCount 重连次数,默认值为 3
1222
+ * @order 4
903
1223
  *
904
1224
  */
905
- VeLiveVideoMirrorCapture = 0,
1225
+
1226
+ setReconnectCount(maxCount: int): this;
906
1227
  /** {zh}
907
- * @brief 对预览画面的镜像控制。开启时,只有主播预览画面呈现镜像状态。
1228
+ * @detail api
1229
+ * @brief 获取推流器推流失败后尝试重连的次数。
1230
+ * @order 5
1231
+ * @return <br>
1232
+ * 重连次数。
908
1233
  *
909
1234
  */
910
- VeLiveVideoMirrorPreview = 1,
1235
+
1236
+ getReconnectCount(): int;
911
1237
  /** {zh}
912
- * @brief 对编码前画面的镜像控制。开启时,主播推流画面呈现镜像状态。
1238
+ * @detail api
1239
+ * @brief 设置视频采集参数,用于调整和设置视频采集相关的参数。
1240
+ * @order 6
1241
+ * @param config 视频采集参数,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
1242
+ * @return 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
913
1243
  *
914
1244
  */
915
- VeLiveVideoMirrorPushStream = 2
916
- }
917
- export declare class VeLivePusherLogConfig {
1245
+
1246
+ setVideoCaptureConfig(config: VeLiveVideoCaptureConfiguration): this;
918
1247
  /** {zh}
919
- * @brief 日志文件保存路径。
1248
+ * @detail api
1249
+ * @brief 获取视频采集参数,用于调整和设置视频采集相关的参数。
1250
+ * @order 7
1251
+ * @return 视频采集参数配置对象,详情请参见 [VeLiveVideoCaptureConfiguration](#VeLivePusherDef-VeLiveVideoCaptureConfiguration)。
920
1252
  *
921
1253
  */
922
- logPath: String;
1254
+
1255
+ getVideoCaptureConfig(): VeLiveVideoCaptureConfiguration;
923
1256
  /** {zh}
924
- * @brief 日志文件整体最大尺寸,单位为 M,默认值为 100。
1257
+ * @detail api
1258
+ * @brief 设置音频采集参数,用于调整和设置音频采集相关的参数。
1259
+ * @order 7
1260
+ * @param config 音频采集参数,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
1261
+ * @return 推流引擎初始化配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
925
1262
  *
926
1263
  */
927
- maxLogSizeM: int;
1264
+
1265
+ setAudioCaptureConfig(config: VeLiveAudioCaptureConfiguration): this;
928
1266
  /** {zh}
929
- * @brief 单个日志文件最大尺寸,单位为 M,默认值为 2。
1267
+ * @detail api
1268
+ * @brief 获取音频采集参数,用于调整和设置音频采集相关的参数。
1269
+ * @order 8
1270
+ * @return 音频采集参数配置对象,详情请参见 [VeLiveAudioCaptureConfiguration](#VeLivePusherDef-VeLiveAudioCaptureConfiguration)。
930
1271
  *
931
1272
  */
932
- singleLogSizeM: int;
1273
+
1274
+ getAudioCaptureConfig(): VeLiveAudioCaptureConfiguration;
933
1275
  /** {zh}
934
- * @brief 日志文件有效期,单位为 s,默认值为 604,800,即 7 天。
1276
+ * @detail api
1277
+ * @brief 设置应用上下文。
1278
+ * @order 9
1279
+ * @param context 应用上下文。
1280
+ * @return 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
935
1281
  *
936
1282
  */
937
- logExpireTimeS: long;
1283
+
1284
+ setContext(context: Context): this;
938
1285
  /** {zh}
939
- * @brief 是否开启线程轮询,默认值为 `1` <br>
940
- * - `0`:关闭;
941
- * - `1`:开启。
1286
+ * @detail api
1287
+ * @brief 获取应用上下文。
1288
+ * @order 10
1289
+ * @return <br>
1290
+ * 应用上下文。
942
1291
  *
943
1292
  */
944
- enableThreadLoop: int;
1293
+
1294
+ getContext(): Context;
945
1295
  /** {zh}
946
- * @brief 日志是否打印到控制台输出,默认为不打印。
1296
+ * @detail api
1297
+ * @brief 设置扩展参数,默认不需要设置。如果需要使用,您可通过提交工单联系[技术支持](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000076)。
1298
+ * @order 11
1299
+ * @param params 扩展参数。
1300
+ * @return
1301
+ * 推流引擎初始化配置对象,详情请参见 [VeLivePusherConfiguration](#VeLivePusherConfiguration)。
947
1302
  *
948
1303
  */
949
- enableStdout: int;
1304
+
1305
+ setExtraParameters(params: String): this;
950
1306
  /** {zh}
951
- * @brief 日志是否打印到文件输出,默认为打印。
1307
+ * @detail api
1308
+ * @brief 获取扩展参数。
1309
+ * @order 12
1310
+ * @return <br>
1311
+ * 扩展参数。
952
1312
  *
953
1313
  */
954
- enableLogFile: int;
1314
+
1315
+ getExtraParams(): LiveSdkSetting;
955
1316
  /** {zh}
956
- * @brief 日志级别,默认值为 `kVolcLogLevelWarning`。
1317
+ * @detail api
1318
+ * @brief 构造推流引擎。
1319
+ * @order 1
1320
+ * @return 推流引擎,详情请参见 [VeLivePusher](147517#VeLivePusher)。
957
1321
  *
958
1322
  */
959
- logLevel: int;
1323
+
1324
+ build(): VeLivePusher;
1325
+ }
1326
+ export declare enum VeLiveOrientation {
960
1327
  /** {zh}
961
- * @brief 日志刷新频率,单位为 ms,默认值为 120,000,即 2 分钟。
1328
+ * @brief 横屏模式。
962
1329
  *
963
1330
  */
964
- intervalMs: long;
1331
+
1332
+ VeLiveOrientationLandscape = 0,
965
1333
  /** {zh}
966
- * @brief 日志上报路径。
1334
+ * @brief 竖屏模式。
967
1335
  *
968
1336
  */
969
- queryUrl: String;
1337
+
1338
+ VeLiveOrientationPortrait = 1
1339
+ }
1340
+ export declare enum VeLiveVideoMirrorType {
970
1341
  /** {zh}
971
- * @brief 设备唯一 ID。
1342
+ * @brief 对采集画面的镜像控制。开启时,预览和推流画面都会呈现为镜像状态。
972
1343
  *
973
1344
  */
974
- device_id: String;
1345
+
1346
+ VeLiveVideoMirrorCapture = 0,
975
1347
  /** {zh}
976
- * @brief HTTP 请求超时时间。取值范围:大于 0。
1348
+ * @brief 对预览画面的镜像控制。开启时,只有主播预览画面呈现镜像状态。
977
1349
  *
978
1350
  */
979
- httpTimeoutMS: int;
1351
+
1352
+ VeLiveVideoMirrorPreview = 1,
980
1353
  /** {zh}
981
- * @brief 文件上传超时时间。取值范围:大于 0。
1354
+ * @brief 对编码前画面的镜像控制。开启时,主播推流画面呈现镜像状态。
982
1355
  *
983
1356
  */
984
- httpUploadFileTimeoutMS: int;
1357
+
1358
+ VeLiveVideoMirrorPushStream = 2
985
1359
  }
986
1360
  export declare class VeLiveFileRecorderConfiguration {
987
1361
  /** {zh}
@@ -996,8 +1370,8 @@ export declare class VeLiveFileRecorderConfiguration {
996
1370
  /** {zh}
997
1371
  * @detail api
998
1372
  * @brief 设置录制视频宽度。
999
- * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
1000
1373
  * @param width 录制视频宽度,默认值为 360
1374
+ * @return 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
1001
1375
  *
1002
1376
  */
1003
1377
 
@@ -1014,8 +1388,8 @@ export declare class VeLiveFileRecorderConfiguration {
1014
1388
  /** {zh}
1015
1389
  * @detail api
1016
1390
  * @brief 设置录制视频高度。
1017
- * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
1018
1391
  * @param height 录制视频宽度,默认值为 640。
1392
+ * @return 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。<br/>
1019
1393
  *
1020
1394
  */
1021
1395
 
@@ -1032,8 +1406,8 @@ export declare class VeLiveFileRecorderConfiguration {
1032
1406
  /** {zh}
1033
1407
  * @detail api
1034
1408
  * @brief 设置录制视频帧率。
1035
- * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
1036
1409
  * @param fps 录制视频帧率,默认值为 15。
1410
+ * @return 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
1037
1411
  *
1038
1412
  */
1039
1413
 
@@ -1050,8 +1424,9 @@ export declare class VeLiveFileRecorderConfiguration {
1050
1424
  /** {zh}
1051
1425
  * @detail api
1052
1426
  * @brief 设置录制视频码率。
1053
- * @return <br>推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLiveFileRecorderConfiguration)。
1054
1427
  * @param bitrate 录制视频码率,单位为 kbps,默认值为 2000。
1428
+ * @return
1429
+ * 推流本地文件录制配置对象,详情请参见 [VeLiveFileRecorderConfiguration](#VeLivePusherDef-VeLiveFileRecorderConfiguration)。
1055
1430
  *
1056
1431
  */
1057
1432
 
@@ -1062,46 +1437,62 @@ export declare class VeLiveMixVideoLayout {
1062
1437
  * @brief 视频流 ID,唯一标识,用于区分不同的视频流。
1063
1438
  *
1064
1439
  */
1440
+
1065
1441
  streamId: int;
1066
1442
  /** {zh}
1067
1443
  * @brief 视频流对应区域左上角的横坐标,该坐标是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1068
1444
  *
1069
1445
  */
1446
+
1070
1447
  x: float;
1071
1448
  /** {zh}
1072
1449
  * @brief 视频流对应区域左上角的纵坐标,该坐标是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1073
1450
  *
1074
1451
  */
1452
+
1075
1453
  y: float;
1076
1454
  /** {zh}
1077
1455
  * @brief 视频流对应区域宽度,该宽度是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1078
1456
  *
1079
1457
  */
1458
+
1080
1459
  width: float;
1081
1460
  /** {zh}
1082
1461
  * @brief 视频流对应区域高度,该高度是相对整体画面的归一化比例,取值的范围为 [0.0,1.0]。
1083
1462
  *
1084
1463
  */
1464
+
1085
1465
  height: float;
1086
1466
  /** {zh}
1087
1467
  * @brief 视频流在混流中的透明度,取值范围为 [0.0,1.0],取值 0.0 表示全透明,取值 1.0 表示不透明。
1088
1468
  *
1089
1469
  */
1470
+
1090
1471
  alpha: float;
1091
1472
  /** {zh}
1092
1473
  * @brief 视频流在混流中的层级。取值范围为 [0,100],取值 0 表示最底层,取值越大,层级越高。
1093
1474
  *
1094
1475
  */
1476
+
1095
1477
  zOrder: int;
1096
1478
  /** {zh}
1097
- * @brief 视频流的渲染模式。详情请参见 VeLivePusherRenderMode{@link #VeLivePusherRenderMode}
1479
+ * @brief 视频流的渲染模式。详情请参见 [VeLivePusherRenderMode](#VeLivePusherRenderMode)
1098
1480
  *
1099
1481
  */
1482
+
1100
1483
  renderMode: VeLivePusherRenderMode;
1484
+ /** {zh}
1485
+ * @brief 是否保留视频流原 Alpha 通道值,默认为保留,当 [alpha](#VeLiveMixVideoLayout-alpha) 取值在 [0.0, 1.0] 之间时,则忽略该配置。
1486
+ * - YES:保留;
1487
+ * - NO:不保留。
1488
+ *
1489
+ */
1490
+
1491
+ enableAlpha: boolean;
1101
1492
  /** {zh}
1102
1493
  * @detail api
1103
1494
  * @brief 更新视频混流设置。
1104
- * @param other 新的视频混流设置,详情请参见 [VeLiveMixVideoLayout](147521#VeLiveMixVideoLayout)。
1495
+ * @param other 新的视频混流设置,详情请参见 [VeLiveMixVideoLayout](#VeLivePusherDef-VeLiveMixVideoLayout)。
1105
1496
  *
1106
1497
  */
1107
1498
 
@@ -1111,8 +1502,8 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1111
1502
  /** {zh}
1112
1503
  * @detail api
1113
1504
  * @brief 初始化配置为本地验证模式。
1114
- * @return <br>返回 VeLiveVideoEffectLicenseConfiguration 类的实例,该实例使用指定的本地路径进行许可证验证。
1115
1505
  * @param path 视频特效许可证的本地缓存路径。可通过 [getPath](#VeLiveVideoEffectLicenseConfiguration-getpath) 获取。
1506
+ * @return 返回 VeLiveVideoEffectLicenseConfiguration 类的实例,该实例使用指定的本地路径进行许可证验证。
1116
1507
  *
1117
1508
  */
1118
1509
 
@@ -1131,44 +1522,39 @@ export declare class VeLiveVideoEffectLicenseConfiguration {
1131
1522
  /** {zh}
1132
1523
  * @detail api
1133
1524
  * @brief 获取视频特效许可证类型。
1134
- * @return <br>
1135
- * 视频特效许可证类型,许可证类型请参见 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType}。
1525
+ * @return 视频特效许可证类型,许可证类型请参见 [VeLiveVideoEffectLicenseType](147521#VeLiveVideoEffectLicenseType)。
1136
1526
  *
1137
1527
  */
1138
1528
 
1139
1529
  getType(): VeLiveVideoEffectLicenseType;
1140
1530
  /** {zh}
1141
1531
  * @detail api
1142
- * @brief 获取视频特效许可证的本地路径。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOffLine` 时,返回许可证文件的本地路径。
1143
- * @return <br>
1144
- * 视频特效许可证的本地路径。
1532
+ * @brief 获取视频特效许可证的本地路径。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOffLine` 时,返回许可证文件的本地路径。
1533
+ * @return 视频特效许可证的本地路径。
1145
1534
  *
1146
1535
  */
1147
1536
 
1148
1537
  getPath(): String;
1149
1538
  /** {zh}
1150
1539
  * @detail api
1151
- * @brief 获取视频特效许可证的在线认证 key。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 key。
1152
- * @return <br>
1153
- * 视频特效许可证的在线认证 key。
1540
+ * @brief 获取视频特效许可证的在线认证 key。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 key。
1541
+ * @return 视频特效许可证的在线认证 key。
1154
1542
  *
1155
1543
  */
1156
1544
 
1157
1545
  getKey(): String;
1158
1546
  /** {zh}
1159
1547
  * @detail api
1160
- * @brief 获取视频特效许可证的在线认证 secret。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 secret。
1161
- * @return <br>
1162
- * 视频特效许可证的在线认证 secret。
1548
+ * @brief 获取视频特效许可证的在线认证 secret。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证的 secret。
1549
+ * @return 视频特效许可证的在线认证 secret。
1163
1550
  *
1164
1551
  */
1165
1552
 
1166
1553
  getSecret(): String;
1167
1554
  /** {zh}
1168
1555
  * @detail api
1169
- * @brief 获取视频特效许可证的在线认证地址。当 VeLiveVideoEffectLicenseType{@link #VeLiveVideoEffectLicenseType} 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证地址。
1170
- * @return <br>
1171
- * 视频特效许可证的在线认证地址。
1556
+ * @brief 获取视频特效许可证的在线认证地址。当 [VeLiveVideoEffectLicenseType](#VeLiveVideoEffectLicenseType) 为 `VeLiveVideoEffectLicenseTypeOnLine` 时,返回在线认证地址。
1557
+ * @return 视频特效许可证的在线认证地址。
1172
1558
  *
1173
1559
  */
1174
1560
 
@@ -1179,11 +1565,13 @@ export declare enum VeLiveAudioFrameSource {
1179
1565
  * @brief 采集到的原始音频帧。这是从设备的麦克风或其他音频输入源获取的音频帧。
1180
1566
  *
1181
1567
  */
1568
+
1182
1569
  VeLiveAudioFrameSourceCapture = 1,
1183
1570
  /** {zh}
1184
1571
  * @brief 编码前的音频帧。这是通过各种处理(例如噪音消除、回声消除等)后,准备进行编码的音频帧。
1185
1572
  *
1186
1573
  */
1574
+
1187
1575
  VeLiveAudioFrameSourcePreEncode = "1 << 1"
1188
1576
  }
1189
1577
  export declare class VeLiveAudioEncoderConfiguration {
@@ -1199,8 +1587,8 @@ export declare class VeLiveAudioEncoderConfiguration {
1199
1587
  /** {zh}
1200
1588
  * @detail api
1201
1589
  * @brief 设置推流音频编码码率。
1202
- * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
1203
1590
  * @param bitrate 推流音频编码码率,单位为 kbps,默认值为 64。
1591
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
1204
1592
  *
1205
1593
  */
1206
1594
 
@@ -1208,8 +1596,7 @@ export declare class VeLiveAudioEncoderConfiguration {
1208
1596
  /** {zh}
1209
1597
  * @detail api
1210
1598
  * @brief 获取推流音频采样率。
1211
- * @return <br>
1212
- * 推流音频采样率。详情请参见 VeLiveAudioSampleRate{@link #VeLiveAudioSampleRate}。
1599
+ * @return 推流音频采样率。详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
1213
1600
  *
1214
1601
  */
1215
1602
 
@@ -1217,8 +1604,8 @@ export declare class VeLiveAudioEncoderConfiguration {
1217
1604
  /** {zh}
1218
1605
  * @detail api
1219
1606
  * @brief 设置推流音频采样率。
1220
- * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
1221
- * @param sampleRate 推流音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](147521#VeLiveAudioSampleRate)。
1607
+ * @param sampleRate 推流音频采样率,默认值为 VeLiveAudioSampleRate44100,详情请参见 [VeLiveAudioSampleRate](#VeLiveAudioSampleRate)。
1608
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
1222
1609
  *
1223
1610
  */
1224
1611
 
@@ -1226,8 +1613,7 @@ export declare class VeLiveAudioEncoderConfiguration {
1226
1613
  /** {zh}
1227
1614
  * @detail api
1228
1615
  * @brief 获取推流音频声道。
1229
- * @return <br>
1230
- * 推流音频声道。详情请参见 VeLiveAudioChannel{@link #VeLiveAudioChannel}。
1616
+ * @return 推流音频声道。详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
1231
1617
  *
1232
1618
  */
1233
1619
 
@@ -1235,8 +1621,8 @@ export declare class VeLiveAudioEncoderConfiguration {
1235
1621
  /** {zh}
1236
1622
  * @detail api
1237
1623
  * @brief 设置推流音频声道。
1238
- * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
1239
- * @param channel 推流音频声道,默认值为 VeLiveAudioChannelStereo,详情请参见 [VeLiveAudioChannel](147521#VeLiveAudioChannel)。
1624
+ * @param channel 推流音频声道,默认值为 VeLiveAudioChannelStereo,详情请参见 [VeLiveAudioChannel](#VeLiveAudioChannel)。
1625
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
1240
1626
  *
1241
1627
  */
1242
1628
 
@@ -1244,8 +1630,7 @@ export declare class VeLiveAudioEncoderConfiguration {
1244
1630
  /** {zh}
1245
1631
  * @detail api
1246
1632
  * @brief 获取推流音频编码类型。
1247
- * @return <br>
1248
- * 推流音频编码类型。详情请参见 VeLiveAudioProfile{@link #VeLiveAudioProfile}。
1633
+ * @return 推流音频编码类型。详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
1249
1634
  *
1250
1635
  */
1251
1636
 
@@ -1253,8 +1638,8 @@ export declare class VeLiveAudioEncoderConfiguration {
1253
1638
  /** {zh}
1254
1639
  * @detail api
1255
1640
  * @brief 设置推流音频编码类型。
1256
- * @return <br>推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLiveAudioEncoderConfiguration)。
1257
- * @param profile 推流音频编码类型,默认值为 VeLiveAudioAACProfileLC,详情请参见 [VeLiveAudioProfile](147521#VeLiveAudioProfile)。
1641
+ * @param profile 推流音频编码类型,默认值为 VeLiveAudioAACProfileLC,详情请参见 [VeLiveAudioProfile](#VeLiveAudioProfile)。
1642
+ * @return 推流音频编码参数配置对象,详情请参见 [VeLiveAudioEncoderConfiguration](#VeLivePusherDef-VeLiveAudioEncoderConfiguration)。
1258
1643
  *
1259
1644
  */
1260
1645
 
@@ -1265,11 +1650,13 @@ export declare enum VeLiveAudioMixType {
1265
1650
  * @brief 拉流端可以听到混音效果,本地无法听到。
1266
1651
  *
1267
1652
  */
1653
+
1268
1654
  VeLiveAudioMixPush = 0,
1269
1655
  /** {zh}
1270
1656
  * @brief 拉流端和本地都可以听到混音效果。
1271
1657
  *
1272
1658
  */
1659
+
1273
1660
  VeLiveAudioMixPlayAndPush = 1
1274
1661
  }
1275
1662
  export declare enum VeLiveAudioCaptureType {
@@ -1277,25 +1664,30 @@ export declare enum VeLiveAudioCaptureType {
1277
1664
  * @brief 使用默认麦克风设备进行音频采集。
1278
1665
  *
1279
1666
  */
1667
+
1280
1668
  VeLiveAudioCaptureMicrophone = 0,
1281
1669
  /** {zh}
1282
1670
  * @brief 使用语音通话模式进行音频采集,此模式下会启动硬件的 3A 功能,即自动增益控制、自动频率控制和自动噪声抑制。
1283
1671
  *
1284
1672
  */
1673
+
1285
1674
  VeLiveAudioCaptureVoiceCommunication = 1,
1286
1675
  /** {zh}
1287
1676
  * @brief 使用录屏直播无障碍音频模式进行音频采集。
1288
1677
  *
1289
1678
  */
1679
+
1290
1680
  VeLiveAudioCaptureVoiceRecognition = 2,
1291
1681
  /** {zh}
1292
1682
  * @brief 使用外部设备或源进行音频采集。
1293
1683
  *
1294
1684
  */
1685
+
1295
1686
  VeLiveAudioCaptureExternal = 3,
1296
1687
  /** {zh}
1297
1688
  * @brief 使用静音帧作为音频源。
1298
1689
  *
1299
1690
  */
1691
+
1300
1692
  VeLiveAudioCaptureMuteFrame = 4
1301
1693
  }