@volcengine/veplayer 2.5.0 → 2.5.1-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/veplayer.d.ts CHANGED
@@ -1530,13 +1530,13 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1530
1530
  */
1531
1531
  interface Fullscreen {
1532
1532
  /** {zh}
1533
- * @brief 切换全屏时,是否旋转为横屏播放,通常在移动端使用。如果开启横屏播放,切换全屏时,将在竖屏状态下把播放器旋转 90 度,实现横屏效果。该配置优先级高于 useCssFullscreen。
1534
- * - `true`:使用旋转横屏;
1535
- * - `false`:不使用旋转横屏。
1533
+ * @brief 切换全屏时,是否旋转为横屏播放,通常在移动端使用。如果开启横屏播放,切换全屏时,将在竖屏状态下把播放器旋转 90 度,实现横屏效果。该配置优先级低于 useCssFullscreen。
1534
+ * - `true`:使用旋转横屏;
1535
+ * - `false`:不使用旋转横屏。
1536
1536
  * @default false
1537
1537
  */
1538
1538
  /** {en}
1539
- * @brief Whether to play the video in landscape mode when the video enters full-screen mode. This feature is usually used on mobile devices. Once enabled, when the video enters fullscreen mode, the player will be rotated from portrait mode by 90 degrees to landscape mode. This property has a higher priority over `useCssFullscreen`.
1539
+ * @brief Whether to play the video in landscape mode when the video enters full-screen mode. This feature is usually used on mobile devices. Once enabled, when the video enters fullscreen mode, the player will be rotated from portrait mode by 90 degrees to landscape mode. This property has a lower priority than `useCssFullscreen`.
1540
1540
  * - `true`: Enable.
1541
1541
  * - `false`: Disable.
1542
1542
  * @default false
@@ -3895,13 +3895,13 @@ declare namespace strategy {
3895
3895
  */
3896
3896
  interface Fullscreen {
3897
3897
  /** {zh}
3898
- * @brief 切换全屏时,是否旋转为横屏播放,通常在移动端使用。如果开启横屏播放,切换全屏时,将在竖屏状态下把播放器旋转 90 度,实现横屏效果。该配置优先级高于 useCssFullscreen。
3899
- * - `true`:使用旋转横屏;
3900
- * - `false`:不使用旋转横屏。
3898
+ * @brief 切换全屏时,是否旋转为横屏播放,通常在移动端使用。如果开启横屏播放,切换全屏时,将在竖屏状态下把播放器旋转 90 度,实现横屏效果。该配置优先级低于 useCssFullscreen。
3899
+ * - `true`:使用旋转横屏;
3900
+ * - `false`:不使用旋转横屏。
3901
3901
  * @default false
3902
3902
  */
3903
3903
  /** {en}
3904
- * @brief Whether to play the video in landscape mode when the video enters full-screen mode. This feature is usually used on mobile devices. Once enabled, when the video enters fullscreen mode, the player will be rotated from portrait mode by 90 degrees to landscape mode. This property has a higher priority over `useCssFullscreen`.
3904
+ * @brief Whether to play the video in landscape mode when the video enters full-screen mode. This feature is usually used on mobile devices. Once enabled, when the video enters fullscreen mode, the player will be rotated from portrait mode by 90 degrees to landscape mode. This property has a lower priority than `useCssFullscreen`.
3905
3905
  * - `true`: Enable.
3906
3906
  * - `false`: Disable.
3907
3907
  * @default false
@@ -4175,13 +4175,6 @@ declare namespace strategy {
4175
4175
  function detectCodec(url: string): Promise<"unknown" | Codec>;
4176
4176
  function isSoftDecode(options: VePlayerBaseOptions, currentCodec?: Codec | "unknown"): Promise<boolean>;
4177
4177
  function combineOptions<T = VePlayerBaseOptions>(strategyList: (Strategy<T> | undefined)[]): Partial<T>;
4178
- const getFlvStrategy: (options: VePlayerBaseOptions) => Promise<{
4179
- options?: undefined;
4180
- plugins?: undefined;
4181
- } | {
4182
- options: Partial<VePlayerBaseOptions>;
4183
- plugins: any[];
4184
- }>;
4185
4178
  const getHlsStrategy: (options: VePlayerBaseOptions) => Promise<{
4186
4179
  options?: undefined;
4187
4180
  plugins?: undefined;
@@ -4194,17 +4187,17 @@ declare function getStreamType(url: string): "unknown" | "hls" | "flv" | "rtm" |
4194
4187
  /** {zh}
4195
4188
  * @detail api
4196
4189
  * @brief 当前浏览器是否支持播放编码格式。
4197
- * @param codec 编码格式。
4198
- * - `Codec.H264`: 返回当前浏览器是否支持 MediaSource Extends。
4199
- * - `Codec.H265`: 返回当前浏览器是否支持硬解播放 H265。
4190
+ * @param codec 编码格式,支持以下选择。
4191
+ * - `Codec.H264`: 检查 MSE 是否支持 H.264 编码格式。
4192
+ * - `Codec.H265`: 检查 MSE 是否支持 H.265 编码格式。
4200
4193
  * @returns
4201
4194
  */
4202
4195
  /** {en}
4203
4196
  * @detail api
4204
4197
  * @brief Checkes whether the current browser supports the specified encoding format.
4205
- * @param codec The encoding format.
4206
- * - `Codec.H264`: Checks whether the current browser supports MediaSource Extends.
4207
- * - `Codec.H265`: Checks whether the current browser supports H.265 using hardware decoding.
4198
+ * @param codec Code format supports the following options.
4199
+ * - `Codec.H264`: Check whether MSE supports H.264 encoding format.
4200
+ * - `Codec.H265`: Check whether MSE supports H.265 encoding format.
4208
4201
  * @returns
4209
4202
  */
4210
4203
  declare function isMseSupported(codec?: string): boolean;
@@ -4219,7 +4212,27 @@ declare function isMseSupported(codec?: string): boolean;
4219
4212
  * @returns
4220
4213
  */
4221
4214
  declare function isSoftDecodeSupported(): Promise<boolean>;
4222
- declare function isMMSSupported(): boolean;
4215
+ /** {zh}
4216
+ * @detail api
4217
+ * @brief 判断当前浏览器是否支持 MMS(ManagedMediaSource) API,如果支持的话可满足大部分 H.264 视频播放。
4218
+ * :::tip
4219
+ * - 当前方法无法判断是否支持 H.265 视频播放。
4220
+ * - 使用场景:检查 Safari 浏览器是否满足 H.264 编码流拉流要求。
4221
+ * - Safari 17.1 以上版本浏览器开始支持 MMS。
4222
+ * :::
4223
+ * @returns
4224
+ */
4225
+ /** {en}
4226
+ * @detail api
4227
+ * @returns
4228
+ * @brief Determine whether the current browser supports the MMS (ManagedMediaSource) API, if so, it can meet most of the H.264 playback.
4229
+ * :::tip
4230
+ * - The current method cannot determine whether H.265 video playback is supported.
4231
+ * - Usage scenario: Check whether Safari browser meets the requirements for pulling H.264 encoded streams.
4232
+ * - Browsers with iOS 17.1 or above start to support MMS.
4233
+ * :::
4234
+ */
4235
+ declare function isMMSSupported(codec?: string): any;
4223
4236
  declare const util: {
4224
4237
  getStreamType: typeof getStreamType;
4225
4238
  isMseSupported: typeof isMseSupported;
@@ -5175,7 +5188,7 @@ interface LoggerConfig {
5175
5188
  /** {en}
5176
5189
  * @brief The SDK application ID. You can access it by logging in to the BytePlus MediaLive console and navigating to [SDK Management](https://console.byteplus.com/live/main/sdk).
5177
5190
  */
5178
- appId: string;
5191
+ appId?: string;
5179
5192
  /** {zh}
5180
5193
  * @brief 应用名称。
5181
5194
  * @default 无
@@ -5239,23 +5252,25 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5239
5252
  */
5240
5253
  rtm?: Rtm;
5241
5254
  /** {zh}
5242
- * @brief 为播放器设置 FLV 拉流配置。FLV 格式流相关配置仅适用于支持 MSE 播放的 PC 端浏览器和安卓端浏览器。
5255
+ * @brief 为播放器设置 FLV 拉流配置。
5256
+ * @listtip FLV 拉流格式流相关配置适用于支持 MSE 播放的 PC 端浏览器、安卓端浏览器和支持 MMS API 的 iOS 浏览器。
5243
5257
  */
5244
5258
  /** {en}
5245
- * @brief Configurations for playing an FLV stream. You can only play FLV streams with web browsers on PC and Android devices, and the browsers need to support Media Source Extensions (MSE) playback.
5259
+ * @brief Configurations for playing an FLV stream.
5260
+ * @listtip FLV pull stream format stream configurations are applicable to PC browsers, Android browsers that support MSE playback, and iOS browsers that support MMS API.
5246
5261
  */
5247
5262
  flv?: Flv;
5248
5263
  /** {zh}
5249
- * @brief 为播放器设置 HLS 拉流配置。HLS 格式流相关配置仅适用于支持 MSE 播放的 PC 端浏览器和安卓端浏览器。
5250
- * @listtip
5251
- * - PC 端该配置默认生效;
5252
- * - 移动端仅在 `enableMSE` 设置为 `true` 且支持 MSE 的浏览器中生效。
5264
+ * @brief 为播放器设置 HLS 拉流配置。
5265
+ * @listtip - HLS 格式流相关配置仅适用于支持 MSE API的 PC 端浏览器和安卓端浏览器。
5266
+ * - PC 端该配置默认生效;
5267
+ * - 移动端仅在 `enableMSE` 设置为 `true` 且支持 MSE 的浏览器中生效。
5253
5268
  */
5254
5269
  /** {en}
5255
- * @brief Configurations for playing an HLS stream. You can only play HLS streams with web browsers on PC and Android devices, and the browsers need to support Media Source Extensions (MSE) playback.
5256
- * @listtip
5257
- * - This configuration takes effect by default on PC;
5258
- * - For mobile devices, the configuration takes effect only when `enableMSE` is set to `true` for the browser.
5270
+ * @brief Configurations for playing an HLS stream.
5271
+ * @listtip - The HLS format stream configuration is only applicable to PC browsers and Android browsers that support the MSE API.
5272
+ * - This configuration takes effect by default on PC;
5273
+ * - For mobile devices, the configuration takes effect only when `enableMSE` is set to `true` for the browser.
5259
5274
  */
5260
5275
  hls?: Hls;
5261
5276
  /** {zh}
@@ -5314,14 +5329,14 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5314
5329
  interface Abr {
5315
5330
  /** {zh}
5316
5331
  * @brief 是否开启 FLV 拉流时的自适应码率(ABR)功能,默认为开启。
5317
- * - true: 开启
5318
- * - false: 关闭
5332
+ * - `true`: 开启;
5333
+ * - `false`: 关闭。
5319
5334
  * @default true
5320
5335
  */
5321
5336
  /** {en}
5322
5337
  * @brief Enable or disable the Adaptive Bitrate (ABR) feature. The default setting is enabled.
5323
- * - true: Enable;
5324
- * - false: Disable.
5338
+ * - `true`: Enable;
5339
+ * - `false`: Disable.
5325
5340
  */
5326
5341
  enable?: boolean;
5327
5342
  /** {zh}
@@ -5340,14 +5355,14 @@ interface Abr {
5340
5355
  downTip?: boolean;
5341
5356
  /** {zh}
5342
5357
  * @brief 是否开始调试模式,默认为关闭。
5343
- * - true: 开启;
5344
- * - false: 关闭。
5358
+ * - `true`: 开启;
5359
+ * - `false`: 关闭。
5345
5360
  * @default false
5346
5361
  */
5347
5362
  /** {en}
5348
5363
  * @brief Whether to start debug mode, default is false.
5349
- * - true: Enable,
5350
- * - false: Disable.
5364
+ * - `true`: Enable,
5365
+ * - `false`: Disable.
5351
5366
  * @default false
5352
5367
  */
5353
5368
  debug?: boolean;
@@ -5585,16 +5600,16 @@ interface Rtm {
5585
5600
  retryDelay?: number;
5586
5601
  /** {zh}
5587
5602
  * @brief 播放器发起 RTM 拉流请求时,是否开启自动转码。
5588
- * - true:开启
5589
- * - false:关闭
5603
+ * - `true`:开启;
5604
+ * - `false`:关闭。
5590
5605
  * @listtip
5591
5606
  * 如有使用 RTM 拉流自动转码的需求,请先创建工单联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)进行配置。
5592
5607
  * @default false
5593
5608
  */
5594
5609
  /** {en}
5595
5610
  * @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
5596
- * - true: Enable
5597
- * - false: Disable
5611
+ * - `true`: Enable;
5612
+ * - `false`: Disable.
5598
5613
  * @listtip
5599
5614
  * If you want to use the automatic transcoding feature when playing an RTM stream, contact your [technical support](https://www.byteplus.com/en/support).
5600
5615
  * @default false
@@ -5609,20 +5624,38 @@ interface Rtm {
5609
5624
  */
5610
5625
  networkEvaluateInterval?: number;
5611
5626
  /** {zh}
5612
- * @brief 断流后重新拉流是否无缝播放。
5627
+ * @brief 暂停后重新拉流的处理方式是否为无缝替换。
5628
+ * - `true`:是,重新拉流期间不会出现黑屏现象。
5629
+ * - `false`:否,重新拉流期间会出现黑屏现象。
5613
5630
  * @default false
5631
+ * @listtip Safari 浏览器在进行 RTM 拉流时不支持使用此配置。
5614
5632
  */
5615
5633
  /** {en}
5616
- * @brief
5634
+ * @brief Whether the processing method for re-pulling the stream after pausing is seamless replacement.
5635
+ * - `true`: Yes, there will be no black screen phenomenon during re-pulling the stream.
5636
+ * - `false`: No, there will be a black screen phenomenon during re-pulling the stream.
5637
+ * :::tip
5638
+ * Safari browsers do not support using this configuration when performing RTM stream pulling.
5639
+ * :::
5640
+ * @default false
5617
5641
  */
5618
5642
  seamlesslyReload?: boolean;
5619
5643
  /** {zh}
5620
- * @brief 暂停后多久断流,默认不断流。
5644
+ * @brief 暂停播放后的断联时间,单位为秒,默认不断联。
5645
+ * @listtip Safari 浏览器在进行 RTM 拉流时,如果出现断联,重新拉流时会出现短暂黑屏或加载情况。
5621
5646
  */
5622
5647
  /** {en}
5623
- * @brief
5648
+ * @brief The disconnection time after pausing playback is in seconds. By default, there is no disconnection.
5649
+ * @listtip When Safari browser performs RTM streaming, if there is a disconnection, there will be a short black screen or loading situation when re-streaming.
5624
5650
  */
5625
5651
  disconnectTime?: number;
5652
+ /** {zh}
5653
+ * @hidden
5654
+ */
5655
+ /** {en}
5656
+ * @hidden
5657
+ */
5658
+ enableOriginSdpLogger?: boolean;
5626
5659
  }
5627
5660
  /** {zh}
5628
5661
  * @list option
@@ -5662,14 +5695,14 @@ interface Flv {
5662
5695
  loadTimeout?: number;
5663
5696
  /** {zh}
5664
5697
  * @brief 播放器发起 FLV 拉流请求时,是否开启低延时。例如,当您开启低延时且推流端 GOP 设置为 2s 的情况下,FLV 拉流平均端到端延时约为 2s。
5665
- * - true:开启
5666
- * - false:关闭
5698
+ * - `true`:开启;
5699
+ * - `false`:关闭
5667
5700
  * @default false
5668
5701
  */
5669
5702
  /** {en}
5670
5703
  * @brief Whether to enable low latency when playing an FLV address. For example, if you have enabled low latency, and set GOP to 2 seconds, the average latency will be around 2 seconds.
5671
- * - true: Enable
5672
- * - false: Disable
5704
+ * - `true`: Enable;
5705
+ * - `false`: Disable.
5673
5706
  * @default false
5674
5707
  */
5675
5708
  enableLowLatency?: boolean;
@@ -5703,23 +5736,24 @@ interface Flv {
5703
5736
  */
5704
5737
  maxReaderInterval?: number;
5705
5738
  /** {zh}
5706
- * @brief
5707
- * 直播暂停时的断流等待时间,单位为秒,默认值为 0,表示直播暂停时即断流。
5739
+ * @brief 暂停播放后的断联时间,单位为秒,默认值为 0,表示暂停播放后立即断联。
5708
5740
  * @default 0
5709
5741
  */
5710
5742
  /** {en}
5711
- * @brief The waiting time for disconnection during live streaming suspension, measured in seconds. The default value is 0, indicating immediate disconnection when live streaming is suspended.
5743
+ * @brief The disconnection time after pausing playback is in seconds. The default value is 0, indicating immediate disconnection after pausing playback.
5712
5744
  * @default 0
5713
5745
  */
5714
5746
  disconnectTime?: number;
5715
5747
  /** {zh}
5716
- * @brief 断流后重新拉流是否无缝,无缝拉流时重新拉流不会出现黑帧。
5717
- * - `true`:是;
5718
- * - `false`:否。
5748
+ * @brief 暂停后重新拉流的处理方式是否为无缝替换。
5749
+ * - `true`:是,重新拉流期间不会出现黑屏现象。
5750
+ * - `false`:否,重新拉流期间会出现黑屏现象。
5719
5751
  * @default false
5720
5752
  */
5721
5753
  /** {en}
5722
- * @brief Whether re-pulling the stream after disconnection is seamless. When seamless stream pulling, there will be no black frames during re-pulling. - `true`: Yes; - `false`: No.
5754
+ * @brief Whether the processing method for re-pulling the stream after pausing is seamless replacement.
5755
+ * - `true`: Yes, there will be no black screen phenomenon during re-pulling the stream.
5756
+ * - `false`: No, there will be a black screen phenomenon during re-pulling the stream.
5723
5757
  * @default false
5724
5758
  */
5725
5759
  seamlesslyReload?: boolean;
@@ -5742,14 +5776,14 @@ interface LowLatency {
5742
5776
  abrPts?: string | number;
5743
5777
  /** {zh}
5744
5778
  * @brief FLV 低延时模式下,是否开启倍速追帧。
5745
- * - true:开启;
5746
- * - false:关闭。
5779
+ * - `true`:开启;
5780
+ * - `false`:关闭。
5747
5781
  * @default true
5748
5782
  */
5749
5783
  /** {en}
5750
5784
  * @brief Whether to enable speed-up frame chasing in FLV low latency mode.
5751
- * - true: enabled;
5752
- * - false: disabled.
5785
+ * - `true`: enabled;
5786
+ * - `false`: disabled.
5753
5787
  * @default true
5754
5788
  */
5755
5789
  enableFrameChasing?: boolean;
@@ -6427,7 +6461,7 @@ declare function isRTMSupported(): Promise<boolean>;
6427
6461
  * @returns
6428
6462
  */
6429
6463
  declare function isRTMSupportCodec(codec?: string): Promise<boolean>;
6430
- declare function isFLVSupported(): boolean;
6464
+ declare function isFLVSupported(codec?: string): boolean;
6431
6465
  declare module MobilePlayerPanelWrapper {
6432
6466
  export { MobilePlayerPanel };
6433
6467
  }
@@ -8975,13 +9009,13 @@ declare namespace live {
8975
9009
  */
8976
9010
  interface Fullscreen {
8977
9011
  /** {zh}
8978
- * @brief 切换全屏时,是否旋转为横屏播放,通常在移动端使用。如果开启横屏播放,切换全屏时,将在竖屏状态下把播放器旋转 90 度,实现横屏效果。该配置优先级高于 useCssFullscreen。
8979
- * - `true`:使用旋转横屏;
8980
- * - `false`:不使用旋转横屏。
9012
+ * @brief 切换全屏时,是否旋转为横屏播放,通常在移动端使用。如果开启横屏播放,切换全屏时,将在竖屏状态下把播放器旋转 90 度,实现横屏效果。该配置优先级低于 useCssFullscreen。
9013
+ * - `true`:使用旋转横屏;
9014
+ * - `false`:不使用旋转横屏。
8981
9015
  * @default false
8982
9016
  */
8983
9017
  /** {en}
8984
- * @brief Whether to play the video in landscape mode when the video enters full-screen mode. This feature is usually used on mobile devices. Once enabled, when the video enters fullscreen mode, the player will be rotated from portrait mode by 90 degrees to landscape mode. This property has a higher priority over `useCssFullscreen`.
9018
+ * @brief Whether to play the video in landscape mode when the video enters full-screen mode. This feature is usually used on mobile devices. Once enabled, when the video enters fullscreen mode, the player will be rotated from portrait mode by 90 degrees to landscape mode. This property has a lower priority than `useCssFullscreen`.
8985
9019
  * - `true`: Enable.
8986
9020
  * - `false`: Disable.
8987
9021
  * @default false
@@ -9867,17 +9901,17 @@ declare namespace live {
9867
9901
  /** {zh}
9868
9902
  * @detail api
9869
9903
  * @brief 当前浏览器是否支持播放编码格式。
9870
- * @param codec 编码格式。
9871
- * - `Codec.H264`: 返回当前浏览器是否支持 MediaSource Extends。
9872
- * - `Codec.H265`: 返回当前浏览器是否支持硬解播放 H265。
9904
+ * @param codec 编码格式,支持以下选择。
9905
+ * - `Codec.H264`: 检查 MSE 是否支持 H.264 编码格式。
9906
+ * - `Codec.H265`: 检查 MSE 是否支持 H.265 编码格式。
9873
9907
  * @returns
9874
9908
  */
9875
9909
  /** {en}
9876
9910
  * @detail api
9877
9911
  * @brief Checkes whether the current browser supports the specified encoding format.
9878
- * @param codec The encoding format.
9879
- * - `Codec.H264`: Checks whether the current browser supports MediaSource Extends.
9880
- * - `Codec.H265`: Checks whether the current browser supports H.265 using hardware decoding.
9912
+ * @param codec Code format supports the following options.
9913
+ * - `Codec.H264`: Check whether MSE supports H.264 encoding format.
9914
+ * - `Codec.H265`: Check whether MSE supports H.265 encoding format.
9881
9915
  * @returns
9882
9916
  */
9883
9917
  function isMseSupported(codec?: string): boolean;
@@ -9892,7 +9926,27 @@ declare namespace live {
9892
9926
  * @returns
9893
9927
  */
9894
9928
  function isSoftDecodeSupported(): Promise<boolean>;
9895
- function isMMSSupported(): boolean;
9929
+ /** {zh}
9930
+ * @detail api
9931
+ * @brief 判断当前浏览器是否支持 MMS(ManagedMediaSource) API,如果支持的话可满足大部分 H.264 视频播放。
9932
+ * :::tip
9933
+ * - 当前方法无法判断是否支持 H.265 视频播放。
9934
+ * - 使用场景:检查 Safari 浏览器是否满足 H.264 编码流拉流要求。
9935
+ * - Safari 17.1 以上版本浏览器开始支持 MMS。
9936
+ * :::
9937
+ * @returns
9938
+ */
9939
+ /** {en}
9940
+ * @detail api
9941
+ * @returns
9942
+ * @brief Determine whether the current browser supports the MMS (ManagedMediaSource) API, if so, it can meet most of the H.264 playback.
9943
+ * :::tip
9944
+ * - The current method cannot determine whether H.265 video playback is supported.
9945
+ * - Usage scenario: Check whether Safari browser meets the requirements for pulling H.264 encoded streams.
9946
+ * - Browsers with iOS 17.1 or above start to support MMS.
9947
+ * :::
9948
+ */
9949
+ function isMMSSupported(codec?: string): any;
9896
9950
  const util: {
9897
9951
  getStreamType: typeof getStreamType;
9898
9952
  isMseSupported: typeof isMseSupported;
@@ -10134,6 +10188,7 @@ declare namespace live {
10134
10188
  }
10135
10189
  const EN$0: {
10136
10190
  INVALID_PARAMETER: string;
10191
+ INVALID_LOGGER: string;
10137
10192
  FORMAT: string;
10138
10193
  FPS: string;
10139
10194
  BITRATE: string;
@@ -10206,6 +10261,7 @@ declare namespace live {
10206
10261
  };
10207
10262
  const ZH_CN$0: {
10208
10263
  INVALID_PARAMETER: string;
10264
+ INVALID_LOGGER: string;
10209
10265
  FORMAT: string;
10210
10266
  FPS: string;
10211
10267
  BITRATE: string;
@@ -10278,6 +10334,10 @@ declare namespace live {
10278
10334
  };
10279
10335
  type TextKey$0 = keyof typeof EN$0;
10280
10336
  const VeError$0: typeof error.VeError;
10337
+ // ve 自定义错误码
10338
+ // 第一位: 1 表示点播,2 表示直播
10339
+ // 第二位: 功能粒度,比如 210 中 1 表示入参参数有问题
10340
+ // 第三位: 某功能下细分,如果细拆成地址有问题就可以用 211 表示。
10281
10341
  enum LiveErrorCode {
10282
10342
  /** {zh}
10283
10343
  * @brief 参数错误
@@ -10287,7 +10347,16 @@ declare namespace live {
10287
10347
  * @brief Parameter errors.
10288
10348
  * @solution Please check whether the required parameters `url` and `playlist` are specified.
10289
10349
  */
10290
- INVALID_PARAMETER = 210
10350
+ INVALID_PARAMETER = 210,
10351
+ /** {zh}
10352
+ * @brief 日志错误
10353
+ * @solution 未正确配置质量日志参数, 请参考 https://www.volcengine.com/docs/6469/138655#日志上报 配置。
10354
+ */
10355
+ /** {en}
10356
+ * @brief Log errors.
10357
+ * @solution Log options not configured correctly. Please refer to this document https://docs.byteplus.com/en/docs/byteplus-media-live/docs-feature-implementation#uploading-logs to configure the logs.
10358
+ */
10359
+ INVALID_LOGGER = 220
10291
10360
  }
10292
10361
  const Level$0: typeof error.Level;
10293
10362
  type ErrorInfo$0 = error.ErrorInfo;
@@ -10341,10 +10410,11 @@ declare namespace live {
10341
10410
  MODULE_LOAD_ERROR: error.ErrorCode.MODULE_LOAD_ERROR;
10342
10411
  UNKNOWN: error.ErrorCode.UNKNOWN;
10343
10412
  INVALID_PARAMETER: LiveErrorCode.INVALID_PARAMETER;
10413
+ INVALID_LOGGER: LiveErrorCode.INVALID_LOGGER;
10344
10414
  };
10345
10415
  type ValueOf<T> = T[keyof T];
10346
10416
  const ERRORS: Partial<Record<ValueOf<typeof ErrorCode$0>, error.ErrorInfo<TextKey$0>>>;
10347
- function create$0(errorCode: ValueOf<typeof ErrorCode$0>, i18n?: VeI18n<TextKey$0>): error.VeError<"DEFINITION_FALLBACK_TOAST" | "DEFINITION_SWITCHING" | "ERROR_REFRESH" | "UNMUTE" | "MANIFEST" | "NETWORK" | "NETWORK_TIMEOUT" | "NETWORK_FORBIDDEN" | "NETWORK_NOTFOUND" | "DEMUX" | "REMUX" | "MEDIA" | "MEDIA_ERR_CODEC_NOT_SUPPORTED" | "MEDIA_ERR_URL_EMPTY" | "DRM" | "DRM_LICENSE" | "OTHER" | "RUNTIME" | "MODULE_LOAD_ERROR" | "UNKNOWN" | "ERROR_TYPES" | "HAVE_NOTHING" | "HAVE_METADATA" | "HAVE_CURRENT_DATA" | "HAVE_FUTURE_DATA" | "HAVE_ENOUGH_DATA" | "NETWORK_EMPTY" | "NETWORK_IDLE" | "NETWORK_LOADING" | "NETWORK_NO_SOURCE" | "MEDIA_ERR_ABORTED" | "MEDIA_ERR_NETWORK" | "MEDIA_ERR_DECODE" | "MEDIA_ERR_SRC_NOT_SUPPORTED" | "REPLAY" | "ERROR" | "PLAY_TIPS" | "PAUSE_TIPS" | "PLAYNEXT_TIPS" | "DOWNLOAD_TIPS" | "ROTATE_TIPS" | "RELOAD_TIPS" | "FULLSCREEN_TIPS" | "EXITFULLSCREEN_TIPS" | "CSSFULLSCREEN_TIPS" | "EXITCSSFULLSCREEN_TIPS" | "TEXTTRACK" | "PIP" | "SCREENSHOT" | "LIVE" | "OFF" | "OPEN" | "MINI_DRAG" | "MINISCREEN" | "REFRESH_TIPS" | "REFRESH" | "FORWARD" | "LIVE_TIP" | "GOP" | "INVALID_PARAMETER" | "FORMAT" | "FPS" | "BITRATE" | "RESOLUTION" | "ENCODE_TYPE" | "BUFFER_END" | "CURRENT_TIME" | "DECODE_EFFICIENCY" | "DECODE_COST" | "DECODE_INFO">;
10417
+ function create$0(errorCode: ValueOf<typeof ErrorCode$0>, i18n?: VeI18n<TextKey$0>): error.VeError<"DEFINITION_FALLBACK_TOAST" | "DEFINITION_SWITCHING" | "ERROR_REFRESH" | "UNMUTE" | "MANIFEST" | "NETWORK" | "NETWORK_TIMEOUT" | "NETWORK_FORBIDDEN" | "NETWORK_NOTFOUND" | "DEMUX" | "REMUX" | "MEDIA" | "MEDIA_ERR_CODEC_NOT_SUPPORTED" | "MEDIA_ERR_URL_EMPTY" | "DRM" | "DRM_LICENSE" | "OTHER" | "RUNTIME" | "MODULE_LOAD_ERROR" | "UNKNOWN" | "ERROR_TYPES" | "HAVE_NOTHING" | "HAVE_METADATA" | "HAVE_CURRENT_DATA" | "HAVE_FUTURE_DATA" | "HAVE_ENOUGH_DATA" | "NETWORK_EMPTY" | "NETWORK_IDLE" | "NETWORK_LOADING" | "NETWORK_NO_SOURCE" | "MEDIA_ERR_ABORTED" | "MEDIA_ERR_NETWORK" | "MEDIA_ERR_DECODE" | "MEDIA_ERR_SRC_NOT_SUPPORTED" | "REPLAY" | "ERROR" | "PLAY_TIPS" | "PAUSE_TIPS" | "PLAYNEXT_TIPS" | "DOWNLOAD_TIPS" | "ROTATE_TIPS" | "RELOAD_TIPS" | "FULLSCREEN_TIPS" | "EXITFULLSCREEN_TIPS" | "CSSFULLSCREEN_TIPS" | "EXITCSSFULLSCREEN_TIPS" | "TEXTTRACK" | "PIP" | "SCREENSHOT" | "LIVE" | "OFF" | "OPEN" | "MINI_DRAG" | "MINISCREEN" | "REFRESH_TIPS" | "REFRESH" | "FORWARD" | "LIVE_TIP" | "GOP" | "INVALID_PARAMETER" | "INVALID_LOGGER" | "FORMAT" | "FPS" | "BITRATE" | "RESOLUTION" | "ENCODE_TYPE" | "BUFFER_END" | "CURRENT_TIME" | "DECODE_EFFICIENCY" | "DECODE_COST" | "DECODE_INFO">;
10348
10418
  /** {zh}
10349
10419
  * @list option
10350
10420
  * @kind property
@@ -10450,7 +10520,7 @@ declare namespace live {
10450
10520
  /** {en}
10451
10521
  * @brief The SDK application ID. You can access it by logging in to the BytePlus MediaLive console and navigating to [SDK Management](https://console.byteplus.com/live/main/sdk).
10452
10522
  */
10453
- appId: string;
10523
+ appId?: string;
10454
10524
  /** {zh}
10455
10525
  * @brief 应用名称。
10456
10526
  * @default 无
@@ -10534,23 +10604,25 @@ declare namespace live {
10534
10604
  */
10535
10605
  rtm?: Rtm;
10536
10606
  /** {zh}
10537
- * @brief 为播放器设置 FLV 拉流配置。FLV 格式流相关配置仅适用于支持 MSE 播放的 PC 端浏览器和安卓端浏览器。
10607
+ * @brief 为播放器设置 FLV 拉流配置。
10608
+ * @listtip FLV 拉流格式流相关配置适用于支持 MSE 播放的 PC 端浏览器、安卓端浏览器和支持 MMS API 的 iOS 浏览器。
10538
10609
  */
10539
10610
  /** {en}
10540
- * @brief Configurations for playing an FLV stream. You can only play FLV streams with web browsers on PC and Android devices, and the browsers need to support Media Source Extensions (MSE) playback.
10611
+ * @brief Configurations for playing an FLV stream.
10612
+ * @listtip FLV pull stream format stream configurations are applicable to PC browsers, Android browsers that support MSE playback, and iOS browsers that support MMS API.
10541
10613
  */
10542
10614
  flv?: Flv;
10543
10615
  /** {zh}
10544
- * @brief 为播放器设置 HLS 拉流配置。HLS 格式流相关配置仅适用于支持 MSE 播放的 PC 端浏览器和安卓端浏览器。
10545
- * @listtip
10546
- * - PC 端该配置默认生效;
10547
- * - 移动端仅在 `enableMSE` 设置为 `true` 且支持 MSE 的浏览器中生效。
10616
+ * @brief 为播放器设置 HLS 拉流配置。
10617
+ * @listtip - HLS 格式流相关配置仅适用于支持 MSE API的 PC 端浏览器和安卓端浏览器。
10618
+ * - PC 端该配置默认生效;
10619
+ * - 移动端仅在 `enableMSE` 设置为 `true` 且支持 MSE 的浏览器中生效。
10548
10620
  */
10549
10621
  /** {en}
10550
- * @brief Configurations for playing an HLS stream. You can only play HLS streams with web browsers on PC and Android devices, and the browsers need to support Media Source Extensions (MSE) playback.
10551
- * @listtip
10552
- * - This configuration takes effect by default on PC;
10553
- * - For mobile devices, the configuration takes effect only when `enableMSE` is set to `true` for the browser.
10622
+ * @brief Configurations for playing an HLS stream.
10623
+ * @listtip - The HLS format stream configuration is only applicable to PC browsers and Android browsers that support the MSE API.
10624
+ * - This configuration takes effect by default on PC;
10625
+ * - For mobile devices, the configuration takes effect only when `enableMSE` is set to `true` for the browser.
10554
10626
  */
10555
10627
  hls?: Hls;
10556
10628
  /** {zh}
@@ -10609,14 +10681,14 @@ declare namespace live {
10609
10681
  interface Abr {
10610
10682
  /** {zh}
10611
10683
  * @brief 是否开启 FLV 拉流时的自适应码率(ABR)功能,默认为开启。
10612
- * - true: 开启
10613
- * - false: 关闭
10684
+ * - `true`: 开启;
10685
+ * - `false`: 关闭。
10614
10686
  * @default true
10615
10687
  */
10616
10688
  /** {en}
10617
10689
  * @brief Enable or disable the Adaptive Bitrate (ABR) feature. The default setting is enabled.
10618
- * - true: Enable;
10619
- * - false: Disable.
10690
+ * - `true`: Enable;
10691
+ * - `false`: Disable.
10620
10692
  */
10621
10693
  enable?: boolean;
10622
10694
  /** {zh}
@@ -10635,14 +10707,14 @@ declare namespace live {
10635
10707
  downTip?: boolean;
10636
10708
  /** {zh}
10637
10709
  * @brief 是否开始调试模式,默认为关闭。
10638
- * - true: 开启;
10639
- * - false: 关闭。
10710
+ * - `true`: 开启;
10711
+ * - `false`: 关闭。
10640
10712
  * @default false
10641
10713
  */
10642
10714
  /** {en}
10643
10715
  * @brief Whether to start debug mode, default is false.
10644
- * - true: Enable,
10645
- * - false: Disable.
10716
+ * - `true`: Enable,
10717
+ * - `false`: Disable.
10646
10718
  * @default false
10647
10719
  */
10648
10720
  debug?: boolean;
@@ -10880,16 +10952,16 @@ declare namespace live {
10880
10952
  retryDelay?: number;
10881
10953
  /** {zh}
10882
10954
  * @brief 播放器发起 RTM 拉流请求时,是否开启自动转码。
10883
- * - true:开启
10884
- * - false:关闭
10955
+ * - `true`:开启;
10956
+ * - `false`:关闭。
10885
10957
  * @listtip
10886
10958
  * 如有使用 RTM 拉流自动转码的需求,请先创建工单联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)进行配置。
10887
10959
  * @default false
10888
10960
  */
10889
10961
  /** {en}
10890
10962
  * @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
10891
- * - true: Enable
10892
- * - false: Disable
10963
+ * - `true`: Enable;
10964
+ * - `false`: Disable.
10893
10965
  * @listtip
10894
10966
  * If you want to use the automatic transcoding feature when playing an RTM stream, contact your [technical support](https://www.byteplus.com/en/support).
10895
10967
  * @default false
@@ -10904,20 +10976,38 @@ declare namespace live {
10904
10976
  */
10905
10977
  networkEvaluateInterval?: number;
10906
10978
  /** {zh}
10907
- * @brief 断流后重新拉流是否无缝播放。
10979
+ * @brief 暂停后重新拉流的处理方式是否为无缝替换。
10980
+ * - `true`:是,重新拉流期间不会出现黑屏现象。
10981
+ * - `false`:否,重新拉流期间会出现黑屏现象。
10908
10982
  * @default false
10983
+ * @listtip Safari 浏览器在进行 RTM 拉流时不支持使用此配置。
10909
10984
  */
10910
10985
  /** {en}
10911
- * @brief
10986
+ * @brief Whether the processing method for re-pulling the stream after pausing is seamless replacement.
10987
+ * - `true`: Yes, there will be no black screen phenomenon during re-pulling the stream.
10988
+ * - `false`: No, there will be a black screen phenomenon during re-pulling the stream.
10989
+ * :::tip
10990
+ * Safari browsers do not support using this configuration when performing RTM stream pulling.
10991
+ * :::
10992
+ * @default false
10912
10993
  */
10913
10994
  seamlesslyReload?: boolean;
10914
10995
  /** {zh}
10915
- * @brief 暂停后多久断流,默认不断流。
10996
+ * @brief 暂停播放后的断联时间,单位为秒,默认不断联。
10997
+ * @listtip Safari 浏览器在进行 RTM 拉流时,如果出现断联,重新拉流时会出现短暂黑屏或加载情况。
10916
10998
  */
10917
10999
  /** {en}
10918
- * @brief
11000
+ * @brief The disconnection time after pausing playback is in seconds. By default, there is no disconnection.
11001
+ * @listtip When Safari browser performs RTM streaming, if there is a disconnection, there will be a short black screen or loading situation when re-streaming.
10919
11002
  */
10920
11003
  disconnectTime?: number;
11004
+ /** {zh}
11005
+ * @hidden
11006
+ */
11007
+ /** {en}
11008
+ * @hidden
11009
+ */
11010
+ enableOriginSdpLogger?: boolean;
10921
11011
  }
10922
11012
  /** {zh}
10923
11013
  * @list option
@@ -10957,14 +11047,14 @@ declare namespace live {
10957
11047
  loadTimeout?: number;
10958
11048
  /** {zh}
10959
11049
  * @brief 播放器发起 FLV 拉流请求时,是否开启低延时。例如,当您开启低延时且推流端 GOP 设置为 2s 的情况下,FLV 拉流平均端到端延时约为 2s。
10960
- * - true:开启
10961
- * - false:关闭
11050
+ * - `true`:开启;
11051
+ * - `false`:关闭
10962
11052
  * @default false
10963
11053
  */
10964
11054
  /** {en}
10965
11055
  * @brief Whether to enable low latency when playing an FLV address. For example, if you have enabled low latency, and set GOP to 2 seconds, the average latency will be around 2 seconds.
10966
- * - true: Enable
10967
- * - false: Disable
11056
+ * - `true`: Enable;
11057
+ * - `false`: Disable.
10968
11058
  * @default false
10969
11059
  */
10970
11060
  enableLowLatency?: boolean;
@@ -10998,23 +11088,24 @@ declare namespace live {
10998
11088
  */
10999
11089
  maxReaderInterval?: number;
11000
11090
  /** {zh}
11001
- * @brief
11002
- * 直播暂停时的断流等待时间,单位为秒,默认值为 0,表示直播暂停时即断流。
11091
+ * @brief 暂停播放后的断联时间,单位为秒,默认值为 0,表示暂停播放后立即断联。
11003
11092
  * @default 0
11004
11093
  */
11005
11094
  /** {en}
11006
- * @brief The waiting time for disconnection during live streaming suspension, measured in seconds. The default value is 0, indicating immediate disconnection when live streaming is suspended.
11095
+ * @brief The disconnection time after pausing playback is in seconds. The default value is 0, indicating immediate disconnection after pausing playback.
11007
11096
  * @default 0
11008
11097
  */
11009
11098
  disconnectTime?: number;
11010
11099
  /** {zh}
11011
- * @brief 断流后重新拉流是否无缝,无缝拉流时重新拉流不会出现黑帧。
11012
- * - `true`:是;
11013
- * - `false`:否。
11100
+ * @brief 暂停后重新拉流的处理方式是否为无缝替换。
11101
+ * - `true`:是,重新拉流期间不会出现黑屏现象。
11102
+ * - `false`:否,重新拉流期间会出现黑屏现象。
11014
11103
  * @default false
11015
11104
  */
11016
11105
  /** {en}
11017
- * @brief Whether re-pulling the stream after disconnection is seamless. When seamless stream pulling, there will be no black frames during re-pulling. - `true`: Yes; - `false`: No.
11106
+ * @brief Whether the processing method for re-pulling the stream after pausing is seamless replacement.
11107
+ * - `true`: Yes, there will be no black screen phenomenon during re-pulling the stream.
11108
+ * - `false`: No, there will be a black screen phenomenon during re-pulling the stream.
11018
11109
  * @default false
11019
11110
  */
11020
11111
  seamlesslyReload?: boolean;
@@ -11037,14 +11128,14 @@ declare namespace live {
11037
11128
  abrPts?: string | number;
11038
11129
  /** {zh}
11039
11130
  * @brief FLV 低延时模式下,是否开启倍速追帧。
11040
- * - true:开启;
11041
- * - false:关闭。
11131
+ * - `true`:开启;
11132
+ * - `false`:关闭。
11042
11133
  * @default true
11043
11134
  */
11044
11135
  /** {en}
11045
11136
  * @brief Whether to enable speed-up frame chasing in FLV low latency mode.
11046
- * - true: enabled;
11047
- * - false: disabled.
11137
+ * - `true`: enabled;
11138
+ * - `false`: disabled.
11048
11139
  * @default true
11049
11140
  */
11050
11141
  enableFrameChasing?: boolean;