@byteplus/react-native-live-pull 1.5.1-rc.3 → 1.5.2-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/ios/VeLivePullView.m +12 -21
  2. package/lib/commonjs/index.js +2 -2
  3. package/lib/module/index.js +2 -2
  4. package/lib/typescript/codegen/android/api.d.ts +27 -257
  5. package/lib/typescript/codegen/android/callback.d.ts +19 -162
  6. package/lib/typescript/codegen/android/errorcode.d.ts +28 -115
  7. package/lib/typescript/codegen/android/keytype.d.ts +113 -482
  8. package/lib/typescript/codegen/ios/api.d.ts +29 -225
  9. package/lib/typescript/codegen/ios/callback.d.ts +18 -134
  10. package/lib/typescript/codegen/ios/errorcode.d.ts +26 -102
  11. package/lib/typescript/codegen/ios/keytype.d.ts +113 -424
  12. package/lib/typescript/codegen/pack/api.d.ts +33 -291
  13. package/lib/typescript/codegen/pack/callback.d.ts +20 -167
  14. package/lib/typescript/codegen/pack/errorcode.d.ts +30 -126
  15. package/lib/typescript/codegen/pack/keytype.d.ts +130 -582
  16. package/lib/typescript/core/keytype.d.ts +4 -16
  17. package/package.json +1 -1
  18. package/android/bin/build/generated/res/pngs/debug/drawable-anydpi-v24/new_window.xml +0 -16
  19. package/android/bin/build/generated/res/pngs/debug/drawable-hdpi/new_window.png +0 -0
  20. package/android/bin/build/generated/res/pngs/debug/drawable-ldpi/new_window.png +0 -0
  21. package/android/bin/build/generated/res/pngs/debug/drawable-mdpi/new_window.png +0 -0
  22. package/android/bin/build/generated/res/pngs/debug/drawable-xhdpi/new_window.png +0 -0
  23. package/android/bin/build/generated/res/pngs/debug/drawable-xxhdpi/new_window.png +0 -0
  24. package/android/bin/build/generated/res/pngs/debug/drawable-xxxhdpi/new_window.png +0 -0
  25. package/android/bin/build/generated/source/buildConfig/debug/com/volcengine/velive/rn/pull/BuildConfig.class +0 -0
  26. package/android/bin/build/intermediates/aapt_friendly_merged_manifests/debug/aapt/AndroidManifest.xml +0 -25
  27. package/android/bin/build/intermediates/aapt_friendly_merged_manifests/debug/aapt/output-metadata.json +0 -18
  28. package/android/bin/build/intermediates/aar_metadata/debug/aar-metadata.properties +0 -5
  29. package/android/bin/build/intermediates/annotation_processor_list/debug/annotationProcessors.json +0 -1
  30. package/android/bin/build/intermediates/compile_library_classes_jar/debug/classes.jar +0 -0
  31. package/android/bin/build/intermediates/compile_r_class_jar/debug/R.jar +0 -0
  32. package/android/bin/build/intermediates/compile_symbol_list/debug/R.txt +0 -6
  33. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable-anydpi-v24_new_window.xml.flat +0 -0
  34. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable-hdpi-v4_new_window.png.flat +0 -0
  35. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable-ldpi-v4_new_window.png.flat +0 -0
  36. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable-mdpi-v4_new_window.png.flat +0 -0
  37. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable-xhdpi-v4_new_window.png.flat +0 -0
  38. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable-xxhdpi-v4_new_window.png.flat +0 -0
  39. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable-xxxhdpi-v4_new_window.png.flat +0 -0
  40. package/android/bin/build/intermediates/compiled_local_resources/debug/out/drawable_button_close.xml.flat +0 -0
  41. package/android/bin/build/intermediates/compiled_local_resources/debug/out/layout_floating_window_layout.xml.flat +0 -0
  42. package/android/bin/build/intermediates/incremental/debug/packageDebugResources/compile-file-map.properties +0 -10
  43. package/android/bin/build/intermediates/incremental/debug/packageDebugResources/merger.xml +0 -2
  44. package/android/bin/build/intermediates/incremental/mergeDebugJniLibFolders/merger.xml +0 -2
  45. package/android/bin/build/intermediates/incremental/mergeDebugShaders/merger.xml +0 -2
  46. package/android/bin/build/intermediates/incremental/packageDebugAssets/merger.xml +0 -2
  47. package/android/bin/build/intermediates/local_only_symbol_list/debug/R-def.txt +0 -8
  48. package/android/bin/build/intermediates/manifest_merge_blame_file/debug/manifest-merger-blame-debug-report.txt +0 -44
  49. package/android/bin/build/intermediates/merged_manifest/debug/AndroidManifest.xml +0 -25
  50. package/android/bin/build/intermediates/navigation_json/debug/navigation.json +0 -1
  51. package/android/bin/build/intermediates/packaged_res/debug/drawable/button_close.xml +0 -9
  52. package/android/bin/build/intermediates/packaged_res/debug/drawable-anydpi-v24/new_window.xml +0 -16
  53. package/android/bin/build/intermediates/packaged_res/debug/drawable-hdpi-v4/new_window.png +0 -0
  54. package/android/bin/build/intermediates/packaged_res/debug/drawable-ldpi-v4/new_window.png +0 -0
  55. package/android/bin/build/intermediates/packaged_res/debug/drawable-mdpi-v4/new_window.png +0 -0
  56. package/android/bin/build/intermediates/packaged_res/debug/drawable-xhdpi-v4/new_window.png +0 -0
  57. package/android/bin/build/intermediates/packaged_res/debug/drawable-xxhdpi-v4/new_window.png +0 -0
  58. package/android/bin/build/intermediates/packaged_res/debug/drawable-xxxhdpi-v4/new_window.png +0 -0
  59. package/android/bin/build/intermediates/packaged_res/debug/layout/floating_window_layout.xml +0 -29
  60. package/android/bin/build/intermediates/runtime_library_classes_jar/debug/classes.jar +0 -0
  61. package/android/bin/build/intermediates/symbol_list_with_package_name/debug/package-aware-r.txt +0 -7
  62. package/android/bin/build/outputs/logs/manifest-merger-debug-report.txt +0 -54
  63. package/android/bin/build/tmp/compileDebugJavaWithJavac/previous-compilation-data.bin +0 -0
  64. package/lib/typescript/core/logger.d.ts +0 -1
  65. package/lib/typescript/platforms/android/AppLogWrapper.d.ts +0 -8
  66. package/lib/typescript/platforms/ios/RangersAppLog.d.ts +0 -4
@@ -1,18 +1,12 @@
1
1
  import { BOOL, NSInteger, NSString, int, CMTime, NSData, int64_t, CVPixelBufferRef, CMSampleBufferRef, NSArray, NSURL, long, float } from './types';
2
2
  export declare enum VeLivePlayerResolutionSwitchReason {
3
- /** {zh}
4
- * @brief ABR 自动切档。
5
- *
6
- */
3
+
7
4
  /** {en}
8
5
  * @brief The resolution is switched automatically through the adaptive bitrate (ABR) feature.
9
6
  *
10
7
  */
11
8
  VeLivePlayerResolutionSwitchByAuto = 0,
12
- /** {zh}
13
- * @brief 调用 [switchResolution:](188118#TVLManager(VeLivePlayer)-switchresolution)手动切换档位。
14
- *
15
- */
9
+
16
10
  /** {en}
17
11
  * @brief The resolution is changed after [switchResolution:](docs-player-sdk-for-ios-api#TVLManager(VeLivePlayer)-switchresolution) is called.
18
12
  *
@@ -20,23 +14,14 @@ export declare enum VeLivePlayerResolutionSwitchReason {
20
14
  VeLivePlayerResolutionSwitchByManual = 1
21
15
  }
22
16
  export declare class VeLivePlayerConfiguration {
23
- /** {zh}
24
- * @brief 是否开启字符串 SEI 消息的解析,默认值为 NO。<br/>
25
- * - YES:开启;
26
- * - NO:关闭。
27
- */
17
+
28
18
  /** {en}
29
19
  * @brief Whether to enable the parsing of string SEI messages. The default value is `NO`.<br/>
30
20
  * - YES: Enable;
31
21
  * - NO: Disable.
32
22
  */
33
23
  enableSei: BOOL;
34
- /** {zh}
35
- * @brief 是否开启二进制 SEI 消息的解析,默认值为 NO。<br/>
36
- * - YES:开启;
37
- * - NO:关闭。
38
- * @notes 二进制 SEI 开启后,字符串 SEI 的回调将不再发送。
39
- */
24
+
40
25
  /** {en}
41
26
  * @brief Whether to enable the parsing of binary SEI messages. The default value is `NO`.<br/>
42
27
  * - YES: Enable;
@@ -44,184 +29,126 @@ export declare class VeLivePlayerConfiguration {
44
29
  * @notes After binary SEI is enabled, callbacks for string SEI will no longer be sent.
45
30
  */
46
31
  enableBinarySei: BOOL;
47
- /** {zh}
48
- * @brief 是否开启硬件解码功能,默认值为 YES。开启硬件解码后,如果出现硬件解码启动失败或硬件解码失败的情况,播放器内部会自动切换为软解。<br>
49
- * - YES:开启;
50
- * - NO:关闭。
51
- */
32
+
52
33
  /** {en}
53
34
  * @brief Whether to turn on hardware decoding. The default value is `YES`. When hardware decoding is enabled, if the player fails to start hardware decoding or if hardware decoding fails, the player automatically switches to software decoding. <br>
54
35
  * - YES: Enable;
55
36
  * - NO: Disable.
56
37
  */
57
38
  enableHardwareDecode: BOOL;
58
- /** {zh}
59
- * @brief 是否开启本地 DNS 预解析,默认值为 NO。开启本地 DNS 预解析可以缩短启播时间。如果本地 DNS 预解析出现异常,可能会影响播放器的正常使用。<br>
60
- * - YES:开启;
61
- * - NO:关闭。
62
- */
39
+
63
40
  /** {en}
64
41
  * @brief Whether to enable local DNS prefetch. The default value is `NO`. Enabling local DNS prefetch can reduce the time required to start playback. If an abnormality occurs with local DNS prefetch, the player may not function properly. <br>
65
42
  * - YES: Enable;
66
43
  * - NO: Disable.
67
44
  */
68
45
  enableLiveDNS: BOOL;
69
- /** {zh}
70
- * @brief 是否开启播放信息周期性回调。默认值为 NO。周期性回调参数详细说明请参见 [VeLivePlayerStatistics](#VeLivePlayerStatistics) 。当 enableStatisticsCallback 为 YES,且 [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) 大于 0 时,播放器会在指定的时间间隔内,周期性地回调播放器状态信息。<br/>
71
- * - YES:开启;
72
- * - NO:关闭。
73
- */
46
+
74
47
  /** {en}
75
48
  * @brief Whether to enable periodic callbacks for playback information. The default value is `NO`. Refer to [VeLivePlayerStatistics](#VeLivePlayerStatistics) for more information on callback statistics. If `enableStatisticsCallback` is `YES` and [statisticsCallbackInterval](#VeLivePlayerConfiguration-statisticscallbackinterval) is greater than `0`, the player will periodically report the player status information after the specified time interval.<br/>
76
49
  * - YES: Enable;
77
50
  * - NO: Disable.
78
51
  */
79
52
  enableStatisticsCallback: BOOL;
80
- /** {zh}
81
- * @brief 播放信息周期性回调的时间间隔,单位为 s,默认值为 5。当 [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) 为 YES,且 `statisticsCallbackInterval` 大于 0 时,播放器会在指定的时间间隔内,周期性地回调播放器状态信息。
82
- */
53
+
83
54
  /** {en}
84
55
  * @brief The time interval for periodic callbacks that provide playback information, in seconds. The default value is `5`. If enableStatisticsCallback is `YES` and [enableStatisticsCallback](#VeLivePlayerConfiguration-enablestatisticscallback) is greater than `0`, the player will periodically report the player status information after the specified time interval.
85
56
  */
86
57
  statisticsCallbackInterval: NSInteger;
87
- /** {zh}
88
- * @brief 网络超时时间,单位为 ms,默认值为 5000。播放器发起网络请求,如果超过了该时间仍未收到服务器响应,则认为网络请求失败。
89
- */
58
+
90
59
  /** {en}
91
60
  * @brief Network timeout duration in milliseconds. The default value is `5000`. Once the player sends a network request, if the player does not receive a response from the server after the timeout duration, the network request is considered to have failed.
92
61
  */
93
62
  networkTimeoutMs: NSInteger;
94
- /** {zh}
95
- * @brief 重试时间间隔,单位为 ms,默认值为 5000,仅在无备流时生效。<br>
96
- * - 在无备流的场景下,若遇到网络异常等问题导致播放中断,播放器会立即进行重试,前三次重试为立即执行,第四次及之后的重试将按照设置的重试时间间隔执行;
97
- * - 在有备流的场景下,重试时间间隔将不生效,所有重试均会立即执行。
98
- */
63
+
99
64
  /** {en}
100
65
  * @brief Retry interval, in ms. The default value is 5000 and it is only effective when there is no backup stream.
101
66
  * - In scenarios without a backup stream, if playback is interrupted due to issues such as network anomalies, the player will immediately retry. The first three retries are executed immediately, and the fourth and subsequent retries will be executed according to the set retry interval.
102
67
  * - In scenarios with a backup stream, the retry interval will not take effect and all retries will be executed immediately.
103
68
  */
104
69
  retryIntervalTimeMs: NSInteger;
105
- /** {zh}
106
- * @brief 在网络连接错误的情况下,播放器最大重试次数,默认值为 5。如果取值为 0,表示关闭播放器内部重试。<br>
107
- * - 在无备流的场景下,每次重试,会消耗一次重试次数;
108
- * - 在有备流的场景下,每次主备流切换,会消耗一次重试次数。
109
- */
70
+
110
71
  /** {en}
111
72
  * @brief In the case of a network connection error, the maximum number of automatic retries of the player. The default value is `5`. If the value is `0`, the player will not automatically retry.<br/>
112
73
  * - In a scenario without backup streams, each retry consumes one retry attempt.
113
74
  * - In a scenario with backup streams, each primary-backup stream switch consumes one retry attempt.
114
75
  */
115
76
  retryMaxCount: NSInteger;
116
- /** {zh}
117
- * @brief 默认初始化方法。
118
- */
77
+
119
78
  /** {en}
120
79
  * @brief Initializes the configurations.
121
80
  */
122
81
  init(): this;
123
82
  }
124
83
  export declare class VeLivePlayerStream {
125
- /** {zh}
126
- * @brief 播放地址。
127
- */
84
+
128
85
  /** {en}
129
86
  * @brief The pull stream address.
130
87
  */
131
88
  url: NSString;
132
- /** {zh}
133
- * @brief 清晰度档位,详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
134
- */
89
+
135
90
  /** {en}
136
91
  * @brief The resolution. See [VeLivePlayerResolution](#VeLivePlayerResolution) for details.
137
92
  */
138
93
  resolution: VeLivePlayerResolution;
139
- /** {zh}
140
- * @brief 播放码率,单位为 bps。
141
- */
94
+
142
95
  /** {en}
143
96
  * @brief The playback bitrate, in bps.
144
97
  */
145
98
  bitrate: int;
146
- /** {zh}
147
- * @brief 传输协议,详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
148
- */
99
+
149
100
  /** {en}
150
101
  * @brief The transmission protocol. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
151
102
  */
152
103
  protocol: VeLivePlayerProtocol;
153
- /** {zh}
154
- * @brief 播放格式,详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
155
- */
104
+
156
105
  /** {en}
157
106
  * @brief The video format. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
158
107
  */
159
108
  format: VeLivePlayerFormat;
160
- /** {zh}
161
- * @brief 播放流类型为主路或备路,详情请参见 [VeLivePlayerStreamType](188121#VeLivePlayerStreamType)。
162
- */
109
+
163
110
  /** {en}
164
111
  * @brief Whether the stream is a primary or a backup stream. See [VeLivePlayerStreamType](#VeLivePlayerStreamType) for details.
165
112
  */
166
113
  type: VeLivePlayerStreamType;
167
- /** {zh}
168
- * @brief 单路直播流配置初始化方法。
169
- */
114
+
170
115
  /** {en}
171
116
  * @brief Initializes a pull stream address.
172
117
  */
173
118
  init(): this;
174
119
  }
175
120
  export declare enum VeLivePlayerLogLevel {
176
- /** {zh}
177
- * @brief 输出 VERBOSE、DEBUG、INFO、WARNING 和 ERROR 级别的日志。
178
- *
179
- */
121
+
180
122
  /** {en}
181
123
  * @brief Output logs at the VERBOSE, DEBUG, INFO, WARNING, and ERROR levels.
182
124
  *
183
125
  */
184
126
  VeLivePlayerLogLevelVerbose = 0,
185
- /** {zh}
186
- * @brief 输出 DEBUG、INFO、WARNING 和 ERROR 级别的日志。
187
- *
188
- */
127
+
189
128
  /** {en}
190
129
  * @brief Output logs at the DEBUG, INFO, WARNING, and ERROR levels.
191
130
  *
192
131
  */
193
132
  VeLivePlayerLogLevelDebug = 1,
194
- /** {zh}
195
- * @brief 输出 INFO、WARNING 和 ERROR 级别的日志。
196
- *
197
- */
133
+
198
134
  /** {en}
199
135
  * @brief Output logs at the INFO, WARNING, and ERROR levels.
200
136
  *
201
137
  */
202
138
  VeLivePlayerLogLevelInfo = 2,
203
- /** {zh}
204
- * @brief 输出 WARNING 和 ERROR 级别的日志。
205
- *
206
- */
139
+
207
140
  /** {en}
208
141
  * @brief Output logs at the WARNING and ERROR levels.
209
142
  *
210
143
  */
211
144
  VeLivePlayerLogLevelWarn = 3,
212
- /** {zh}
213
- * @brief 输出 ERROR 级别的日志。
214
- *
215
- */
145
+
216
146
  /** {en}
217
147
  * @brief Output logs at the ERROR level.
218
148
  *
219
149
  */
220
150
  VeLivePlayerLogLevelError = 4,
221
- /** {zh}
222
- * @brief 关闭日志打印。
223
- *
224
- */
151
+
225
152
  /** {en}
226
153
  * @brief Disable log printing.
227
154
  *
@@ -229,55 +156,39 @@ export declare enum VeLivePlayerLogLevel {
229
156
  VeLivePlayerLogLevelNone = 5
230
157
  }
231
158
  export declare class VeLivePlayerAudioFrame {
232
- /** {zh}
233
- * @brief 音频帧数据封装格式,详情请参见 [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType)。
234
- */
159
+
235
160
  /** {en}
236
161
  * @brief The encapsulation format of the audio data. See [VeLivePlayerAudioBufferType](#VeLivePlayerAudioBufferType) for details.
237
162
  */
238
163
  bufferType: VeLivePlayerAudioBufferType;
239
- /** {zh}
240
- * @brief 音频采样率,单位为 Hz。
241
- */
164
+
242
165
  /** {en}
243
166
  * @brief The audio sample rate, in Hz.
244
167
  */
245
168
  sampleRate: int;
246
- /** {zh}
247
- * @brief 声道数。<br>
248
- * - 1:单声道;
249
- * - 2:双声道。
250
- */
169
+
251
170
  /** {en}
252
171
  * @brief The number of audio channels. <br>
253
172
  * - 1: Mono;
254
173
  * - 2: Stereo.
255
174
  */
256
175
  channels: int;
257
- /** {zh}
258
- * @brief 音频位深度。
259
- */
176
+
260
177
  /** {en}
261
178
  * @brief The audio bit depth.
262
179
  */
263
180
  bitDepth: int;
264
- /** {zh}
265
- * @brief 音频渲染时间戳,单位为 ms。
266
- */
181
+
267
182
  /** {en}
268
183
  * @brief The timestamp indicating the time when the audio is rendered, in milliseconds.
269
184
  */
270
185
  pts: CMTime;
271
- /** {zh}
272
- * @brief PCM 音频数据。
273
- */
186
+
274
187
  /** {en}
275
188
  * @brief The PCM audio data.
276
189
  */
277
190
  data: NSData;
278
- /** {zh}
279
- * @brief 音频采样点个数。
280
- */
191
+
281
192
  /** {en}
282
193
  * @brief The number of audio samples.
283
194
  */
@@ -285,58 +196,42 @@ export declare class VeLivePlayerAudioFrame {
285
196
  init(): this;
286
197
  }
287
198
  export declare class VeLivePlayerVideoFrame {
288
- /** {zh}
289
- * @brief 视频帧数据封装格式,详情请参见 [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType)。
290
- */
199
+
291
200
  /** {en}
292
201
  * @brief The encapsulation format. See [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) for details.
293
202
  */
294
203
  bufferType: VeLivePlayerVideoBufferType;
295
- /** {zh}
296
- * @brief 视频帧像素格式,详情请参见 [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat)。
297
- */
204
+
298
205
  /** {en}
299
206
  * @brief The pixel format. See [VeLivePlayerPixelFormat](#VeLivePlayerPixelFormat) for details.
300
207
  */
301
208
  pixelFormat: VeLivePlayerPixelFormat;
302
- /** {zh}
303
- * @brief 视频宽度,单位为 px。
304
- */
209
+
305
210
  /** {en}
306
211
  * @brief The video width, in pixels.
307
212
  */
308
213
  width: NSInteger;
309
- /** {zh}
310
- * @brief 视频高度,单位为 px。
311
- */
214
+
312
215
  /** {en}
313
216
  * @brief The video height, in pixels.
314
217
  */
315
218
  height: NSInteger;
316
- /** {zh}
317
- * @brief 视频帧的渲染时间戳,单位为 ms。
318
- */
219
+
319
220
  /** {en}
320
221
  * @brief The timestamp indicating the time when the video frame is rendered, in milliseconds.
321
222
  */
322
223
  pts: int64_t;
323
- /** {zh}
324
- * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypePixelBuffer` 时的视频数据。
325
- */
224
+
326
225
  /** {en}
327
226
  * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypePixelBuffer`.
328
227
  */
329
228
  pixelBuffer: CVPixelBufferRef;
330
- /** {zh}
331
- * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypeSampleBuffer` 时的视频数据。
332
- */
229
+
333
230
  /** {en}
334
231
  * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeSampleBuffer`.
335
232
  */
336
233
  sampleBuffer: CMSampleBufferRef;
337
- /** {zh}
338
- * @brief `pixelFormat` 为 `VeLivePlayerVideoBufferTypeNSData` 时的视频数据。
339
- */
234
+
340
235
  /** {en}
341
236
  * @brief The video data, if you set [VeLivePlayerVideoBufferType](#VeLivePlayerVideoBufferType) to `VeLivePlayerVideoBufferTypeNSData`.
342
237
  */
@@ -344,55 +239,37 @@ export declare class VeLivePlayerVideoFrame {
344
239
  init(): this;
345
240
  }
346
241
  export declare enum VeLivePlayerSupportResolutionSwitchError {
347
- /** {zh}
348
- * @brief 没有找到对应分辨率档位。
349
- *
350
- */
242
+
351
243
  /** {en}
352
244
  * @brief The corresponding resolution gear is not found.
353
245
  *
354
246
  */
355
247
  VeLivePlayerErrorResNotFound = -1,
356
- /** {zh}
357
- * @brief 和当前分辨率档位相同。
358
- *
359
- */
248
+
360
249
  /** {en}
361
250
  * @brief The same as the current resolution level.
362
251
  *
363
252
  */
364
253
  VeLivePlayerErrorSameRes = -2,
365
- /** {zh}
366
- * @brief 播放器状态为非 prepare 状态。
367
- *
368
- */
254
+
369
255
  /** {en}
370
256
  * @brief The player status is not in the prepare state.
371
257
  *
372
258
  */
373
259
  VeLivePlayerErrorStatusInvalid = -3,
374
- /** {zh}
375
- * @brief 分辨率档位错误。
376
- *
377
- */
260
+
378
261
  /** {en}
379
262
  * @brief Resolution level error.
380
263
  *
381
264
  */
382
265
  VeLivePlayerErrorInvalidRes = -4,
383
- /** {zh}
384
- * @brief 配置不支持。
385
- *
386
- */
266
+
387
267
  /** {en}
388
268
  * @brief Configuration not supported.
389
269
  *
390
270
  */
391
271
  VeLivePlayerErrorConfigNotSupport = -5,
392
- /** {zh}
393
- * @brief 格式不支持。
394
- *
395
- */
272
+
396
273
  /** {en}
397
274
  * @brief Format not supported.
398
275
  *
@@ -400,59 +277,41 @@ export declare enum VeLivePlayerSupportResolutionSwitchError {
400
277
  VeLivePlayerErrorFormatNotSupport = -6
401
278
  }
402
279
  export declare class VeLivePlayerStreamData {
403
- /** {zh}
404
- * @brief 是否打开 ABR 平滑切档功能,默认为 NO。<br>
405
- * - YES:开启;
406
- * - NO:关闭。
407
- */
280
+
408
281
  /** {en}
409
282
  * @brief Whether to enable adaptive bitrate (ABR). The default value is `NO`. <br>
410
283
  * - YES: Enable;
411
284
  * - NO: Disable.
412
285
  */
413
286
  enableABR: BOOL;
414
- /** {zh}
415
- * @brief 是否打开主备切换,默认为 NO。<br>
416
- * - YES:开启;
417
- * - NO:关闭。
418
- */
287
+
419
288
  /** {en}
420
289
  * @brief Whether to enable switching between the primary and the backup stream. The default value is `NO`. <br>
421
290
  * - YES: Enable;
422
291
  * - NO: Disable.
423
292
  */
424
293
  enableMainBackupSwitch: BOOL;
425
- /** {zh}
426
- * @brief 播放器的默认清晰度档位,默认使用原始流清晰度,详情请参见 [VeLivePlayerResolution](#VeLivePlayerResolution)。
427
- */
294
+
428
295
  /** {en}
429
296
  * @brief The default resolution. The default value is `VeLivePlayerResolutionOrigin`, which indicates the original resolution. See [VeLivePlayerResolution](#VeLivePlayerResolution) for details.
430
297
  */
431
298
  defaultResolution: VeLivePlayerResolution;
432
- /** {zh}
433
- * @brief 播放器的默认播放格式,默认值为 FLV,详情请参见 [VeLivePlayerFormat](#VeLivePlayerFormat)。
434
- */
299
+
435
300
  /** {en}
436
301
  * @brief The default video format. The default value is `VeLivePlayerFormatFLV`. See [VeLivePlayerFormat](#VeLivePlayerFormat) for details.
437
302
  */
438
303
  defaultFormat: VeLivePlayerFormat;
439
- /** {zh}
440
- * @brief 播放器的默认播放传输层协议,默认值为 TCP,详情请参见 [VeLivePlayerProtocol](#VeLivePlayerProtocol)。
441
- */
304
+
442
305
  /** {en}
443
306
  * @brief The default transmission protocol. The default value is `VeLivePlayerProtocolTCP`. See [VeLivePlayerProtocol](#VeLivePlayerProtocol) for details.
444
307
  */
445
308
  defaultProtocol: VeLivePlayerProtocol;
446
- /** {zh}
447
- * @brief 主路流地址列表,详情请参见 [VeLivePlayerStream](#VeLivePlayerStream)。
448
- */
309
+
449
310
  /** {en}
450
311
  * @brief A list of main stream addresses. See [VeLivePlayerStream](#VeLivePlayerStream) for details.
451
312
  */
452
313
  mainStream: NSArray<VeLivePlayerStream>;
453
- /** {zh}
454
- * @brief 备路流地址列表,详情请参见 [VeLivePlayerStream](#VeLivePlayerStream)。
455
- */
314
+
456
315
  /** {en}
457
316
  * @brief A list of backup stream addresses. See [VeLivePlayerStream](#VeLivePlayerStream) for details.
458
317
  */
@@ -460,28 +319,19 @@ export declare class VeLivePlayerStreamData {
460
319
  init(): this;
461
320
  }
462
321
  export declare enum VeLivePlayerAudioBufferType {
463
- /** {zh}
464
- * @brief 未知格式。
465
- *
466
- */
322
+
467
323
  /** {en}
468
324
  * @brief Unknown format.
469
325
  *
470
326
  */
471
327
  VeLivePlayerAudioBufferUnknown = 0,
472
- /** {zh}
473
- * @brief CVSampleBufferRef 格式,音频数据以样本缓冲区 sample buffer 的形式进行处理和渲染。
474
- *
475
- */
328
+
476
329
  /** {en}
477
330
  * @brief CVSampleBufferRef. The audio data is processed and rendered as sample buffers.
478
331
  *
479
332
  */
480
333
  VeLivePlayerAudioBufferTypeSampleBuffer = 1,
481
- /** {zh}
482
- * @brief NSData 格式,音频数据以 NSData 对象的形式进行处理和渲染。
483
- *
484
- */
334
+
485
335
  /** {en}
486
336
  * @brief NSData. The audio data is processed and rendered as NSData objects.
487
337
  *
@@ -489,37 +339,25 @@ export declare enum VeLivePlayerAudioBufferType {
489
339
  VeLivePlayerAudioBufferTypeNSData = 2
490
340
  }
491
341
  export declare enum VeLivePlayerVideoBufferType {
492
- /** {zh}
493
- * @brief 未知格式。
494
- *
495
- */
342
+
496
343
  /** {en}
497
344
  * @brief Unknown format.
498
345
  *
499
346
  */
500
347
  VeLivePlayerVideoBufferTypeUnknown = 0,
501
- /** {zh}
502
- * @brief CVPixelBufferRef 格式。
503
- *
504
- */
348
+
505
349
  /** {en}
506
350
  * @brief CVPixelBufferRef.
507
351
  *
508
352
  */
509
353
  VeLivePlayerVideoBufferTypePixelBuffer = 1,
510
- /** {zh}
511
- * @brief CVSampleBufferRef 格式。
512
- *
513
- */
354
+
514
355
  /** {en}
515
356
  * @brief CVSampleBufferRef.
516
357
  *
517
358
  */
518
359
  VeLivePlayerVideoBufferTypeSampleBuffer = 2,
519
- /** {zh}
520
- * @brief NSData 格式。
521
- *
522
- */
360
+
523
361
  /** {en}
524
362
  * @brief NSData.
525
363
  *
@@ -527,37 +365,25 @@ export declare enum VeLivePlayerVideoBufferType {
527
365
  VeLivePlayerVideoBufferTypeNSData = 3
528
366
  }
529
367
  export declare enum VeLivePlayerProtocol {
530
- /** {zh}
531
- * @brief TCP 协议。
532
- *
533
- */
368
+
534
369
  /** {en}
535
370
  * @brief TCP.
536
371
  *
537
372
  */
538
373
  VeLivePlayerProtocolTCP = 0,
539
- /** {zh}
540
- * @brief QUIC 协议。
541
- *
542
- */
374
+
543
375
  /** {en}
544
376
  * @brief QUIC.
545
377
  *
546
378
  */
547
379
  VeLivePlayerProtocolQUIC = 1,
548
- /** {zh}
549
- * @brief TLS 协议。
550
- *
551
- */
380
+
552
381
  /** {en}
553
382
  * @brief TLS.
554
383
  *
555
384
  */
556
385
  VeLivePlayerProtocolTLS = 2,
557
- /** {zh}
558
- * @brief HTTP 协议。
559
- *
560
- */
386
+
561
387
  /** {en}
562
388
  * @brief HTTP。
563
389
  *
@@ -565,28 +391,19 @@ export declare enum VeLivePlayerProtocol {
565
391
  VeLivePlayerProtocolHTTP2 = 3
566
392
  }
567
393
  export declare enum VeLivePlayerFillMode {
568
- /** {zh}
569
- * @brief 视频填满画布。视频帧等比缩放,直至填满画布,超出屏幕的部分将被裁剪,画面可能不完整。
570
- *
571
- */
394
+
572
395
  /** {en}
573
396
  * @brief Uniformly scale the video until the screen is completely filled. Part of the video may be cropped.
574
397
  *
575
398
  */
576
399
  VeLivePlayerFillModeAspectFill = 0,
577
- /** {zh}
578
- * @brief 显示完整的视频帧。视频帧等比缩放,直至视频帧恰好在画布上全部显示。如果视频帧长宽比例与画布不同,视窗上未被视频帧填满区域将填充为黑色。
579
- *
580
- */
400
+
581
401
  /** {en}
582
402
  * @brief Display the full video. The video is uniformly scaled until one dimension of the video hits the boundary of the screen. Any remaining space on the screen will be filled with black.
583
403
  *
584
404
  */
585
405
  VeLivePlayerFillModeAspectFit = 1,
586
- /** {zh}
587
- * @brief 视频帧自适应画布。视频帧非等比缩放,直至填满画布。在此过程中,视频帧的长宽比例可能会发生变化。
588
- *
589
- */
406
+
590
407
  /** {en}
591
408
  * @brief Stretch the video to fill the screen. The aspect ratio of the video might change.
592
409
  *
@@ -594,37 +411,25 @@ export declare enum VeLivePlayerFillMode {
594
411
  VeLivePlayerFillModeFullFill = 2
595
412
  }
596
413
  export declare enum VeLivePlayerRotation {
597
- /** {zh}
598
- * @brief 关闭旋转。
599
- *
600
- */
414
+
601
415
  /** {en}
602
416
  * @brief No rotation.
603
417
  *
604
418
  */
605
419
  VeLivePlayerRotation0 = 0,
606
- /** {zh}
607
- * @brief 顺时针旋转 90 度。
608
- *
609
- */
420
+
610
421
  /** {en}
611
422
  * @brief Rotate 90 degrees clockwise.
612
423
  *
613
424
  */
614
425
  VeLivePlayerRotation90 = 90,
615
- /** {zh}
616
- * @brief 顺时针旋转 180 度。
617
- *
618
- */
426
+
619
427
  /** {en}
620
428
  * @brief Rotate 180 degrees clockwise.
621
429
  *
622
430
  */
623
431
  VeLivePlayerRotation180 = 180,
624
- /** {zh}
625
- * @brief 顺时针旋转 270 度。
626
- *
627
- */
432
+
628
433
  /** {en}
629
434
  * @brief Rotate 270 degrees clockwise.
630
435
  *
@@ -632,28 +437,19 @@ export declare enum VeLivePlayerRotation {
632
437
  VeLivePlayerRotation270 = 270
633
438
  }
634
439
  export declare enum VeLivePlayerMirror {
635
- /** {zh}
636
- * @brief 关闭镜像。
637
- *
638
- */
440
+
639
441
  /** {en}
640
442
  * @brief No mirroring.
641
443
  *
642
444
  */
643
445
  VeLivePlayerMirrorNone = 0,
644
- /** {zh}
645
- * @brief 水平镜像。
646
- *
647
- */
446
+
648
447
  /** {en}
649
448
  * @brief Horizontal mirroring.
650
449
  *
651
450
  */
652
451
  VeLivePlayerMirrorHorizontal = 1,
653
- /** {zh}
654
- * @brief 垂直镜像。
655
- *
656
- */
452
+
657
453
  /** {en}
658
454
  * @brief Vertical mirroring.
659
455
  *
@@ -661,37 +457,25 @@ export declare enum VeLivePlayerMirror {
661
457
  VeLivePlayerMirrorVertical = 2
662
458
  }
663
459
  export declare enum VeLivePlayerPixelFormat {
664
- /** {zh}
665
- * @brief 未知格式。
666
- *
667
- */
460
+
668
461
  /** {en}
669
462
  * @brief Unknown format.
670
463
  *
671
464
  */
672
465
  VeLivePlayerPixelFormatUnknown = 0,
673
- /** {zh}
674
- * @brief NV12 格式。
675
- *
676
- */
466
+
677
467
  /** {en}
678
468
  * @brief NV12.
679
469
  *
680
470
  */
681
471
  VeLivePlayerPixelFormatNV12 = 1,
682
- /** {zh}
683
- * @brief YUVI420 格式。
684
- *
685
- */
472
+
686
473
  /** {en}
687
474
  * @brief YUVI420.
688
475
  *
689
476
  */
690
477
  VeLivePlayerPixelFormatI420 = 2,
691
- /** {zh}
692
- * @brief BGRA 格式。
693
- *
694
- */
478
+
695
479
  /** {en}
696
480
  * @brief BGRA.
697
481
  *
@@ -699,46 +483,31 @@ export declare enum VeLivePlayerPixelFormat {
699
483
  VeLivePlayerPixelFormatBGRA32 = 3
700
484
  }
701
485
  export declare enum VeLivePlayerStatus {
702
- /** {zh}
703
- * @brief 播放器准备完成,等待渲染。
704
- *
705
- */
486
+
706
487
  /** {en}
707
488
  * @brief The player finishes preparing and is waiting to render the video.
708
489
  *
709
490
  */
710
491
  VeLivePlayerStatusPrepared = 0,
711
- /** {zh}
712
- * @brief 正在播放状态。
713
- *
714
- */
492
+
715
493
  /** {en}
716
494
  * @brief Playback is currently in progress, meaning that the first frame has been rendered and no errors have occurred to the player.
717
495
  *
718
496
  */
719
497
  VeLivePlayerStatusPlaying = 1,
720
- /** {zh}
721
- * @brief 暂停播放状态。
722
- *
723
- */
498
+
724
499
  /** {en}
725
500
  * @brief The playback is paused.
726
501
  *
727
502
  */
728
503
  VeLivePlayerStatusPaused = 2,
729
- /** {zh}
730
- * @brief 停止播放状态。
731
- *
732
- */
504
+
733
505
  /** {en}
734
506
  * @brief The playback is stopped.
735
507
  *
736
508
  */
737
509
  VeLivePlayerStatusStopped = 3,
738
- /** {zh}
739
- * @brief 播放器发生错误。
740
- *
741
- */
510
+
742
511
  /** {en}
743
512
  * @brief An error has occurred to the player.
744
513
  *
@@ -746,104 +515,74 @@ export declare enum VeLivePlayerStatus {
746
515
  VeLivePlayerStatusError = 4
747
516
  }
748
517
  export declare class VeLivePlayerStatistics {
749
- /** {zh}
750
- * @brief 当前直播的播放地址。
751
- */
518
+
752
519
  /** {en}
753
520
  * @brief The current pull stream address.
754
521
  */
755
522
  url: NSURL;
756
- /** {zh}
757
- * @brief 是否使用硬件解码。<br>
758
- * - YES:硬解;
759
- * - NO:非硬解。
760
- */
523
+
761
524
  /** {en}
762
525
  * @brief Whether hardware decoding is used. <br>
763
526
  * - YES: Hardware decoding is used;
764
527
  * - NO: Hardware decoding is not used.
765
528
  */
766
529
  isHardWareDecode: BOOL;
767
- /** {zh}
768
- * @brief 当前播放延时,单位为 ms。仅在使用了火山引擎视频直播推流 SDK 时,支持统计播放延时。
769
- */
530
+
770
531
  /** {en}
771
532
  * @brief The current playback latency, in milliseconds. The latency data is available only if you use the BytePlus MediaLive Broadcast SDK to push the live stream.
772
533
  */
773
534
  delayMs: int;
774
- /** {zh}
775
- * @brief 从当前视频开始播放起,累计的卡顿时长,单位为 ms。
776
- */
535
+
777
536
  /** {en}
778
537
  * @brief The cumulative duration of stutters that occurred since the beginning of playback, in milliseconds.
779
538
  */
780
539
  stallTimeMs: int;
781
- /** {zh}
782
- * @brief 带宽预测 ,单位为 kbps。
783
- */
540
+
784
541
  /** {en}
785
542
  * @brief The estimated bandwidth, in kbps.
786
543
  */
787
544
  bandwidthEstimation: long;
788
- /** {zh}
789
- * @brief 视频的编码类型。
790
- */
545
+
791
546
  /** {en}
792
547
  * @brief The encoding format of the video.
793
548
  */
794
549
  videoCodec: NSString;
795
- /** {zh}
796
- * @brief 当前播放视频的宽度,单位为 px。
797
- */
550
+
798
551
  /** {en}
799
552
  * @brief The width of the video, in pixels.
800
553
  */
801
554
  width: int;
802
- /** {zh}
803
- * @brief 当前播放视频的高度,单位为 px。
804
- */
555
+
805
556
  /** {en}
806
557
  * @brief The height of the video, in pixels.
807
558
  */
808
559
  height: int;
809
- /** {zh}
810
- * @brief 当前播放视频的帧率,单位为 fps。
811
- */
560
+
812
561
  /** {en}
813
562
  * @brief The frame rate of the video, in fps.
814
563
  */
815
564
  fps: float;
816
- /** {zh}
817
- * @brief 实时下载的码率,单位为 kbps。
818
- */
565
+
819
566
  /** {en}
820
567
  * @brief The downlink bitrate, in Kbps.
821
568
  */
822
569
  bitrate: long;
823
- /** {zh}
824
- * @brief 视频播放的缓冲区 buffer 大小,单位为 ms。
825
- */
570
+
826
571
  /** {en}
827
572
  * @brief The video buffer, in milliseconds.
828
573
  */
829
574
  videoBufferMs: long;
830
- /** {zh}
831
- * @brief 音频播放的缓冲区 buffer 大小,单位为 ms。
832
- */
575
+
833
576
  /** {en}
834
577
  * @brief The audio buffer, in milliseconds.
835
578
  */
836
579
  audioBufferMs: long;
837
- /** {zh}
838
- * @brief 当前播放的视频格式。
839
- */
580
+
840
581
  /** {en}
841
582
  * @brief The video format.
842
583
  */
843
584
  format: VeLivePlayerFormat;
844
- /** {zh}
845
- * @brief 当前播放的传输协议。
846
- */
585
+
847
586
  /** {en}
848
587
  * @brief The transmission protocol of the live stream.
849
588
  */
@@ -851,19 +590,13 @@ export declare class VeLivePlayerStatistics {
851
590
  init(): this;
852
591
  }
853
592
  export declare enum VeLivePlayerType {
854
- /** {zh}
855
- * @brief 自研播放器。
856
- *
857
- */
593
+
858
594
  /** {en}
859
595
  * @brief Custom player.
860
596
  *
861
597
  */
862
598
  VeLivePlayerTypeOwn = 0,
863
- /** {zh}
864
- * @brief 系统播放器。
865
- *
866
- */
599
+
867
600
  /** {en}
868
601
  * @brief System player.
869
602
  *
@@ -871,19 +604,13 @@ export declare enum VeLivePlayerType {
871
604
  VeLivePlayerTypeSystem = 1
872
605
  }
873
606
  export declare enum VeLivePlayerStreamType {
874
- /** {zh}
875
- * @brief 主路流。
876
- *
877
- */
607
+
878
608
  /** {en}
879
609
  * @brief The primary stream.
880
610
  *
881
611
  */
882
612
  VeLivePlayerStreamTypeMain = 0,
883
- /** {zh}
884
- * @brief 备路流。
885
- *
886
- */
613
+
887
614
  /** {en}
888
615
  * @brief The backup stream.
889
616
  *
@@ -891,28 +618,19 @@ export declare enum VeLivePlayerStreamType {
891
618
  VeLivePlayerStreamTypeBackup = 1
892
619
  }
893
620
  export declare enum VeLivePlayerFormat {
894
- /** {zh}
895
- * @brief FLV 格式。
896
- *
897
- */
621
+
898
622
  /** {en}
899
623
  * @brief FLV.
900
624
  *
901
625
  */
902
626
  VeLivePlayerFormatFLV = 0,
903
- /** {zh}
904
- * @brief HLS 格式。
905
- *
906
- */
627
+
907
628
  /** {en}
908
629
  * @brief HLS.
909
630
  *
910
631
  */
911
632
  VeLivePlayerFormatHLS = 1,
912
- /** {zh}
913
- * @brief RTM 格式。
914
- *
915
- */
633
+
916
634
  /** {en}
917
635
  * @brief Real Time Media (RTM).
918
636
  *
@@ -920,84 +638,55 @@ export declare enum VeLivePlayerFormat {
920
638
  VeLivePlayerFormatRTM = 2
921
639
  }
922
640
  export declare enum VeLivePlayerResolution {
923
- /** {zh}
924
- * @brief 原始流。
925
- *
926
- */
641
+
927
642
  /** {en}
928
643
  * @brief Original.
929
644
  *
930
645
  */
931
646
  VeLivePlayerResolutionOrigin = 0,
932
- /** {zh}
933
- * @brief UHD 超高清。
934
- *
935
- */
647
+
936
648
  /** {en}
937
649
  * @brief Ultra high definition (UHD).
938
650
  *
939
651
  */
940
652
  VeLivePlayerResolutionUHD = 1,
941
- /** {zh}
942
- * @brief FHD 全高清
943
- *
944
- */
653
+
945
654
  /** {en}
946
655
  * @brief Full High definition (FHD).
947
656
  *
948
657
  */
949
658
  VeLivePlayerResolutionFHD = 2,
950
- /** {zh}
951
- * @brief HD 高清。
952
- *
953
- */
659
+
954
660
  /** {en}
955
661
  * @brief High definition (HD).
956
662
  *
957
663
  */
958
664
  VeLivePlayerResolutionHD = 3,
959
- /** {zh}
960
- * @brief SD 标清。
961
- *
962
- */
665
+
963
666
  /** {en}
964
667
  * @brief Standard definition (SD).
965
668
  *
966
669
  */
967
670
  VeLivePlayerResolutionSD = 4,
968
- /** {zh}
969
- * @brief LD 低清。
970
- *
971
- */
671
+
972
672
  /** {en}
973
673
  * @brief Low definition (LD).
974
674
  *
975
675
  */
976
676
  VeLivePlayerResolutionLD = 5,
977
- /** {zh}
978
- * @brief MD 审核档位
979
- * @hidden (iOS)
980
- *
981
- */
677
+
982
678
  /** {en}
983
679
  * @hidden (iOS)
984
680
  *
985
681
  */
986
682
  VeLivePlayerResolutionMD = 6,
987
- /** {zh}
988
- * @brief 仅音频
989
- * @hidden (iOS)
990
- *
991
- */
683
+
992
684
  /** {en}
993
685
  * @hidden (iOS)
994
686
  *
995
687
  */
996
688
  VeLivePlayerResolutionAO = 7,
997
- /** {zh}
998
- * @brief 自动档位。
999
- *
1000
- */
689
+
1001
690
  /** {en}
1002
691
  * @brief Auto.
1003
692
  *