@volcengine/veplayer 2.8.0-rc.1 → 2.8.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
@@ -9,7 +9,7 @@ import XG_EN from "xgplayer/es/lang/en";
9
9
  import XG_ZH_CN from "xgplayer/es/lang/zh-cn";
10
10
  import OptionList from "xgplayer/es/plugins/common/optionList";
11
11
  import { default as XGPlayer } from "xgplayer/es/player";
12
- import Poster from "xgplayer/es/plugins/poster";
12
+ import Poster$0 from "xgplayer/es/plugins/poster";
13
13
  import Start from "xgplayer/es/plugins/start";
14
14
  import Enter from "xgplayer/es/plugins/enter";
15
15
  import PC from "xgplayer/es/plugins/pc";
@@ -40,6 +40,15 @@ declare const EN: {
40
40
  MEDIA_ERR_URL_EMPTY: string;
41
41
  DRM: string;
42
42
  DRM_LICENSE: string;
43
+ DRM_UNSUPPORTED: string;
44
+ DRM_NO_MEDIA_KEY: string;
45
+ DRM_NO_KEY_SESSION: string;
46
+ DRM_GENERATE_QUEST_FAIL: string;
47
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
48
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
49
+ DRM_LICENSE_FAIL: string;
50
+ DRM_KEY_ERROR: string;
51
+ DRM_CERT_FAIL: string;
43
52
  OTHER: string;
44
53
  RUNTIME: string;
45
54
  MODULE_LOAD_ERROR: string;
@@ -100,6 +109,15 @@ declare const ZH_CN: {
100
109
  MEDIA_ERR_URL_EMPTY: string;
101
110
  DRM: string;
102
111
  DRM_LICENSE: string;
112
+ DRM_UNSUPPORTED: string;
113
+ DRM_NO_MEDIA_KEY: string;
114
+ DRM_NO_KEY_SESSION: string;
115
+ DRM_GENERATE_QUEST_FAIL: string;
116
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
117
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
118
+ DRM_LICENSE_FAIL: string;
119
+ DRM_KEY_ERROR: string;
120
+ DRM_CERT_FAIL: string;
103
121
  OTHER: string;
104
122
  RUNTIME: string;
105
123
  MODULE_LOAD_ERROR: string;
@@ -228,6 +246,14 @@ interface ExposedDefinition {
228
246
  *
229
247
  */
230
248
  fallbackUrls?: string[];
249
+ /** {zh}
250
+ * @hidden
251
+ * @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
252
+ */
253
+ /** {en}
254
+ * @hidden
255
+ * @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
256
+ */
231
257
  type?: string;
232
258
  }
233
259
  /** {zh}
@@ -497,7 +523,7 @@ declare enum ErrorCode {
497
523
  */
498
524
  /** {en}
499
525
  * @brief Video parsing error.
500
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
526
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
501
527
  */
502
528
  MANIFEST_HLS_ERROR = 1100,
503
529
  /** {zh}
@@ -506,7 +532,7 @@ declare enum ErrorCode {
506
532
  */
507
533
  /** {en}
508
534
  * @brief Video parsing error.
509
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
535
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
510
536
  */
511
537
  MANIFEST_DASH_ERROR = 1200,
512
538
  /** {zh}
@@ -560,7 +586,7 @@ declare enum ErrorCode {
560
586
  */
561
587
  /** {en}
562
588
  * @brief Video parsing error.
563
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
589
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
564
590
  */
565
591
  DEMUX_FLV_ERROR = 3100,
566
592
  /** {zh}
@@ -569,7 +595,7 @@ declare enum ErrorCode {
569
595
  */
570
596
  /** {en}
571
597
  * @brief Video parsing error.
572
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
598
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
573
599
  */
574
600
  DEMUX_HLS_ERROR = 3200,
575
601
  /** {zh}
@@ -579,8 +605,7 @@ declare enum ErrorCode {
579
605
  */
580
606
  /** {en}
581
607
  * @brief Video parsing error.
582
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
583
- *
608
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
584
609
  */
585
610
  DEMUX_MP4_ERROR = 3300,
586
611
  /** {zh}
@@ -590,8 +615,7 @@ declare enum ErrorCode {
590
615
  */
591
616
  /** {en}
592
617
  * @brief Video parsing error.
593
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
594
- *
618
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
595
619
  */
596
620
  DEMUX_FMP4_ERROR = 3400,
597
621
  /** {zh}
@@ -601,8 +625,7 @@ declare enum ErrorCode {
601
625
  */
602
626
  /** {en}
603
627
  * @brief Video parsing error.
604
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
605
- *
628
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
606
629
  */
607
630
  DEMUX_SIDX_ERROR = 3410,
608
631
  /** {zh}
@@ -612,8 +635,7 @@ declare enum ErrorCode {
612
635
  */
613
636
  /** {en}
614
637
  * @brief Video parsing error.
615
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
616
- *
638
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
617
639
  */
618
640
  REMUX_FMP4_ERROR = 4100,
619
641
  /** {zh}
@@ -623,8 +645,7 @@ declare enum ErrorCode {
623
645
  */
624
646
  /** {en}
625
647
  * @brief Video parsing error.
626
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
627
- *
648
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
628
649
  */
629
650
  REMUX_MP4_ERROR = 4200,
630
651
  /** {zh}
@@ -654,10 +675,9 @@ declare enum ErrorCode {
654
675
  */
655
676
  /** {en}
656
677
  * @brief An error occurred to the browser while decoding the media resources.
657
- * @solution
658
- * 1. Check whether there is any issue with the original video.
659
- * 2. Re-transcode the video and play it again.
660
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
678
+ * @solution 1. Check whether there is any issue with the original video.
679
+ * 2. Re-transcode the video and play it again.
680
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
661
681
  */
662
682
  MEDIA_ERR_DECODE = 5103,
663
683
  /** {zh}
@@ -669,10 +689,9 @@ declare enum ErrorCode {
669
689
  */
670
690
  /** {en}
671
691
  * @brief The video cannot be loaded due to unsupported video format or server or network issues.
672
- * @solution
673
- * 1. Check whether there is any issue with the browser's request.
674
- * 2. Check whether the browser and the current page support the video format.
675
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
692
+ * @solution 1. Check whether there is any issue with the browser's request.
693
+ * 2. Check whether the browser and the current page support the video format.
694
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
676
695
  */
677
696
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
678
697
  /** {zh}
@@ -684,10 +703,9 @@ declare enum ErrorCode {
684
703
  */
685
704
  /** {en}
686
705
  * @brief The current browser does not support video decoding.
687
- * @solution
688
- * 1. Check whether there is any issue with the browser's request.
689
- * 2. Check whether the browser and the current page support the video format.
690
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
706
+ * @solution 1. Check whether there is any issue with the browser's request.
707
+ * 2. Check whether the browser and the current page support the video format.
708
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
691
709
  */
692
710
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
693
711
  /** {zh}
@@ -705,7 +723,7 @@ declare enum ErrorCode {
705
723
  */
706
724
  /** {en}
707
725
  * @brief A playback issue occurred.
708
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
726
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
709
727
  */
710
728
  MEDIA_MSE_ADD_SB = 5200,
711
729
  /** {zh}
@@ -714,7 +732,7 @@ declare enum ErrorCode {
714
732
  */
715
733
  /** {en}
716
734
  * @brief A playback issue occurred.
717
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
735
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
718
736
  */
719
737
  MEDIA_MSE_APPEND_BUFFER = 5201,
720
738
  /** {zh}
@@ -723,7 +741,7 @@ declare enum ErrorCode {
723
741
  */
724
742
  /** {en}
725
743
  * @brief A playback issue occurred.
726
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
744
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
727
745
  */
728
746
  MEDIA_MSE_OTHER = 5202,
729
747
  /** {zh}
@@ -732,7 +750,7 @@ declare enum ErrorCode {
732
750
  */
733
751
  /** {en}
734
752
  * @brief A playback issue occurred.
735
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
753
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
736
754
  */
737
755
  MEDIA_MSE_FULL = 5203,
738
756
  /** {zh}
@@ -741,7 +759,7 @@ declare enum ErrorCode {
741
759
  */
742
760
  /** {en}
743
761
  * @brief A playback issue occurred.
744
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
762
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
745
763
  */
746
764
  MEDIA_MSE_HIJACK = 5204,
747
765
  /** {zh}
@@ -750,25 +768,92 @@ declare enum ErrorCode {
750
768
  */
751
769
  /** {en}
752
770
  * @brief A playback issue occurred.
753
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
771
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
754
772
  */
755
773
  MEDIA_EME_HIJACK = 5301,
756
774
  /** {zh}
757
775
  * @brief DRM 权限校验失败
758
776
  * @hidden
777
+ * @solution 请检查权限配置,确保播放权限正确。
759
778
  */
760
779
  /** {en}
761
780
  * @brief DRM authentication failed.
762
781
  * @hidden
782
+ * @solution Verify the authentication and ensure proper playback permissions.
763
783
  */
764
784
  DRM_LICENSE = 7100,
785
+ /** {zh}
786
+ * @brief 不支持 DRM 加密播放
787
+ */
788
+ /** {en}
789
+ * @brief DRM encrypted playback is not supported
790
+ */
791
+ DRM_UNSUPPORTED = 7101,
792
+ /** {zh}
793
+ * @brief 视频数据缺少相应 MediaKey
794
+ */
795
+ /** {en}
796
+ * @brief Video data lacks the corresponding MediaKey
797
+ */
798
+ DRM_NO_MEDIA_KEY = 7103,
799
+ /** {zh}
800
+ * @brief 浏览器不支持相应 DRM KeySession
801
+ */
802
+ /** {en}
803
+ * @brief Browser does not support the corresponding DRM KeySession
804
+ */
805
+ DRM_NO_KEY_SESSION = 7104,
806
+ /** {zh}
807
+ * @brief 解密播放错误
808
+ */
809
+ /** {en}
810
+ * @brief Decryption playback error
811
+ */
812
+ DRM_GENERATE_QUEST_FAIL = 7105,
813
+ /** {zh}
814
+ * @brief 缺少 DRM 证书请求链接
815
+ */
816
+ /** {en}
817
+ * @brief Missing DRM certificate request link
818
+ */
819
+ DRM_LACK_SERVER_CERTIFICATE_PATH = 7106,
820
+ /** {zh}
821
+ * @brief 缺少 DRM License 请求链接
822
+ */
823
+ /** {en}
824
+ * @brief Missing DRM License request link
825
+ */
826
+ DRM_LACK_SERVER_PROCESS_SPC_PATH = 7107,
827
+ /** {zh}
828
+ * @brief 请求或更新 License 失败
829
+ */
830
+ /** {en}
831
+ * @brief Request or update License failed
832
+ */
833
+ DRM_LICENSE_FAIL = 7108,
834
+ /** {zh}
835
+ * @brief 解密错误
836
+ */
837
+ /** {en}
838
+ * @brief Decryption error
839
+ */
840
+ DRM_KEY_ERROR = 7109,
841
+ /** {zh}
842
+ * @brief 请求 DRM 证书失败'
843
+ */
844
+ /** {en}
845
+ * @brief Request for DRM certificate failed'
846
+ */
847
+ DRM_CERT_FAIL = 7110,
765
848
  /** {zh}
766
849
  * @brief DRM 权限校验失败
767
850
  * @hidden
851
+ * @solution 请检查自定义 DRM 权限。
768
852
  */
769
853
  /** {en}
770
854
  * @brief DRM authentication failed.
771
855
  * @hidden
856
+ * @solution Please check the custom DRM authentication.
772
857
  */
773
858
  DRM_CUSTOM_LICENSE = 7200,
774
859
  /** {zh}
@@ -777,7 +862,7 @@ declare enum ErrorCode {
777
862
  */
778
863
  /** {en}
779
864
  * @brief A playback issue occurred.
780
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
865
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
781
866
  */
782
867
  OTHER = 8000,
783
868
  /** {zh}
@@ -786,7 +871,7 @@ declare enum ErrorCode {
786
871
  */
787
872
  /** {en}
788
873
  * @brief A playback issue occurred.
789
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
874
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
790
875
  */
791
876
  RUNTIME_NO_CANPLAY_ERROR = 9001,
792
877
  /** {zh}
@@ -795,7 +880,7 @@ declare enum ErrorCode {
795
880
  */
796
881
  /** {en}
797
882
  * @brief A playback issue occurred.
798
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
883
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
799
884
  */
800
885
  RUNTIME_BUFFERBREAK_ERROR = 9002,
801
886
  /** {zh}
@@ -804,9 +889,9 @@ declare enum ErrorCode {
804
889
  */
805
890
  /** {en}
806
891
  * @brief A playback issue occurred.
807
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
892
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
808
893
  */
809
- RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
894
+ RUNTIME_WAITING_TIMEOUT_ERROR = 9003,
810
895
  // veplayer 报错
811
896
  /** {zh}
812
897
  * @brief CDN 异步获取失败
@@ -821,9 +906,11 @@ declare enum ErrorCode {
821
906
  MODULE_LOAD_ERROR = 110,
822
907
  /** {zh}
823
908
  * @hidden
909
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
824
910
  */
825
911
  /** {en}
826
912
  * @hidden
913
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
827
914
  */
828
915
  UNKNOWN = "UNKNOWN"
829
916
  }
@@ -1001,10 +1088,12 @@ declare class Error extends Plugin {
1001
1088
  /** {zh}
1002
1089
  * @list option
1003
1090
  * @kind property
1091
+ * @hidden
1004
1092
  */
1005
1093
  /** {en}
1006
1094
  * @list option
1007
1095
  * @kind property
1096
+ * @hidden
1008
1097
  */
1009
1098
  interface DefinitionConfig {
1010
1099
  /** {zh}
@@ -1216,7 +1305,7 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1216
1305
  /** {en}
1217
1306
  * @brief The URL of the player's cover image.
1218
1307
  */
1219
- poster?: string;
1308
+ poster?: string | Poster;
1220
1309
  /** {zh}
1221
1310
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
1222
1311
  */
@@ -1589,8 +1678,7 @@ interface CommonStyle {
1589
1678
  * @brief 缓存部分进度条底色。
1590
1679
  */
1591
1680
  /** {en}
1592
- * @brief
1593
- * @brief The background color of the progress bar for the cached portion of video playback.
1681
+ * @brief The background color of the buffered portion of the progress bar.
1594
1682
  */
1595
1683
  cachedColor?: string;
1596
1684
  /** {zh}
@@ -1611,6 +1699,73 @@ interface CommonStyle {
1611
1699
  */
1612
1700
  volumeColor?: string;
1613
1701
  }
1702
+ /** {zh}
1703
+ * @list option
1704
+ * @kind property
1705
+ */
1706
+ /** {en}
1707
+ * @list option
1708
+ * @kind property
1709
+ */
1710
+ interface Poster {
1711
+ /** {zh}
1712
+ * @brief 封面图 URL 地址。
1713
+ */
1714
+ /** {en}
1715
+ * @brief The URL of the player's cover image.
1716
+ */
1717
+ poster: string;
1718
+ /** {zh}
1719
+ * @brief 是否在播放结束之后显示封面图。
1720
+ * - `true`:播放结束之后显示封面图。
1721
+ * - `false`:播放结束之后不显示封面图。
1722
+ * @default true
1723
+ */
1724
+ /** {en}
1725
+ * @brief Whether to display the cover image after playback ends.
1726
+ * - `true`:display the cover image after playback ends.
1727
+ * - `false`:not display the cover image after playback ends.
1728
+ * @default true
1729
+ */
1730
+ isEndedShow?: boolean;
1731
+ /** {zh}
1732
+ * @brief 是否播放后再隐藏封面图。
1733
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
1734
+ * - `false`:在 `play` 事件触发后隐藏封面图。
1735
+ * @default false
1736
+ */
1737
+ /** {en}
1738
+ * @brief Whether to hide the cover image after `canplay` event.
1739
+ * - `true`:hide the cover image after `canplay` event.
1740
+ * - `false`:hide the cover image after `play` event.
1741
+ * @default false
1742
+ */
1743
+ hideCanplay?: boolean;
1744
+ /** {zh}
1745
+ * @brief 是否一直显示封面图。
1746
+ * @default false
1747
+ * @hidden
1748
+ */
1749
+ /** {}
1750
+ * @hidden
1751
+ */
1752
+ notHidden?: boolean;
1753
+ /** {zh}
1754
+ * @brief 封面图填充方式。取值如下:
1755
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
1756
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
1757
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
1758
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
1759
+ */
1760
+ /** {en}
1761
+ * @brief Cover image fill mode.
1762
+ * - `fixWidth`:Fill the width of the container and crop the height if necessary.
1763
+ * - `fixHeight`:Fill the height of the container and crop the width if necessary.
1764
+ * - `cover`:Fill the entire container while keeping the original aspect ratio.
1765
+ * - `contain`:Stretch the video to fill the container.
1766
+ */
1767
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
1768
+ }
1614
1769
  type PrepareResult = {
1615
1770
  options?: Partial<VePlayerBaseOptions>;
1616
1771
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -2008,11 +2163,15 @@ declare class VePlayerBase {
2008
2163
  */
2009
2164
  fallbackToFirstDefinition?: boolean;
2010
2165
  /** {zh}
2011
- * @brief 是否无缝切换,true 为无缝切换,false 为非无缝切换。
2166
+ * @brief 是否启用无缝切换。
2167
+ * - `true`:启用无缝切换,保证播放过程中不中断。
2168
+ * - `false`:不启用无缝切换,可能会出现播放中断。
2012
2169
  * @default false
2013
2170
  */
2014
2171
  /** {en}
2015
- * @brief Whether seamless switching or not. True means seamless switching and false means non-seamless switching.
2172
+ * @brief Whether seamless switching is enabled.
2173
+ * - `true`: Enables seamless switching, ensuring no interruption during playback.
2174
+ * - `false`: Disables seamless switching, which may cause interruptions during playback.
2016
2175
  */
2017
2176
  seamless?: boolean;
2018
2177
  }): Promise<ExposedDefinition>;
@@ -2097,7 +2256,7 @@ declare class VePlayerBase {
2097
2256
  */
2098
2257
  on(event: string, callback: (data?: any) => any): void;
2099
2258
  /** {zh}
2100
- * @brief 调用此方法开始播放 。
2259
+ * @brief 调用此方法开始播放。
2101
2260
  */
2102
2261
  /** {en}
2103
2262
  * @brief Starts playback.
@@ -2141,20 +2300,24 @@ declare class VePlayerBase {
2141
2300
  */
2142
2301
  focus(data?: {
2143
2302
  /** {zh}
2144
- * @brief 是否需要自动失焦,默认为 true,即经过 delay 时长之后,会自动调用 blur() 进行失焦。
2303
+ * @brief 是否需要自动失焦。
2304
+ * - `true`:启用自动失焦,经过指定的延迟时间后,自动调用 `blur()` 方法进行失焦。
2305
+ * - `false`:禁用自动失焦,不会在延迟时间后自动调用 `blur()` 方法。
2145
2306
  * @default true
2146
2307
  */
2147
2308
  /** {en}
2148
- * @brief Whether to turn on automatic hide, that is, after the duration specified by `delay`, the `blur` method will be automatically called so that the player loses focus. The default is `true`.
2309
+ * @brief Whether auto-blur is enabled.
2310
+ * - `true`: Enables auto-blur, meaning `blur()` will be automatically called after the specified delay time.
2311
+ * - `false`: Disables auto-blur, meaning `blur()` will not be automatically called after the delay.
2149
2312
  * @default true
2150
2313
  */
2151
2314
  autoHide?: boolean;
2152
2315
  /** {zh}
2153
- * @brief 自动失焦延迟时长,单位ms,autoHide 为 true 时生效。
2316
+ * @brief 自动失焦的延迟时间,单位为毫秒。在 `autoHide``true` 时生效。
2154
2317
  * @default 3000
2155
2318
  */
2156
2319
  /** {en}
2157
- * @brief The duration after which the player automatically loses focus, in milliseconds. This parameter takes effect when `autoHide` is `true`.
2320
+ * @brief Delay duration (in milliseconds) before auto-blur is triggered. This takes effect only when `autoHide` is set to `true`.
2158
2321
  * @default 3000
2159
2322
  */
2160
2323
  delay?: number;
@@ -2169,11 +2332,11 @@ declare class VePlayerBase {
2169
2332
  */
2170
2333
  blur(data?: {
2171
2334
  /** {zh}
2172
- * @brief 播放器失焦是否忽略暂停状态,默认值是 true,即默认暂停的时候不取消播放器焦点状态。
2335
+ * @brief 播放器在暂停时是否保留焦点状态。默认值为 `true`,即播放器暂停时不会自动失焦。
2173
2336
  * @default false
2174
2337
  */
2175
2338
  /** {en}
2176
- * @brief Whether to ignore the pause state. The default value is `true`, which means the player will not lose focus when the playback is paused.
2339
+ * @brief Whether the player retains focus when paused. The default is `true`, meaning the player will not automatically lose focus during pause.
2177
2340
  * @default false
2178
2341
  */
2179
2342
  ignorePaused?: boolean;
@@ -2333,6 +2496,7 @@ declare enum DynamicModule {
2333
2496
  PluginMp4 = "plugin:mp4",
2334
2497
  PluginHls = "plugin:hls",
2335
2498
  PluginHlsJs = "plugin:hlsjs",
2499
+ PluginDashJs = "plugin:dashjs",
2336
2500
  PluginShaka = "plugin:shaka",
2337
2501
  PluginRtm = "plugin:rtm",
2338
2502
  PluginXgvideo = "plugin:xgvideo",
@@ -2348,6 +2512,7 @@ type ModulesMap = {
2348
2512
  [DynamicModule.PluginMp4]: Exports;
2349
2513
  [DynamicModule.PluginHls]: Exports;
2350
2514
  [DynamicModule.PluginHlsJs]: Exports;
2515
+ [DynamicModule.PluginDashJs]: Exports;
2351
2516
  [DynamicModule.PluginShaka]: Exports;
2352
2517
  [DynamicModule.PluginRtm]: Exports;
2353
2518
  [DynamicModule.PluginXgvideo]: Exports;
@@ -2388,6 +2553,15 @@ declare namespace strategy {
2388
2553
  MEDIA_ERR_URL_EMPTY: string;
2389
2554
  DRM: string;
2390
2555
  DRM_LICENSE: string;
2556
+ DRM_UNSUPPORTED: string;
2557
+ DRM_NO_MEDIA_KEY: string;
2558
+ DRM_NO_KEY_SESSION: string;
2559
+ DRM_GENERATE_QUEST_FAIL: string;
2560
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
2561
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
2562
+ DRM_LICENSE_FAIL: string;
2563
+ DRM_KEY_ERROR: string;
2564
+ DRM_CERT_FAIL: string;
2391
2565
  OTHER: string;
2392
2566
  RUNTIME: string;
2393
2567
  MODULE_LOAD_ERROR: string;
@@ -2448,6 +2622,15 @@ declare namespace strategy {
2448
2622
  MEDIA_ERR_URL_EMPTY: string;
2449
2623
  DRM: string;
2450
2624
  DRM_LICENSE: string;
2625
+ DRM_UNSUPPORTED: string;
2626
+ DRM_NO_MEDIA_KEY: string;
2627
+ DRM_NO_KEY_SESSION: string;
2628
+ DRM_GENERATE_QUEST_FAIL: string;
2629
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
2630
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
2631
+ DRM_LICENSE_FAIL: string;
2632
+ DRM_KEY_ERROR: string;
2633
+ DRM_CERT_FAIL: string;
2451
2634
  OTHER: string;
2452
2635
  RUNTIME: string;
2453
2636
  MODULE_LOAD_ERROR: string;
@@ -2577,6 +2760,14 @@ declare namespace strategy {
2577
2760
  *
2578
2761
  */
2579
2762
  fallbackUrls?: string[];
2763
+ /** {zh}
2764
+ * @hidden
2765
+ * @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
2766
+ */
2767
+ /** {en}
2768
+ * @hidden
2769
+ * @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
2770
+ */
2580
2771
  type?: string;
2581
2772
  }
2582
2773
  /** {zh}
@@ -2843,7 +3034,7 @@ declare namespace strategy {
2843
3034
  */
2844
3035
  /** {en}
2845
3036
  * @brief Video parsing error.
2846
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
3037
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2847
3038
  */
2848
3039
  MANIFEST_HLS_ERROR = 1100,
2849
3040
  /** {zh}
@@ -2852,7 +3043,7 @@ declare namespace strategy {
2852
3043
  */
2853
3044
  /** {en}
2854
3045
  * @brief Video parsing error.
2855
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
3046
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2856
3047
  */
2857
3048
  MANIFEST_DASH_ERROR = 1200,
2858
3049
  /** {zh}
@@ -2906,7 +3097,7 @@ declare namespace strategy {
2906
3097
  */
2907
3098
  /** {en}
2908
3099
  * @brief Video parsing error.
2909
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
3100
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2910
3101
  */
2911
3102
  DEMUX_FLV_ERROR = 3100,
2912
3103
  /** {zh}
@@ -2915,7 +3106,7 @@ declare namespace strategy {
2915
3106
  */
2916
3107
  /** {en}
2917
3108
  * @brief Video parsing error.
2918
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
3109
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2919
3110
  */
2920
3111
  DEMUX_HLS_ERROR = 3200,
2921
3112
  /** {zh}
@@ -2925,8 +3116,7 @@ declare namespace strategy {
2925
3116
  */
2926
3117
  /** {en}
2927
3118
  * @brief Video parsing error.
2928
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
2929
- *
3119
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2930
3120
  */
2931
3121
  DEMUX_MP4_ERROR = 3300,
2932
3122
  /** {zh}
@@ -2936,8 +3126,7 @@ declare namespace strategy {
2936
3126
  */
2937
3127
  /** {en}
2938
3128
  * @brief Video parsing error.
2939
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
2940
- *
3129
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2941
3130
  */
2942
3131
  DEMUX_FMP4_ERROR = 3400,
2943
3132
  /** {zh}
@@ -2947,8 +3136,7 @@ declare namespace strategy {
2947
3136
  */
2948
3137
  /** {en}
2949
3138
  * @brief Video parsing error.
2950
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
2951
- *
3139
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2952
3140
  */
2953
3141
  DEMUX_SIDX_ERROR = 3410,
2954
3142
  /** {zh}
@@ -2958,8 +3146,7 @@ declare namespace strategy {
2958
3146
  */
2959
3147
  /** {en}
2960
3148
  * @brief Video parsing error.
2961
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
2962
- *
3149
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2963
3150
  */
2964
3151
  REMUX_FMP4_ERROR = 4100,
2965
3152
  /** {zh}
@@ -2969,8 +3156,7 @@ declare namespace strategy {
2969
3156
  */
2970
3157
  /** {en}
2971
3158
  * @brief Video parsing error.
2972
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
2973
- *
3159
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2974
3160
  */
2975
3161
  REMUX_MP4_ERROR = 4200,
2976
3162
  /** {zh}
@@ -3000,10 +3186,9 @@ declare namespace strategy {
3000
3186
  */
3001
3187
  /** {en}
3002
3188
  * @brief An error occurred to the browser while decoding the media resources.
3003
- * @solution
3004
- * 1. Check whether there is any issue with the original video.
3005
- * 2. Re-transcode the video and play it again.
3006
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
3189
+ * @solution 1. Check whether there is any issue with the original video.
3190
+ * 2. Re-transcode the video and play it again.
3191
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3007
3192
  */
3008
3193
  MEDIA_ERR_DECODE = 5103,
3009
3194
  /** {zh}
@@ -3015,10 +3200,9 @@ declare namespace strategy {
3015
3200
  */
3016
3201
  /** {en}
3017
3202
  * @brief The video cannot be loaded due to unsupported video format or server or network issues.
3018
- * @solution
3019
- * 1. Check whether there is any issue with the browser's request.
3020
- * 2. Check whether the browser and the current page support the video format.
3021
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
3203
+ * @solution 1. Check whether there is any issue with the browser's request.
3204
+ * 2. Check whether the browser and the current page support the video format.
3205
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3022
3206
  */
3023
3207
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
3024
3208
  /** {zh}
@@ -3030,10 +3214,9 @@ declare namespace strategy {
3030
3214
  */
3031
3215
  /** {en}
3032
3216
  * @brief The current browser does not support video decoding.
3033
- * @solution
3034
- * 1. Check whether there is any issue with the browser's request.
3035
- * 2. Check whether the browser and the current page support the video format.
3036
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
3217
+ * @solution 1. Check whether there is any issue with the browser's request.
3218
+ * 2. Check whether the browser and the current page support the video format.
3219
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3037
3220
  */
3038
3221
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
3039
3222
  /** {zh}
@@ -3051,7 +3234,7 @@ declare namespace strategy {
3051
3234
  */
3052
3235
  /** {en}
3053
3236
  * @brief A playback issue occurred.
3054
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3237
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3055
3238
  */
3056
3239
  MEDIA_MSE_ADD_SB = 5200,
3057
3240
  /** {zh}
@@ -3060,7 +3243,7 @@ declare namespace strategy {
3060
3243
  */
3061
3244
  /** {en}
3062
3245
  * @brief A playback issue occurred.
3063
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3246
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3064
3247
  */
3065
3248
  MEDIA_MSE_APPEND_BUFFER = 5201,
3066
3249
  /** {zh}
@@ -3069,7 +3252,7 @@ declare namespace strategy {
3069
3252
  */
3070
3253
  /** {en}
3071
3254
  * @brief A playback issue occurred.
3072
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3255
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3073
3256
  */
3074
3257
  MEDIA_MSE_OTHER = 5202,
3075
3258
  /** {zh}
@@ -3078,7 +3261,7 @@ declare namespace strategy {
3078
3261
  */
3079
3262
  /** {en}
3080
3263
  * @brief A playback issue occurred.
3081
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3264
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3082
3265
  */
3083
3266
  MEDIA_MSE_FULL = 5203,
3084
3267
  /** {zh}
@@ -3087,7 +3270,7 @@ declare namespace strategy {
3087
3270
  */
3088
3271
  /** {en}
3089
3272
  * @brief A playback issue occurred.
3090
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3273
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3091
3274
  */
3092
3275
  MEDIA_MSE_HIJACK = 5204,
3093
3276
  /** {zh}
@@ -3096,25 +3279,92 @@ declare namespace strategy {
3096
3279
  */
3097
3280
  /** {en}
3098
3281
  * @brief A playback issue occurred.
3099
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3282
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3100
3283
  */
3101
3284
  MEDIA_EME_HIJACK = 5301,
3102
3285
  /** {zh}
3103
3286
  * @brief DRM 权限校验失败
3104
3287
  * @hidden
3288
+ * @solution 请检查权限配置,确保播放权限正确。
3105
3289
  */
3106
3290
  /** {en}
3107
3291
  * @brief DRM authentication failed.
3108
3292
  * @hidden
3293
+ * @solution Verify the authentication and ensure proper playback permissions.
3109
3294
  */
3110
3295
  DRM_LICENSE = 7100,
3296
+ /** {zh}
3297
+ * @brief 不支持 DRM 加密播放
3298
+ */
3299
+ /** {en}
3300
+ * @brief DRM encrypted playback is not supported
3301
+ */
3302
+ DRM_UNSUPPORTED = 7101,
3303
+ /** {zh}
3304
+ * @brief 视频数据缺少相应 MediaKey
3305
+ */
3306
+ /** {en}
3307
+ * @brief Video data lacks the corresponding MediaKey
3308
+ */
3309
+ DRM_NO_MEDIA_KEY = 7103,
3310
+ /** {zh}
3311
+ * @brief 浏览器不支持相应 DRM KeySession
3312
+ */
3313
+ /** {en}
3314
+ * @brief Browser does not support the corresponding DRM KeySession
3315
+ */
3316
+ DRM_NO_KEY_SESSION = 7104,
3317
+ /** {zh}
3318
+ * @brief 解密播放错误
3319
+ */
3320
+ /** {en}
3321
+ * @brief Decryption playback error
3322
+ */
3323
+ DRM_GENERATE_QUEST_FAIL = 7105,
3324
+ /** {zh}
3325
+ * @brief 缺少 DRM 证书请求链接
3326
+ */
3327
+ /** {en}
3328
+ * @brief Missing DRM certificate request link
3329
+ */
3330
+ DRM_LACK_SERVER_CERTIFICATE_PATH = 7106,
3331
+ /** {zh}
3332
+ * @brief 缺少 DRM License 请求链接
3333
+ */
3334
+ /** {en}
3335
+ * @brief Missing DRM License request link
3336
+ */
3337
+ DRM_LACK_SERVER_PROCESS_SPC_PATH = 7107,
3338
+ /** {zh}
3339
+ * @brief 请求或更新 License 失败
3340
+ */
3341
+ /** {en}
3342
+ * @brief Request or update License failed
3343
+ */
3344
+ DRM_LICENSE_FAIL = 7108,
3345
+ /** {zh}
3346
+ * @brief 解密错误
3347
+ */
3348
+ /** {en}
3349
+ * @brief Decryption error
3350
+ */
3351
+ DRM_KEY_ERROR = 7109,
3352
+ /** {zh}
3353
+ * @brief 请求 DRM 证书失败'
3354
+ */
3355
+ /** {en}
3356
+ * @brief Request for DRM certificate failed'
3357
+ */
3358
+ DRM_CERT_FAIL = 7110,
3111
3359
  /** {zh}
3112
3360
  * @brief DRM 权限校验失败
3113
3361
  * @hidden
3362
+ * @solution 请检查自定义 DRM 权限。
3114
3363
  */
3115
3364
  /** {en}
3116
3365
  * @brief DRM authentication failed.
3117
3366
  * @hidden
3367
+ * @solution Please check the custom DRM authentication.
3118
3368
  */
3119
3369
  DRM_CUSTOM_LICENSE = 7200,
3120
3370
  /** {zh}
@@ -3123,7 +3373,7 @@ declare namespace strategy {
3123
3373
  */
3124
3374
  /** {en}
3125
3375
  * @brief A playback issue occurred.
3126
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3376
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3127
3377
  */
3128
3378
  OTHER = 8000,
3129
3379
  /** {zh}
@@ -3132,7 +3382,7 @@ declare namespace strategy {
3132
3382
  */
3133
3383
  /** {en}
3134
3384
  * @brief A playback issue occurred.
3135
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3385
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3136
3386
  */
3137
3387
  RUNTIME_NO_CANPLAY_ERROR = 9001,
3138
3388
  /** {zh}
@@ -3141,7 +3391,7 @@ declare namespace strategy {
3141
3391
  */
3142
3392
  /** {en}
3143
3393
  * @brief A playback issue occurred.
3144
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3394
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3145
3395
  */
3146
3396
  RUNTIME_BUFFERBREAK_ERROR = 9002,
3147
3397
  /** {zh}
@@ -3150,9 +3400,9 @@ declare namespace strategy {
3150
3400
  */
3151
3401
  /** {en}
3152
3402
  * @brief A playback issue occurred.
3153
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3403
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3154
3404
  */
3155
- RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
3405
+ RUNTIME_WAITING_TIMEOUT_ERROR = 9003,
3156
3406
  // veplayer 报错
3157
3407
  /** {zh}
3158
3408
  * @brief CDN 异步获取失败
@@ -3167,9 +3417,11 @@ declare namespace strategy {
3167
3417
  MODULE_LOAD_ERROR = 110,
3168
3418
  /** {zh}
3169
3419
  * @hidden
3420
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
3170
3421
  */
3171
3422
  /** {en}
3172
3423
  * @hidden
3424
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3173
3425
  */
3174
3426
  UNKNOWN = "UNKNOWN"
3175
3427
  }
@@ -3249,8 +3501,8 @@ declare namespace strategy {
3249
3501
  */
3250
3502
  constructor(error?: string | ErrorInfo<T>, i18n?: VeI18n<T>);
3251
3503
  }
3252
- function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): 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">;
3253
- function transform(xgErr: XGError, i18n?: VeI18n): 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">;
3504
+ function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): 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" | "DRM_UNSUPPORTED" | "DRM_NO_MEDIA_KEY" | "DRM_NO_KEY_SESSION" | "DRM_GENERATE_QUEST_FAIL" | "DRM_LACK_SERVER_CERTIFICATE_PATH" | "DRM_LACK_SERVER_PROCESS_SPC_PATH" | "DRM_LICENSE_FAIL" | "DRM_KEY_ERROR" | "DRM_CERT_FAIL" | "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">;
3505
+ function transform(xgErr: XGError, i18n?: VeI18n): 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" | "DRM_UNSUPPORTED" | "DRM_NO_MEDIA_KEY" | "DRM_NO_KEY_SESSION" | "DRM_GENERATE_QUEST_FAIL" | "DRM_LACK_SERVER_CERTIFICATE_PATH" | "DRM_LACK_SERVER_PROCESS_SPC_PATH" | "DRM_LICENSE_FAIL" | "DRM_KEY_ERROR" | "DRM_CERT_FAIL" | "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">;
3254
3506
  /** {zh}
3255
3507
  * @list option
3256
3508
  * @kind property
@@ -3351,10 +3603,12 @@ declare namespace strategy {
3351
3603
  /** {zh}
3352
3604
  * @list option
3353
3605
  * @kind property
3606
+ * @hidden
3354
3607
  */
3355
3608
  /** {en}
3356
3609
  * @list option
3357
3610
  * @kind property
3611
+ * @hidden
3358
3612
  */
3359
3613
  interface DefinitionConfig {
3360
3614
  /** {zh}
@@ -3566,7 +3820,7 @@ declare namespace strategy {
3566
3820
  /** {en}
3567
3821
  * @brief The URL of the player's cover image.
3568
3822
  */
3569
- poster?: string;
3823
+ poster?: string | Poster;
3570
3824
  /** {zh}
3571
3825
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
3572
3826
  */
@@ -3939,8 +4193,7 @@ declare namespace strategy {
3939
4193
  * @brief 缓存部分进度条底色。
3940
4194
  */
3941
4195
  /** {en}
3942
- * @brief
3943
- * @brief The background color of the progress bar for the cached portion of video playback.
4196
+ * @brief The background color of the buffered portion of the progress bar.
3944
4197
  */
3945
4198
  cachedColor?: string;
3946
4199
  /** {zh}
@@ -3961,6 +4214,73 @@ declare namespace strategy {
3961
4214
  */
3962
4215
  volumeColor?: string;
3963
4216
  }
4217
+ /** {zh}
4218
+ * @list option
4219
+ * @kind property
4220
+ */
4221
+ /** {en}
4222
+ * @list option
4223
+ * @kind property
4224
+ */
4225
+ interface Poster {
4226
+ /** {zh}
4227
+ * @brief 封面图 URL 地址。
4228
+ */
4229
+ /** {en}
4230
+ * @brief The URL of the player's cover image.
4231
+ */
4232
+ poster: string;
4233
+ /** {zh}
4234
+ * @brief 是否在播放结束之后显示封面图。
4235
+ * - `true`:播放结束之后显示封面图。
4236
+ * - `false`:播放结束之后不显示封面图。
4237
+ * @default true
4238
+ */
4239
+ /** {en}
4240
+ * @brief Whether to display the cover image after playback ends.
4241
+ * - `true`:display the cover image after playback ends.
4242
+ * - `false`:not display the cover image after playback ends.
4243
+ * @default true
4244
+ */
4245
+ isEndedShow?: boolean;
4246
+ /** {zh}
4247
+ * @brief 是否播放后再隐藏封面图。
4248
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
4249
+ * - `false`:在 `play` 事件触发后隐藏封面图。
4250
+ * @default false
4251
+ */
4252
+ /** {en}
4253
+ * @brief Whether to hide the cover image after `canplay` event.
4254
+ * - `true`:hide the cover image after `canplay` event.
4255
+ * - `false`:hide the cover image after `play` event.
4256
+ * @default false
4257
+ */
4258
+ hideCanplay?: boolean;
4259
+ /** {zh}
4260
+ * @brief 是否一直显示封面图。
4261
+ * @default false
4262
+ * @hidden
4263
+ */
4264
+ /** {}
4265
+ * @hidden
4266
+ */
4267
+ notHidden?: boolean;
4268
+ /** {zh}
4269
+ * @brief 封面图填充方式。取值如下:
4270
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
4271
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
4272
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
4273
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
4274
+ */
4275
+ /** {en}
4276
+ * @brief Cover image fill mode.
4277
+ * - `fixWidth`:Fill the width of the container and crop the height if necessary.
4278
+ * - `fixHeight`:Fill the height of the container and crop the width if necessary.
4279
+ * - `cover`:Fill the entire container while keeping the original aspect ratio.
4280
+ * - `contain`:Stretch the video to fill the container.
4281
+ */
4282
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
4283
+ }
3964
4284
  type PrepareResult = {
3965
4285
  options?: Partial<VePlayerBaseOptions>;
3966
4286
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -4053,6 +4373,7 @@ declare namespace strategy {
4053
4373
  readonly "plugin:mp4": "veplayer.plugin.mp4.[env].[ext]";
4054
4374
  readonly "plugin:hls": "veplayer.plugin.hls.[env].[ext]";
4055
4375
  readonly "plugin:hlsjs": "veplayer.plugin.hlsjs.[env].[ext]";
4376
+ readonly "plugin:dashjs": "veplayer.plugin.dashjs.[env].[ext]";
4056
4377
  readonly "plugin:shaka": "veplayer.plugin.shaka.[env].[ext]";
4057
4378
  readonly "plugin:rtm": "veplayer.plugin.rtm.[env].[ext]";
4058
4379
  readonly "plugin:xgvideo": "veplayer.plugin.xgvideo.[env].[ext]";
@@ -4087,6 +4408,7 @@ declare namespace strategy {
4087
4408
  PluginMp4 = "plugin:mp4",
4088
4409
  PluginHls = "plugin:hls",
4089
4410
  PluginHlsJs = "plugin:hlsjs",
4411
+ PluginDashJs = "plugin:dashjs",
4090
4412
  PluginShaka = "plugin:shaka",
4091
4413
  PluginRtm = "plugin:rtm",
4092
4414
  PluginXgvideo = "plugin:xgvideo",
@@ -4102,6 +4424,7 @@ declare namespace strategy {
4102
4424
  [DynamicModule.PluginMp4]: Exports;
4103
4425
  [DynamicModule.PluginHls]: Exports;
4104
4426
  [DynamicModule.PluginHlsJs]: Exports;
4427
+ [DynamicModule.PluginDashJs]: Exports;
4105
4428
  [DynamicModule.PluginShaka]: Exports;
4106
4429
  [DynamicModule.PluginRtm]: Exports;
4107
4430
  [DynamicModule.PluginXgvideo]: Exports;
@@ -4325,6 +4648,15 @@ declare namespace error {
4325
4648
  MEDIA_ERR_URL_EMPTY: string;
4326
4649
  DRM: string;
4327
4650
  DRM_LICENSE: string;
4651
+ DRM_UNSUPPORTED: string;
4652
+ DRM_NO_MEDIA_KEY: string;
4653
+ DRM_NO_KEY_SESSION: string;
4654
+ DRM_GENERATE_QUEST_FAIL: string;
4655
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
4656
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
4657
+ DRM_LICENSE_FAIL: string;
4658
+ DRM_KEY_ERROR: string;
4659
+ DRM_CERT_FAIL: string;
4328
4660
  OTHER: string;
4329
4661
  RUNTIME: string;
4330
4662
  MODULE_LOAD_ERROR: string;
@@ -4385,6 +4717,15 @@ declare namespace error {
4385
4717
  MEDIA_ERR_URL_EMPTY: string;
4386
4718
  DRM: string;
4387
4719
  DRM_LICENSE: string;
4720
+ DRM_UNSUPPORTED: string;
4721
+ DRM_NO_MEDIA_KEY: string;
4722
+ DRM_NO_KEY_SESSION: string;
4723
+ DRM_GENERATE_QUEST_FAIL: string;
4724
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
4725
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
4726
+ DRM_LICENSE_FAIL: string;
4727
+ DRM_KEY_ERROR: string;
4728
+ DRM_CERT_FAIL: string;
4388
4729
  OTHER: string;
4389
4730
  RUNTIME: string;
4390
4731
  MODULE_LOAD_ERROR: string;
@@ -4484,7 +4825,7 @@ declare namespace error {
4484
4825
  */
4485
4826
  /** {en}
4486
4827
  * @brief Video parsing error.
4487
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
4828
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4488
4829
  */
4489
4830
  MANIFEST_HLS_ERROR = 1100,
4490
4831
  /** {zh}
@@ -4493,7 +4834,7 @@ declare namespace error {
4493
4834
  */
4494
4835
  /** {en}
4495
4836
  * @brief Video parsing error.
4496
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
4837
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4497
4838
  */
4498
4839
  MANIFEST_DASH_ERROR = 1200,
4499
4840
  /** {zh}
@@ -4547,7 +4888,7 @@ declare namespace error {
4547
4888
  */
4548
4889
  /** {en}
4549
4890
  * @brief Video parsing error.
4550
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4891
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4551
4892
  */
4552
4893
  DEMUX_FLV_ERROR = 3100,
4553
4894
  /** {zh}
@@ -4556,7 +4897,7 @@ declare namespace error {
4556
4897
  */
4557
4898
  /** {en}
4558
4899
  * @brief Video parsing error.
4559
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4900
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4560
4901
  */
4561
4902
  DEMUX_HLS_ERROR = 3200,
4562
4903
  /** {zh}
@@ -4566,8 +4907,7 @@ declare namespace error {
4566
4907
  */
4567
4908
  /** {en}
4568
4909
  * @brief Video parsing error.
4569
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4570
- *
4910
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4571
4911
  */
4572
4912
  DEMUX_MP4_ERROR = 3300,
4573
4913
  /** {zh}
@@ -4577,8 +4917,7 @@ declare namespace error {
4577
4917
  */
4578
4918
  /** {en}
4579
4919
  * @brief Video parsing error.
4580
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4581
- *
4920
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4582
4921
  */
4583
4922
  DEMUX_FMP4_ERROR = 3400,
4584
4923
  /** {zh}
@@ -4588,8 +4927,7 @@ declare namespace error {
4588
4927
  */
4589
4928
  /** {en}
4590
4929
  * @brief Video parsing error.
4591
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4592
- *
4930
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4593
4931
  */
4594
4932
  DEMUX_SIDX_ERROR = 3410,
4595
4933
  /** {zh}
@@ -4599,8 +4937,7 @@ declare namespace error {
4599
4937
  */
4600
4938
  /** {en}
4601
4939
  * @brief Video parsing error.
4602
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4603
- *
4940
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4604
4941
  */
4605
4942
  REMUX_FMP4_ERROR = 4100,
4606
4943
  /** {zh}
@@ -4610,8 +4947,7 @@ declare namespace error {
4610
4947
  */
4611
4948
  /** {en}
4612
4949
  * @brief Video parsing error.
4613
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4614
- *
4950
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4615
4951
  */
4616
4952
  REMUX_MP4_ERROR = 4200,
4617
4953
  /** {zh}
@@ -4641,10 +4977,9 @@ declare namespace error {
4641
4977
  */
4642
4978
  /** {en}
4643
4979
  * @brief An error occurred to the browser while decoding the media resources.
4644
- * @solution
4645
- * 1. Check whether there is any issue with the original video.
4646
- * 2. Re-transcode the video and play it again.
4647
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
4980
+ * @solution 1. Check whether there is any issue with the original video.
4981
+ * 2. Re-transcode the video and play it again.
4982
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4648
4983
  */
4649
4984
  MEDIA_ERR_DECODE = 5103,
4650
4985
  /** {zh}
@@ -4656,10 +4991,9 @@ declare namespace error {
4656
4991
  */
4657
4992
  /** {en}
4658
4993
  * @brief The video cannot be loaded due to unsupported video format or server or network issues.
4659
- * @solution
4660
- * 1. Check whether there is any issue with the browser's request.
4661
- * 2. Check whether the browser and the current page support the video format.
4662
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
4994
+ * @solution 1. Check whether there is any issue with the browser's request.
4995
+ * 2. Check whether the browser and the current page support the video format.
4996
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4663
4997
  */
4664
4998
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
4665
4999
  /** {zh}
@@ -4671,10 +5005,9 @@ declare namespace error {
4671
5005
  */
4672
5006
  /** {en}
4673
5007
  * @brief The current browser does not support video decoding.
4674
- * @solution
4675
- * 1. Check whether there is any issue with the browser's request.
4676
- * 2. Check whether the browser and the current page support the video format.
4677
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
5008
+ * @solution 1. Check whether there is any issue with the browser's request.
5009
+ * 2. Check whether the browser and the current page support the video format.
5010
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4678
5011
  */
4679
5012
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
4680
5013
  /** {zh}
@@ -4692,7 +5025,7 @@ declare namespace error {
4692
5025
  */
4693
5026
  /** {en}
4694
5027
  * @brief A playback issue occurred.
4695
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5028
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4696
5029
  */
4697
5030
  MEDIA_MSE_ADD_SB = 5200,
4698
5031
  /** {zh}
@@ -4701,7 +5034,7 @@ declare namespace error {
4701
5034
  */
4702
5035
  /** {en}
4703
5036
  * @brief A playback issue occurred.
4704
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5037
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4705
5038
  */
4706
5039
  MEDIA_MSE_APPEND_BUFFER = 5201,
4707
5040
  /** {zh}
@@ -4710,7 +5043,7 @@ declare namespace error {
4710
5043
  */
4711
5044
  /** {en}
4712
5045
  * @brief A playback issue occurred.
4713
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5046
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4714
5047
  */
4715
5048
  MEDIA_MSE_OTHER = 5202,
4716
5049
  /** {zh}
@@ -4719,7 +5052,7 @@ declare namespace error {
4719
5052
  */
4720
5053
  /** {en}
4721
5054
  * @brief A playback issue occurred.
4722
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5055
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4723
5056
  */
4724
5057
  MEDIA_MSE_FULL = 5203,
4725
5058
  /** {zh}
@@ -4728,7 +5061,7 @@ declare namespace error {
4728
5061
  */
4729
5062
  /** {en}
4730
5063
  * @brief A playback issue occurred.
4731
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5064
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4732
5065
  */
4733
5066
  MEDIA_MSE_HIJACK = 5204,
4734
5067
  /** {zh}
@@ -4737,25 +5070,92 @@ declare namespace error {
4737
5070
  */
4738
5071
  /** {en}
4739
5072
  * @brief A playback issue occurred.
4740
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5073
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4741
5074
  */
4742
5075
  MEDIA_EME_HIJACK = 5301,
4743
5076
  /** {zh}
4744
5077
  * @brief DRM 权限校验失败
4745
5078
  * @hidden
5079
+ * @solution 请检查权限配置,确保播放权限正确。
4746
5080
  */
4747
5081
  /** {en}
4748
5082
  * @brief DRM authentication failed.
4749
5083
  * @hidden
5084
+ * @solution Verify the authentication and ensure proper playback permissions.
4750
5085
  */
4751
5086
  DRM_LICENSE = 7100,
5087
+ /** {zh}
5088
+ * @brief 不支持 DRM 加密播放
5089
+ */
5090
+ /** {en}
5091
+ * @brief DRM encrypted playback is not supported
5092
+ */
5093
+ DRM_UNSUPPORTED = 7101,
5094
+ /** {zh}
5095
+ * @brief 视频数据缺少相应 MediaKey
5096
+ */
5097
+ /** {en}
5098
+ * @brief Video data lacks the corresponding MediaKey
5099
+ */
5100
+ DRM_NO_MEDIA_KEY = 7103,
5101
+ /** {zh}
5102
+ * @brief 浏览器不支持相应 DRM KeySession
5103
+ */
5104
+ /** {en}
5105
+ * @brief Browser does not support the corresponding DRM KeySession
5106
+ */
5107
+ DRM_NO_KEY_SESSION = 7104,
5108
+ /** {zh}
5109
+ * @brief 解密播放错误
5110
+ */
5111
+ /** {en}
5112
+ * @brief Decryption playback error
5113
+ */
5114
+ DRM_GENERATE_QUEST_FAIL = 7105,
5115
+ /** {zh}
5116
+ * @brief 缺少 DRM 证书请求链接
5117
+ */
5118
+ /** {en}
5119
+ * @brief Missing DRM certificate request link
5120
+ */
5121
+ DRM_LACK_SERVER_CERTIFICATE_PATH = 7106,
5122
+ /** {zh}
5123
+ * @brief 缺少 DRM License 请求链接
5124
+ */
5125
+ /** {en}
5126
+ * @brief Missing DRM License request link
5127
+ */
5128
+ DRM_LACK_SERVER_PROCESS_SPC_PATH = 7107,
5129
+ /** {zh}
5130
+ * @brief 请求或更新 License 失败
5131
+ */
5132
+ /** {en}
5133
+ * @brief Request or update License failed
5134
+ */
5135
+ DRM_LICENSE_FAIL = 7108,
5136
+ /** {zh}
5137
+ * @brief 解密错误
5138
+ */
5139
+ /** {en}
5140
+ * @brief Decryption error
5141
+ */
5142
+ DRM_KEY_ERROR = 7109,
5143
+ /** {zh}
5144
+ * @brief 请求 DRM 证书失败'
5145
+ */
5146
+ /** {en}
5147
+ * @brief Request for DRM certificate failed'
5148
+ */
5149
+ DRM_CERT_FAIL = 7110,
4752
5150
  /** {zh}
4753
5151
  * @brief DRM 权限校验失败
4754
5152
  * @hidden
5153
+ * @solution 请检查自定义 DRM 权限。
4755
5154
  */
4756
5155
  /** {en}
4757
5156
  * @brief DRM authentication failed.
4758
5157
  * @hidden
5158
+ * @solution Please check the custom DRM authentication.
4759
5159
  */
4760
5160
  DRM_CUSTOM_LICENSE = 7200,
4761
5161
  /** {zh}
@@ -4764,7 +5164,7 @@ declare namespace error {
4764
5164
  */
4765
5165
  /** {en}
4766
5166
  * @brief A playback issue occurred.
4767
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5167
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4768
5168
  */
4769
5169
  OTHER = 8000,
4770
5170
  /** {zh}
@@ -4773,7 +5173,7 @@ declare namespace error {
4773
5173
  */
4774
5174
  /** {en}
4775
5175
  * @brief A playback issue occurred.
4776
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5176
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4777
5177
  */
4778
5178
  RUNTIME_NO_CANPLAY_ERROR = 9001,
4779
5179
  /** {zh}
@@ -4782,7 +5182,7 @@ declare namespace error {
4782
5182
  */
4783
5183
  /** {en}
4784
5184
  * @brief A playback issue occurred.
4785
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5185
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4786
5186
  */
4787
5187
  RUNTIME_BUFFERBREAK_ERROR = 9002,
4788
5188
  /** {zh}
@@ -4791,9 +5191,9 @@ declare namespace error {
4791
5191
  */
4792
5192
  /** {en}
4793
5193
  * @brief A playback issue occurred.
4794
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
5194
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4795
5195
  */
4796
- RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
5196
+ RUNTIME_WAITING_TIMEOUT_ERROR = 9003,
4797
5197
  // veplayer 报错
4798
5198
  /** {zh}
4799
5199
  * @brief CDN 异步获取失败
@@ -4808,9 +5208,11 @@ declare namespace error {
4808
5208
  MODULE_LOAD_ERROR = 110,
4809
5209
  /** {zh}
4810
5210
  * @hidden
5211
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
4811
5212
  */
4812
5213
  /** {en}
4813
5214
  * @hidden
5215
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4814
5216
  */
4815
5217
  UNKNOWN = "UNKNOWN"
4816
5218
  }
@@ -4890,8 +5292,8 @@ declare namespace error {
4890
5292
  */
4891
5293
  constructor(error?: string | ErrorInfo<T>, i18n?: VeI18n<T>);
4892
5294
  }
4893
- function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): 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">;
4894
- function transform(xgErr: XGError, i18n?: VeI18n): 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">;
5295
+ function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): 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" | "DRM_UNSUPPORTED" | "DRM_NO_MEDIA_KEY" | "DRM_NO_KEY_SESSION" | "DRM_GENERATE_QUEST_FAIL" | "DRM_LACK_SERVER_CERTIFICATE_PATH" | "DRM_LACK_SERVER_PROCESS_SPC_PATH" | "DRM_LICENSE_FAIL" | "DRM_KEY_ERROR" | "DRM_CERT_FAIL" | "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">;
5296
+ function transform(xgErr: XGError, i18n?: VeI18n): 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" | "DRM_UNSUPPORTED" | "DRM_NO_MEDIA_KEY" | "DRM_NO_KEY_SESSION" | "DRM_GENERATE_QUEST_FAIL" | "DRM_LACK_SERVER_CERTIFICATE_PATH" | "DRM_LACK_SERVER_PROCESS_SPC_PATH" | "DRM_LICENSE_FAIL" | "DRM_KEY_ERROR" | "DRM_CERT_FAIL" | "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">;
4895
5297
  }
4896
5298
  declare namespace event {
4897
5299
  const BaseEvents: {
@@ -5290,7 +5692,7 @@ type StrategyInitOptions<T = Record<string, Partial<VeStrategyConfig> | boolean>
5290
5692
  /** {en}
5291
5693
  * @brief 应用ID
5292
5694
  */
5293
- appId: number;
5695
+ appId: number | string;
5294
5696
  /**
5295
5697
  * 高级能力(策略)配置
5296
5698
  * @brief 策略配置
@@ -5319,6 +5721,7 @@ type StrategyInitOptions<T = Record<string, Partial<VeStrategyConfig> | boolean>
5319
5721
  * @brief 策略Module,默认自动加载
5320
5722
  */
5321
5723
  Module?: typeof VeStrategy;
5724
+ type?: "VOD" | "LIVE"; // 视频类型,默认VOD
5322
5725
  };
5323
5726
  interface Config$1 {
5324
5727
  /**
@@ -5364,9 +5767,40 @@ declare enum FallbackKind {
5364
5767
  Error = "Error",
5365
5768
  Stall = "Stall"
5366
5769
  }
5770
+ /** {zh}
5771
+ * @list option
5772
+ * @kind property
5773
+ */
5774
+ /** {en}
5775
+ * @list option
5776
+ * @kind property
5777
+ */
5367
5778
  interface ErrorFallbackStrategy {
5779
+ /** {zh}
5780
+ * @brief 降级类型,定义是否自动降级或手动控制。
5781
+ * @hidden
5782
+ */
5783
+ /** {en}
5784
+ * @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
5785
+ */
5368
5786
  type?: FallbackKind;
5787
+ /** {zh}
5788
+ * @brief 降级黑名单。若错误码命中该列表,则不会触发降级逻辑。
5789
+ */
5790
+ /** {en}
5791
+ * @brief List of error codes to ignore for fallback. If the error code is in this list, fallback will not be triggered.
5792
+ */
5369
5793
  excludeList?: ErrorCode[];
5794
+ /** {zh}
5795
+ * @brief 自定义降级策略。返回值为:
5796
+ * - `true`:执行降级。
5797
+ * - `false`:不执行降级。
5798
+ */
5799
+ /** {en}
5800
+ * @brief Custom fallback logic. Returns:<br>
5801
+ * - `true`: fallback will occur<br>
5802
+ * - `false`: no fallback
5803
+ */
5370
5804
  shouldFallback?: (type: string, params: {
5371
5805
  error: VeError;
5372
5806
  }) => boolean;
@@ -5412,6 +5846,7 @@ declare abstract class BaseProtocol {
5412
5846
  abstract getVeStrategy(options: VePlayerBaseOptions, config?: {
5413
5847
  veStrategyManager?: VeStrategyManager;
5414
5848
  }): Promise<Strategy> | undefined;
5849
+ abstract updateDrmConfig(drmConfig: any, player?: VePlayerBase): void;
5415
5850
  }
5416
5851
  type Strategy = {
5417
5852
  options?: undefined;
@@ -5447,6 +5882,15 @@ declare class ProtocolManager {
5447
5882
  private _init;
5448
5883
  private _initSingleProtocol;
5449
5884
  }
5885
+ interface PrepareOptions {
5886
+ appId: string;
5887
+ userId?: string;
5888
+ deviceId?: string;
5889
+ strategies: RtmAdaptiveBufferStrategy;
5890
+ }
5891
+ type RtmAdaptiveBufferStrategy = {
5892
+ rtmAdaptiveBuffer?: boolean;
5893
+ };
5450
5894
  /** {zh}
5451
5895
  * @list option
5452
5896
  * @kind property
@@ -5505,14 +5949,14 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5505
5949
  */
5506
5950
  ad?: AdConfig;
5507
5951
  /** {zh}
5508
- * @brief 为播放器设置直播时移配置,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
5952
+ * @brief 为播放器设置直播时移配置,接入方法请参见[直播时移](https://www.volcengine.com/docs/6469/1548574)。
5509
5953
  */
5510
5954
  /** {en}
5511
5955
  * @brief Configurations for time shifting.
5512
5956
  */
5513
5957
  timeShift?: TimeShiftConfig;
5514
5958
  /** {zh}
5515
- * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#日志上报)。
5959
+ * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[播放日志上报](https://www.volcengine.com/docs/6469/1548575)。
5516
5960
  */
5517
5961
  /** {en}
5518
5962
  * @brief Configurations for log upload. Supports enabling/disabling log upload and setting log parameters.
@@ -5539,16 +5983,84 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5539
5983
  * @brief Digital Rights Management (DRM) configurations.
5540
5984
  */
5541
5985
  drm?: Drm;
5986
+ /** {zh}
5987
+ * @brief 设置播放器的播放延迟模式。
5988
+ * - `standard`:标准延迟,稳定性高。
5989
+ * - `low`:低延迟,适用于互动场景。
5990
+ * @hidden
5991
+ */
5992
+ /** {en}
5993
+ * @brief Sets the playback latency mode of the player. Optional values:
5994
+ * - `standard`: Standard latency with higher stability.
5995
+ * - `low`: Low latency, suitable for interactive scenarios.
5996
+ * @hidden
5997
+ */
5542
5998
  latencyMode?: "standard" | "low";
5999
+ /** {zh}
6000
+ * @brief 配置协议降级参数。当播放失败或卡顿时,可根据策略降级使用其他协议。
6001
+ */
6002
+ /** {en}
6003
+ * @brief Configure protocol downgrade parameters. When playback fails or stutters, other protocols can be downgraded according to the strategy.
6004
+ */
5543
6005
  fallback?: Fallback;
5544
6006
  }
6007
+ /** {zh}
6008
+ * @list option
6009
+ * @kind property
6010
+ */
6011
+ /** {en}
6012
+ * @list option
6013
+ * @kind property
6014
+ */
5545
6015
  interface Fallback {
6016
+ /** {zh}
6017
+ * @brief 是否开启协议降级功能。
6018
+ * @hidden
6019
+ */
6020
+ /** {en}
6021
+ * @brief Whether to enable protocol fallback.
6022
+ */
5546
6023
  enableFallback?: boolean;
5547
- fallbackOrder?: string[];
5548
- fallbackStrategy?: Record<string | "all", {
5549
- [FallbackKind.Error]?: ErrorFallbackStrategy;
5550
- [FallbackKind.Stall]?: StallFallbackStrategy;
5551
- }>;
6024
+ /** {zh}
6025
+ * @brief 协议选择优先级顺序。
6026
+ * @listtip - 配置多个协议时,按该顺序选择当前浏览器环境支持的协议。
6027
+ * - 播放失败时根据 `fallbackStrategy` 判断需要降级时,按该顺序选择下一个协议。
6028
+ */
6029
+ /** {en}
6030
+ * @brief Protocol priority list. When multiple protocols are configured, the player selects the first supported protocol in this order. On playback failure, the next protocol is selected based on `fallbackStrategy`.
6031
+ */
6032
+ fallbackOrder?: Array<"rtm" | "flv" | "hls">;
6033
+ /** {zh}
6034
+ * @brief 协议降级策略配置。
6035
+ * @listtip - 默认为 RTM 播放出错时触发降级。
6036
+ * - 若所有协议采用同一策略,可通过设置 `all` 实现统一配置。
6037
+ * - 若同时配置了 `all` 和某个协议(如 `rtm`),将优先使用协议自身的配置,即 `rtm` 策略优先级高于 `all`。
6038
+ */
6039
+ /** {en}
6040
+ * @listtip - By default, fallback is triggered when RTM playback fails.
6041
+ * - Use `all` to apply the same strategy across all protocols.
6042
+ * - If both `all` and a specific protocol (e.g., `rtm`) are set, the specific protocol strategy takes precedence.
6043
+ * @brief Strategy for protocol fallback.
6044
+ */
6045
+ fallbackStrategy?: Record<"rtm" | "flv" | "hls" | "all", FallbackStrategy>;
6046
+ }
6047
+ /** {zh}
6048
+ * @list option
6049
+ * @kind property
6050
+ */
6051
+ /** {en}
6052
+ * @list option
6053
+ * @kind property
6054
+ */
6055
+ interface FallbackStrategy {
6056
+ /** {zh}
6057
+ * @brief 拉流报错时降级策略
6058
+ */
6059
+ [FallbackKind.Error]?: ErrorFallbackStrategy;
6060
+ /**
6061
+ * @hidden
6062
+ */
6063
+ [FallbackKind.Stall]?: StallFallbackStrategy;
5552
6064
  }
5553
6065
  /** {zh}
5554
6066
  * @list option
@@ -5680,6 +6192,8 @@ interface Drm {
5680
6192
  * @brief FairPlay DRM configurations.
5681
6193
  */
5682
6194
  fairplay?: FairplayDrm;
6195
+ widevine?: WidevineDrm;
6196
+ playready?: PlayreadyDrm;
5683
6197
  }
5684
6198
  /** {zh}
5685
6199
  * @list option
@@ -5689,20 +6203,21 @@ interface Drm {
5689
6203
  * @list option
5690
6204
  * @kind property
5691
6205
  */
5692
- interface FairplayDrm extends FairplayDrmConfig {
6206
+ interface FairplayDrm {
5693
6207
  /** {zh}
5694
- * @brief 获取 DRM 配置的方法,用于更新 DRM 配置。
5695
- * @param config
5696
- * @returns 证书的请求地址和内容密钥许可证的请求地址。
6208
+ * @brief 获取证书的请求地址。
5697
6209
  */
5698
6210
  /** {en}
5699
- * @brief Gets DRM configurations.
5700
- * @param config
5701
- * @returns URLs used to get the DRM license and FairPlay streaming certificate.
6211
+ * @brief URL used to acquire the FairPlay certificate.
5702
6212
  */
5703
- getDrmConfig?: (config: {
5704
- url: string;
5705
- }) => Promise<FairplayDrmConfig>;
6213
+ serverCertificatePath?: string;
6214
+ /** {zh}
6215
+ * @brief 获取内容密钥许可证的请求地址。
6216
+ */
6217
+ /** {en}
6218
+ * @brief URL used to acquire the DRM license.
6219
+ */
6220
+ serverProcessSPCPath?: string;
5706
6221
  }
5707
6222
  /** {zh}
5708
6223
  * @list option
@@ -5712,14 +6227,35 @@ interface FairplayDrm extends FairplayDrmConfig {
5712
6227
  * @list option
5713
6228
  * @kind property
5714
6229
  */
5715
- interface FairplayDrmConfig {
6230
+ interface WidevineDrm {
5716
6231
  /** {zh}
5717
- * @brief 获取证书的请求地址。
6232
+ * @hidden
5718
6233
  */
5719
6234
  /** {en}
5720
- * @brief URL used to acquire the FairPlay certificate.
6235
+ * @hidden
6236
+ */
6237
+ // [x: string]: string | undefined;
6238
+ /** {zh}
6239
+ * @brief 获取内容密钥许可证的请求地址。
6240
+ */
6241
+ /** {en}
6242
+ * @brief URL used to acquire the DRM license.
6243
+ */
6244
+ serverProcessSPCPath?: string;
6245
+ }
6246
+ /** {zh}
6247
+ * @list option
6248
+ * @kind property
6249
+ */
6250
+ /** {en}
6251
+ * @list option
6252
+ * @kind property
6253
+ */
6254
+ interface PlayreadyDrm {
6255
+ /**
6256
+ * @hidden
5721
6257
  */
5722
- serverCertificatePath?: string;
6258
+ // [x: string]: string | undefined;
5723
6259
  /** {zh}
5724
6260
  * @brief 获取内容密钥许可证的请求地址。
5725
6261
  */
@@ -5866,10 +6402,12 @@ interface Rtm {
5866
6402
  /** {zh}
5867
6403
  * @brief 当前环境不支持播放 RTM 或者 RTM 拉流播放失败时是否进行降级。
5868
6404
  * @default true
6405
+ * @hidden
5869
6406
  */
5870
6407
  /** {en}
5871
6408
  * @brief Whether to fall back to other protocols when RTM is not supported or an error occurs when playing an RTM stream.
5872
6409
  * @default true
6410
+ * @hidden
5873
6411
  */
5874
6412
  enableFallback?: boolean;
5875
6413
  /** {zh}
@@ -5877,7 +6415,7 @@ interface Rtm {
5877
6415
  * - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
5878
6416
  * - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
5879
6417
  * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
5880
- * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 拉流](https://www.volcengine.com/docs/6469/138655#rtm-%E6%8B%89%E6%B5%81)。
6418
+ * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
5881
6419
  */
5882
6420
  /** {en}
5883
6421
  * @brief The FLV or HLS addresses the player uses when failing to pull an RTM stream. This parameter takes effect when `enableFallback` is set to `true`.
@@ -5924,8 +6462,7 @@ interface Rtm {
5924
6462
  * @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
5925
6463
  * - `true`: Enable;
5926
6464
  * - `false`: Disable.
5927
- * @listtip
5928
- * If you want to use the automatic transcoding feature when playing an RTM stream, contact your [technical support](https://www.byteplus.com/en/support).
6465
+ * @listtip If you want to use the automatic transcoding feature when playing an RTM stream, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
5929
6466
  * @default false
5930
6467
  */
5931
6468
  enableRTMAutoTranscode?: boolean;
@@ -5974,9 +6511,22 @@ interface Rtm {
5974
6511
  * @brief RTM 协议缓冲区延迟,单位为秒。
5975
6512
  */
5976
6513
  /** {en}
5977
- * @brief buffer delay to handle network jitter, in seconds
6514
+ * @brief buffer delay to handle network jitter, in seconds.
5978
6515
  */
5979
6516
  delayHint?: number;
6517
+ /** {zh}
6518
+ * @brief RTM 建联后将在达到该阈值后检测数据接收是否异常,如果异常则播放器报错,单位毫秒。
6519
+ * @default 5000
6520
+ */
6521
+ /** {en}
6522
+ * @brief After RTM connection is established, the system will detect abnormal data reception once the threshold (in milliseconds) is reached. If anomalies occur, the player triggers an error.
6523
+ * @default 5000
6524
+ */
6525
+ checkStatsErrorDelay?: number;
6526
+ /** {zh}
6527
+ * @brief 是否打开 RTM SEI
6528
+ */
6529
+ enableSei?: boolean;
5980
6530
  }
5981
6531
  /** {zh}
5982
6532
  * @list option
@@ -6452,10 +7002,12 @@ interface StatsSnapShoot {
6452
7002
  /** {zh}
6453
7003
  * @list option
6454
7004
  * @kind property
7005
+ * @brief HLS、FLV 协议播放基础信息。
6455
7006
  */
6456
7007
  /** {en}
6457
7008
  * @list option
6458
7009
  * @kind property
7010
+ * @brief Basic information for HLS and FLV protocol playback.
6459
7011
  */
6460
7012
  interface Stats$0 {
6461
7013
  /** {zh}
@@ -6576,7 +7128,7 @@ interface Stats$0 {
6576
7128
  /** {zh}
6577
7129
  * @list option
6578
7130
  * @kind property
6579
- * @brief FLV 直播流播放信息。
7131
+ * @brief 除了 Stats 基础信息,FLV 直播流额外播放信息。
6580
7132
  */
6581
7133
  /** {en}
6582
7134
  * @list option
@@ -6610,6 +7162,12 @@ interface FlvStats extends Stats$0 {
6610
7162
  * @inheritdoc
6611
7163
  */
6612
7164
  declare class VePlayerLive extends VePlayerBase {
7165
+ /** {en}
7166
+ * @hidden
7167
+ */
7168
+ /** {zh}
7169
+ * @hidden
7170
+ */
6613
7171
  _protocolManager?: ProtocolManager;
6614
7172
  /** {zh}
6615
7173
  * @hidden
@@ -6680,12 +7238,13 @@ declare class VePlayerLive extends VePlayerBase {
6680
7238
  closeAbr(): void;
6681
7239
  /** {zh}
6682
7240
  * @brief 调用此方法更新 DRM 配置。
7241
+ * @param config DRM 配置对象,包含 Fairplay DRM 的相关设置。
6683
7242
  */
6684
7243
  /** {en}
6685
7244
  * @brief Use this method to update DRM configuration.
6686
- * @param config
7245
+ * @param config A configuration object containing settings for Fairplay DRM.
6687
7246
  */
6688
- updateDrmConfig(config: FairplayDrmConfig): void;
7247
+ updateDrmConfig(config: Drm): Promise<void | undefined>;
6689
7248
  /** {zh}
6690
7249
  * @brief 修改 ABR 配置,包含修改是否开启 ABR 功能,和修改其他清晰度。
6691
7250
  * @param options ABR 的配置。
@@ -6698,13 +7257,13 @@ declare class VePlayerLive extends VePlayerBase {
6698
7257
  switchAbr(options: {
6699
7258
  /** {zh}
6700
7259
  * @brief 是否开启 ABR 功能。
6701
- * - true:开启
6702
- * - false:关闭
7260
+ * - `true`:开启
7261
+ * - `false`:关闭
6703
7262
  */
6704
7263
  /** {en}
6705
7264
  * @brief Whether to enable the ABR function.
6706
- * - true: Enabled ;
6707
- * - false: Disabled
7265
+ * - `true`: Enabled ;
7266
+ * - `false`: Disabled
6708
7267
  * @default -
6709
7268
  */
6710
7269
  enable: boolean;
@@ -6748,11 +7307,26 @@ declare class VePlayerLive extends VePlayerBase {
6748
7307
  * @brief Obtain the playback information of HLS pull streaming.
6749
7308
  */
6750
7309
  getHLSStats(): Stats$0;
7310
+ /** {en}
7311
+ * @brief This method is used to update the playlist, supporting updates to source, resolution, and related information.
7312
+ * @param playlist The playlist, consisting of multiple `Source` type elements.
7313
+ * @param target An optional target configuration, which can specify the resolution or source. Providing this information helps update the playback source for a specific resolution or stream.
7314
+ * @param needUpdateProtocol Whether the protocol needs to be updated.
7315
+ *
7316
+ * - `true`: Forces the protocol update to ensure compatibility with the playback configuration or source.
7317
+ * - `false`: Does not update the protocol and continues to use the current configuration.
7318
+ */
7319
+ /** {zh}
7320
+ * @brief 调用此方法更新播放列表,支持更新源、清晰度等相关信息。
7321
+ * @param playlist 播放列表,包含多个 `Source` 类型的元素。
7322
+ * @param target 可选的目标配置项,可以指定清晰度或源。提供这些信息可以帮助更新特定清晰度或线路的播放源。
7323
+ * @param needUpdateProtocol 是否需要更新协议。
7324
+ * - `true`:强制更新协议,以确保播放配置或源的兼容性。
7325
+ * - `false`:不更新协议,继续使用当前配置。
7326
+ */
6751
7327
  updatePlaylist(playlist: ExposedSource[], target?: string | {
6752
7328
  /** {zh}
6753
7329
  * @brief 清晰度唯一标识。
6754
- * @default 无
6755
- *
6756
7330
  */
6757
7331
  /** {en}
6758
7332
  * @brief The resolution ID.
@@ -6761,8 +7335,6 @@ declare class VePlayerLive extends VePlayerBase {
6761
7335
  definition?: string;
6762
7336
  /** {zh}
6763
7337
  * @brief 线路的唯一标识。
6764
- * @default 无
6765
- *
6766
7338
  */
6767
7339
  /** {en}
6768
7340
  * @brief The playback resource ID.
@@ -6886,6 +7458,15 @@ declare namespace live {
6886
7458
  MEDIA_ERR_URL_EMPTY: string;
6887
7459
  DRM: string;
6888
7460
  DRM_LICENSE: string;
7461
+ DRM_UNSUPPORTED: string;
7462
+ DRM_NO_MEDIA_KEY: string;
7463
+ DRM_NO_KEY_SESSION: string;
7464
+ DRM_GENERATE_QUEST_FAIL: string;
7465
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
7466
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
7467
+ DRM_LICENSE_FAIL: string;
7468
+ DRM_KEY_ERROR: string;
7469
+ DRM_CERT_FAIL: string;
6889
7470
  OTHER: string;
6890
7471
  RUNTIME: string;
6891
7472
  MODULE_LOAD_ERROR: string;
@@ -6946,6 +7527,15 @@ declare namespace live {
6946
7527
  MEDIA_ERR_URL_EMPTY: string;
6947
7528
  DRM: string;
6948
7529
  DRM_LICENSE: string;
7530
+ DRM_UNSUPPORTED: string;
7531
+ DRM_NO_MEDIA_KEY: string;
7532
+ DRM_NO_KEY_SESSION: string;
7533
+ DRM_GENERATE_QUEST_FAIL: string;
7534
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
7535
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
7536
+ DRM_LICENSE_FAIL: string;
7537
+ DRM_KEY_ERROR: string;
7538
+ DRM_CERT_FAIL: string;
6949
7539
  OTHER: string;
6950
7540
  RUNTIME: string;
6951
7541
  MODULE_LOAD_ERROR: string;
@@ -7075,6 +7665,14 @@ declare namespace live {
7075
7665
  *
7076
7666
  */
7077
7667
  fallbackUrls?: string[];
7668
+ /** {zh}
7669
+ * @hidden
7670
+ * @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
7671
+ */
7672
+ /** {en}
7673
+ * @hidden
7674
+ * @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
7675
+ */
7078
7676
  type?: string;
7079
7677
  }
7080
7678
  /** {zh}
@@ -7341,7 +7939,7 @@ declare namespace live {
7341
7939
  */
7342
7940
  /** {en}
7343
7941
  * @brief Video parsing error.
7344
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
7942
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7345
7943
  */
7346
7944
  MANIFEST_HLS_ERROR = 1100,
7347
7945
  /** {zh}
@@ -7350,7 +7948,7 @@ declare namespace live {
7350
7948
  */
7351
7949
  /** {en}
7352
7950
  * @brief Video parsing error.
7353
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
7951
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7354
7952
  */
7355
7953
  MANIFEST_DASH_ERROR = 1200,
7356
7954
  /** {zh}
@@ -7404,7 +8002,7 @@ declare namespace live {
7404
8002
  */
7405
8003
  /** {en}
7406
8004
  * @brief Video parsing error.
7407
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
8005
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7408
8006
  */
7409
8007
  DEMUX_FLV_ERROR = 3100,
7410
8008
  /** {zh}
@@ -7413,7 +8011,7 @@ declare namespace live {
7413
8011
  */
7414
8012
  /** {en}
7415
8013
  * @brief Video parsing error.
7416
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
8014
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7417
8015
  */
7418
8016
  DEMUX_HLS_ERROR = 3200,
7419
8017
  /** {zh}
@@ -7423,8 +8021,7 @@ declare namespace live {
7423
8021
  */
7424
8022
  /** {en}
7425
8023
  * @brief Video parsing error.
7426
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
7427
- *
8024
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7428
8025
  */
7429
8026
  DEMUX_MP4_ERROR = 3300,
7430
8027
  /** {zh}
@@ -7434,8 +8031,7 @@ declare namespace live {
7434
8031
  */
7435
8032
  /** {en}
7436
8033
  * @brief Video parsing error.
7437
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
7438
- *
8034
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7439
8035
  */
7440
8036
  DEMUX_FMP4_ERROR = 3400,
7441
8037
  /** {zh}
@@ -7445,8 +8041,7 @@ declare namespace live {
7445
8041
  */
7446
8042
  /** {en}
7447
8043
  * @brief Video parsing error.
7448
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
7449
- *
8044
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7450
8045
  */
7451
8046
  DEMUX_SIDX_ERROR = 3410,
7452
8047
  /** {zh}
@@ -7456,8 +8051,7 @@ declare namespace live {
7456
8051
  */
7457
8052
  /** {en}
7458
8053
  * @brief Video parsing error.
7459
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
7460
- *
8054
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7461
8055
  */
7462
8056
  REMUX_FMP4_ERROR = 4100,
7463
8057
  /** {zh}
@@ -7467,8 +8061,7 @@ declare namespace live {
7467
8061
  */
7468
8062
  /** {en}
7469
8063
  * @brief Video parsing error.
7470
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
7471
- *
8064
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7472
8065
  */
7473
8066
  REMUX_MP4_ERROR = 4200,
7474
8067
  /** {zh}
@@ -7498,10 +8091,9 @@ declare namespace live {
7498
8091
  */
7499
8092
  /** {en}
7500
8093
  * @brief An error occurred to the browser while decoding the media resources.
7501
- * @solution
7502
- * 1. Check whether there is any issue with the original video.
7503
- * 2. Re-transcode the video and play it again.
7504
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
8094
+ * @solution 1. Check whether there is any issue with the original video.
8095
+ * 2. Re-transcode the video and play it again.
8096
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7505
8097
  */
7506
8098
  MEDIA_ERR_DECODE = 5103,
7507
8099
  /** {zh}
@@ -7513,10 +8105,9 @@ declare namespace live {
7513
8105
  */
7514
8106
  /** {en}
7515
8107
  * @brief The video cannot be loaded due to unsupported video format or server or network issues.
7516
- * @solution
7517
- * 1. Check whether there is any issue with the browser's request.
7518
- * 2. Check whether the browser and the current page support the video format.
7519
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
8108
+ * @solution 1. Check whether there is any issue with the browser's request.
8109
+ * 2. Check whether the browser and the current page support the video format.
8110
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7520
8111
  */
7521
8112
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
7522
8113
  /** {zh}
@@ -7528,10 +8119,9 @@ declare namespace live {
7528
8119
  */
7529
8120
  /** {en}
7530
8121
  * @brief The current browser does not support video decoding.
7531
- * @solution
7532
- * 1. Check whether there is any issue with the browser's request.
7533
- * 2. Check whether the browser and the current page support the video format.
7534
- * 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
8122
+ * @solution 1. Check whether there is any issue with the browser's request.
8123
+ * 2. Check whether the browser and the current page support the video format.
8124
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7535
8125
  */
7536
8126
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
7537
8127
  /** {zh}
@@ -7549,7 +8139,7 @@ declare namespace live {
7549
8139
  */
7550
8140
  /** {en}
7551
8141
  * @brief A playback issue occurred.
7552
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8142
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7553
8143
  */
7554
8144
  MEDIA_MSE_ADD_SB = 5200,
7555
8145
  /** {zh}
@@ -7558,7 +8148,7 @@ declare namespace live {
7558
8148
  */
7559
8149
  /** {en}
7560
8150
  * @brief A playback issue occurred.
7561
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8151
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7562
8152
  */
7563
8153
  MEDIA_MSE_APPEND_BUFFER = 5201,
7564
8154
  /** {zh}
@@ -7567,7 +8157,7 @@ declare namespace live {
7567
8157
  */
7568
8158
  /** {en}
7569
8159
  * @brief A playback issue occurred.
7570
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8160
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7571
8161
  */
7572
8162
  MEDIA_MSE_OTHER = 5202,
7573
8163
  /** {zh}
@@ -7576,7 +8166,7 @@ declare namespace live {
7576
8166
  */
7577
8167
  /** {en}
7578
8168
  * @brief A playback issue occurred.
7579
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8169
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7580
8170
  */
7581
8171
  MEDIA_MSE_FULL = 5203,
7582
8172
  /** {zh}
@@ -7585,7 +8175,7 @@ declare namespace live {
7585
8175
  */
7586
8176
  /** {en}
7587
8177
  * @brief A playback issue occurred.
7588
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8178
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7589
8179
  */
7590
8180
  MEDIA_MSE_HIJACK = 5204,
7591
8181
  /** {zh}
@@ -7594,25 +8184,92 @@ declare namespace live {
7594
8184
  */
7595
8185
  /** {en}
7596
8186
  * @brief A playback issue occurred.
7597
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8187
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7598
8188
  */
7599
8189
  MEDIA_EME_HIJACK = 5301,
7600
8190
  /** {zh}
7601
8191
  * @brief DRM 权限校验失败
7602
8192
  * @hidden
8193
+ * @solution 请检查权限配置,确保播放权限正确。
7603
8194
  */
7604
8195
  /** {en}
7605
8196
  * @brief DRM authentication failed.
7606
8197
  * @hidden
8198
+ * @solution Verify the authentication and ensure proper playback permissions.
7607
8199
  */
7608
8200
  DRM_LICENSE = 7100,
8201
+ /** {zh}
8202
+ * @brief 不支持 DRM 加密播放
8203
+ */
8204
+ /** {en}
8205
+ * @brief DRM encrypted playback is not supported
8206
+ */
8207
+ DRM_UNSUPPORTED = 7101,
8208
+ /** {zh}
8209
+ * @brief 视频数据缺少相应 MediaKey
8210
+ */
8211
+ /** {en}
8212
+ * @brief Video data lacks the corresponding MediaKey
8213
+ */
8214
+ DRM_NO_MEDIA_KEY = 7103,
8215
+ /** {zh}
8216
+ * @brief 浏览器不支持相应 DRM KeySession
8217
+ */
8218
+ /** {en}
8219
+ * @brief Browser does not support the corresponding DRM KeySession
8220
+ */
8221
+ DRM_NO_KEY_SESSION = 7104,
8222
+ /** {zh}
8223
+ * @brief 解密播放错误
8224
+ */
8225
+ /** {en}
8226
+ * @brief Decryption playback error
8227
+ */
8228
+ DRM_GENERATE_QUEST_FAIL = 7105,
8229
+ /** {zh}
8230
+ * @brief 缺少 DRM 证书请求链接
8231
+ */
8232
+ /** {en}
8233
+ * @brief Missing DRM certificate request link
8234
+ */
8235
+ DRM_LACK_SERVER_CERTIFICATE_PATH = 7106,
8236
+ /** {zh}
8237
+ * @brief 缺少 DRM License 请求链接
8238
+ */
8239
+ /** {en}
8240
+ * @brief Missing DRM License request link
8241
+ */
8242
+ DRM_LACK_SERVER_PROCESS_SPC_PATH = 7107,
8243
+ /** {zh}
8244
+ * @brief 请求或更新 License 失败
8245
+ */
8246
+ /** {en}
8247
+ * @brief Request or update License failed
8248
+ */
8249
+ DRM_LICENSE_FAIL = 7108,
8250
+ /** {zh}
8251
+ * @brief 解密错误
8252
+ */
8253
+ /** {en}
8254
+ * @brief Decryption error
8255
+ */
8256
+ DRM_KEY_ERROR = 7109,
8257
+ /** {zh}
8258
+ * @brief 请求 DRM 证书失败'
8259
+ */
8260
+ /** {en}
8261
+ * @brief Request for DRM certificate failed'
8262
+ */
8263
+ DRM_CERT_FAIL = 7110,
7609
8264
  /** {zh}
7610
8265
  * @brief DRM 权限校验失败
7611
8266
  * @hidden
8267
+ * @solution 请检查自定义 DRM 权限。
7612
8268
  */
7613
8269
  /** {en}
7614
8270
  * @brief DRM authentication failed.
7615
8271
  * @hidden
8272
+ * @solution Please check the custom DRM authentication.
7616
8273
  */
7617
8274
  DRM_CUSTOM_LICENSE = 7200,
7618
8275
  /** {zh}
@@ -7621,7 +8278,7 @@ declare namespace live {
7621
8278
  */
7622
8279
  /** {en}
7623
8280
  * @brief A playback issue occurred.
7624
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8281
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7625
8282
  */
7626
8283
  OTHER = 8000,
7627
8284
  /** {zh}
@@ -7630,7 +8287,7 @@ declare namespace live {
7630
8287
  */
7631
8288
  /** {en}
7632
8289
  * @brief A playback issue occurred.
7633
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8290
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7634
8291
  */
7635
8292
  RUNTIME_NO_CANPLAY_ERROR = 9001,
7636
8293
  /** {zh}
@@ -7639,7 +8296,7 @@ declare namespace live {
7639
8296
  */
7640
8297
  /** {en}
7641
8298
  * @brief A playback issue occurred.
7642
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8299
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7643
8300
  */
7644
8301
  RUNTIME_BUFFERBREAK_ERROR = 9002,
7645
8302
  /** {zh}
@@ -7648,9 +8305,9 @@ declare namespace live {
7648
8305
  */
7649
8306
  /** {en}
7650
8307
  * @brief A playback issue occurred.
7651
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
8308
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7652
8309
  */
7653
- RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
8310
+ RUNTIME_WAITING_TIMEOUT_ERROR = 9003,
7654
8311
  // veplayer 报错
7655
8312
  /** {zh}
7656
8313
  * @brief CDN 异步获取失败
@@ -7665,9 +8322,11 @@ declare namespace live {
7665
8322
  MODULE_LOAD_ERROR = 110,
7666
8323
  /** {zh}
7667
8324
  * @hidden
8325
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
7668
8326
  */
7669
8327
  /** {en}
7670
8328
  * @hidden
8329
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7671
8330
  */
7672
8331
  UNKNOWN = "UNKNOWN"
7673
8332
  }
@@ -7747,8 +8406,8 @@ declare namespace live {
7747
8406
  */
7748
8407
  constructor(error?: string | ErrorInfo<T>, i18n?: VeI18n<T>);
7749
8408
  }
7750
- function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): 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">;
7751
- function transform(xgErr: XGError, i18n?: VeI18n): 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">;
8409
+ function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): 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" | "DRM_UNSUPPORTED" | "DRM_NO_MEDIA_KEY" | "DRM_NO_KEY_SESSION" | "DRM_GENERATE_QUEST_FAIL" | "DRM_LACK_SERVER_CERTIFICATE_PATH" | "DRM_LACK_SERVER_PROCESS_SPC_PATH" | "DRM_LICENSE_FAIL" | "DRM_KEY_ERROR" | "DRM_CERT_FAIL" | "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">;
8410
+ function transform(xgErr: XGError, i18n?: VeI18n): 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" | "DRM_UNSUPPORTED" | "DRM_NO_MEDIA_KEY" | "DRM_NO_KEY_SESSION" | "DRM_GENERATE_QUEST_FAIL" | "DRM_LACK_SERVER_CERTIFICATE_PATH" | "DRM_LACK_SERVER_PROCESS_SPC_PATH" | "DRM_LICENSE_FAIL" | "DRM_KEY_ERROR" | "DRM_CERT_FAIL" | "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">;
7752
8411
  /** {zh}
7753
8412
  * @list option
7754
8413
  * @kind property
@@ -7849,10 +8508,12 @@ declare namespace live {
7849
8508
  /** {zh}
7850
8509
  * @list option
7851
8510
  * @kind property
8511
+ * @hidden
7852
8512
  */
7853
8513
  /** {en}
7854
8514
  * @list option
7855
8515
  * @kind property
8516
+ * @hidden
7856
8517
  */
7857
8518
  interface DefinitionConfig {
7858
8519
  /** {zh}
@@ -8064,7 +8725,7 @@ declare namespace live {
8064
8725
  /** {en}
8065
8726
  * @brief The URL of the player's cover image.
8066
8727
  */
8067
- poster?: string;
8728
+ poster?: string | Poster;
8068
8729
  /** {zh}
8069
8730
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
8070
8731
  */
@@ -8437,8 +9098,7 @@ declare namespace live {
8437
9098
  * @brief 缓存部分进度条底色。
8438
9099
  */
8439
9100
  /** {en}
8440
- * @brief
8441
- * @brief The background color of the progress bar for the cached portion of video playback.
9101
+ * @brief The background color of the buffered portion of the progress bar.
8442
9102
  */
8443
9103
  cachedColor?: string;
8444
9104
  /** {zh}
@@ -8459,6 +9119,73 @@ declare namespace live {
8459
9119
  */
8460
9120
  volumeColor?: string;
8461
9121
  }
9122
+ /** {zh}
9123
+ * @list option
9124
+ * @kind property
9125
+ */
9126
+ /** {en}
9127
+ * @list option
9128
+ * @kind property
9129
+ */
9130
+ interface Poster {
9131
+ /** {zh}
9132
+ * @brief 封面图 URL 地址。
9133
+ */
9134
+ /** {en}
9135
+ * @brief The URL of the player's cover image.
9136
+ */
9137
+ poster: string;
9138
+ /** {zh}
9139
+ * @brief 是否在播放结束之后显示封面图。
9140
+ * - `true`:播放结束之后显示封面图。
9141
+ * - `false`:播放结束之后不显示封面图。
9142
+ * @default true
9143
+ */
9144
+ /** {en}
9145
+ * @brief Whether to display the cover image after playback ends.
9146
+ * - `true`:display the cover image after playback ends.
9147
+ * - `false`:not display the cover image after playback ends.
9148
+ * @default true
9149
+ */
9150
+ isEndedShow?: boolean;
9151
+ /** {zh}
9152
+ * @brief 是否播放后再隐藏封面图。
9153
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
9154
+ * - `false`:在 `play` 事件触发后隐藏封面图。
9155
+ * @default false
9156
+ */
9157
+ /** {en}
9158
+ * @brief Whether to hide the cover image after `canplay` event.
9159
+ * - `true`:hide the cover image after `canplay` event.
9160
+ * - `false`:hide the cover image after `play` event.
9161
+ * @default false
9162
+ */
9163
+ hideCanplay?: boolean;
9164
+ /** {zh}
9165
+ * @brief 是否一直显示封面图。
9166
+ * @default false
9167
+ * @hidden
9168
+ */
9169
+ /** {}
9170
+ * @hidden
9171
+ */
9172
+ notHidden?: boolean;
9173
+ /** {zh}
9174
+ * @brief 封面图填充方式。取值如下:
9175
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
9176
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
9177
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
9178
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
9179
+ */
9180
+ /** {en}
9181
+ * @brief Cover image fill mode.
9182
+ * - `fixWidth`:Fill the width of the container and crop the height if necessary.
9183
+ * - `fixHeight`:Fill the height of the container and crop the width if necessary.
9184
+ * - `cover`:Fill the entire container while keeping the original aspect ratio.
9185
+ * - `contain`:Stretch the video to fill the container.
9186
+ */
9187
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
9188
+ }
8462
9189
  type PrepareResult = {
8463
9190
  options?: Partial<VePlayerBaseOptions>;
8464
9191
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -8857,11 +9584,15 @@ declare namespace live {
8857
9584
  */
8858
9585
  fallbackToFirstDefinition?: boolean;
8859
9586
  /** {zh}
8860
- * @brief 是否无缝切换,true 为无缝切换,false 为非无缝切换。
9587
+ * @brief 是否启用无缝切换。
9588
+ * - `true`:启用无缝切换,保证播放过程中不中断。
9589
+ * - `false`:不启用无缝切换,可能会出现播放中断。
8861
9590
  * @default false
8862
9591
  */
8863
9592
  /** {en}
8864
- * @brief Whether seamless switching or not. True means seamless switching and false means non-seamless switching.
9593
+ * @brief Whether seamless switching is enabled.
9594
+ * - `true`: Enables seamless switching, ensuring no interruption during playback.
9595
+ * - `false`: Disables seamless switching, which may cause interruptions during playback.
8865
9596
  */
8866
9597
  seamless?: boolean;
8867
9598
  }): Promise<ExposedDefinition>;
@@ -8946,7 +9677,7 @@ declare namespace live {
8946
9677
  */
8947
9678
  on(event: string, callback: (data?: any) => any): void;
8948
9679
  /** {zh}
8949
- * @brief 调用此方法开始播放 。
9680
+ * @brief 调用此方法开始播放。
8950
9681
  */
8951
9682
  /** {en}
8952
9683
  * @brief Starts playback.
@@ -8990,20 +9721,24 @@ declare namespace live {
8990
9721
  */
8991
9722
  focus(data?: {
8992
9723
  /** {zh}
8993
- * @brief 是否需要自动失焦,默认为 true,即经过 delay 时长之后,会自动调用 blur() 进行失焦。
9724
+ * @brief 是否需要自动失焦。
9725
+ * - `true`:启用自动失焦,经过指定的延迟时间后,自动调用 `blur()` 方法进行失焦。
9726
+ * - `false`:禁用自动失焦,不会在延迟时间后自动调用 `blur()` 方法。
8994
9727
  * @default true
8995
9728
  */
8996
9729
  /** {en}
8997
- * @brief Whether to turn on automatic hide, that is, after the duration specified by `delay`, the `blur` method will be automatically called so that the player loses focus. The default is `true`.
9730
+ * @brief Whether auto-blur is enabled.
9731
+ * - `true`: Enables auto-blur, meaning `blur()` will be automatically called after the specified delay time.
9732
+ * - `false`: Disables auto-blur, meaning `blur()` will not be automatically called after the delay.
8998
9733
  * @default true
8999
9734
  */
9000
9735
  autoHide?: boolean;
9001
9736
  /** {zh}
9002
- * @brief 自动失焦延迟时长,单位ms,autoHide 为 true 时生效。
9737
+ * @brief 自动失焦的延迟时间,单位为毫秒。在 `autoHide``true` 时生效。
9003
9738
  * @default 3000
9004
9739
  */
9005
9740
  /** {en}
9006
- * @brief The duration after which the player automatically loses focus, in milliseconds. This parameter takes effect when `autoHide` is `true`.
9741
+ * @brief Delay duration (in milliseconds) before auto-blur is triggered. This takes effect only when `autoHide` is set to `true`.
9007
9742
  * @default 3000
9008
9743
  */
9009
9744
  delay?: number;
@@ -9018,11 +9753,11 @@ declare namespace live {
9018
9753
  */
9019
9754
  blur(data?: {
9020
9755
  /** {zh}
9021
- * @brief 播放器失焦是否忽略暂停状态,默认值是 true,即默认暂停的时候不取消播放器焦点状态。
9756
+ * @brief 播放器在暂停时是否保留焦点状态。默认值为 `true`,即播放器暂停时不会自动失焦。
9022
9757
  * @default false
9023
9758
  */
9024
9759
  /** {en}
9025
- * @brief Whether to ignore the pause state. The default value is `true`, which means the player will not lose focus when the playback is paused.
9760
+ * @brief Whether the player retains focus when paused. The default is `true`, meaning the player will not automatically lose focus during pause.
9026
9761
  * @default false
9027
9762
  */
9028
9763
  ignorePaused?: boolean;
@@ -9164,6 +9899,7 @@ declare namespace live {
9164
9899
  readonly "plugin:mp4": "veplayer.plugin.mp4.[env].[ext]";
9165
9900
  readonly "plugin:hls": "veplayer.plugin.hls.[env].[ext]";
9166
9901
  readonly "plugin:hlsjs": "veplayer.plugin.hlsjs.[env].[ext]";
9902
+ readonly "plugin:dashjs": "veplayer.plugin.dashjs.[env].[ext]";
9167
9903
  readonly "plugin:shaka": "veplayer.plugin.shaka.[env].[ext]";
9168
9904
  readonly "plugin:rtm": "veplayer.plugin.rtm.[env].[ext]";
9169
9905
  readonly "plugin:xgvideo": "veplayer.plugin.xgvideo.[env].[ext]";
@@ -9198,6 +9934,7 @@ declare namespace live {
9198
9934
  PluginMp4 = "plugin:mp4",
9199
9935
  PluginHls = "plugin:hls",
9200
9936
  PluginHlsJs = "plugin:hlsjs",
9937
+ PluginDashJs = "plugin:dashjs",
9201
9938
  PluginShaka = "plugin:shaka",
9202
9939
  PluginRtm = "plugin:rtm",
9203
9940
  PluginXgvideo = "plugin:xgvideo",
@@ -9213,6 +9950,7 @@ declare namespace live {
9213
9950
  [DynamicModule.PluginMp4]: Exports;
9214
9951
  [DynamicModule.PluginHls]: Exports;
9215
9952
  [DynamicModule.PluginHlsJs]: Exports;
9953
+ [DynamicModule.PluginDashJs]: Exports;
9216
9954
  [DynamicModule.PluginShaka]: Exports;
9217
9955
  [DynamicModule.PluginRtm]: Exports;
9218
9956
  [DynamicModule.PluginXgvideo]: Exports;
@@ -9506,9 +10244,9 @@ declare namespace live {
9506
10244
  destroy(): void;
9507
10245
  render(): string;
9508
10246
  }
9509
- const DEFAULT_PC_PLUGINS: (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster | typeof Start | typeof Loading | typeof Enter | typeof Keyboard | typeof PC)[];
9510
- const DEFAULT_MOBILE_PLUGINS: (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster | typeof Start | typeof Loading | typeof Enter | typeof Mobile)[];
9511
- const DEFAULT_PLUGINS: (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster | typeof Start | typeof Loading | typeof Enter | typeof Keyboard | typeof PC)[] | (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster | typeof Start | typeof Loading | typeof Enter | typeof Mobile)[];
10247
+ const DEFAULT_PC_PLUGINS: (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster$0 | typeof Start | typeof Loading | typeof Enter | typeof Keyboard | typeof PC)[];
10248
+ const DEFAULT_MOBILE_PLUGINS: (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster$0 | typeof Start | typeof Loading | typeof Enter | typeof Mobile)[];
10249
+ const DEFAULT_PLUGINS: (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster$0 | typeof Start | typeof Loading | typeof Enter | typeof Keyboard | typeof PC)[] | (typeof Error | typeof Toast | typeof Sources | typeof DefinitionPlugin | typeof Autoplay | typeof TopRightBar | typeof Play | typeof FullScreen | typeof Volume | typeof MiniScreen | typeof PIPIcon | typeof Poster$0 | typeof Start | typeof Loading | typeof Enter | typeof Mobile)[];
9512
10250
  interface Options$0 {
9513
10251
  url?: string;
9514
10252
  defaultDefinition?: string;
@@ -9761,7 +10499,7 @@ declare namespace live {
9761
10499
  /** {en}
9762
10500
  * @brief 应用ID
9763
10501
  */
9764
- appId: number;
10502
+ appId: number | string;
9765
10503
  /**
9766
10504
  * 高级能力(策略)配置
9767
10505
  * @brief 策略配置
@@ -9790,6 +10528,7 @@ declare namespace live {
9790
10528
  * @brief 策略Module,默认自动加载
9791
10529
  */
9792
10530
  Module?: typeof VeStrategy;
10531
+ type?: "VOD" | "LIVE"; // 视频类型,默认VOD
9793
10532
  };
9794
10533
  /** {zh}
9795
10534
  * 预加载模块状态
@@ -9861,9 +10600,40 @@ declare namespace live {
9861
10600
  Error = "Error",
9862
10601
  Stall = "Stall"
9863
10602
  }
10603
+ /** {zh}
10604
+ * @list option
10605
+ * @kind property
10606
+ */
10607
+ /** {en}
10608
+ * @list option
10609
+ * @kind property
10610
+ */
9864
10611
  interface ErrorFallbackStrategy {
10612
+ /** {zh}
10613
+ * @brief 降级类型,定义是否自动降级或手动控制。
10614
+ * @hidden
10615
+ */
10616
+ /** {en}
10617
+ * @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
10618
+ */
9865
10619
  type?: FallbackKind;
10620
+ /** {zh}
10621
+ * @brief 降级黑名单。若错误码命中该列表,则不会触发降级逻辑。
10622
+ */
10623
+ /** {en}
10624
+ * @brief List of error codes to ignore for fallback. If the error code is in this list, fallback will not be triggered.
10625
+ */
9866
10626
  excludeList?: ErrorCode[];
10627
+ /** {zh}
10628
+ * @brief 自定义降级策略。返回值为:
10629
+ * - `true`:执行降级。
10630
+ * - `false`:不执行降级。
10631
+ */
10632
+ /** {en}
10633
+ * @brief Custom fallback logic. Returns:<br>
10634
+ * - `true`: fallback will occur<br>
10635
+ * - `false`: no fallback
10636
+ */
9867
10637
  shouldFallback?: (type: string, params: {
9868
10638
  error: VeError;
9869
10639
  }) => boolean;
@@ -9909,6 +10679,7 @@ declare namespace live {
9909
10679
  abstract getVeStrategy(options: VePlayerBaseOptions, config?: {
9910
10680
  veStrategyManager?: VeStrategyManager;
9911
10681
  }): Promise<Strategy> | undefined;
10682
+ abstract updateDrmConfig(drmConfig: any, player?: VePlayerBase): void;
9912
10683
  }
9913
10684
  type Strategy = {
9914
10685
  options?: undefined;
@@ -9944,6 +10715,15 @@ declare namespace live {
9944
10715
  private _init;
9945
10716
  private _initSingleProtocol;
9946
10717
  }
10718
+ interface PrepareOptions {
10719
+ appId: string;
10720
+ userId?: string;
10721
+ deviceId?: string;
10722
+ strategies: RtmAdaptiveBufferStrategy;
10723
+ }
10724
+ type RtmAdaptiveBufferStrategy = {
10725
+ rtmAdaptiveBuffer?: boolean;
10726
+ };
9947
10727
  /** {zh}
9948
10728
  * @list option
9949
10729
  * @kind property
@@ -10002,14 +10782,14 @@ declare namespace live {
10002
10782
  */
10003
10783
  ad?: AdConfig;
10004
10784
  /** {zh}
10005
- * @brief 为播放器设置直播时移配置,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
10785
+ * @brief 为播放器设置直播时移配置,接入方法请参见[直播时移](https://www.volcengine.com/docs/6469/1548574)。
10006
10786
  */
10007
10787
  /** {en}
10008
10788
  * @brief Configurations for time shifting.
10009
10789
  */
10010
10790
  timeShift?: TimeShiftConfig;
10011
10791
  /** {zh}
10012
- * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#日志上报)。
10792
+ * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[播放日志上报](https://www.volcengine.com/docs/6469/1548575)。
10013
10793
  */
10014
10794
  /** {en}
10015
10795
  * @brief Configurations for log upload. Supports enabling/disabling log upload and setting log parameters.
@@ -10036,16 +10816,84 @@ declare namespace live {
10036
10816
  * @brief Digital Rights Management (DRM) configurations.
10037
10817
  */
10038
10818
  drm?: Drm;
10819
+ /** {zh}
10820
+ * @brief 设置播放器的播放延迟模式。
10821
+ * - `standard`:标准延迟,稳定性高。
10822
+ * - `low`:低延迟,适用于互动场景。
10823
+ * @hidden
10824
+ */
10825
+ /** {en}
10826
+ * @brief Sets the playback latency mode of the player. Optional values:
10827
+ * - `standard`: Standard latency with higher stability.
10828
+ * - `low`: Low latency, suitable for interactive scenarios.
10829
+ * @hidden
10830
+ */
10039
10831
  latencyMode?: "standard" | "low";
10832
+ /** {zh}
10833
+ * @brief 配置协议降级参数。当播放失败或卡顿时,可根据策略降级使用其他协议。
10834
+ */
10835
+ /** {en}
10836
+ * @brief Configure protocol downgrade parameters. When playback fails or stutters, other protocols can be downgraded according to the strategy.
10837
+ */
10040
10838
  fallback?: Fallback;
10041
10839
  }
10840
+ /** {zh}
10841
+ * @list option
10842
+ * @kind property
10843
+ */
10844
+ /** {en}
10845
+ * @list option
10846
+ * @kind property
10847
+ */
10042
10848
  interface Fallback {
10849
+ /** {zh}
10850
+ * @brief 是否开启协议降级功能。
10851
+ * @hidden
10852
+ */
10853
+ /** {en}
10854
+ * @brief Whether to enable protocol fallback.
10855
+ */
10043
10856
  enableFallback?: boolean;
10044
- fallbackOrder?: string[];
10045
- fallbackStrategy?: Record<string | "all", {
10046
- [FallbackKind.Error]?: ErrorFallbackStrategy;
10047
- [FallbackKind.Stall]?: StallFallbackStrategy;
10048
- }>;
10857
+ /** {zh}
10858
+ * @brief 协议选择优先级顺序。
10859
+ * @listtip - 配置多个协议时,按该顺序选择当前浏览器环境支持的协议。
10860
+ * - 播放失败时根据 `fallbackStrategy` 判断需要降级时,按该顺序选择下一个协议。
10861
+ */
10862
+ /** {en}
10863
+ * @brief Protocol priority list. When multiple protocols are configured, the player selects the first supported protocol in this order. On playback failure, the next protocol is selected based on `fallbackStrategy`.
10864
+ */
10865
+ fallbackOrder?: Array<"rtm" | "flv" | "hls">;
10866
+ /** {zh}
10867
+ * @brief 协议降级策略配置。
10868
+ * @listtip - 默认为 RTM 播放出错时触发降级。
10869
+ * - 若所有协议采用同一策略,可通过设置 `all` 实现统一配置。
10870
+ * - 若同时配置了 `all` 和某个协议(如 `rtm`),将优先使用协议自身的配置,即 `rtm` 策略优先级高于 `all`。
10871
+ */
10872
+ /** {en}
10873
+ * @listtip - By default, fallback is triggered when RTM playback fails.
10874
+ * - Use `all` to apply the same strategy across all protocols.
10875
+ * - If both `all` and a specific protocol (e.g., `rtm`) are set, the specific protocol strategy takes precedence.
10876
+ * @brief Strategy for protocol fallback.
10877
+ */
10878
+ fallbackStrategy?: Record<"rtm" | "flv" | "hls" | "all", FallbackStrategy>;
10879
+ }
10880
+ /** {zh}
10881
+ * @list option
10882
+ * @kind property
10883
+ */
10884
+ /** {en}
10885
+ * @list option
10886
+ * @kind property
10887
+ */
10888
+ interface FallbackStrategy {
10889
+ /** {zh}
10890
+ * @brief 拉流报错时降级策略
10891
+ */
10892
+ [FallbackKind.Error]?: ErrorFallbackStrategy;
10893
+ /**
10894
+ * @hidden
10895
+ */
10896
+ [FallbackKind.Stall]?: StallFallbackStrategy;
10049
10897
  }
10050
10898
  /** {zh}
10051
10899
  * @list option
@@ -10177,6 +11025,8 @@ declare namespace live {
10177
11025
  * @brief FairPlay DRM configurations.
10178
11026
  */
10179
11027
  fairplay?: FairplayDrm;
11028
+ widevine?: WidevineDrm;
11029
+ playready?: PlayreadyDrm;
10180
11030
  }
10181
11031
  /** {zh}
10182
11032
  * @list option
@@ -10186,20 +11036,21 @@ declare namespace live {
10186
11036
  * @list option
10187
11037
  * @kind property
10188
11038
  */
10189
- interface FairplayDrm extends FairplayDrmConfig {
11039
+ interface FairplayDrm {
10190
11040
  /** {zh}
10191
- * @brief 获取 DRM 配置的方法,用于更新 DRM 配置。
10192
- * @param config
10193
- * @returns 证书的请求地址和内容密钥许可证的请求地址。
11041
+ * @brief 获取证书的请求地址。
10194
11042
  */
10195
11043
  /** {en}
10196
- * @brief Gets DRM configurations.
10197
- * @param config
10198
- * @returns URLs used to get the DRM license and FairPlay streaming certificate.
11044
+ * @brief URL used to acquire the FairPlay certificate.
10199
11045
  */
10200
- getDrmConfig?: (config: {
10201
- url: string;
10202
- }) => Promise<FairplayDrmConfig>;
11046
+ serverCertificatePath?: string;
11047
+ /** {zh}
11048
+ * @brief 获取内容密钥许可证的请求地址。
11049
+ */
11050
+ /** {en}
11051
+ * @brief URL used to acquire the DRM license.
11052
+ */
11053
+ serverProcessSPCPath?: string;
10203
11054
  }
10204
11055
  /** {zh}
10205
11056
  * @list option
@@ -10209,14 +11060,35 @@ declare namespace live {
10209
11060
  * @list option
10210
11061
  * @kind property
10211
11062
  */
10212
- interface FairplayDrmConfig {
11063
+ interface WidevineDrm {
10213
11064
  /** {zh}
10214
- * @brief 获取证书的请求地址。
11065
+ * @hidden
10215
11066
  */
10216
11067
  /** {en}
10217
- * @brief URL used to acquire the FairPlay certificate.
11068
+ * @hidden
10218
11069
  */
10219
- serverCertificatePath?: string;
11070
+ // [x: string]: string | undefined;
11071
+ /** {zh}
11072
+ * @brief 获取内容密钥许可证的请求地址。
11073
+ */
11074
+ /** {en}
11075
+ * @brief URL used to acquire the DRM license.
11076
+ */
11077
+ serverProcessSPCPath?: string;
11078
+ }
11079
+ /** {zh}
11080
+ * @list option
11081
+ * @kind property
11082
+ */
11083
+ /** {en}
11084
+ * @list option
11085
+ * @kind property
11086
+ */
11087
+ interface PlayreadyDrm {
11088
+ /**
11089
+ * @hidden
11090
+ */
11091
+ // [x: string]: string | undefined;
10220
11092
  /** {zh}
10221
11093
  * @brief 获取内容密钥许可证的请求地址。
10222
11094
  */
@@ -10363,10 +11235,12 @@ declare namespace live {
10363
11235
  /** {zh}
10364
11236
  * @brief 当前环境不支持播放 RTM 或者 RTM 拉流播放失败时是否进行降级。
10365
11237
  * @default true
11238
+ * @hidden
10366
11239
  */
10367
11240
  /** {en}
10368
11241
  * @brief Whether to fall back to other protocols when RTM is not supported or an error occurs when playing an RTM stream.
10369
11242
  * @default true
11243
+ * @hidden
10370
11244
  */
10371
11245
  enableFallback?: boolean;
10372
11246
  /** {zh}
@@ -10374,7 +11248,7 @@ declare namespace live {
10374
11248
  * - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
10375
11249
  * - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
10376
11250
  * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
10377
- * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 拉流](https://www.volcengine.com/docs/6469/138655#rtm-%E6%8B%89%E6%B5%81)。
11251
+ * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
10378
11252
  */
10379
11253
  /** {en}
10380
11254
  * @brief The FLV or HLS addresses the player uses when failing to pull an RTM stream. This parameter takes effect when `enableFallback` is set to `true`.
@@ -10421,8 +11295,7 @@ declare namespace live {
10421
11295
  * @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
10422
11296
  * - `true`: Enable;
10423
11297
  * - `false`: Disable.
10424
- * @listtip
10425
- * If you want to use the automatic transcoding feature when playing an RTM stream, contact your [technical support](https://www.byteplus.com/en/support).
11298
+ * @listtip If you want to use the automatic transcoding feature when playing an RTM stream, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
10426
11299
  * @default false
10427
11300
  */
10428
11301
  enableRTMAutoTranscode?: boolean;
@@ -10471,9 +11344,22 @@ declare namespace live {
10471
11344
  * @brief RTM 协议缓冲区延迟,单位为秒。
10472
11345
  */
10473
11346
  /** {en}
10474
- * @brief buffer delay to handle network jitter, in seconds
11347
+ * @brief buffer delay to handle network jitter, in seconds.
10475
11348
  */
10476
11349
  delayHint?: number;
11350
+ /** {zh}
11351
+ * @brief RTM 建联后将在达到该阈值后检测数据接收是否异常,如果异常则播放器报错,单位毫秒。
11352
+ * @default 5000
11353
+ */
11354
+ /** {en}
11355
+ * @brief After RTM connection is established, the system will detect abnormal data reception once the threshold (in milliseconds) is reached. If anomalies occur, the player triggers an error.
11356
+ * @default 5000
11357
+ */
11358
+ checkStatsErrorDelay?: number;
11359
+ /** {zh}
11360
+ * @brief 是否打开 RTM SEI
11361
+ */
11362
+ enableSei?: boolean;
10477
11363
  }
10478
11364
  /** {zh}
10479
11365
  * @list option
@@ -10949,10 +11835,12 @@ declare namespace live {
10949
11835
  /** {zh}
10950
11836
  * @list option
10951
11837
  * @kind property
11838
+ * @brief HLS、FLV 协议播放基础信息。
10952
11839
  */
10953
11840
  /** {en}
10954
11841
  * @list option
10955
11842
  * @kind property
11843
+ * @brief Basic information for HLS and FLV protocol playback.
10956
11844
  */
10957
11845
  interface Stats$0 {
10958
11846
  /** {zh}
@@ -11073,7 +11961,7 @@ declare namespace live {
11073
11961
  /** {zh}
11074
11962
  * @list option
11075
11963
  * @kind property
11076
- * @brief FLV 直播流播放信息。
11964
+ * @brief 除了 Stats 基础信息,FLV 直播流额外播放信息。
11077
11965
  */
11078
11966
  /** {en}
11079
11967
  * @list option
@@ -11107,6 +11995,12 @@ declare namespace live {
11107
11995
  * @inheritdoc
11108
11996
  */
11109
11997
  class VePlayerLive extends VePlayerBase {
11998
+ /** {en}
11999
+ * @hidden
12000
+ */
12001
+ /** {zh}
12002
+ * @hidden
12003
+ */
11110
12004
  _protocolManager?: ProtocolManager;
11111
12005
  /** {zh}
11112
12006
  * @hidden
@@ -11177,12 +12071,13 @@ declare namespace live {
11177
12071
  closeAbr(): void;
11178
12072
  /** {zh}
11179
12073
  * @brief 调用此方法更新 DRM 配置。
12074
+ * @param config DRM 配置对象,包含 Fairplay DRM 的相关设置。
11180
12075
  */
11181
12076
  /** {en}
11182
12077
  * @brief Use this method to update DRM configuration.
11183
- * @param config
12078
+ * @param config A configuration object containing settings for Fairplay DRM.
11184
12079
  */
11185
- updateDrmConfig(config: FairplayDrmConfig): void;
12080
+ updateDrmConfig(config: Drm): Promise<void | undefined>;
11186
12081
  /** {zh}
11187
12082
  * @brief 修改 ABR 配置,包含修改是否开启 ABR 功能,和修改其他清晰度。
11188
12083
  * @param options ABR 的配置。
@@ -11195,13 +12090,13 @@ declare namespace live {
11195
12090
  switchAbr(options: {
11196
12091
  /** {zh}
11197
12092
  * @brief 是否开启 ABR 功能。
11198
- * - true:开启
11199
- * - false:关闭
12093
+ * - `true`:开启
12094
+ * - `false`:关闭
11200
12095
  */
11201
12096
  /** {en}
11202
12097
  * @brief Whether to enable the ABR function.
11203
- * - true: Enabled ;
11204
- * - false: Disabled
12098
+ * - `true`: Enabled ;
12099
+ * - `false`: Disabled
11205
12100
  * @default -
11206
12101
  */
11207
12102
  enable: boolean;
@@ -11245,11 +12140,26 @@ declare namespace live {
11245
12140
  * @brief Obtain the playback information of HLS pull streaming.
11246
12141
  */
11247
12142
  getHLSStats(): Stats$0;
12143
+ /** {en}
12144
+ * @brief This method is used to update the playlist, supporting updates to source, resolution, and related information.
12145
+ * @param playlist The playlist, consisting of multiple `Source` type elements.
12146
+ * @param target An optional target configuration, which can specify the resolution or source. Providing this information helps update the playback source for a specific resolution or stream.
12147
+ * @param needUpdateProtocol Whether the protocol needs to be updated.
12148
+ *
12149
+ * - `true`: Forces the protocol update to ensure compatibility with the playback configuration or source.
12150
+ * - `false`: Does not update the protocol and continues to use the current configuration.
12151
+ */
12152
+ /** {zh}
12153
+ * @brief 调用此方法更新播放列表,支持更新源、清晰度等相关信息。
12154
+ * @param playlist 播放列表,包含多个 `Source` 类型的元素。
12155
+ * @param target 可选的目标配置项,可以指定清晰度或源。提供这些信息可以帮助更新特定清晰度或线路的播放源。
12156
+ * @param needUpdateProtocol 是否需要更新协议。
12157
+ * - `true`:强制更新协议,以确保播放配置或源的兼容性。
12158
+ * - `false`:不更新协议,继续使用当前配置。
12159
+ */
11248
12160
  updatePlaylist(playlist: ExposedSource[], target?: string | {
11249
12161
  /** {zh}
11250
12162
  * @brief 清晰度唯一标识。
11251
- * @default 无
11252
- *
11253
12163
  */
11254
12164
  /** {en}
11255
12165
  * @brief The resolution ID.
@@ -11258,8 +12168,6 @@ declare namespace live {
11258
12168
  definition?: string;
11259
12169
  /** {zh}
11260
12170
  * @brief 线路的唯一标识。
11261
- * @default 无
11262
- *
11263
12171
  */
11264
12172
  /** {en}
11265
12173
  * @brief The playback resource ID.
@@ -11307,7 +12215,7 @@ declare namespace live {
11307
12215
  * @returns The player instance.
11308
12216
  */
11309
12217
  function createLivePlayer(options?: LiveVePlayerOptions): Promise<VePlayerLive>;
11310
- function prepare(options: any): Promise<VeStrategyManager | undefined>;
12218
+ function prepare(options: PrepareOptions): Promise<VeStrategyManager | undefined>;
11311
12219
  /** {zh}
11312
12220
  * @detail events
11313
12221
  * @id LiveEvents
@@ -12390,6 +13298,15 @@ declare namespace live {
12390
13298
  MEDIA_ERR_URL_EMPTY: string;
12391
13299
  DRM: string;
12392
13300
  DRM_LICENSE: string;
13301
+ DRM_UNSUPPORTED: string;
13302
+ DRM_NO_MEDIA_KEY: string;
13303
+ DRM_NO_KEY_SESSION: string;
13304
+ DRM_GENERATE_QUEST_FAIL: string;
13305
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
13306
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
13307
+ DRM_LICENSE_FAIL: string;
13308
+ DRM_KEY_ERROR: string;
13309
+ DRM_CERT_FAIL: string;
12393
13310
  OTHER: string;
12394
13311
  RUNTIME: string;
12395
13312
  MODULE_LOAD_ERROR: string;
@@ -12464,6 +13381,15 @@ declare namespace live {
12464
13381
  MEDIA_ERR_URL_EMPTY: string;
12465
13382
  DRM: string;
12466
13383
  DRM_LICENSE: string;
13384
+ DRM_UNSUPPORTED: string;
13385
+ DRM_NO_MEDIA_KEY: string;
13386
+ DRM_NO_KEY_SESSION: string;
13387
+ DRM_GENERATE_QUEST_FAIL: string;
13388
+ DRM_LACK_SERVER_CERTIFICATE_PATH: string;
13389
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: string;
13390
+ DRM_LICENSE_FAIL: string;
13391
+ DRM_KEY_ERROR: string;
13392
+ DRM_CERT_FAIL: string;
12467
13393
  OTHER: string;
12468
13394
  RUNTIME: string;
12469
13395
  MODULE_LOAD_ERROR: string;
@@ -12523,16 +13449,22 @@ declare namespace live {
12523
13449
  */
12524
13450
  INVALID_PARAMETER = 210,
12525
13451
  /**
13452
+ * @brief 缺少 RTM 降级参数
13453
+ * @solution 请检查是否设置 `playlist` 传入 `rtm` 降级协议地址
13454
+ * @hidden
13455
+ */
13456
+ /** {en}
13457
+ * @brief Missing RTM fallback parameter.
12526
13458
  * @hidden
12527
13459
  */
12528
13460
  EMPTY_RTM_FALLBACK_PARAMETER = 211,
12529
13461
  /** {zh}
12530
13462
  * @brief 日志错误
12531
- * @solution 未正确配置质量日志参数,请参考 https://www.volcengine.com/docs/6469/138655#日志上报 配置。
13463
+ * @solution 未正确配置质量日志参数,请参考[播放日志上报](https://www.volcengine.com/docs/6469/1548575)进行配置。
12532
13464
  */
12533
13465
  /** {en}
12534
13466
  * @brief Log errors.
12535
- * @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.
13467
+ * @solution Log options are not configured correctly. For details, see [Playback Logging and Reporting](https://docs.byteplus.com/en/docs/byteplus-media-live/docs-playback-logging-and-reporting).
12536
13468
  */
12537
13469
  INVALID_LOGGER = 220
12538
13470
  }
@@ -12580,11 +13512,20 @@ declare namespace live {
12580
13512
  MEDIA_MSE_HIJACK: error.ErrorCode.MEDIA_MSE_HIJACK;
12581
13513
  MEDIA_EME_HIJACK: error.ErrorCode.MEDIA_EME_HIJACK;
12582
13514
  DRM_LICENSE: error.ErrorCode.DRM_LICENSE;
13515
+ DRM_UNSUPPORTED: error.ErrorCode.DRM_UNSUPPORTED;
13516
+ DRM_NO_MEDIA_KEY: error.ErrorCode.DRM_NO_MEDIA_KEY;
13517
+ DRM_NO_KEY_SESSION: error.ErrorCode.DRM_NO_KEY_SESSION;
13518
+ DRM_GENERATE_QUEST_FAIL: error.ErrorCode.DRM_GENERATE_QUEST_FAIL;
13519
+ DRM_LACK_SERVER_CERTIFICATE_PATH: error.ErrorCode.DRM_LACK_SERVER_CERTIFICATE_PATH;
13520
+ DRM_LACK_SERVER_PROCESS_SPC_PATH: error.ErrorCode.DRM_LACK_SERVER_PROCESS_SPC_PATH;
13521
+ DRM_LICENSE_FAIL: error.ErrorCode.DRM_LICENSE_FAIL;
13522
+ DRM_KEY_ERROR: error.ErrorCode.DRM_KEY_ERROR;
13523
+ DRM_CERT_FAIL: error.ErrorCode.DRM_CERT_FAIL;
12583
13524
  DRM_CUSTOM_LICENSE: error.ErrorCode.DRM_CUSTOM_LICENSE;
12584
13525
  OTHER: error.ErrorCode.OTHER;
12585
13526
  RUNTIME_NO_CANPLAY_ERROR: error.ErrorCode.RUNTIME_NO_CANPLAY_ERROR;
12586
13527
  RUNTIME_BUFFERBREAK_ERROR: error.ErrorCode.RUNTIME_BUFFERBREAK_ERROR;
12587
- RUNTIME_BWAITING_TIMEOUT_ERROR: error.ErrorCode.RUNTIME_BUFFERBREAK_ERROR;
13528
+ RUNTIME_WAITING_TIMEOUT_ERROR: error.ErrorCode.RUNTIME_WAITING_TIMEOUT_ERROR;
12588
13529
  MODULE_LOAD_ERROR: error.ErrorCode.MODULE_LOAD_ERROR;
12589
13530
  UNKNOWN: error.ErrorCode.UNKNOWN;
12590
13531
  INVALID_PARAMETER: LiveErrorCode.INVALID_PARAMETER;
@@ -12593,6 +13534,6 @@ declare namespace live {
12593
13534
  };
12594
13535
  type ValueOf<T> = T[keyof T];
12595
13536
  const ERRORS: Partial<Record<ValueOf<typeof ErrorCode$0>, error.ErrorInfo<TextKey$0>>>;
12596
- 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" | "EMPTY_RTM_FALLBACK_PARAMETER" | "INVALID_LOGGER" | "FORMAT" | "FPS" | "BITRATE" | "RESOLUTION" | "ENCODE_TYPE" | "BUFFER_END" | "CURRENT_TIME" | "DECODE_EFFICIENCY" | "DECODE_COST" | "DECODE_INFO">;
13537
+ 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" | "DRM_UNSUPPORTED" | "DRM_NO_MEDIA_KEY" | "DRM_NO_KEY_SESSION" | "DRM_GENERATE_QUEST_FAIL" | "DRM_LACK_SERVER_CERTIFICATE_PATH" | "DRM_LACK_SERVER_PROCESS_SPC_PATH" | "DRM_LICENSE_FAIL" | "DRM_KEY_ERROR" | "DRM_CERT_FAIL" | "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" | "EMPTY_RTM_FALLBACK_PARAMETER" | "INVALID_LOGGER" | "FORMAT" | "FPS" | "BITRATE" | "RESOLUTION" | "ENCODE_TYPE" | "BUFFER_END" | "CURRENT_TIME" | "DECODE_EFFICIENCY" | "DECODE_COST" | "DECODE_INFO">;
12597
13538
  }
12598
13539
  export { Codec, DecodeType, Degradation, DynamicModule, RTMCodec, ListType, Plugin, ExposedSource, VePlayerLive, util, register, registerPlugin, createLivePlayer, isMseSupported, isSoftDecodeSupported, isRTMSupported, isFLVSupported, isRTMSupportCodec, isMMSSupported, load, POSITIONS, EN, ZH_CN, Sniffer, live };