@volcengine/veplayer 2.8.0-rc.0 → 2.8.0-rc.2

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
@@ -228,6 +228,14 @@ interface ExposedDefinition {
228
228
  *
229
229
  */
230
230
  fallbackUrls?: string[];
231
+ /** {zh}
232
+ * @hidden
233
+ * @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
234
+ */
235
+ /** {en}
236
+ * @hidden
237
+ * @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
238
+ */
231
239
  type?: string;
232
240
  }
233
241
  /** {zh}
@@ -490,6 +498,12 @@ declare enum Level {
490
498
  */
491
499
  Warn = "Warn"
492
500
  }
501
+ /** {zh}
502
+ * @id ErrorCodeRaw
503
+ */
504
+ /** {en}
505
+ * @id ErrorCodeRaw
506
+ */
493
507
  declare enum ErrorCode {
494
508
  /** {zh}
495
509
  * @brief 视频解析错误
@@ -497,7 +511,7 @@ declare enum ErrorCode {
497
511
  */
498
512
  /** {en}
499
513
  * @brief Video parsing error.
500
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
514
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
501
515
  */
502
516
  MANIFEST_HLS_ERROR = 1100,
503
517
  /** {zh}
@@ -506,7 +520,7 @@ declare enum ErrorCode {
506
520
  */
507
521
  /** {en}
508
522
  * @brief Video parsing error.
509
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
523
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
510
524
  */
511
525
  MANIFEST_DASH_ERROR = 1200,
512
526
  /** {zh}
@@ -560,7 +574,7 @@ declare enum ErrorCode {
560
574
  */
561
575
  /** {en}
562
576
  * @brief Video parsing error.
563
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
577
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
564
578
  */
565
579
  DEMUX_FLV_ERROR = 3100,
566
580
  /** {zh}
@@ -569,7 +583,7 @@ declare enum ErrorCode {
569
583
  */
570
584
  /** {en}
571
585
  * @brief Video parsing error.
572
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
586
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
573
587
  */
574
588
  DEMUX_HLS_ERROR = 3200,
575
589
  /** {zh}
@@ -579,8 +593,7 @@ declare enum ErrorCode {
579
593
  */
580
594
  /** {en}
581
595
  * @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
- *
596
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
584
597
  */
585
598
  DEMUX_MP4_ERROR = 3300,
586
599
  /** {zh}
@@ -590,8 +603,7 @@ declare enum ErrorCode {
590
603
  */
591
604
  /** {en}
592
605
  * @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
- *
606
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
595
607
  */
596
608
  DEMUX_FMP4_ERROR = 3400,
597
609
  /** {zh}
@@ -601,8 +613,7 @@ declare enum ErrorCode {
601
613
  */
602
614
  /** {en}
603
615
  * @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
- *
616
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
606
617
  */
607
618
  DEMUX_SIDX_ERROR = 3410,
608
619
  /** {zh}
@@ -612,8 +623,7 @@ declare enum ErrorCode {
612
623
  */
613
624
  /** {en}
614
625
  * @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
- *
626
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
617
627
  */
618
628
  REMUX_FMP4_ERROR = 4100,
619
629
  /** {zh}
@@ -623,8 +633,7 @@ declare enum ErrorCode {
623
633
  */
624
634
  /** {en}
625
635
  * @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
- *
636
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
628
637
  */
629
638
  REMUX_MP4_ERROR = 4200,
630
639
  /** {zh}
@@ -654,10 +663,9 @@ declare enum ErrorCode {
654
663
  */
655
664
  /** {en}
656
665
  * @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).
666
+ * @solution 1. Check whether there is any issue with the original video.
667
+ * 2. Re-transcode the video and play it again.
668
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
661
669
  */
662
670
  MEDIA_ERR_DECODE = 5103,
663
671
  /** {zh}
@@ -669,10 +677,9 @@ declare enum ErrorCode {
669
677
  */
670
678
  /** {en}
671
679
  * @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).
680
+ * @solution 1. Check whether there is any issue with the browser's request.
681
+ * 2. Check whether the browser and the current page support the video format.
682
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
676
683
  */
677
684
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
678
685
  /** {zh}
@@ -684,10 +691,9 @@ declare enum ErrorCode {
684
691
  */
685
692
  /** {en}
686
693
  * @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).
694
+ * @solution 1. Check whether there is any issue with the browser's request.
695
+ * 2. Check whether the browser and the current page support the video format.
696
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
691
697
  */
692
698
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
693
699
  /** {zh}
@@ -705,7 +711,7 @@ declare enum ErrorCode {
705
711
  */
706
712
  /** {en}
707
713
  * @brief A playback issue occurred.
708
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
714
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
709
715
  */
710
716
  MEDIA_MSE_ADD_SB = 5200,
711
717
  /** {zh}
@@ -714,7 +720,7 @@ declare enum ErrorCode {
714
720
  */
715
721
  /** {en}
716
722
  * @brief A playback issue occurred.
717
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
723
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
718
724
  */
719
725
  MEDIA_MSE_APPEND_BUFFER = 5201,
720
726
  /** {zh}
@@ -723,7 +729,7 @@ declare enum ErrorCode {
723
729
  */
724
730
  /** {en}
725
731
  * @brief A playback issue occurred.
726
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
732
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
727
733
  */
728
734
  MEDIA_MSE_OTHER = 5202,
729
735
  /** {zh}
@@ -732,7 +738,7 @@ declare enum ErrorCode {
732
738
  */
733
739
  /** {en}
734
740
  * @brief A playback issue occurred.
735
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
741
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
736
742
  */
737
743
  MEDIA_MSE_FULL = 5203,
738
744
  /** {zh}
@@ -741,7 +747,7 @@ declare enum ErrorCode {
741
747
  */
742
748
  /** {en}
743
749
  * @brief A playback issue occurred.
744
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
750
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
745
751
  */
746
752
  MEDIA_MSE_HIJACK = 5204,
747
753
  /** {zh}
@@ -750,25 +756,29 @@ declare enum ErrorCode {
750
756
  */
751
757
  /** {en}
752
758
  * @brief A playback issue occurred.
753
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
759
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
754
760
  */
755
761
  MEDIA_EME_HIJACK = 5301,
756
762
  /** {zh}
757
763
  * @brief DRM 权限校验失败
758
764
  * @hidden
765
+ * @solution 请检查权限配置,确保播放权限正确。
759
766
  */
760
767
  /** {en}
761
768
  * @brief DRM authentication failed.
762
769
  * @hidden
770
+ * @solution Verify the authentication and ensure proper playback permissions.
763
771
  */
764
772
  DRM_LICENSE = 7100,
765
773
  /** {zh}
766
774
  * @brief DRM 权限校验失败
767
775
  * @hidden
776
+ * @solution 请检查自定义 DRM 权限。
768
777
  */
769
778
  /** {en}
770
779
  * @brief DRM authentication failed.
771
780
  * @hidden
781
+ * @solution Please check the custom DRM authentication.
772
782
  */
773
783
  DRM_CUSTOM_LICENSE = 7200,
774
784
  /** {zh}
@@ -777,7 +787,7 @@ declare enum ErrorCode {
777
787
  */
778
788
  /** {en}
779
789
  * @brief A playback issue occurred.
780
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
790
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
781
791
  */
782
792
  OTHER = 8000,
783
793
  /** {zh}
@@ -786,7 +796,7 @@ declare enum ErrorCode {
786
796
  */
787
797
  /** {en}
788
798
  * @brief A playback issue occurred.
789
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
799
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
790
800
  */
791
801
  RUNTIME_NO_CANPLAY_ERROR = 9001,
792
802
  /** {zh}
@@ -795,7 +805,7 @@ declare enum ErrorCode {
795
805
  */
796
806
  /** {en}
797
807
  * @brief A playback issue occurred.
798
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
808
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
799
809
  */
800
810
  RUNTIME_BUFFERBREAK_ERROR = 9002,
801
811
  /** {zh}
@@ -804,7 +814,7 @@ declare enum ErrorCode {
804
814
  */
805
815
  /** {en}
806
816
  * @brief A playback issue occurred.
807
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
817
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
808
818
  */
809
819
  RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
810
820
  // veplayer 报错
@@ -821,9 +831,11 @@ declare enum ErrorCode {
821
831
  MODULE_LOAD_ERROR = 110,
822
832
  /** {zh}
823
833
  * @hidden
834
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
824
835
  */
825
836
  /** {en}
826
837
  * @hidden
838
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
827
839
  */
828
840
  UNKNOWN = "UNKNOWN"
829
841
  }
@@ -1589,8 +1601,7 @@ interface CommonStyle {
1589
1601
  * @brief 缓存部分进度条底色。
1590
1602
  */
1591
1603
  /** {en}
1592
- * @brief
1593
- * @brief The background color of the progress bar for the cached portion of video playback.
1604
+ * @brief The background color of the buffered portion of the progress bar.
1594
1605
  */
1595
1606
  cachedColor?: string;
1596
1607
  /** {zh}
@@ -2008,11 +2019,15 @@ declare class VePlayerBase {
2008
2019
  */
2009
2020
  fallbackToFirstDefinition?: boolean;
2010
2021
  /** {zh}
2011
- * @brief 是否无缝切换,true 为无缝切换,false 为非无缝切换。
2022
+ * @brief 是否启用无缝切换。
2023
+ * - `true`:启用无缝切换,保证播放过程中不中断。
2024
+ * - `false`:不启用无缝切换,可能会出现播放中断。
2012
2025
  * @default false
2013
2026
  */
2014
2027
  /** {en}
2015
- * @brief Whether seamless switching or not. True means seamless switching and false means non-seamless switching.
2028
+ * @brief Whether seamless switching is enabled.
2029
+ * - `true`: Enables seamless switching, ensuring no interruption during playback.
2030
+ * - `false`: Disables seamless switching, which may cause interruptions during playback.
2016
2031
  */
2017
2032
  seamless?: boolean;
2018
2033
  }): Promise<ExposedDefinition>;
@@ -2097,7 +2112,7 @@ declare class VePlayerBase {
2097
2112
  */
2098
2113
  on(event: string, callback: (data?: any) => any): void;
2099
2114
  /** {zh}
2100
- * @brief 调用此方法开始播放 。
2115
+ * @brief 调用此方法开始播放。
2101
2116
  */
2102
2117
  /** {en}
2103
2118
  * @brief Starts playback.
@@ -2141,20 +2156,24 @@ declare class VePlayerBase {
2141
2156
  */
2142
2157
  focus(data?: {
2143
2158
  /** {zh}
2144
- * @brief 是否需要自动失焦,默认为 true,即经过 delay 时长之后,会自动调用 blur() 进行失焦。
2159
+ * @brief 是否需要自动失焦。
2160
+ * - `true`:启用自动失焦,经过指定的延迟时间后,自动调用 `blur()` 方法进行失焦。
2161
+ * - `false`:禁用自动失焦,不会在延迟时间后自动调用 `blur()` 方法。
2145
2162
  * @default true
2146
2163
  */
2147
2164
  /** {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`.
2165
+ * @brief Whether auto-blur is enabled.
2166
+ * - `true`: Enables auto-blur, meaning `blur()` will be automatically called after the specified delay time.
2167
+ * - `false`: Disables auto-blur, meaning `blur()` will not be automatically called after the delay.
2149
2168
  * @default true
2150
2169
  */
2151
2170
  autoHide?: boolean;
2152
2171
  /** {zh}
2153
- * @brief 自动失焦延迟时长,单位ms,autoHide 为 true 时生效。
2172
+ * @brief 自动失焦的延迟时间,单位为毫秒。在 `autoHide``true` 时生效。
2154
2173
  * @default 3000
2155
2174
  */
2156
2175
  /** {en}
2157
- * @brief The duration after which the player automatically loses focus, in milliseconds. This parameter takes effect when `autoHide` is `true`.
2176
+ * @brief Delay duration (in milliseconds) before auto-blur is triggered. This takes effect only when `autoHide` is set to `true`.
2158
2177
  * @default 3000
2159
2178
  */
2160
2179
  delay?: number;
@@ -2169,11 +2188,11 @@ declare class VePlayerBase {
2169
2188
  */
2170
2189
  blur(data?: {
2171
2190
  /** {zh}
2172
- * @brief 播放器失焦是否忽略暂停状态,默认值是 true,即默认暂停的时候不取消播放器焦点状态。
2191
+ * @brief 播放器在暂停时是否保留焦点状态。默认值为 `true`,即播放器暂停时不会自动失焦。
2173
2192
  * @default false
2174
2193
  */
2175
2194
  /** {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.
2195
+ * @brief Whether the player retains focus when paused. The default is `true`, meaning the player will not automatically lose focus during pause.
2177
2196
  * @default false
2178
2197
  */
2179
2198
  ignorePaused?: boolean;
@@ -2577,6 +2596,14 @@ declare namespace strategy {
2577
2596
  *
2578
2597
  */
2579
2598
  fallbackUrls?: string[];
2599
+ /** {zh}
2600
+ * @hidden
2601
+ * @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
2602
+ */
2603
+ /** {en}
2604
+ * @hidden
2605
+ * @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
2606
+ */
2580
2607
  type?: string;
2581
2608
  }
2582
2609
  /** {zh}
@@ -2836,6 +2863,12 @@ declare namespace strategy {
2836
2863
  */
2837
2864
  Warn = "Warn"
2838
2865
  }
2866
+ /** {zh}
2867
+ * @id ErrorCodeRaw
2868
+ */
2869
+ /** {en}
2870
+ * @id ErrorCodeRaw
2871
+ */
2839
2872
  enum ErrorCode {
2840
2873
  /** {zh}
2841
2874
  * @brief 视频解析错误
@@ -2843,7 +2876,7 @@ declare namespace strategy {
2843
2876
  */
2844
2877
  /** {en}
2845
2878
  * @brief Video parsing error.
2846
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
2879
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2847
2880
  */
2848
2881
  MANIFEST_HLS_ERROR = 1100,
2849
2882
  /** {zh}
@@ -2852,7 +2885,7 @@ declare namespace strategy {
2852
2885
  */
2853
2886
  /** {en}
2854
2887
  * @brief Video parsing error.
2855
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
2888
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2856
2889
  */
2857
2890
  MANIFEST_DASH_ERROR = 1200,
2858
2891
  /** {zh}
@@ -2906,7 +2939,7 @@ declare namespace strategy {
2906
2939
  */
2907
2940
  /** {en}
2908
2941
  * @brief Video parsing error.
2909
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
2942
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2910
2943
  */
2911
2944
  DEMUX_FLV_ERROR = 3100,
2912
2945
  /** {zh}
@@ -2915,7 +2948,7 @@ declare namespace strategy {
2915
2948
  */
2916
2949
  /** {en}
2917
2950
  * @brief Video parsing error.
2918
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
2951
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2919
2952
  */
2920
2953
  DEMUX_HLS_ERROR = 3200,
2921
2954
  /** {zh}
@@ -2925,8 +2958,7 @@ declare namespace strategy {
2925
2958
  */
2926
2959
  /** {en}
2927
2960
  * @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
- *
2961
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2930
2962
  */
2931
2963
  DEMUX_MP4_ERROR = 3300,
2932
2964
  /** {zh}
@@ -2936,8 +2968,7 @@ declare namespace strategy {
2936
2968
  */
2937
2969
  /** {en}
2938
2970
  * @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
- *
2971
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2941
2972
  */
2942
2973
  DEMUX_FMP4_ERROR = 3400,
2943
2974
  /** {zh}
@@ -2947,8 +2978,7 @@ declare namespace strategy {
2947
2978
  */
2948
2979
  /** {en}
2949
2980
  * @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
- *
2981
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2952
2982
  */
2953
2983
  DEMUX_SIDX_ERROR = 3410,
2954
2984
  /** {zh}
@@ -2958,8 +2988,7 @@ declare namespace strategy {
2958
2988
  */
2959
2989
  /** {en}
2960
2990
  * @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
- *
2991
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2963
2992
  */
2964
2993
  REMUX_FMP4_ERROR = 4100,
2965
2994
  /** {zh}
@@ -2969,8 +2998,7 @@ declare namespace strategy {
2969
2998
  */
2970
2999
  /** {en}
2971
3000
  * @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
- *
3001
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
2974
3002
  */
2975
3003
  REMUX_MP4_ERROR = 4200,
2976
3004
  /** {zh}
@@ -3000,10 +3028,9 @@ declare namespace strategy {
3000
3028
  */
3001
3029
  /** {en}
3002
3030
  * @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).
3031
+ * @solution 1. Check whether there is any issue with the original video.
3032
+ * 2. Re-transcode the video and play it again.
3033
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3007
3034
  */
3008
3035
  MEDIA_ERR_DECODE = 5103,
3009
3036
  /** {zh}
@@ -3015,10 +3042,9 @@ declare namespace strategy {
3015
3042
  */
3016
3043
  /** {en}
3017
3044
  * @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).
3045
+ * @solution 1. Check whether there is any issue with the browser's request.
3046
+ * 2. Check whether the browser and the current page support the video format.
3047
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3022
3048
  */
3023
3049
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
3024
3050
  /** {zh}
@@ -3030,10 +3056,9 @@ declare namespace strategy {
3030
3056
  */
3031
3057
  /** {en}
3032
3058
  * @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).
3059
+ * @solution 1. Check whether there is any issue with the browser's request.
3060
+ * 2. Check whether the browser and the current page support the video format.
3061
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3037
3062
  */
3038
3063
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
3039
3064
  /** {zh}
@@ -3051,7 +3076,7 @@ declare namespace strategy {
3051
3076
  */
3052
3077
  /** {en}
3053
3078
  * @brief A playback issue occurred.
3054
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3079
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3055
3080
  */
3056
3081
  MEDIA_MSE_ADD_SB = 5200,
3057
3082
  /** {zh}
@@ -3060,7 +3085,7 @@ declare namespace strategy {
3060
3085
  */
3061
3086
  /** {en}
3062
3087
  * @brief A playback issue occurred.
3063
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3088
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3064
3089
  */
3065
3090
  MEDIA_MSE_APPEND_BUFFER = 5201,
3066
3091
  /** {zh}
@@ -3069,7 +3094,7 @@ declare namespace strategy {
3069
3094
  */
3070
3095
  /** {en}
3071
3096
  * @brief A playback issue occurred.
3072
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3097
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3073
3098
  */
3074
3099
  MEDIA_MSE_OTHER = 5202,
3075
3100
  /** {zh}
@@ -3078,7 +3103,7 @@ declare namespace strategy {
3078
3103
  */
3079
3104
  /** {en}
3080
3105
  * @brief A playback issue occurred.
3081
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3106
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3082
3107
  */
3083
3108
  MEDIA_MSE_FULL = 5203,
3084
3109
  /** {zh}
@@ -3087,7 +3112,7 @@ declare namespace strategy {
3087
3112
  */
3088
3113
  /** {en}
3089
3114
  * @brief A playback issue occurred.
3090
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3115
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3091
3116
  */
3092
3117
  MEDIA_MSE_HIJACK = 5204,
3093
3118
  /** {zh}
@@ -3096,25 +3121,29 @@ declare namespace strategy {
3096
3121
  */
3097
3122
  /** {en}
3098
3123
  * @brief A playback issue occurred.
3099
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3124
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3100
3125
  */
3101
3126
  MEDIA_EME_HIJACK = 5301,
3102
3127
  /** {zh}
3103
3128
  * @brief DRM 权限校验失败
3104
3129
  * @hidden
3130
+ * @solution 请检查权限配置,确保播放权限正确。
3105
3131
  */
3106
3132
  /** {en}
3107
3133
  * @brief DRM authentication failed.
3108
3134
  * @hidden
3135
+ * @solution Verify the authentication and ensure proper playback permissions.
3109
3136
  */
3110
3137
  DRM_LICENSE = 7100,
3111
3138
  /** {zh}
3112
3139
  * @brief DRM 权限校验失败
3113
3140
  * @hidden
3141
+ * @solution 请检查自定义 DRM 权限。
3114
3142
  */
3115
3143
  /** {en}
3116
3144
  * @brief DRM authentication failed.
3117
3145
  * @hidden
3146
+ * @solution Please check the custom DRM authentication.
3118
3147
  */
3119
3148
  DRM_CUSTOM_LICENSE = 7200,
3120
3149
  /** {zh}
@@ -3123,7 +3152,7 @@ declare namespace strategy {
3123
3152
  */
3124
3153
  /** {en}
3125
3154
  * @brief A playback issue occurred.
3126
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3155
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3127
3156
  */
3128
3157
  OTHER = 8000,
3129
3158
  /** {zh}
@@ -3132,7 +3161,7 @@ declare namespace strategy {
3132
3161
  */
3133
3162
  /** {en}
3134
3163
  * @brief A playback issue occurred.
3135
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3164
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3136
3165
  */
3137
3166
  RUNTIME_NO_CANPLAY_ERROR = 9001,
3138
3167
  /** {zh}
@@ -3141,7 +3170,7 @@ declare namespace strategy {
3141
3170
  */
3142
3171
  /** {en}
3143
3172
  * @brief A playback issue occurred.
3144
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3173
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3145
3174
  */
3146
3175
  RUNTIME_BUFFERBREAK_ERROR = 9002,
3147
3176
  /** {zh}
@@ -3150,7 +3179,7 @@ declare namespace strategy {
3150
3179
  */
3151
3180
  /** {en}
3152
3181
  * @brief A playback issue occurred.
3153
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
3182
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3154
3183
  */
3155
3184
  RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
3156
3185
  // veplayer 报错
@@ -3167,9 +3196,11 @@ declare namespace strategy {
3167
3196
  MODULE_LOAD_ERROR = 110,
3168
3197
  /** {zh}
3169
3198
  * @hidden
3199
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
3170
3200
  */
3171
3201
  /** {en}
3172
3202
  * @hidden
3203
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
3173
3204
  */
3174
3205
  UNKNOWN = "UNKNOWN"
3175
3206
  }
@@ -3939,8 +3970,7 @@ declare namespace strategy {
3939
3970
  * @brief 缓存部分进度条底色。
3940
3971
  */
3941
3972
  /** {en}
3942
- * @brief
3943
- * @brief The background color of the progress bar for the cached portion of video playback.
3973
+ * @brief The background color of the buffered portion of the progress bar.
3944
3974
  */
3945
3975
  cachedColor?: string;
3946
3976
  /** {zh}
@@ -4477,6 +4507,12 @@ declare namespace error {
4477
4507
  */
4478
4508
  Warn = "Warn"
4479
4509
  }
4510
+ /** {zh}
4511
+ * @id ErrorCodeRaw
4512
+ */
4513
+ /** {en}
4514
+ * @id ErrorCodeRaw
4515
+ */
4480
4516
  enum ErrorCode {
4481
4517
  /** {zh}
4482
4518
  * @brief 视频解析错误
@@ -4484,7 +4520,7 @@ declare namespace error {
4484
4520
  */
4485
4521
  /** {en}
4486
4522
  * @brief Video parsing error.
4487
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
4523
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4488
4524
  */
4489
4525
  MANIFEST_HLS_ERROR = 1100,
4490
4526
  /** {zh}
@@ -4493,7 +4529,7 @@ declare namespace error {
4493
4529
  */
4494
4530
  /** {en}
4495
4531
  * @brief Video parsing error.
4496
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
4532
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4497
4533
  */
4498
4534
  MANIFEST_DASH_ERROR = 1200,
4499
4535
  /** {zh}
@@ -4547,7 +4583,7 @@ declare namespace error {
4547
4583
  */
4548
4584
  /** {en}
4549
4585
  * @brief Video parsing error.
4550
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4586
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4551
4587
  */
4552
4588
  DEMUX_FLV_ERROR = 3100,
4553
4589
  /** {zh}
@@ -4556,7 +4592,7 @@ declare namespace error {
4556
4592
  */
4557
4593
  /** {en}
4558
4594
  * @brief Video parsing error.
4559
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
4595
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4560
4596
  */
4561
4597
  DEMUX_HLS_ERROR = 3200,
4562
4598
  /** {zh}
@@ -4566,8 +4602,7 @@ declare namespace error {
4566
4602
  */
4567
4603
  /** {en}
4568
4604
  * @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
- *
4605
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4571
4606
  */
4572
4607
  DEMUX_MP4_ERROR = 3300,
4573
4608
  /** {zh}
@@ -4577,8 +4612,7 @@ declare namespace error {
4577
4612
  */
4578
4613
  /** {en}
4579
4614
  * @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
- *
4615
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4582
4616
  */
4583
4617
  DEMUX_FMP4_ERROR = 3400,
4584
4618
  /** {zh}
@@ -4588,8 +4622,7 @@ declare namespace error {
4588
4622
  */
4589
4623
  /** {en}
4590
4624
  * @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
- *
4625
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4593
4626
  */
4594
4627
  DEMUX_SIDX_ERROR = 3410,
4595
4628
  /** {zh}
@@ -4599,8 +4632,7 @@ declare namespace error {
4599
4632
  */
4600
4633
  /** {en}
4601
4634
  * @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
- *
4635
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4604
4636
  */
4605
4637
  REMUX_FMP4_ERROR = 4100,
4606
4638
  /** {zh}
@@ -4610,8 +4642,7 @@ declare namespace error {
4610
4642
  */
4611
4643
  /** {en}
4612
4644
  * @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
- *
4645
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4615
4646
  */
4616
4647
  REMUX_MP4_ERROR = 4200,
4617
4648
  /** {zh}
@@ -4641,10 +4672,9 @@ declare namespace error {
4641
4672
  */
4642
4673
  /** {en}
4643
4674
  * @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).
4675
+ * @solution 1. Check whether there is any issue with the original video.
4676
+ * 2. Re-transcode the video and play it again.
4677
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4648
4678
  */
4649
4679
  MEDIA_ERR_DECODE = 5103,
4650
4680
  /** {zh}
@@ -4656,10 +4686,9 @@ declare namespace error {
4656
4686
  */
4657
4687
  /** {en}
4658
4688
  * @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).
4689
+ * @solution 1. Check whether there is any issue with the browser's request.
4690
+ * 2. Check whether the browser and the current page support the video format.
4691
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4663
4692
  */
4664
4693
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
4665
4694
  /** {zh}
@@ -4671,10 +4700,9 @@ declare namespace error {
4671
4700
  */
4672
4701
  /** {en}
4673
4702
  * @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).
4703
+ * @solution 1. Check whether there is any issue with the browser's request.
4704
+ * 2. Check whether the browser and the current page support the video format.
4705
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4678
4706
  */
4679
4707
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
4680
4708
  /** {zh}
@@ -4692,7 +4720,7 @@ declare namespace error {
4692
4720
  */
4693
4721
  /** {en}
4694
4722
  * @brief A playback issue occurred.
4695
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4723
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4696
4724
  */
4697
4725
  MEDIA_MSE_ADD_SB = 5200,
4698
4726
  /** {zh}
@@ -4701,7 +4729,7 @@ declare namespace error {
4701
4729
  */
4702
4730
  /** {en}
4703
4731
  * @brief A playback issue occurred.
4704
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4732
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4705
4733
  */
4706
4734
  MEDIA_MSE_APPEND_BUFFER = 5201,
4707
4735
  /** {zh}
@@ -4710,7 +4738,7 @@ declare namespace error {
4710
4738
  */
4711
4739
  /** {en}
4712
4740
  * @brief A playback issue occurred.
4713
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4741
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4714
4742
  */
4715
4743
  MEDIA_MSE_OTHER = 5202,
4716
4744
  /** {zh}
@@ -4719,7 +4747,7 @@ declare namespace error {
4719
4747
  */
4720
4748
  /** {en}
4721
4749
  * @brief A playback issue occurred.
4722
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4750
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4723
4751
  */
4724
4752
  MEDIA_MSE_FULL = 5203,
4725
4753
  /** {zh}
@@ -4728,7 +4756,7 @@ declare namespace error {
4728
4756
  */
4729
4757
  /** {en}
4730
4758
  * @brief A playback issue occurred.
4731
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4759
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4732
4760
  */
4733
4761
  MEDIA_MSE_HIJACK = 5204,
4734
4762
  /** {zh}
@@ -4737,25 +4765,29 @@ declare namespace error {
4737
4765
  */
4738
4766
  /** {en}
4739
4767
  * @brief A playback issue occurred.
4740
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4768
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4741
4769
  */
4742
4770
  MEDIA_EME_HIJACK = 5301,
4743
4771
  /** {zh}
4744
4772
  * @brief DRM 权限校验失败
4745
4773
  * @hidden
4774
+ * @solution 请检查权限配置,确保播放权限正确。
4746
4775
  */
4747
4776
  /** {en}
4748
4777
  * @brief DRM authentication failed.
4749
4778
  * @hidden
4779
+ * @solution Verify the authentication and ensure proper playback permissions.
4750
4780
  */
4751
4781
  DRM_LICENSE = 7100,
4752
4782
  /** {zh}
4753
4783
  * @brief DRM 权限校验失败
4754
4784
  * @hidden
4785
+ * @solution 请检查自定义 DRM 权限。
4755
4786
  */
4756
4787
  /** {en}
4757
4788
  * @brief DRM authentication failed.
4758
4789
  * @hidden
4790
+ * @solution Please check the custom DRM authentication.
4759
4791
  */
4760
4792
  DRM_CUSTOM_LICENSE = 7200,
4761
4793
  /** {zh}
@@ -4764,7 +4796,7 @@ declare namespace error {
4764
4796
  */
4765
4797
  /** {en}
4766
4798
  * @brief A playback issue occurred.
4767
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4799
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4768
4800
  */
4769
4801
  OTHER = 8000,
4770
4802
  /** {zh}
@@ -4773,7 +4805,7 @@ declare namespace error {
4773
4805
  */
4774
4806
  /** {en}
4775
4807
  * @brief A playback issue occurred.
4776
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4808
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4777
4809
  */
4778
4810
  RUNTIME_NO_CANPLAY_ERROR = 9001,
4779
4811
  /** {zh}
@@ -4782,7 +4814,7 @@ declare namespace error {
4782
4814
  */
4783
4815
  /** {en}
4784
4816
  * @brief A playback issue occurred.
4785
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4817
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4786
4818
  */
4787
4819
  RUNTIME_BUFFERBREAK_ERROR = 9002,
4788
4820
  /** {zh}
@@ -4791,7 +4823,7 @@ declare namespace error {
4791
4823
  */
4792
4824
  /** {en}
4793
4825
  * @brief A playback issue occurred.
4794
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
4826
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4795
4827
  */
4796
4828
  RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
4797
4829
  // veplayer 报错
@@ -4808,9 +4840,11 @@ declare namespace error {
4808
4840
  MODULE_LOAD_ERROR = 110,
4809
4841
  /** {zh}
4810
4842
  * @hidden
4843
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
4811
4844
  */
4812
4845
  /** {en}
4813
4846
  * @hidden
4847
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
4814
4848
  */
4815
4849
  UNKNOWN = "UNKNOWN"
4816
4850
  }
@@ -5364,9 +5398,40 @@ declare enum FallbackKind {
5364
5398
  Error = "Error",
5365
5399
  Stall = "Stall"
5366
5400
  }
5401
+ /** {zh}
5402
+ * @list option
5403
+ * @kind property
5404
+ */
5405
+ /** {en}
5406
+ * @list option
5407
+ * @kind property
5408
+ */
5367
5409
  interface ErrorFallbackStrategy {
5410
+ /** {zh}
5411
+ * @brief 降级类型,定义是否自动降级或手动控制。
5412
+ * @hidden
5413
+ */
5414
+ /** {en}
5415
+ * @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
5416
+ */
5368
5417
  type?: FallbackKind;
5418
+ /** {zh}
5419
+ * @brief 降级黑名单。若错误码命中该列表,则不会触发降级逻辑。
5420
+ */
5421
+ /** {en}
5422
+ * @brief List of error codes to ignore for fallback. If the error code is in this list, fallback will not be triggered.
5423
+ */
5369
5424
  excludeList?: ErrorCode[];
5425
+ /** {zh}
5426
+ * @brief 自定义降级策略。返回值为:
5427
+ * - `true`:执行降级。
5428
+ * - `false`:不执行降级。
5429
+ */
5430
+ /** {en}
5431
+ * @brief Custom fallback logic. Returns:<br>
5432
+ * - `true`: fallback will occur<br>
5433
+ * - `false`: no fallback
5434
+ */
5370
5435
  shouldFallback?: (type: string, params: {
5371
5436
  error: VeError;
5372
5437
  }) => boolean;
@@ -5505,14 +5570,14 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5505
5570
  */
5506
5571
  ad?: AdConfig;
5507
5572
  /** {zh}
5508
- * @brief 为播放器设置直播时移配置,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
5573
+ * @brief 为播放器设置直播时移配置,接入方法请参见[直播时移](https://www.volcengine.com/docs/6469/1548574)。
5509
5574
  */
5510
5575
  /** {en}
5511
5576
  * @brief Configurations for time shifting.
5512
5577
  */
5513
5578
  timeShift?: TimeShiftConfig;
5514
5579
  /** {zh}
5515
- * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#日志上报)。
5580
+ * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[播放日志上报](https://www.volcengine.com/docs/6469/1548575)。
5516
5581
  */
5517
5582
  /** {en}
5518
5583
  * @brief Configurations for log upload. Supports enabling/disabling log upload and setting log parameters.
@@ -5539,16 +5604,84 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5539
5604
  * @brief Digital Rights Management (DRM) configurations.
5540
5605
  */
5541
5606
  drm?: Drm;
5607
+ /** {zh}
5608
+ * @brief 设置播放器的播放延迟模式。
5609
+ * - `standard`:标准延迟,稳定性高。
5610
+ * - `low`:低延迟,适用于互动场景。
5611
+ * @hidden
5612
+ */
5613
+ /** {en}
5614
+ * @brief Sets the playback latency mode of the player. Optional values:
5615
+ * - `standard`: Standard latency with higher stability.
5616
+ * - `low`: Low latency, suitable for interactive scenarios.
5617
+ * @hidden
5618
+ */
5542
5619
  latencyMode?: "standard" | "low";
5620
+ /** {zh}
5621
+ * @brief 配置协议降级参数。当播放失败或卡顿时,可根据策略降级使用其他协议。
5622
+ */
5623
+ /** {en}
5624
+ * @brief Configure protocol downgrade parameters. When playback fails or stutters, other protocols can be downgraded according to the strategy.
5625
+ */
5543
5626
  fallback?: Fallback;
5544
5627
  }
5628
+ /** {zh}
5629
+ * @list option
5630
+ * @kind property
5631
+ */
5632
+ /** {en}
5633
+ * @list option
5634
+ * @kind property
5635
+ */
5545
5636
  interface Fallback {
5637
+ /** {zh}
5638
+ * @brief 是否开启协议降级功能。
5639
+ * @hidden
5640
+ */
5641
+ /** {en}
5642
+ * @brief Whether to enable protocol fallback.
5643
+ */
5546
5644
  enableFallback?: boolean;
5547
- fallbackOrder?: string[];
5548
- fallbackStrategy?: Record<string | "all", {
5549
- [FallbackKind.Error]?: ErrorFallbackStrategy;
5550
- [FallbackKind.Stall]?: StallFallbackStrategy;
5551
- }>;
5645
+ /** {zh}
5646
+ * @brief 协议选择优先级顺序。
5647
+ * @listtip - 配置多个协议时,按该顺序选择当前浏览器环境支持的协议。
5648
+ * - 播放失败时根据 `fallbackStrategy` 判断需要降级时,按该顺序选择下一个协议。
5649
+ */
5650
+ /** {en}
5651
+ * @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`.
5652
+ */
5653
+ fallbackOrder?: Array<"rtm" | "flv" | "hls">;
5654
+ /** {zh}
5655
+ * @brief 协议降级策略配置。
5656
+ * @listtip - 默认为 RTM 播放出错时触发降级。
5657
+ * - 若所有协议采用同一策略,可通过设置 `all` 实现统一配置。
5658
+ * - 若同时配置了 `all` 和某个协议(如 `rtm`),将优先使用协议自身的配置,即 `rtm` 策略优先级高于 `all`。
5659
+ */
5660
+ /** {en}
5661
+ * @listtip - By default, fallback is triggered when RTM playback fails.
5662
+ * - Use `all` to apply the same strategy across all protocols.
5663
+ * - If both `all` and a specific protocol (e.g., `rtm`) are set, the specific protocol strategy takes precedence.
5664
+ * @brief Strategy for protocol fallback.
5665
+ */
5666
+ fallbackStrategy?: Record<"rtm" | "flv" | "hls" | "all", FallbackStrategy>;
5667
+ }
5668
+ /** {zh}
5669
+ * @list option
5670
+ * @kind property
5671
+ */
5672
+ /** {en}
5673
+ * @list option
5674
+ * @kind property
5675
+ */
5676
+ interface FallbackStrategy {
5677
+ /** {zh}
5678
+ * @brief 拉流报错时降级策略
5679
+ */
5680
+ [FallbackKind.Error]?: ErrorFallbackStrategy;
5681
+ /**
5682
+ * @hidden
5683
+ */
5684
+ [FallbackKind.Stall]?: StallFallbackStrategy;
5552
5685
  }
5553
5686
  /** {zh}
5554
5687
  * @list option
@@ -5877,7 +6010,7 @@ interface Rtm {
5877
6010
  * - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
5878
6011
  * - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
5879
6012
  * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
5880
- * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 拉流](https://www.volcengine.com/docs/6469/138655#rtm-%E6%8B%89%E6%B5%81)。
6013
+ * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
5881
6014
  */
5882
6015
  /** {en}
5883
6016
  * @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 +6057,7 @@ interface Rtm {
5924
6057
  * @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
5925
6058
  * - `true`: Enable;
5926
6059
  * - `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).
6060
+ * @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
6061
  * @default false
5930
6062
  */
5931
6063
  enableRTMAutoTranscode?: boolean;
@@ -5974,7 +6106,7 @@ interface Rtm {
5974
6106
  * @brief RTM 协议缓冲区延迟,单位为秒。
5975
6107
  */
5976
6108
  /** {en}
5977
- * @brief buffer delay to handle network jitter, in seconds
6109
+ * @brief buffer delay to handle network jitter, in seconds.
5978
6110
  */
5979
6111
  delayHint?: number;
5980
6112
  }
@@ -6452,10 +6584,12 @@ interface StatsSnapShoot {
6452
6584
  /** {zh}
6453
6585
  * @list option
6454
6586
  * @kind property
6587
+ * @brief HLS、FLV 协议播放基础信息。
6455
6588
  */
6456
6589
  /** {en}
6457
6590
  * @list option
6458
6591
  * @kind property
6592
+ * @brief Basic information for HLS and FLV protocol playback.
6459
6593
  */
6460
6594
  interface Stats$0 {
6461
6595
  /** {zh}
@@ -6576,7 +6710,7 @@ interface Stats$0 {
6576
6710
  /** {zh}
6577
6711
  * @list option
6578
6712
  * @kind property
6579
- * @brief FLV 直播流播放信息。
6713
+ * @brief 除了 Stats 基础信息,FLV 直播流额外播放信息。
6580
6714
  */
6581
6715
  /** {en}
6582
6716
  * @list option
@@ -6610,6 +6744,12 @@ interface FlvStats extends Stats$0 {
6610
6744
  * @inheritdoc
6611
6745
  */
6612
6746
  declare class VePlayerLive extends VePlayerBase {
6747
+ /** {en}
6748
+ * @hidden
6749
+ */
6750
+ /** {zh}
6751
+ * @hidden
6752
+ */
6613
6753
  _protocolManager?: ProtocolManager;
6614
6754
  /** {zh}
6615
6755
  * @hidden
@@ -6680,10 +6820,11 @@ declare class VePlayerLive extends VePlayerBase {
6680
6820
  closeAbr(): void;
6681
6821
  /** {zh}
6682
6822
  * @brief 调用此方法更新 DRM 配置。
6823
+ * @param config DRM 配置对象,包含 Fairplay DRM 的相关设置。
6683
6824
  */
6684
6825
  /** {en}
6685
6826
  * @brief Use this method to update DRM configuration.
6686
- * @param config
6827
+ * @param config A configuration object containing settings for Fairplay DRM.
6687
6828
  */
6688
6829
  updateDrmConfig(config: FairplayDrmConfig): void;
6689
6830
  /** {zh}
@@ -6698,13 +6839,13 @@ declare class VePlayerLive extends VePlayerBase {
6698
6839
  switchAbr(options: {
6699
6840
  /** {zh}
6700
6841
  * @brief 是否开启 ABR 功能。
6701
- * - true:开启
6702
- * - false:关闭
6842
+ * - `true`:开启
6843
+ * - `false`:关闭
6703
6844
  */
6704
6845
  /** {en}
6705
6846
  * @brief Whether to enable the ABR function.
6706
- * - true: Enabled ;
6707
- * - false: Disabled
6847
+ * - `true`: Enabled ;
6848
+ * - `false`: Disabled
6708
6849
  * @default -
6709
6850
  */
6710
6851
  enable: boolean;
@@ -6748,11 +6889,26 @@ declare class VePlayerLive extends VePlayerBase {
6748
6889
  * @brief Obtain the playback information of HLS pull streaming.
6749
6890
  */
6750
6891
  getHLSStats(): Stats$0;
6892
+ /** {en}
6893
+ * @brief This method is used to update the playlist, supporting updates to source, resolution, and related information.
6894
+ * @param playlist The playlist, consisting of multiple `Source` type elements.
6895
+ * @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.
6896
+ * @param needUpdateProtocol Whether the protocol needs to be updated.
6897
+ *
6898
+ * - `true`: Forces the protocol update to ensure compatibility with the playback configuration or source.
6899
+ * - `false`: Does not update the protocol and continues to use the current configuration.
6900
+ */
6901
+ /** {zh}
6902
+ * @brief 调用此方法更新播放列表,支持更新源、清晰度等相关信息。
6903
+ * @param playlist 播放列表,包含多个 `Source` 类型的元素。
6904
+ * @param target 可选的目标配置项,可以指定清晰度或源。提供这些信息可以帮助更新特定清晰度或线路的播放源。
6905
+ * @param needUpdateProtocol 是否需要更新协议。
6906
+ * - `true`:强制更新协议,以确保播放配置或源的兼容性。
6907
+ * - `false`:不更新协议,继续使用当前配置。
6908
+ */
6751
6909
  updatePlaylist(playlist: ExposedSource[], target?: string | {
6752
6910
  /** {zh}
6753
6911
  * @brief 清晰度唯一标识。
6754
- * @default 无
6755
- *
6756
6912
  */
6757
6913
  /** {en}
6758
6914
  * @brief The resolution ID.
@@ -6761,8 +6917,6 @@ declare class VePlayerLive extends VePlayerBase {
6761
6917
  definition?: string;
6762
6918
  /** {zh}
6763
6919
  * @brief 线路的唯一标识。
6764
- * @default 无
6765
- *
6766
6920
  */
6767
6921
  /** {en}
6768
6922
  * @brief The playback resource ID.
@@ -7075,6 +7229,14 @@ declare namespace live {
7075
7229
  *
7076
7230
  */
7077
7231
  fallbackUrls?: string[];
7232
+ /** {zh}
7233
+ * @hidden
7234
+ * @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
7235
+ */
7236
+ /** {en}
7237
+ * @hidden
7238
+ * @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
7239
+ */
7078
7240
  type?: string;
7079
7241
  }
7080
7242
  /** {zh}
@@ -7334,6 +7496,12 @@ declare namespace live {
7334
7496
  */
7335
7497
  Warn = "Warn"
7336
7498
  }
7499
+ /** {zh}
7500
+ * @id ErrorCodeRaw
7501
+ */
7502
+ /** {en}
7503
+ * @id ErrorCodeRaw
7504
+ */
7337
7505
  enum ErrorCode {
7338
7506
  /** {zh}
7339
7507
  * @brief 视频解析错误
@@ -7341,7 +7509,7 @@ declare namespace live {
7341
7509
  */
7342
7510
  /** {en}
7343
7511
  * @brief Video parsing error.
7344
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
7512
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7345
7513
  */
7346
7514
  MANIFEST_HLS_ERROR = 1100,
7347
7515
  /** {zh}
@@ -7350,7 +7518,7 @@ declare namespace live {
7350
7518
  */
7351
7519
  /** {en}
7352
7520
  * @brief Video parsing error.
7353
- * @solution Please contact your [technical support](https://www.byteplus.com/en/support).
7521
+ * @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7354
7522
  */
7355
7523
  MANIFEST_DASH_ERROR = 1200,
7356
7524
  /** {zh}
@@ -7404,7 +7572,7 @@ declare namespace live {
7404
7572
  */
7405
7573
  /** {en}
7406
7574
  * @brief Video parsing error.
7407
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
7575
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7408
7576
  */
7409
7577
  DEMUX_FLV_ERROR = 3100,
7410
7578
  /** {zh}
@@ -7413,7 +7581,7 @@ declare namespace live {
7413
7581
  */
7414
7582
  /** {en}
7415
7583
  * @brief Video parsing error.
7416
- * @solution Check whether the pull stream address is valid, or contact [technical support](https://www.byteplus.com/en/support).
7584
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7417
7585
  */
7418
7586
  DEMUX_HLS_ERROR = 3200,
7419
7587
  /** {zh}
@@ -7423,8 +7591,7 @@ declare namespace live {
7423
7591
  */
7424
7592
  /** {en}
7425
7593
  * @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
- *
7594
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7428
7595
  */
7429
7596
  DEMUX_MP4_ERROR = 3300,
7430
7597
  /** {zh}
@@ -7434,8 +7601,7 @@ declare namespace live {
7434
7601
  */
7435
7602
  /** {en}
7436
7603
  * @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
- *
7604
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7439
7605
  */
7440
7606
  DEMUX_FMP4_ERROR = 3400,
7441
7607
  /** {zh}
@@ -7445,8 +7611,7 @@ declare namespace live {
7445
7611
  */
7446
7612
  /** {en}
7447
7613
  * @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
- *
7614
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7450
7615
  */
7451
7616
  DEMUX_SIDX_ERROR = 3410,
7452
7617
  /** {zh}
@@ -7456,8 +7621,7 @@ declare namespace live {
7456
7621
  */
7457
7622
  /** {en}
7458
7623
  * @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
- *
7624
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7461
7625
  */
7462
7626
  REMUX_FMP4_ERROR = 4100,
7463
7627
  /** {zh}
@@ -7467,8 +7631,7 @@ declare namespace live {
7467
7631
  */
7468
7632
  /** {en}
7469
7633
  * @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
- *
7634
+ * @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7472
7635
  */
7473
7636
  REMUX_MP4_ERROR = 4200,
7474
7637
  /** {zh}
@@ -7498,10 +7661,9 @@ declare namespace live {
7498
7661
  */
7499
7662
  /** {en}
7500
7663
  * @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).
7664
+ * @solution 1. Check whether there is any issue with the original video.
7665
+ * 2. Re-transcode the video and play it again.
7666
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7505
7667
  */
7506
7668
  MEDIA_ERR_DECODE = 5103,
7507
7669
  /** {zh}
@@ -7513,10 +7675,9 @@ declare namespace live {
7513
7675
  */
7514
7676
  /** {en}
7515
7677
  * @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).
7678
+ * @solution 1. Check whether there is any issue with the browser's request.
7679
+ * 2. Check whether the browser and the current page support the video format.
7680
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7520
7681
  */
7521
7682
  MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
7522
7683
  /** {zh}
@@ -7528,10 +7689,9 @@ declare namespace live {
7528
7689
  */
7529
7690
  /** {en}
7530
7691
  * @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).
7692
+ * @solution 1. Check whether there is any issue with the browser's request.
7693
+ * 2. Check whether the browser and the current page support the video format.
7694
+ * 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7535
7695
  */
7536
7696
  MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
7537
7697
  /** {zh}
@@ -7549,7 +7709,7 @@ declare namespace live {
7549
7709
  */
7550
7710
  /** {en}
7551
7711
  * @brief A playback issue occurred.
7552
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7712
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7553
7713
  */
7554
7714
  MEDIA_MSE_ADD_SB = 5200,
7555
7715
  /** {zh}
@@ -7558,7 +7718,7 @@ declare namespace live {
7558
7718
  */
7559
7719
  /** {en}
7560
7720
  * @brief A playback issue occurred.
7561
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7721
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7562
7722
  */
7563
7723
  MEDIA_MSE_APPEND_BUFFER = 5201,
7564
7724
  /** {zh}
@@ -7567,7 +7727,7 @@ declare namespace live {
7567
7727
  */
7568
7728
  /** {en}
7569
7729
  * @brief A playback issue occurred.
7570
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7730
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7571
7731
  */
7572
7732
  MEDIA_MSE_OTHER = 5202,
7573
7733
  /** {zh}
@@ -7576,7 +7736,7 @@ declare namespace live {
7576
7736
  */
7577
7737
  /** {en}
7578
7738
  * @brief A playback issue occurred.
7579
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7739
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7580
7740
  */
7581
7741
  MEDIA_MSE_FULL = 5203,
7582
7742
  /** {zh}
@@ -7585,7 +7745,7 @@ declare namespace live {
7585
7745
  */
7586
7746
  /** {en}
7587
7747
  * @brief A playback issue occurred.
7588
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7748
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7589
7749
  */
7590
7750
  MEDIA_MSE_HIJACK = 5204,
7591
7751
  /** {zh}
@@ -7594,25 +7754,29 @@ declare namespace live {
7594
7754
  */
7595
7755
  /** {en}
7596
7756
  * @brief A playback issue occurred.
7597
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7757
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7598
7758
  */
7599
7759
  MEDIA_EME_HIJACK = 5301,
7600
7760
  /** {zh}
7601
7761
  * @brief DRM 权限校验失败
7602
7762
  * @hidden
7763
+ * @solution 请检查权限配置,确保播放权限正确。
7603
7764
  */
7604
7765
  /** {en}
7605
7766
  * @brief DRM authentication failed.
7606
7767
  * @hidden
7768
+ * @solution Verify the authentication and ensure proper playback permissions.
7607
7769
  */
7608
7770
  DRM_LICENSE = 7100,
7609
7771
  /** {zh}
7610
7772
  * @brief DRM 权限校验失败
7611
7773
  * @hidden
7774
+ * @solution 请检查自定义 DRM 权限。
7612
7775
  */
7613
7776
  /** {en}
7614
7777
  * @brief DRM authentication failed.
7615
7778
  * @hidden
7779
+ * @solution Please check the custom DRM authentication.
7616
7780
  */
7617
7781
  DRM_CUSTOM_LICENSE = 7200,
7618
7782
  /** {zh}
@@ -7621,7 +7785,7 @@ declare namespace live {
7621
7785
  */
7622
7786
  /** {en}
7623
7787
  * @brief A playback issue occurred.
7624
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7788
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7625
7789
  */
7626
7790
  OTHER = 8000,
7627
7791
  /** {zh}
@@ -7630,7 +7794,7 @@ declare namespace live {
7630
7794
  */
7631
7795
  /** {en}
7632
7796
  * @brief A playback issue occurred.
7633
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7797
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7634
7798
  */
7635
7799
  RUNTIME_NO_CANPLAY_ERROR = 9001,
7636
7800
  /** {zh}
@@ -7639,7 +7803,7 @@ declare namespace live {
7639
7803
  */
7640
7804
  /** {en}
7641
7805
  * @brief A playback issue occurred.
7642
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7806
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7643
7807
  */
7644
7808
  RUNTIME_BUFFERBREAK_ERROR = 9002,
7645
7809
  /** {zh}
@@ -7648,7 +7812,7 @@ declare namespace live {
7648
7812
  */
7649
7813
  /** {en}
7650
7814
  * @brief A playback issue occurred.
7651
- * @solution Check the live stream source or contact your [technical support](https://www.byteplus.com/en/support).
7815
+ * @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7652
7816
  */
7653
7817
  RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
7654
7818
  // veplayer 报错
@@ -7665,9 +7829,11 @@ declare namespace live {
7665
7829
  MODULE_LOAD_ERROR = 110,
7666
7830
  /** {zh}
7667
7831
  * @hidden
7832
+ * @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
7668
7833
  */
7669
7834
  /** {en}
7670
7835
  * @hidden
7836
+ * @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
7671
7837
  */
7672
7838
  UNKNOWN = "UNKNOWN"
7673
7839
  }
@@ -8437,8 +8603,7 @@ declare namespace live {
8437
8603
  * @brief 缓存部分进度条底色。
8438
8604
  */
8439
8605
  /** {en}
8440
- * @brief
8441
- * @brief The background color of the progress bar for the cached portion of video playback.
8606
+ * @brief The background color of the buffered portion of the progress bar.
8442
8607
  */
8443
8608
  cachedColor?: string;
8444
8609
  /** {zh}
@@ -8857,11 +9022,15 @@ declare namespace live {
8857
9022
  */
8858
9023
  fallbackToFirstDefinition?: boolean;
8859
9024
  /** {zh}
8860
- * @brief 是否无缝切换,true 为无缝切换,false 为非无缝切换。
9025
+ * @brief 是否启用无缝切换。
9026
+ * - `true`:启用无缝切换,保证播放过程中不中断。
9027
+ * - `false`:不启用无缝切换,可能会出现播放中断。
8861
9028
  * @default false
8862
9029
  */
8863
9030
  /** {en}
8864
- * @brief Whether seamless switching or not. True means seamless switching and false means non-seamless switching.
9031
+ * @brief Whether seamless switching is enabled.
9032
+ * - `true`: Enables seamless switching, ensuring no interruption during playback.
9033
+ * - `false`: Disables seamless switching, which may cause interruptions during playback.
8865
9034
  */
8866
9035
  seamless?: boolean;
8867
9036
  }): Promise<ExposedDefinition>;
@@ -8946,7 +9115,7 @@ declare namespace live {
8946
9115
  */
8947
9116
  on(event: string, callback: (data?: any) => any): void;
8948
9117
  /** {zh}
8949
- * @brief 调用此方法开始播放 。
9118
+ * @brief 调用此方法开始播放。
8950
9119
  */
8951
9120
  /** {en}
8952
9121
  * @brief Starts playback.
@@ -8990,20 +9159,24 @@ declare namespace live {
8990
9159
  */
8991
9160
  focus(data?: {
8992
9161
  /** {zh}
8993
- * @brief 是否需要自动失焦,默认为 true,即经过 delay 时长之后,会自动调用 blur() 进行失焦。
9162
+ * @brief 是否需要自动失焦。
9163
+ * - `true`:启用自动失焦,经过指定的延迟时间后,自动调用 `blur()` 方法进行失焦。
9164
+ * - `false`:禁用自动失焦,不会在延迟时间后自动调用 `blur()` 方法。
8994
9165
  * @default true
8995
9166
  */
8996
9167
  /** {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`.
9168
+ * @brief Whether auto-blur is enabled.
9169
+ * - `true`: Enables auto-blur, meaning `blur()` will be automatically called after the specified delay time.
9170
+ * - `false`: Disables auto-blur, meaning `blur()` will not be automatically called after the delay.
8998
9171
  * @default true
8999
9172
  */
9000
9173
  autoHide?: boolean;
9001
9174
  /** {zh}
9002
- * @brief 自动失焦延迟时长,单位ms,autoHide 为 true 时生效。
9175
+ * @brief 自动失焦的延迟时间,单位为毫秒。在 `autoHide``true` 时生效。
9003
9176
  * @default 3000
9004
9177
  */
9005
9178
  /** {en}
9006
- * @brief The duration after which the player automatically loses focus, in milliseconds. This parameter takes effect when `autoHide` is `true`.
9179
+ * @brief Delay duration (in milliseconds) before auto-blur is triggered. This takes effect only when `autoHide` is set to `true`.
9007
9180
  * @default 3000
9008
9181
  */
9009
9182
  delay?: number;
@@ -9018,11 +9191,11 @@ declare namespace live {
9018
9191
  */
9019
9192
  blur(data?: {
9020
9193
  /** {zh}
9021
- * @brief 播放器失焦是否忽略暂停状态,默认值是 true,即默认暂停的时候不取消播放器焦点状态。
9194
+ * @brief 播放器在暂停时是否保留焦点状态。默认值为 `true`,即播放器暂停时不会自动失焦。
9022
9195
  * @default false
9023
9196
  */
9024
9197
  /** {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.
9198
+ * @brief Whether the player retains focus when paused. The default is `true`, meaning the player will not automatically lose focus during pause.
9026
9199
  * @default false
9027
9200
  */
9028
9201
  ignorePaused?: boolean;
@@ -9861,9 +10034,40 @@ declare namespace live {
9861
10034
  Error = "Error",
9862
10035
  Stall = "Stall"
9863
10036
  }
10037
+ /** {zh}
10038
+ * @list option
10039
+ * @kind property
10040
+ */
10041
+ /** {en}
10042
+ * @list option
10043
+ * @kind property
10044
+ */
9864
10045
  interface ErrorFallbackStrategy {
10046
+ /** {zh}
10047
+ * @brief 降级类型,定义是否自动降级或手动控制。
10048
+ * @hidden
10049
+ */
10050
+ /** {en}
10051
+ * @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
10052
+ */
9865
10053
  type?: FallbackKind;
10054
+ /** {zh}
10055
+ * @brief 降级黑名单。若错误码命中该列表,则不会触发降级逻辑。
10056
+ */
10057
+ /** {en}
10058
+ * @brief List of error codes to ignore for fallback. If the error code is in this list, fallback will not be triggered.
10059
+ */
9866
10060
  excludeList?: ErrorCode[];
10061
+ /** {zh}
10062
+ * @brief 自定义降级策略。返回值为:
10063
+ * - `true`:执行降级。
10064
+ * - `false`:不执行降级。
10065
+ */
10066
+ /** {en}
10067
+ * @brief Custom fallback logic. Returns:<br>
10068
+ * - `true`: fallback will occur<br>
10069
+ * - `false`: no fallback
10070
+ */
9867
10071
  shouldFallback?: (type: string, params: {
9868
10072
  error: VeError;
9869
10073
  }) => boolean;
@@ -10002,14 +10206,14 @@ declare namespace live {
10002
10206
  */
10003
10207
  ad?: AdConfig;
10004
10208
  /** {zh}
10005
- * @brief 为播放器设置直播时移配置,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#直播时移)。
10209
+ * @brief 为播放器设置直播时移配置,接入方法请参见[直播时移](https://www.volcengine.com/docs/6469/1548574)。
10006
10210
  */
10007
10211
  /** {en}
10008
10212
  * @brief Configurations for time shifting.
10009
10213
  */
10010
10214
  timeShift?: TimeShiftConfig;
10011
10215
  /** {zh}
10012
- * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[功能接入](https://www.volcengine.com/docs/6469/138655#日志上报)。
10216
+ * @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[播放日志上报](https://www.volcengine.com/docs/6469/1548575)。
10013
10217
  */
10014
10218
  /** {en}
10015
10219
  * @brief Configurations for log upload. Supports enabling/disabling log upload and setting log parameters.
@@ -10036,16 +10240,84 @@ declare namespace live {
10036
10240
  * @brief Digital Rights Management (DRM) configurations.
10037
10241
  */
10038
10242
  drm?: Drm;
10243
+ /** {zh}
10244
+ * @brief 设置播放器的播放延迟模式。
10245
+ * - `standard`:标准延迟,稳定性高。
10246
+ * - `low`:低延迟,适用于互动场景。
10247
+ * @hidden
10248
+ */
10249
+ /** {en}
10250
+ * @brief Sets the playback latency mode of the player. Optional values:
10251
+ * - `standard`: Standard latency with higher stability.
10252
+ * - `low`: Low latency, suitable for interactive scenarios.
10253
+ * @hidden
10254
+ */
10039
10255
  latencyMode?: "standard" | "low";
10256
+ /** {zh}
10257
+ * @brief 配置协议降级参数。当播放失败或卡顿时,可根据策略降级使用其他协议。
10258
+ */
10259
+ /** {en}
10260
+ * @brief Configure protocol downgrade parameters. When playback fails or stutters, other protocols can be downgraded according to the strategy.
10261
+ */
10040
10262
  fallback?: Fallback;
10041
10263
  }
10264
+ /** {zh}
10265
+ * @list option
10266
+ * @kind property
10267
+ */
10268
+ /** {en}
10269
+ * @list option
10270
+ * @kind property
10271
+ */
10042
10272
  interface Fallback {
10273
+ /** {zh}
10274
+ * @brief 是否开启协议降级功能。
10275
+ * @hidden
10276
+ */
10277
+ /** {en}
10278
+ * @brief Whether to enable protocol fallback.
10279
+ */
10043
10280
  enableFallback?: boolean;
10044
- fallbackOrder?: string[];
10045
- fallbackStrategy?: Record<string | "all", {
10046
- [FallbackKind.Error]?: ErrorFallbackStrategy;
10047
- [FallbackKind.Stall]?: StallFallbackStrategy;
10048
- }>;
10281
+ /** {zh}
10282
+ * @brief 协议选择优先级顺序。
10283
+ * @listtip - 配置多个协议时,按该顺序选择当前浏览器环境支持的协议。
10284
+ * - 播放失败时根据 `fallbackStrategy` 判断需要降级时,按该顺序选择下一个协议。
10285
+ */
10286
+ /** {en}
10287
+ * @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`.
10288
+ */
10289
+ fallbackOrder?: Array<"rtm" | "flv" | "hls">;
10290
+ /** {zh}
10291
+ * @brief 协议降级策略配置。
10292
+ * @listtip - 默认为 RTM 播放出错时触发降级。
10293
+ * - 若所有协议采用同一策略,可通过设置 `all` 实现统一配置。
10294
+ * - 若同时配置了 `all` 和某个协议(如 `rtm`),将优先使用协议自身的配置,即 `rtm` 策略优先级高于 `all`。
10295
+ */
10296
+ /** {en}
10297
+ * @listtip - By default, fallback is triggered when RTM playback fails.
10298
+ * - Use `all` to apply the same strategy across all protocols.
10299
+ * - If both `all` and a specific protocol (e.g., `rtm`) are set, the specific protocol strategy takes precedence.
10300
+ * @brief Strategy for protocol fallback.
10301
+ */
10302
+ fallbackStrategy?: Record<"rtm" | "flv" | "hls" | "all", FallbackStrategy>;
10303
+ }
10304
+ /** {zh}
10305
+ * @list option
10306
+ * @kind property
10307
+ */
10308
+ /** {en}
10309
+ * @list option
10310
+ * @kind property
10311
+ */
10312
+ interface FallbackStrategy {
10313
+ /** {zh}
10314
+ * @brief 拉流报错时降级策略
10315
+ */
10316
+ [FallbackKind.Error]?: ErrorFallbackStrategy;
10317
+ /**
10318
+ * @hidden
10319
+ */
10320
+ [FallbackKind.Stall]?: StallFallbackStrategy;
10049
10321
  }
10050
10322
  /** {zh}
10051
10323
  * @list option
@@ -10374,7 +10646,7 @@ declare namespace live {
10374
10646
  * - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
10375
10647
  * - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
10376
10648
  * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
10377
- * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 拉流](https://www.volcengine.com/docs/6469/138655#rtm-%E6%8B%89%E6%B5%81)。
10649
+ * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
10378
10650
  */
10379
10651
  /** {en}
10380
10652
  * @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 +10693,7 @@ declare namespace live {
10421
10693
  * @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
10422
10694
  * - `true`: Enable;
10423
10695
  * - `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).
10696
+ * @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
10697
  * @default false
10427
10698
  */
10428
10699
  enableRTMAutoTranscode?: boolean;
@@ -10471,7 +10742,7 @@ declare namespace live {
10471
10742
  * @brief RTM 协议缓冲区延迟,单位为秒。
10472
10743
  */
10473
10744
  /** {en}
10474
- * @brief buffer delay to handle network jitter, in seconds
10745
+ * @brief buffer delay to handle network jitter, in seconds.
10475
10746
  */
10476
10747
  delayHint?: number;
10477
10748
  }
@@ -10949,10 +11220,12 @@ declare namespace live {
10949
11220
  /** {zh}
10950
11221
  * @list option
10951
11222
  * @kind property
11223
+ * @brief HLS、FLV 协议播放基础信息。
10952
11224
  */
10953
11225
  /** {en}
10954
11226
  * @list option
10955
11227
  * @kind property
11228
+ * @brief Basic information for HLS and FLV protocol playback.
10956
11229
  */
10957
11230
  interface Stats$0 {
10958
11231
  /** {zh}
@@ -11073,7 +11346,7 @@ declare namespace live {
11073
11346
  /** {zh}
11074
11347
  * @list option
11075
11348
  * @kind property
11076
- * @brief FLV 直播流播放信息。
11349
+ * @brief 除了 Stats 基础信息,FLV 直播流额外播放信息。
11077
11350
  */
11078
11351
  /** {en}
11079
11352
  * @list option
@@ -11107,6 +11380,12 @@ declare namespace live {
11107
11380
  * @inheritdoc
11108
11381
  */
11109
11382
  class VePlayerLive extends VePlayerBase {
11383
+ /** {en}
11384
+ * @hidden
11385
+ */
11386
+ /** {zh}
11387
+ * @hidden
11388
+ */
11110
11389
  _protocolManager?: ProtocolManager;
11111
11390
  /** {zh}
11112
11391
  * @hidden
@@ -11177,10 +11456,11 @@ declare namespace live {
11177
11456
  closeAbr(): void;
11178
11457
  /** {zh}
11179
11458
  * @brief 调用此方法更新 DRM 配置。
11459
+ * @param config DRM 配置对象,包含 Fairplay DRM 的相关设置。
11180
11460
  */
11181
11461
  /** {en}
11182
11462
  * @brief Use this method to update DRM configuration.
11183
- * @param config
11463
+ * @param config A configuration object containing settings for Fairplay DRM.
11184
11464
  */
11185
11465
  updateDrmConfig(config: FairplayDrmConfig): void;
11186
11466
  /** {zh}
@@ -11195,13 +11475,13 @@ declare namespace live {
11195
11475
  switchAbr(options: {
11196
11476
  /** {zh}
11197
11477
  * @brief 是否开启 ABR 功能。
11198
- * - true:开启
11199
- * - false:关闭
11478
+ * - `true`:开启
11479
+ * - `false`:关闭
11200
11480
  */
11201
11481
  /** {en}
11202
11482
  * @brief Whether to enable the ABR function.
11203
- * - true: Enabled ;
11204
- * - false: Disabled
11483
+ * - `true`: Enabled ;
11484
+ * - `false`: Disabled
11205
11485
  * @default -
11206
11486
  */
11207
11487
  enable: boolean;
@@ -11245,11 +11525,26 @@ declare namespace live {
11245
11525
  * @brief Obtain the playback information of HLS pull streaming.
11246
11526
  */
11247
11527
  getHLSStats(): Stats$0;
11528
+ /** {en}
11529
+ * @brief This method is used to update the playlist, supporting updates to source, resolution, and related information.
11530
+ * @param playlist The playlist, consisting of multiple `Source` type elements.
11531
+ * @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.
11532
+ * @param needUpdateProtocol Whether the protocol needs to be updated.
11533
+ *
11534
+ * - `true`: Forces the protocol update to ensure compatibility with the playback configuration or source.
11535
+ * - `false`: Does not update the protocol and continues to use the current configuration.
11536
+ */
11537
+ /** {zh}
11538
+ * @brief 调用此方法更新播放列表,支持更新源、清晰度等相关信息。
11539
+ * @param playlist 播放列表,包含多个 `Source` 类型的元素。
11540
+ * @param target 可选的目标配置项,可以指定清晰度或源。提供这些信息可以帮助更新特定清晰度或线路的播放源。
11541
+ * @param needUpdateProtocol 是否需要更新协议。
11542
+ * - `true`:强制更新协议,以确保播放配置或源的兼容性。
11543
+ * - `false`:不更新协议,继续使用当前配置。
11544
+ */
11248
11545
  updatePlaylist(playlist: ExposedSource[], target?: string | {
11249
11546
  /** {zh}
11250
11547
  * @brief 清晰度唯一标识。
11251
- * @default 无
11252
- *
11253
11548
  */
11254
11549
  /** {en}
11255
11550
  * @brief The resolution ID.
@@ -11258,8 +11553,6 @@ declare namespace live {
11258
11553
  definition?: string;
11259
11554
  /** {zh}
11260
11555
  * @brief 线路的唯一标识。
11261
- * @default 无
11262
- *
11263
11556
  */
11264
11557
  /** {en}
11265
11558
  * @brief The playback resource ID.
@@ -12523,16 +12816,22 @@ declare namespace live {
12523
12816
  */
12524
12817
  INVALID_PARAMETER = 210,
12525
12818
  /**
12819
+ * @brief 缺少 RTM 降级参数
12820
+ * @solution 请检查是否设置 `playlist` 传入 `rtm` 降级协议地址
12821
+ * @hidden
12822
+ */
12823
+ /** {en}
12824
+ * @brief Missing RTM fallback parameter.
12526
12825
  * @hidden
12527
12826
  */
12528
12827
  EMPTY_RTM_FALLBACK_PARAMETER = 211,
12529
12828
  /** {zh}
12530
12829
  * @brief 日志错误
12531
- * @solution 未正确配置质量日志参数,请参考 https://www.volcengine.com/docs/6469/138655#日志上报 配置。
12830
+ * @solution 未正确配置质量日志参数,请参考[播放日志上报](https://www.volcengine.com/docs/6469/1548575)进行配置。
12532
12831
  */
12533
12832
  /** {en}
12534
12833
  * @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.
12834
+ * @solution Log options not configured correctly. Please refer to this [document](https://docs.byteplus.com/en/docs/byteplus-media-live/docs-feature-implementation).
12536
12835
  */
12537
12836
  INVALID_LOGGER = 220
12538
12837
  }
@@ -12544,12 +12843,14 @@ declare namespace live {
12544
12843
  * @name ErrorCode
12545
12844
  * @id ErrorCode
12546
12845
  * @structure errorCode
12846
+ * @brief 错误码。
12547
12847
  */
12548
12848
  /** {en}
12549
12849
  * @detail error
12550
12850
  * @name ErrorCode
12551
12851
  * @id ErrorCode
12552
12852
  * @structure errorCode
12853
+ * @brief Error code.
12553
12854
  */
12554
12855
  const ErrorCode$0: {
12555
12856
  [x: number]: string;