@volcengine/veplayer 2.7.1-rc.1 → 2.7.1-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/index.d.ts +155 -121
- package/esm/veplayer.biz.live.development.js +35 -5
- package/esm/veplayer.biz.live.production.js +1 -1
- package/esm/veplayer.d.ts +531 -212
- package/esm/veplayer.development.js +39 -11
- package/esm/veplayer.live.d.ts +531 -212
- package/esm/veplayer.live.development.js +39 -11
- package/esm/veplayer.live.production.js +2 -2
- package/esm/veplayer.production.js +2 -2
- package/esm/veplayer.vod.d.ts +155 -121
- package/esm/veplayer.vod.development.js +3 -5
- package/esm/veplayer.vod.production.js +1 -1
- package/package.json +1 -1
- package/umd/index.d.ts +155 -121
- package/umd/veplayer.biz.live.development.js +35 -5
- package/umd/veplayer.biz.live.production.js +1 -1
- package/umd/veplayer.d.ts +531 -212
- package/umd/veplayer.development.js +39 -11
- package/umd/veplayer.live.d.ts +531 -212
- package/umd/veplayer.live.development.js +39 -11
- package/umd/veplayer.live.production.js +1 -1
- package/umd/veplayer.production.js +1 -1
- package/umd/veplayer.vod.d.ts +155 -121
- package/umd/veplayer.vod.development.js +3 -5
- package/umd/veplayer.vod.production.js +1 -1
- package/veplayer.d.ts +531 -212
- package/veplayer.live.d.ts +531 -212
- package/veplayer.vod.d.ts +155 -121
package/veplayer.live.d.ts
CHANGED
|
@@ -226,6 +226,14 @@ interface ExposedDefinition {
|
|
|
226
226
|
*
|
|
227
227
|
*/
|
|
228
228
|
fallbackUrls?: string[];
|
|
229
|
+
/** {zh}
|
|
230
|
+
* @hidden
|
|
231
|
+
* @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
|
|
232
|
+
*/
|
|
233
|
+
/** {en}
|
|
234
|
+
* @hidden
|
|
235
|
+
* @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
|
|
236
|
+
*/
|
|
229
237
|
type?: string;
|
|
230
238
|
}
|
|
231
239
|
/** {zh}
|
|
@@ -488,6 +496,12 @@ declare enum Level {
|
|
|
488
496
|
*/
|
|
489
497
|
Warn = "Warn"
|
|
490
498
|
}
|
|
499
|
+
/** {zh}
|
|
500
|
+
* @id ErrorCodeRaw
|
|
501
|
+
*/
|
|
502
|
+
/** {en}
|
|
503
|
+
* @id ErrorCodeRaw
|
|
504
|
+
*/
|
|
491
505
|
declare enum ErrorCode {
|
|
492
506
|
/** {zh}
|
|
493
507
|
* @brief 视频解析错误
|
|
@@ -495,7 +509,7 @@ declare enum ErrorCode {
|
|
|
495
509
|
*/
|
|
496
510
|
/** {en}
|
|
497
511
|
* @brief Video parsing error.
|
|
498
|
-
* @solution Please contact
|
|
512
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
499
513
|
*/
|
|
500
514
|
MANIFEST_HLS_ERROR = 1100,
|
|
501
515
|
/** {zh}
|
|
@@ -504,7 +518,7 @@ declare enum ErrorCode {
|
|
|
504
518
|
*/
|
|
505
519
|
/** {en}
|
|
506
520
|
* @brief Video parsing error.
|
|
507
|
-
* @solution Please contact
|
|
521
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
508
522
|
*/
|
|
509
523
|
MANIFEST_DASH_ERROR = 1200,
|
|
510
524
|
/** {zh}
|
|
@@ -558,7 +572,7 @@ declare enum ErrorCode {
|
|
|
558
572
|
*/
|
|
559
573
|
/** {en}
|
|
560
574
|
* @brief Video parsing error.
|
|
561
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
575
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
562
576
|
*/
|
|
563
577
|
DEMUX_FLV_ERROR = 3100,
|
|
564
578
|
/** {zh}
|
|
@@ -567,7 +581,7 @@ declare enum ErrorCode {
|
|
|
567
581
|
*/
|
|
568
582
|
/** {en}
|
|
569
583
|
* @brief Video parsing error.
|
|
570
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
584
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
571
585
|
*/
|
|
572
586
|
DEMUX_HLS_ERROR = 3200,
|
|
573
587
|
/** {zh}
|
|
@@ -577,8 +591,7 @@ declare enum ErrorCode {
|
|
|
577
591
|
*/
|
|
578
592
|
/** {en}
|
|
579
593
|
* @brief Video parsing error.
|
|
580
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
581
|
-
*
|
|
594
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
582
595
|
*/
|
|
583
596
|
DEMUX_MP4_ERROR = 3300,
|
|
584
597
|
/** {zh}
|
|
@@ -588,8 +601,7 @@ declare enum ErrorCode {
|
|
|
588
601
|
*/
|
|
589
602
|
/** {en}
|
|
590
603
|
* @brief Video parsing error.
|
|
591
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
592
|
-
*
|
|
604
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
593
605
|
*/
|
|
594
606
|
DEMUX_FMP4_ERROR = 3400,
|
|
595
607
|
/** {zh}
|
|
@@ -599,8 +611,7 @@ declare enum ErrorCode {
|
|
|
599
611
|
*/
|
|
600
612
|
/** {en}
|
|
601
613
|
* @brief Video parsing error.
|
|
602
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
603
|
-
*
|
|
614
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
604
615
|
*/
|
|
605
616
|
DEMUX_SIDX_ERROR = 3410,
|
|
606
617
|
/** {zh}
|
|
@@ -610,8 +621,7 @@ declare enum ErrorCode {
|
|
|
610
621
|
*/
|
|
611
622
|
/** {en}
|
|
612
623
|
* @brief Video parsing error.
|
|
613
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
614
|
-
*
|
|
624
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
615
625
|
*/
|
|
616
626
|
REMUX_FMP4_ERROR = 4100,
|
|
617
627
|
/** {zh}
|
|
@@ -621,8 +631,7 @@ declare enum ErrorCode {
|
|
|
621
631
|
*/
|
|
622
632
|
/** {en}
|
|
623
633
|
* @brief Video parsing error.
|
|
624
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
625
|
-
*
|
|
634
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
626
635
|
*/
|
|
627
636
|
REMUX_MP4_ERROR = 4200,
|
|
628
637
|
/** {zh}
|
|
@@ -652,10 +661,9 @@ declare enum ErrorCode {
|
|
|
652
661
|
*/
|
|
653
662
|
/** {en}
|
|
654
663
|
* @brief An error occurred to the browser while decoding the media resources.
|
|
655
|
-
* @solution
|
|
656
|
-
*
|
|
657
|
-
*
|
|
658
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
664
|
+
* @solution 1. Check whether there is any issue with the original video.
|
|
665
|
+
* 2. Re-transcode the video and play it again.
|
|
666
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
659
667
|
*/
|
|
660
668
|
MEDIA_ERR_DECODE = 5103,
|
|
661
669
|
/** {zh}
|
|
@@ -667,10 +675,9 @@ declare enum ErrorCode {
|
|
|
667
675
|
*/
|
|
668
676
|
/** {en}
|
|
669
677
|
* @brief The video cannot be loaded due to unsupported video format or server or network issues.
|
|
670
|
-
* @solution
|
|
671
|
-
*
|
|
672
|
-
*
|
|
673
|
-
* 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 browser's request.
|
|
679
|
+
* 2. Check whether the browser and the current page support the video format.
|
|
680
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
674
681
|
*/
|
|
675
682
|
MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
|
|
676
683
|
/** {zh}
|
|
@@ -682,10 +689,9 @@ declare enum ErrorCode {
|
|
|
682
689
|
*/
|
|
683
690
|
/** {en}
|
|
684
691
|
* @brief The current browser does not support video decoding.
|
|
685
|
-
* @solution
|
|
686
|
-
*
|
|
687
|
-
*
|
|
688
|
-
* 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).
|
|
689
695
|
*/
|
|
690
696
|
MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
|
|
691
697
|
/** {zh}
|
|
@@ -703,7 +709,7 @@ declare enum ErrorCode {
|
|
|
703
709
|
*/
|
|
704
710
|
/** {en}
|
|
705
711
|
* @brief A playback issue occurred.
|
|
706
|
-
* @solution Check the live stream source or contact
|
|
712
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
707
713
|
*/
|
|
708
714
|
MEDIA_MSE_ADD_SB = 5200,
|
|
709
715
|
/** {zh}
|
|
@@ -712,7 +718,7 @@ declare enum ErrorCode {
|
|
|
712
718
|
*/
|
|
713
719
|
/** {en}
|
|
714
720
|
* @brief A playback issue occurred.
|
|
715
|
-
* @solution Check the live stream source or contact
|
|
721
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
716
722
|
*/
|
|
717
723
|
MEDIA_MSE_APPEND_BUFFER = 5201,
|
|
718
724
|
/** {zh}
|
|
@@ -721,7 +727,7 @@ declare enum ErrorCode {
|
|
|
721
727
|
*/
|
|
722
728
|
/** {en}
|
|
723
729
|
* @brief A playback issue occurred.
|
|
724
|
-
* @solution Check the live stream source or contact
|
|
730
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
725
731
|
*/
|
|
726
732
|
MEDIA_MSE_OTHER = 5202,
|
|
727
733
|
/** {zh}
|
|
@@ -730,7 +736,7 @@ declare enum ErrorCode {
|
|
|
730
736
|
*/
|
|
731
737
|
/** {en}
|
|
732
738
|
* @brief A playback issue occurred.
|
|
733
|
-
* @solution Check the live stream source or contact
|
|
739
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
734
740
|
*/
|
|
735
741
|
MEDIA_MSE_FULL = 5203,
|
|
736
742
|
/** {zh}
|
|
@@ -739,7 +745,7 @@ declare enum ErrorCode {
|
|
|
739
745
|
*/
|
|
740
746
|
/** {en}
|
|
741
747
|
* @brief A playback issue occurred.
|
|
742
|
-
* @solution Check the live stream source or contact
|
|
748
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
743
749
|
*/
|
|
744
750
|
MEDIA_MSE_HIJACK = 5204,
|
|
745
751
|
/** {zh}
|
|
@@ -748,25 +754,29 @@ declare enum ErrorCode {
|
|
|
748
754
|
*/
|
|
749
755
|
/** {en}
|
|
750
756
|
* @brief A playback issue occurred.
|
|
751
|
-
* @solution Check the live stream source or contact
|
|
757
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
752
758
|
*/
|
|
753
759
|
MEDIA_EME_HIJACK = 5301,
|
|
754
760
|
/** {zh}
|
|
755
761
|
* @brief DRM 权限校验失败
|
|
756
762
|
* @hidden
|
|
763
|
+
* @solution 请检查权限配置,确保播放权限正确。
|
|
757
764
|
*/
|
|
758
765
|
/** {en}
|
|
759
766
|
* @brief DRM authentication failed.
|
|
760
767
|
* @hidden
|
|
768
|
+
* @solution Verify the authentication and ensure proper playback permissions.
|
|
761
769
|
*/
|
|
762
770
|
DRM_LICENSE = 7100,
|
|
763
771
|
/** {zh}
|
|
764
772
|
* @brief DRM 权限校验失败
|
|
765
773
|
* @hidden
|
|
774
|
+
* @solution 请检查自定义 DRM 权限。
|
|
766
775
|
*/
|
|
767
776
|
/** {en}
|
|
768
777
|
* @brief DRM authentication failed.
|
|
769
778
|
* @hidden
|
|
779
|
+
* @solution Please check the custom DRM authentication.
|
|
770
780
|
*/
|
|
771
781
|
DRM_CUSTOM_LICENSE = 7200,
|
|
772
782
|
/** {zh}
|
|
@@ -775,7 +785,7 @@ declare enum ErrorCode {
|
|
|
775
785
|
*/
|
|
776
786
|
/** {en}
|
|
777
787
|
* @brief A playback issue occurred.
|
|
778
|
-
* @solution Check the live stream source or contact
|
|
788
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
779
789
|
*/
|
|
780
790
|
OTHER = 8000,
|
|
781
791
|
/** {zh}
|
|
@@ -784,7 +794,7 @@ declare enum ErrorCode {
|
|
|
784
794
|
*/
|
|
785
795
|
/** {en}
|
|
786
796
|
* @brief A playback issue occurred.
|
|
787
|
-
* @solution Check the live stream source or contact
|
|
797
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
788
798
|
*/
|
|
789
799
|
RUNTIME_NO_CANPLAY_ERROR = 9001,
|
|
790
800
|
/** {zh}
|
|
@@ -793,7 +803,7 @@ declare enum ErrorCode {
|
|
|
793
803
|
*/
|
|
794
804
|
/** {en}
|
|
795
805
|
* @brief A playback issue occurred.
|
|
796
|
-
* @solution Check the live stream source or contact
|
|
806
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
797
807
|
*/
|
|
798
808
|
RUNTIME_BUFFERBREAK_ERROR = 9002,
|
|
799
809
|
/** {zh}
|
|
@@ -802,7 +812,7 @@ declare enum ErrorCode {
|
|
|
802
812
|
*/
|
|
803
813
|
/** {en}
|
|
804
814
|
* @brief A playback issue occurred.
|
|
805
|
-
* @solution Check the live stream source or contact
|
|
815
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
806
816
|
*/
|
|
807
817
|
RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
|
|
808
818
|
// veplayer 报错
|
|
@@ -819,9 +829,11 @@ declare enum ErrorCode {
|
|
|
819
829
|
MODULE_LOAD_ERROR = 110,
|
|
820
830
|
/** {zh}
|
|
821
831
|
* @hidden
|
|
832
|
+
* @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
|
|
822
833
|
*/
|
|
823
834
|
/** {en}
|
|
824
835
|
* @hidden
|
|
836
|
+
* @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
825
837
|
*/
|
|
826
838
|
UNKNOWN = "UNKNOWN"
|
|
827
839
|
}
|
|
@@ -1618,8 +1630,7 @@ interface CommonStyle {
|
|
|
1618
1630
|
* @brief 缓存部分进度条底色。
|
|
1619
1631
|
*/
|
|
1620
1632
|
/** {en}
|
|
1621
|
-
* @brief
|
|
1622
|
-
* @brief The background color of the progress bar for the cached portion of video playback.
|
|
1633
|
+
* @brief The background color of the buffered portion of the progress bar.
|
|
1623
1634
|
*/
|
|
1624
1635
|
cachedColor?: string;
|
|
1625
1636
|
/** {zh}
|
|
@@ -2037,11 +2048,15 @@ declare class VePlayerBase {
|
|
|
2037
2048
|
*/
|
|
2038
2049
|
fallbackToFirstDefinition?: boolean;
|
|
2039
2050
|
/** {zh}
|
|
2040
|
-
* @brief
|
|
2051
|
+
* @brief 是否启用无缝切换。
|
|
2052
|
+
* - `true`:启用无缝切换,保证播放过程中不中断。
|
|
2053
|
+
* - `false`:不启用无缝切换,可能会出现播放中断。
|
|
2041
2054
|
* @default false
|
|
2042
2055
|
*/
|
|
2043
2056
|
/** {en}
|
|
2044
|
-
* @brief Whether seamless switching
|
|
2057
|
+
* @brief Whether seamless switching is enabled.
|
|
2058
|
+
* - `true`: Enables seamless switching, ensuring no interruption during playback.
|
|
2059
|
+
* - `false`: Disables seamless switching, which may cause interruptions during playback.
|
|
2045
2060
|
*/
|
|
2046
2061
|
seamless?: boolean;
|
|
2047
2062
|
}): Promise<ExposedDefinition>;
|
|
@@ -2126,7 +2141,7 @@ declare class VePlayerBase {
|
|
|
2126
2141
|
*/
|
|
2127
2142
|
on(event: string, callback: (data?: any) => any): void;
|
|
2128
2143
|
/** {zh}
|
|
2129
|
-
* @brief
|
|
2144
|
+
* @brief 调用此方法开始播放。
|
|
2130
2145
|
*/
|
|
2131
2146
|
/** {en}
|
|
2132
2147
|
* @brief Starts playback.
|
|
@@ -2170,20 +2185,24 @@ declare class VePlayerBase {
|
|
|
2170
2185
|
*/
|
|
2171
2186
|
focus(data?: {
|
|
2172
2187
|
/** {zh}
|
|
2173
|
-
* @brief
|
|
2188
|
+
* @brief 是否需要自动失焦。
|
|
2189
|
+
* - `true`:启用自动失焦,经过指定的延迟时间后,自动调用 `blur()` 方法进行失焦。
|
|
2190
|
+
* - `false`:禁用自动失焦,不会在延迟时间后自动调用 `blur()` 方法。
|
|
2174
2191
|
* @default true
|
|
2175
2192
|
*/
|
|
2176
2193
|
/** {en}
|
|
2177
|
-
* @brief Whether
|
|
2194
|
+
* @brief Whether auto-blur is enabled.
|
|
2195
|
+
* - `true`: Enables auto-blur, meaning `blur()` will be automatically called after the specified delay time.
|
|
2196
|
+
* - `false`: Disables auto-blur, meaning `blur()` will not be automatically called after the delay.
|
|
2178
2197
|
* @default true
|
|
2179
2198
|
*/
|
|
2180
2199
|
autoHide?: boolean;
|
|
2181
2200
|
/** {zh}
|
|
2182
|
-
* @brief
|
|
2201
|
+
* @brief 自动失焦的延迟时间,单位为毫秒。在 `autoHide` 为 `true` 时生效。
|
|
2183
2202
|
* @default 3000
|
|
2184
2203
|
*/
|
|
2185
2204
|
/** {en}
|
|
2186
|
-
* @brief
|
|
2205
|
+
* @brief Delay duration (in milliseconds) before auto-blur is triggered. This takes effect only when `autoHide` is set to `true`.
|
|
2187
2206
|
* @default 3000
|
|
2188
2207
|
*/
|
|
2189
2208
|
delay?: number;
|
|
@@ -2198,11 +2217,11 @@ declare class VePlayerBase {
|
|
|
2198
2217
|
*/
|
|
2199
2218
|
blur(data?: {
|
|
2200
2219
|
/** {zh}
|
|
2201
|
-
* @brief
|
|
2220
|
+
* @brief 播放器在暂停时是否保留焦点状态。默认值为 `true`,即播放器暂停时不会自动失焦。
|
|
2202
2221
|
* @default false
|
|
2203
2222
|
*/
|
|
2204
2223
|
/** {en}
|
|
2205
|
-
* @brief Whether
|
|
2224
|
+
* @brief Whether the player retains focus when paused. The default is `true`, meaning the player will not automatically lose focus during pause.
|
|
2206
2225
|
* @default false
|
|
2207
2226
|
*/
|
|
2208
2227
|
ignorePaused?: boolean;
|
|
@@ -2602,6 +2621,14 @@ declare namespace strategy {
|
|
|
2602
2621
|
*
|
|
2603
2622
|
*/
|
|
2604
2623
|
fallbackUrls?: string[];
|
|
2624
|
+
/** {zh}
|
|
2625
|
+
* @hidden
|
|
2626
|
+
* @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
|
|
2627
|
+
*/
|
|
2628
|
+
/** {en}
|
|
2629
|
+
* @hidden
|
|
2630
|
+
* @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
|
|
2631
|
+
*/
|
|
2605
2632
|
type?: string;
|
|
2606
2633
|
}
|
|
2607
2634
|
/** {zh}
|
|
@@ -2861,6 +2888,12 @@ declare namespace strategy {
|
|
|
2861
2888
|
*/
|
|
2862
2889
|
Warn = "Warn"
|
|
2863
2890
|
}
|
|
2891
|
+
/** {zh}
|
|
2892
|
+
* @id ErrorCodeRaw
|
|
2893
|
+
*/
|
|
2894
|
+
/** {en}
|
|
2895
|
+
* @id ErrorCodeRaw
|
|
2896
|
+
*/
|
|
2864
2897
|
enum ErrorCode {
|
|
2865
2898
|
/** {zh}
|
|
2866
2899
|
* @brief 视频解析错误
|
|
@@ -2868,7 +2901,7 @@ declare namespace strategy {
|
|
|
2868
2901
|
*/
|
|
2869
2902
|
/** {en}
|
|
2870
2903
|
* @brief Video parsing error.
|
|
2871
|
-
* @solution Please contact
|
|
2904
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2872
2905
|
*/
|
|
2873
2906
|
MANIFEST_HLS_ERROR = 1100,
|
|
2874
2907
|
/** {zh}
|
|
@@ -2877,7 +2910,7 @@ declare namespace strategy {
|
|
|
2877
2910
|
*/
|
|
2878
2911
|
/** {en}
|
|
2879
2912
|
* @brief Video parsing error.
|
|
2880
|
-
* @solution Please contact
|
|
2913
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2881
2914
|
*/
|
|
2882
2915
|
MANIFEST_DASH_ERROR = 1200,
|
|
2883
2916
|
/** {zh}
|
|
@@ -2931,7 +2964,7 @@ declare namespace strategy {
|
|
|
2931
2964
|
*/
|
|
2932
2965
|
/** {en}
|
|
2933
2966
|
* @brief Video parsing error.
|
|
2934
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
2967
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2935
2968
|
*/
|
|
2936
2969
|
DEMUX_FLV_ERROR = 3100,
|
|
2937
2970
|
/** {zh}
|
|
@@ -2940,7 +2973,7 @@ declare namespace strategy {
|
|
|
2940
2973
|
*/
|
|
2941
2974
|
/** {en}
|
|
2942
2975
|
* @brief Video parsing error.
|
|
2943
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
2976
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2944
2977
|
*/
|
|
2945
2978
|
DEMUX_HLS_ERROR = 3200,
|
|
2946
2979
|
/** {zh}
|
|
@@ -2950,8 +2983,7 @@ declare namespace strategy {
|
|
|
2950
2983
|
*/
|
|
2951
2984
|
/** {en}
|
|
2952
2985
|
* @brief Video parsing error.
|
|
2953
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
2954
|
-
*
|
|
2986
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2955
2987
|
*/
|
|
2956
2988
|
DEMUX_MP4_ERROR = 3300,
|
|
2957
2989
|
/** {zh}
|
|
@@ -2961,8 +2993,7 @@ declare namespace strategy {
|
|
|
2961
2993
|
*/
|
|
2962
2994
|
/** {en}
|
|
2963
2995
|
* @brief Video parsing error.
|
|
2964
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
2965
|
-
*
|
|
2996
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2966
2997
|
*/
|
|
2967
2998
|
DEMUX_FMP4_ERROR = 3400,
|
|
2968
2999
|
/** {zh}
|
|
@@ -2972,8 +3003,7 @@ declare namespace strategy {
|
|
|
2972
3003
|
*/
|
|
2973
3004
|
/** {en}
|
|
2974
3005
|
* @brief Video parsing error.
|
|
2975
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
2976
|
-
*
|
|
3006
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2977
3007
|
*/
|
|
2978
3008
|
DEMUX_SIDX_ERROR = 3410,
|
|
2979
3009
|
/** {zh}
|
|
@@ -2983,8 +3013,7 @@ declare namespace strategy {
|
|
|
2983
3013
|
*/
|
|
2984
3014
|
/** {en}
|
|
2985
3015
|
* @brief Video parsing error.
|
|
2986
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
2987
|
-
*
|
|
3016
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2988
3017
|
*/
|
|
2989
3018
|
REMUX_FMP4_ERROR = 4100,
|
|
2990
3019
|
/** {zh}
|
|
@@ -2994,8 +3023,7 @@ declare namespace strategy {
|
|
|
2994
3023
|
*/
|
|
2995
3024
|
/** {en}
|
|
2996
3025
|
* @brief Video parsing error.
|
|
2997
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
2998
|
-
*
|
|
3026
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
2999
3027
|
*/
|
|
3000
3028
|
REMUX_MP4_ERROR = 4200,
|
|
3001
3029
|
/** {zh}
|
|
@@ -3025,10 +3053,9 @@ declare namespace strategy {
|
|
|
3025
3053
|
*/
|
|
3026
3054
|
/** {en}
|
|
3027
3055
|
* @brief An error occurred to the browser while decoding the media resources.
|
|
3028
|
-
* @solution
|
|
3029
|
-
*
|
|
3030
|
-
*
|
|
3031
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
3056
|
+
* @solution 1. Check whether there is any issue with the original video.
|
|
3057
|
+
* 2. Re-transcode the video and play it again.
|
|
3058
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3032
3059
|
*/
|
|
3033
3060
|
MEDIA_ERR_DECODE = 5103,
|
|
3034
3061
|
/** {zh}
|
|
@@ -3040,10 +3067,9 @@ declare namespace strategy {
|
|
|
3040
3067
|
*/
|
|
3041
3068
|
/** {en}
|
|
3042
3069
|
* @brief The video cannot be loaded due to unsupported video format or server or network issues.
|
|
3043
|
-
* @solution
|
|
3044
|
-
*
|
|
3045
|
-
*
|
|
3046
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
3070
|
+
* @solution 1. Check whether there is any issue with the browser's request.
|
|
3071
|
+
* 2. Check whether the browser and the current page support the video format.
|
|
3072
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3047
3073
|
*/
|
|
3048
3074
|
MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
|
|
3049
3075
|
/** {zh}
|
|
@@ -3055,10 +3081,9 @@ declare namespace strategy {
|
|
|
3055
3081
|
*/
|
|
3056
3082
|
/** {en}
|
|
3057
3083
|
* @brief The current browser does not support video decoding.
|
|
3058
|
-
* @solution
|
|
3059
|
-
*
|
|
3060
|
-
*
|
|
3061
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
3084
|
+
* @solution 1. Check whether there is any issue with the browser's request.
|
|
3085
|
+
* 2. Check whether the browser and the current page support the video format.
|
|
3086
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3062
3087
|
*/
|
|
3063
3088
|
MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
|
|
3064
3089
|
/** {zh}
|
|
@@ -3076,7 +3101,7 @@ declare namespace strategy {
|
|
|
3076
3101
|
*/
|
|
3077
3102
|
/** {en}
|
|
3078
3103
|
* @brief A playback issue occurred.
|
|
3079
|
-
* @solution Check the live stream source or contact
|
|
3104
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3080
3105
|
*/
|
|
3081
3106
|
MEDIA_MSE_ADD_SB = 5200,
|
|
3082
3107
|
/** {zh}
|
|
@@ -3085,7 +3110,7 @@ declare namespace strategy {
|
|
|
3085
3110
|
*/
|
|
3086
3111
|
/** {en}
|
|
3087
3112
|
* @brief A playback issue occurred.
|
|
3088
|
-
* @solution Check the live stream source or contact
|
|
3113
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3089
3114
|
*/
|
|
3090
3115
|
MEDIA_MSE_APPEND_BUFFER = 5201,
|
|
3091
3116
|
/** {zh}
|
|
@@ -3094,7 +3119,7 @@ declare namespace strategy {
|
|
|
3094
3119
|
*/
|
|
3095
3120
|
/** {en}
|
|
3096
3121
|
* @brief A playback issue occurred.
|
|
3097
|
-
* @solution Check the live stream source or contact
|
|
3122
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3098
3123
|
*/
|
|
3099
3124
|
MEDIA_MSE_OTHER = 5202,
|
|
3100
3125
|
/** {zh}
|
|
@@ -3103,7 +3128,7 @@ declare namespace strategy {
|
|
|
3103
3128
|
*/
|
|
3104
3129
|
/** {en}
|
|
3105
3130
|
* @brief A playback issue occurred.
|
|
3106
|
-
* @solution Check the live stream source or contact
|
|
3131
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3107
3132
|
*/
|
|
3108
3133
|
MEDIA_MSE_FULL = 5203,
|
|
3109
3134
|
/** {zh}
|
|
@@ -3112,7 +3137,7 @@ declare namespace strategy {
|
|
|
3112
3137
|
*/
|
|
3113
3138
|
/** {en}
|
|
3114
3139
|
* @brief A playback issue occurred.
|
|
3115
|
-
* @solution Check the live stream source or contact
|
|
3140
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3116
3141
|
*/
|
|
3117
3142
|
MEDIA_MSE_HIJACK = 5204,
|
|
3118
3143
|
/** {zh}
|
|
@@ -3121,25 +3146,29 @@ declare namespace strategy {
|
|
|
3121
3146
|
*/
|
|
3122
3147
|
/** {en}
|
|
3123
3148
|
* @brief A playback issue occurred.
|
|
3124
|
-
* @solution Check the live stream source or contact
|
|
3149
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3125
3150
|
*/
|
|
3126
3151
|
MEDIA_EME_HIJACK = 5301,
|
|
3127
3152
|
/** {zh}
|
|
3128
3153
|
* @brief DRM 权限校验失败
|
|
3129
3154
|
* @hidden
|
|
3155
|
+
* @solution 请检查权限配置,确保播放权限正确。
|
|
3130
3156
|
*/
|
|
3131
3157
|
/** {en}
|
|
3132
3158
|
* @brief DRM authentication failed.
|
|
3133
3159
|
* @hidden
|
|
3160
|
+
* @solution Verify the authentication and ensure proper playback permissions.
|
|
3134
3161
|
*/
|
|
3135
3162
|
DRM_LICENSE = 7100,
|
|
3136
3163
|
/** {zh}
|
|
3137
3164
|
* @brief DRM 权限校验失败
|
|
3138
3165
|
* @hidden
|
|
3166
|
+
* @solution 请检查自定义 DRM 权限。
|
|
3139
3167
|
*/
|
|
3140
3168
|
/** {en}
|
|
3141
3169
|
* @brief DRM authentication failed.
|
|
3142
3170
|
* @hidden
|
|
3171
|
+
* @solution Please check the custom DRM authentication.
|
|
3143
3172
|
*/
|
|
3144
3173
|
DRM_CUSTOM_LICENSE = 7200,
|
|
3145
3174
|
/** {zh}
|
|
@@ -3148,7 +3177,7 @@ declare namespace strategy {
|
|
|
3148
3177
|
*/
|
|
3149
3178
|
/** {en}
|
|
3150
3179
|
* @brief A playback issue occurred.
|
|
3151
|
-
* @solution Check the live stream source or contact
|
|
3180
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3152
3181
|
*/
|
|
3153
3182
|
OTHER = 8000,
|
|
3154
3183
|
/** {zh}
|
|
@@ -3157,7 +3186,7 @@ declare namespace strategy {
|
|
|
3157
3186
|
*/
|
|
3158
3187
|
/** {en}
|
|
3159
3188
|
* @brief A playback issue occurred.
|
|
3160
|
-
* @solution Check the live stream source or contact
|
|
3189
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3161
3190
|
*/
|
|
3162
3191
|
RUNTIME_NO_CANPLAY_ERROR = 9001,
|
|
3163
3192
|
/** {zh}
|
|
@@ -3166,7 +3195,7 @@ declare namespace strategy {
|
|
|
3166
3195
|
*/
|
|
3167
3196
|
/** {en}
|
|
3168
3197
|
* @brief A playback issue occurred.
|
|
3169
|
-
* @solution Check the live stream source or contact
|
|
3198
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3170
3199
|
*/
|
|
3171
3200
|
RUNTIME_BUFFERBREAK_ERROR = 9002,
|
|
3172
3201
|
/** {zh}
|
|
@@ -3175,7 +3204,7 @@ declare namespace strategy {
|
|
|
3175
3204
|
*/
|
|
3176
3205
|
/** {en}
|
|
3177
3206
|
* @brief A playback issue occurred.
|
|
3178
|
-
* @solution Check the live stream source or contact
|
|
3207
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3179
3208
|
*/
|
|
3180
3209
|
RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
|
|
3181
3210
|
// veplayer 报错
|
|
@@ -3192,9 +3221,11 @@ declare namespace strategy {
|
|
|
3192
3221
|
MODULE_LOAD_ERROR = 110,
|
|
3193
3222
|
/** {zh}
|
|
3194
3223
|
* @hidden
|
|
3224
|
+
* @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
|
|
3195
3225
|
*/
|
|
3196
3226
|
/** {en}
|
|
3197
3227
|
* @hidden
|
|
3228
|
+
* @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
3198
3229
|
*/
|
|
3199
3230
|
UNKNOWN = "UNKNOWN"
|
|
3200
3231
|
}
|
|
@@ -3995,8 +4026,7 @@ declare namespace strategy {
|
|
|
3995
4026
|
* @brief 缓存部分进度条底色。
|
|
3996
4027
|
*/
|
|
3997
4028
|
/** {en}
|
|
3998
|
-
* @brief
|
|
3999
|
-
* @brief The background color of the progress bar for the cached portion of video playback.
|
|
4029
|
+
* @brief The background color of the buffered portion of the progress bar.
|
|
4000
4030
|
*/
|
|
4001
4031
|
cachedColor?: string;
|
|
4002
4032
|
/** {zh}
|
|
@@ -4527,6 +4557,12 @@ declare namespace error {
|
|
|
4527
4557
|
*/
|
|
4528
4558
|
Warn = "Warn"
|
|
4529
4559
|
}
|
|
4560
|
+
/** {zh}
|
|
4561
|
+
* @id ErrorCodeRaw
|
|
4562
|
+
*/
|
|
4563
|
+
/** {en}
|
|
4564
|
+
* @id ErrorCodeRaw
|
|
4565
|
+
*/
|
|
4530
4566
|
enum ErrorCode {
|
|
4531
4567
|
/** {zh}
|
|
4532
4568
|
* @brief 视频解析错误
|
|
@@ -4534,7 +4570,7 @@ declare namespace error {
|
|
|
4534
4570
|
*/
|
|
4535
4571
|
/** {en}
|
|
4536
4572
|
* @brief Video parsing error.
|
|
4537
|
-
* @solution Please contact
|
|
4573
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4538
4574
|
*/
|
|
4539
4575
|
MANIFEST_HLS_ERROR = 1100,
|
|
4540
4576
|
/** {zh}
|
|
@@ -4543,7 +4579,7 @@ declare namespace error {
|
|
|
4543
4579
|
*/
|
|
4544
4580
|
/** {en}
|
|
4545
4581
|
* @brief Video parsing error.
|
|
4546
|
-
* @solution Please contact
|
|
4582
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4547
4583
|
*/
|
|
4548
4584
|
MANIFEST_DASH_ERROR = 1200,
|
|
4549
4585
|
/** {zh}
|
|
@@ -4597,7 +4633,7 @@ declare namespace error {
|
|
|
4597
4633
|
*/
|
|
4598
4634
|
/** {en}
|
|
4599
4635
|
* @brief Video parsing error.
|
|
4600
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
4636
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4601
4637
|
*/
|
|
4602
4638
|
DEMUX_FLV_ERROR = 3100,
|
|
4603
4639
|
/** {zh}
|
|
@@ -4606,7 +4642,7 @@ declare namespace error {
|
|
|
4606
4642
|
*/
|
|
4607
4643
|
/** {en}
|
|
4608
4644
|
* @brief Video parsing error.
|
|
4609
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
4645
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4610
4646
|
*/
|
|
4611
4647
|
DEMUX_HLS_ERROR = 3200,
|
|
4612
4648
|
/** {zh}
|
|
@@ -4616,8 +4652,7 @@ declare namespace error {
|
|
|
4616
4652
|
*/
|
|
4617
4653
|
/** {en}
|
|
4618
4654
|
* @brief Video parsing error.
|
|
4619
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
4620
|
-
*
|
|
4655
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4621
4656
|
*/
|
|
4622
4657
|
DEMUX_MP4_ERROR = 3300,
|
|
4623
4658
|
/** {zh}
|
|
@@ -4627,8 +4662,7 @@ declare namespace error {
|
|
|
4627
4662
|
*/
|
|
4628
4663
|
/** {en}
|
|
4629
4664
|
* @brief Video parsing error.
|
|
4630
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
4631
|
-
*
|
|
4665
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4632
4666
|
*/
|
|
4633
4667
|
DEMUX_FMP4_ERROR = 3400,
|
|
4634
4668
|
/** {zh}
|
|
@@ -4638,8 +4672,7 @@ declare namespace error {
|
|
|
4638
4672
|
*/
|
|
4639
4673
|
/** {en}
|
|
4640
4674
|
* @brief Video parsing error.
|
|
4641
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
4642
|
-
*
|
|
4675
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4643
4676
|
*/
|
|
4644
4677
|
DEMUX_SIDX_ERROR = 3410,
|
|
4645
4678
|
/** {zh}
|
|
@@ -4649,8 +4682,7 @@ declare namespace error {
|
|
|
4649
4682
|
*/
|
|
4650
4683
|
/** {en}
|
|
4651
4684
|
* @brief Video parsing error.
|
|
4652
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
4653
|
-
*
|
|
4685
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4654
4686
|
*/
|
|
4655
4687
|
REMUX_FMP4_ERROR = 4100,
|
|
4656
4688
|
/** {zh}
|
|
@@ -4660,8 +4692,7 @@ declare namespace error {
|
|
|
4660
4692
|
*/
|
|
4661
4693
|
/** {en}
|
|
4662
4694
|
* @brief Video parsing error.
|
|
4663
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
4664
|
-
*
|
|
4695
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4665
4696
|
*/
|
|
4666
4697
|
REMUX_MP4_ERROR = 4200,
|
|
4667
4698
|
/** {zh}
|
|
@@ -4691,10 +4722,9 @@ declare namespace error {
|
|
|
4691
4722
|
*/
|
|
4692
4723
|
/** {en}
|
|
4693
4724
|
* @brief An error occurred to the browser while decoding the media resources.
|
|
4694
|
-
* @solution
|
|
4695
|
-
*
|
|
4696
|
-
*
|
|
4697
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
4725
|
+
* @solution 1. Check whether there is any issue with the original video.
|
|
4726
|
+
* 2. Re-transcode the video and play it again.
|
|
4727
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4698
4728
|
*/
|
|
4699
4729
|
MEDIA_ERR_DECODE = 5103,
|
|
4700
4730
|
/** {zh}
|
|
@@ -4706,10 +4736,9 @@ declare namespace error {
|
|
|
4706
4736
|
*/
|
|
4707
4737
|
/** {en}
|
|
4708
4738
|
* @brief The video cannot be loaded due to unsupported video format or server or network issues.
|
|
4709
|
-
* @solution
|
|
4710
|
-
*
|
|
4711
|
-
*
|
|
4712
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
4739
|
+
* @solution 1. Check whether there is any issue with the browser's request.
|
|
4740
|
+
* 2. Check whether the browser and the current page support the video format.
|
|
4741
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4713
4742
|
*/
|
|
4714
4743
|
MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
|
|
4715
4744
|
/** {zh}
|
|
@@ -4721,10 +4750,9 @@ declare namespace error {
|
|
|
4721
4750
|
*/
|
|
4722
4751
|
/** {en}
|
|
4723
4752
|
* @brief The current browser does not support video decoding.
|
|
4724
|
-
* @solution
|
|
4725
|
-
*
|
|
4726
|
-
*
|
|
4727
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
4753
|
+
* @solution 1. Check whether there is any issue with the browser's request.
|
|
4754
|
+
* 2. Check whether the browser and the current page support the video format.
|
|
4755
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4728
4756
|
*/
|
|
4729
4757
|
MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
|
|
4730
4758
|
/** {zh}
|
|
@@ -4742,7 +4770,7 @@ declare namespace error {
|
|
|
4742
4770
|
*/
|
|
4743
4771
|
/** {en}
|
|
4744
4772
|
* @brief A playback issue occurred.
|
|
4745
|
-
* @solution Check the live stream source or contact
|
|
4773
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4746
4774
|
*/
|
|
4747
4775
|
MEDIA_MSE_ADD_SB = 5200,
|
|
4748
4776
|
/** {zh}
|
|
@@ -4751,7 +4779,7 @@ declare namespace error {
|
|
|
4751
4779
|
*/
|
|
4752
4780
|
/** {en}
|
|
4753
4781
|
* @brief A playback issue occurred.
|
|
4754
|
-
* @solution Check the live stream source or contact
|
|
4782
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4755
4783
|
*/
|
|
4756
4784
|
MEDIA_MSE_APPEND_BUFFER = 5201,
|
|
4757
4785
|
/** {zh}
|
|
@@ -4760,7 +4788,7 @@ declare namespace error {
|
|
|
4760
4788
|
*/
|
|
4761
4789
|
/** {en}
|
|
4762
4790
|
* @brief A playback issue occurred.
|
|
4763
|
-
* @solution Check the live stream source or contact
|
|
4791
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4764
4792
|
*/
|
|
4765
4793
|
MEDIA_MSE_OTHER = 5202,
|
|
4766
4794
|
/** {zh}
|
|
@@ -4769,7 +4797,7 @@ declare namespace error {
|
|
|
4769
4797
|
*/
|
|
4770
4798
|
/** {en}
|
|
4771
4799
|
* @brief A playback issue occurred.
|
|
4772
|
-
* @solution Check the live stream source or contact
|
|
4800
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4773
4801
|
*/
|
|
4774
4802
|
MEDIA_MSE_FULL = 5203,
|
|
4775
4803
|
/** {zh}
|
|
@@ -4778,7 +4806,7 @@ declare namespace error {
|
|
|
4778
4806
|
*/
|
|
4779
4807
|
/** {en}
|
|
4780
4808
|
* @brief A playback issue occurred.
|
|
4781
|
-
* @solution Check the live stream source or contact
|
|
4809
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4782
4810
|
*/
|
|
4783
4811
|
MEDIA_MSE_HIJACK = 5204,
|
|
4784
4812
|
/** {zh}
|
|
@@ -4787,25 +4815,29 @@ declare namespace error {
|
|
|
4787
4815
|
*/
|
|
4788
4816
|
/** {en}
|
|
4789
4817
|
* @brief A playback issue occurred.
|
|
4790
|
-
* @solution Check the live stream source or contact
|
|
4818
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4791
4819
|
*/
|
|
4792
4820
|
MEDIA_EME_HIJACK = 5301,
|
|
4793
4821
|
/** {zh}
|
|
4794
4822
|
* @brief DRM 权限校验失败
|
|
4795
4823
|
* @hidden
|
|
4824
|
+
* @solution 请检查权限配置,确保播放权限正确。
|
|
4796
4825
|
*/
|
|
4797
4826
|
/** {en}
|
|
4798
4827
|
* @brief DRM authentication failed.
|
|
4799
4828
|
* @hidden
|
|
4829
|
+
* @solution Verify the authentication and ensure proper playback permissions.
|
|
4800
4830
|
*/
|
|
4801
4831
|
DRM_LICENSE = 7100,
|
|
4802
4832
|
/** {zh}
|
|
4803
4833
|
* @brief DRM 权限校验失败
|
|
4804
4834
|
* @hidden
|
|
4835
|
+
* @solution 请检查自定义 DRM 权限。
|
|
4805
4836
|
*/
|
|
4806
4837
|
/** {en}
|
|
4807
4838
|
* @brief DRM authentication failed.
|
|
4808
4839
|
* @hidden
|
|
4840
|
+
* @solution Please check the custom DRM authentication.
|
|
4809
4841
|
*/
|
|
4810
4842
|
DRM_CUSTOM_LICENSE = 7200,
|
|
4811
4843
|
/** {zh}
|
|
@@ -4814,7 +4846,7 @@ declare namespace error {
|
|
|
4814
4846
|
*/
|
|
4815
4847
|
/** {en}
|
|
4816
4848
|
* @brief A playback issue occurred.
|
|
4817
|
-
* @solution Check the live stream source or contact
|
|
4849
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4818
4850
|
*/
|
|
4819
4851
|
OTHER = 8000,
|
|
4820
4852
|
/** {zh}
|
|
@@ -4823,7 +4855,7 @@ declare namespace error {
|
|
|
4823
4855
|
*/
|
|
4824
4856
|
/** {en}
|
|
4825
4857
|
* @brief A playback issue occurred.
|
|
4826
|
-
* @solution Check the live stream source or contact
|
|
4858
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4827
4859
|
*/
|
|
4828
4860
|
RUNTIME_NO_CANPLAY_ERROR = 9001,
|
|
4829
4861
|
/** {zh}
|
|
@@ -4832,7 +4864,7 @@ declare namespace error {
|
|
|
4832
4864
|
*/
|
|
4833
4865
|
/** {en}
|
|
4834
4866
|
* @brief A playback issue occurred.
|
|
4835
|
-
* @solution Check the live stream source or contact
|
|
4867
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4836
4868
|
*/
|
|
4837
4869
|
RUNTIME_BUFFERBREAK_ERROR = 9002,
|
|
4838
4870
|
/** {zh}
|
|
@@ -4841,7 +4873,7 @@ declare namespace error {
|
|
|
4841
4873
|
*/
|
|
4842
4874
|
/** {en}
|
|
4843
4875
|
* @brief A playback issue occurred.
|
|
4844
|
-
* @solution Check the live stream source or contact
|
|
4876
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4845
4877
|
*/
|
|
4846
4878
|
RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
|
|
4847
4879
|
// veplayer 报错
|
|
@@ -4858,9 +4890,11 @@ declare namespace error {
|
|
|
4858
4890
|
MODULE_LOAD_ERROR = 110,
|
|
4859
4891
|
/** {zh}
|
|
4860
4892
|
* @hidden
|
|
4893
|
+
* @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
|
|
4861
4894
|
*/
|
|
4862
4895
|
/** {en}
|
|
4863
4896
|
* @hidden
|
|
4897
|
+
* @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
4864
4898
|
*/
|
|
4865
4899
|
UNKNOWN = "UNKNOWN"
|
|
4866
4900
|
}
|
|
@@ -5303,9 +5337,40 @@ declare enum FallbackKind {
|
|
|
5303
5337
|
Error = "Error",
|
|
5304
5338
|
Stall = "Stall"
|
|
5305
5339
|
}
|
|
5340
|
+
/** {zh}
|
|
5341
|
+
* @list option
|
|
5342
|
+
* @kind property
|
|
5343
|
+
*/
|
|
5344
|
+
/** {en}
|
|
5345
|
+
* @list option
|
|
5346
|
+
* @kind property
|
|
5347
|
+
*/
|
|
5306
5348
|
interface ErrorFallbackStrategy {
|
|
5349
|
+
/** {zh}
|
|
5350
|
+
* @brief 降级类型,定义是否自动降级或手动控制。
|
|
5351
|
+
* @hidden
|
|
5352
|
+
*/
|
|
5353
|
+
/** {en}
|
|
5354
|
+
* @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
|
|
5355
|
+
*/
|
|
5307
5356
|
type?: FallbackKind;
|
|
5357
|
+
/** {zh}
|
|
5358
|
+
* @brief 降级黑名单。若错误码命中该列表,则不会触发降级逻辑。
|
|
5359
|
+
*/
|
|
5360
|
+
/** {en}
|
|
5361
|
+
* @brief List of error codes to ignore for fallback. If the error code is in this list, fallback will not be triggered.
|
|
5362
|
+
*/
|
|
5308
5363
|
excludeList?: ErrorCode[];
|
|
5364
|
+
/** {zh}
|
|
5365
|
+
* @brief 自定义降级策略。返回值为:
|
|
5366
|
+
* - `true`:执行降级。
|
|
5367
|
+
* - `false`:不执行降级。
|
|
5368
|
+
*/
|
|
5369
|
+
/** {en}
|
|
5370
|
+
* @brief Custom fallback logic. Returns:<br>
|
|
5371
|
+
* - `true`: fallback will occur<br>
|
|
5372
|
+
* - `false`: no fallback
|
|
5373
|
+
*/
|
|
5309
5374
|
shouldFallback?: (type: string, params: {
|
|
5310
5375
|
error: VeError;
|
|
5311
5376
|
}) => boolean;
|
|
@@ -5439,14 +5504,14 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
|
|
|
5439
5504
|
*/
|
|
5440
5505
|
ad?: AdConfig;
|
|
5441
5506
|
/** {zh}
|
|
5442
|
-
* @brief 为播放器设置直播时移配置,接入方法请参见[
|
|
5507
|
+
* @brief 为播放器设置直播时移配置,接入方法请参见[直播时移](https://www.volcengine.com/docs/6469/1548574)。
|
|
5443
5508
|
*/
|
|
5444
5509
|
/** {en}
|
|
5445
5510
|
* @brief Configurations for time shifting.
|
|
5446
5511
|
*/
|
|
5447
5512
|
timeShift?: TimeShiftConfig;
|
|
5448
5513
|
/** {zh}
|
|
5449
|
-
* @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[
|
|
5514
|
+
* @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[播放日志上报](https://www.volcengine.com/docs/6469/1548575)。
|
|
5450
5515
|
*/
|
|
5451
5516
|
/** {en}
|
|
5452
5517
|
* @brief Configurations for log upload. Supports enabling/disabling log upload and setting log parameters.
|
|
@@ -5473,16 +5538,84 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
|
|
|
5473
5538
|
* @brief Digital Rights Management (DRM) configurations.
|
|
5474
5539
|
*/
|
|
5475
5540
|
drm?: Drm;
|
|
5541
|
+
/** {zh}
|
|
5542
|
+
* @brief 设置播放器的播放延迟模式。
|
|
5543
|
+
* - `standard`:标准延迟,稳定性高。
|
|
5544
|
+
* - `low`:低延迟,适用于互动场景。
|
|
5545
|
+
* @hidden
|
|
5546
|
+
*/
|
|
5547
|
+
/** {en}
|
|
5548
|
+
* @brief Sets the playback latency mode of the player. Optional values:
|
|
5549
|
+
* - `standard`: Standard latency with higher stability.
|
|
5550
|
+
* - `low`: Low latency, suitable for interactive scenarios.
|
|
5551
|
+
* @hidden
|
|
5552
|
+
*/
|
|
5476
5553
|
latencyMode?: "standard" | "low";
|
|
5554
|
+
/** {zh}
|
|
5555
|
+
* @brief 配置协议降级参数。当播放失败或卡顿时,可根据策略降级使用其他协议。
|
|
5556
|
+
*/
|
|
5557
|
+
/** {en}
|
|
5558
|
+
* @brief Configure protocol downgrade parameters. When playback fails or stutters, other protocols can be downgraded according to the strategy.
|
|
5559
|
+
*/
|
|
5477
5560
|
fallback?: Fallback;
|
|
5478
5561
|
}
|
|
5562
|
+
/** {zh}
|
|
5563
|
+
* @list option
|
|
5564
|
+
* @kind property
|
|
5565
|
+
*/
|
|
5566
|
+
/** {en}
|
|
5567
|
+
* @list option
|
|
5568
|
+
* @kind property
|
|
5569
|
+
*/
|
|
5479
5570
|
interface Fallback {
|
|
5571
|
+
/** {zh}
|
|
5572
|
+
* @brief 是否开启协议降级功能。
|
|
5573
|
+
* @hidden
|
|
5574
|
+
*/
|
|
5575
|
+
/** {en}
|
|
5576
|
+
* @brief Whether to enable protocol fallback.
|
|
5577
|
+
*/
|
|
5480
5578
|
enableFallback?: boolean;
|
|
5481
|
-
|
|
5482
|
-
|
|
5483
|
-
|
|
5484
|
-
|
|
5485
|
-
|
|
5579
|
+
/** {zh}
|
|
5580
|
+
* @brief 协议选择优先级顺序。
|
|
5581
|
+
* @listtip - 配置多个协议时,按该顺序选择当前浏览器环境支持的协议。
|
|
5582
|
+
* - 播放失败时根据 `fallbackStrategy` 判断需要降级时,按该顺序选择下一个协议。
|
|
5583
|
+
*/
|
|
5584
|
+
/** {en}
|
|
5585
|
+
* @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`.
|
|
5586
|
+
*/
|
|
5587
|
+
fallbackOrder?: Array<"rtm" | "flv" | "hls">;
|
|
5588
|
+
/** {zh}
|
|
5589
|
+
* @brief 协议降级策略配置。
|
|
5590
|
+
* @listtip - 默认为 RTM 播放出错时触发降级。
|
|
5591
|
+
* - 若所有协议采用同一策略,可通过设置 `all` 实现统一配置。
|
|
5592
|
+
* - 若同时配置了 `all` 和某个协议(如 `rtm`),将优先使用协议自身的配置,即 `rtm` 策略优先级高于 `all`。
|
|
5593
|
+
*/
|
|
5594
|
+
/** {en}
|
|
5595
|
+
* @listtip - By default, fallback is triggered when RTM playback fails.
|
|
5596
|
+
* - Use `all` to apply the same strategy across all protocols.
|
|
5597
|
+
* - If both `all` and a specific protocol (e.g., `rtm`) are set, the specific protocol strategy takes precedence.
|
|
5598
|
+
* @brief Strategy for protocol fallback.
|
|
5599
|
+
*/
|
|
5600
|
+
fallbackStrategy?: Record<"rtm" | "flv" | "hls" | "all", FallbackStrategy>;
|
|
5601
|
+
}
|
|
5602
|
+
/** {zh}
|
|
5603
|
+
* @list option
|
|
5604
|
+
* @kind property
|
|
5605
|
+
*/
|
|
5606
|
+
/** {en}
|
|
5607
|
+
* @list option
|
|
5608
|
+
* @kind property
|
|
5609
|
+
*/
|
|
5610
|
+
interface FallbackStrategy {
|
|
5611
|
+
/** {zh}
|
|
5612
|
+
* @brief 拉流报错时降级策略
|
|
5613
|
+
*/
|
|
5614
|
+
[FallbackKind.Error]?: ErrorFallbackStrategy;
|
|
5615
|
+
/**
|
|
5616
|
+
* @hidden
|
|
5617
|
+
*/
|
|
5618
|
+
[FallbackKind.Stall]?: StallFallbackStrategy;
|
|
5486
5619
|
}
|
|
5487
5620
|
/** {zh}
|
|
5488
5621
|
* @list option
|
|
@@ -5811,7 +5944,7 @@ interface Rtm {
|
|
|
5811
5944
|
* - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
|
|
5812
5945
|
* - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
|
|
5813
5946
|
* @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
|
|
5814
|
-
* - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM
|
|
5947
|
+
* - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
|
|
5815
5948
|
*/
|
|
5816
5949
|
/** {en}
|
|
5817
5950
|
* @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`.
|
|
@@ -5858,8 +5991,7 @@ interface Rtm {
|
|
|
5858
5991
|
* @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
|
|
5859
5992
|
* - `true`: Enable;
|
|
5860
5993
|
* - `false`: Disable.
|
|
5861
|
-
* @listtip
|
|
5862
|
-
* If you want to use the automatic transcoding feature when playing an RTM stream, contact your [technical support](https://www.byteplus.com/en/support).
|
|
5994
|
+
* @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).
|
|
5863
5995
|
* @default false
|
|
5864
5996
|
*/
|
|
5865
5997
|
enableRTMAutoTranscode?: boolean;
|
|
@@ -5908,9 +6040,18 @@ interface Rtm {
|
|
|
5908
6040
|
* @brief RTM 协议缓冲区延迟,单位为秒。
|
|
5909
6041
|
*/
|
|
5910
6042
|
/** {en}
|
|
5911
|
-
* @brief buffer delay to handle network jitter, in seconds
|
|
6043
|
+
* @brief buffer delay to handle network jitter, in seconds.
|
|
5912
6044
|
*/
|
|
5913
6045
|
delayHint?: number;
|
|
6046
|
+
/** {zh}
|
|
6047
|
+
* @brief RTM 建联后将在达到该阈值后检测数据接受是否异常,如果异常则播放器报错,单位毫秒。。
|
|
6048
|
+
* @default 5000
|
|
6049
|
+
*/
|
|
6050
|
+
/** {en}
|
|
6051
|
+
* @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.
|
|
6052
|
+
* @default 5000
|
|
6053
|
+
*/
|
|
6054
|
+
checkStatsErrorDelay?: number;
|
|
5914
6055
|
}
|
|
5915
6056
|
/** {zh}
|
|
5916
6057
|
* @list option
|
|
@@ -6386,10 +6527,12 @@ interface StatsSnapShoot {
|
|
|
6386
6527
|
/** {zh}
|
|
6387
6528
|
* @list option
|
|
6388
6529
|
* @kind property
|
|
6530
|
+
* @brief HLS、FLV 协议播放基础信息。
|
|
6389
6531
|
*/
|
|
6390
6532
|
/** {en}
|
|
6391
6533
|
* @list option
|
|
6392
6534
|
* @kind property
|
|
6535
|
+
* @brief Basic information for HLS and FLV protocol playback.
|
|
6393
6536
|
*/
|
|
6394
6537
|
interface Stats$0 {
|
|
6395
6538
|
/** {zh}
|
|
@@ -6510,7 +6653,7 @@ interface Stats$0 {
|
|
|
6510
6653
|
/** {zh}
|
|
6511
6654
|
* @list option
|
|
6512
6655
|
* @kind property
|
|
6513
|
-
* @brief FLV
|
|
6656
|
+
* @brief 除了 Stats 基础信息,FLV 直播流额外播放信息。
|
|
6514
6657
|
*/
|
|
6515
6658
|
/** {en}
|
|
6516
6659
|
* @list option
|
|
@@ -6544,6 +6687,12 @@ interface FlvStats extends Stats$0 {
|
|
|
6544
6687
|
* @inheritdoc
|
|
6545
6688
|
*/
|
|
6546
6689
|
declare class VePlayerLive extends VePlayerBase {
|
|
6690
|
+
/** {en}
|
|
6691
|
+
* @hidden
|
|
6692
|
+
*/
|
|
6693
|
+
/** {zh}
|
|
6694
|
+
* @hidden
|
|
6695
|
+
*/
|
|
6547
6696
|
_protocolManager?: ProtocolManager;
|
|
6548
6697
|
/** {zh}
|
|
6549
6698
|
* @hidden
|
|
@@ -6614,10 +6763,11 @@ declare class VePlayerLive extends VePlayerBase {
|
|
|
6614
6763
|
closeAbr(): void;
|
|
6615
6764
|
/** {zh}
|
|
6616
6765
|
* @brief 调用此方法更新 DRM 配置。
|
|
6766
|
+
* @param config DRM 配置对象,包含 Fairplay DRM 的相关设置。
|
|
6617
6767
|
*/
|
|
6618
6768
|
/** {en}
|
|
6619
6769
|
* @brief Use this method to update DRM configuration.
|
|
6620
|
-
* @param config
|
|
6770
|
+
* @param config A configuration object containing settings for Fairplay DRM.
|
|
6621
6771
|
*/
|
|
6622
6772
|
updateDrmConfig(config: FairplayDrmConfig): void;
|
|
6623
6773
|
/** {zh}
|
|
@@ -6632,13 +6782,13 @@ declare class VePlayerLive extends VePlayerBase {
|
|
|
6632
6782
|
switchAbr(options: {
|
|
6633
6783
|
/** {zh}
|
|
6634
6784
|
* @brief 是否开启 ABR 功能。
|
|
6635
|
-
* - true
|
|
6636
|
-
* - false
|
|
6785
|
+
* - `true`:开启
|
|
6786
|
+
* - `false`:关闭
|
|
6637
6787
|
*/
|
|
6638
6788
|
/** {en}
|
|
6639
6789
|
* @brief Whether to enable the ABR function.
|
|
6640
|
-
* - true
|
|
6641
|
-
* - false
|
|
6790
|
+
* - `true`: Enabled ;
|
|
6791
|
+
* - `false`: Disabled
|
|
6642
6792
|
* @default -
|
|
6643
6793
|
*/
|
|
6644
6794
|
enable: boolean;
|
|
@@ -6682,11 +6832,26 @@ declare class VePlayerLive extends VePlayerBase {
|
|
|
6682
6832
|
* @brief Obtain the playback information of HLS pull streaming.
|
|
6683
6833
|
*/
|
|
6684
6834
|
getHLSStats(): Stats$0;
|
|
6835
|
+
/** {en}
|
|
6836
|
+
* @brief This method is used to update the playlist, supporting updates to source, resolution, and related information.
|
|
6837
|
+
* @param playlist The playlist, consisting of multiple `Source` type elements.
|
|
6838
|
+
* @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.
|
|
6839
|
+
* @param needUpdateProtocol Whether the protocol needs to be updated.
|
|
6840
|
+
*
|
|
6841
|
+
* - `true`: Forces the protocol update to ensure compatibility with the playback configuration or source.
|
|
6842
|
+
* - `false`: Does not update the protocol and continues to use the current configuration.
|
|
6843
|
+
*/
|
|
6844
|
+
/** {zh}
|
|
6845
|
+
* @brief 调用此方法更新播放列表,支持更新源、清晰度等相关信息。
|
|
6846
|
+
* @param playlist 播放列表,包含多个 `Source` 类型的元素。
|
|
6847
|
+
* @param target 可选的目标配置项,可以指定清晰度或源。提供这些信息可以帮助更新特定清晰度或线路的播放源。
|
|
6848
|
+
* @param needUpdateProtocol 是否需要更新协议。
|
|
6849
|
+
* - `true`:强制更新协议,以确保播放配置或源的兼容性。
|
|
6850
|
+
* - `false`:不更新协议,继续使用当前配置。
|
|
6851
|
+
*/
|
|
6685
6852
|
updatePlaylist(playlist: ExposedSource[], target?: string | {
|
|
6686
6853
|
/** {zh}
|
|
6687
6854
|
* @brief 清晰度唯一标识。
|
|
6688
|
-
* @default 无
|
|
6689
|
-
*
|
|
6690
6855
|
*/
|
|
6691
6856
|
/** {en}
|
|
6692
6857
|
* @brief The resolution ID.
|
|
@@ -6695,8 +6860,6 @@ declare class VePlayerLive extends VePlayerBase {
|
|
|
6695
6860
|
definition?: string;
|
|
6696
6861
|
/** {zh}
|
|
6697
6862
|
* @brief 线路的唯一标识。
|
|
6698
|
-
* @default 无
|
|
6699
|
-
*
|
|
6700
6863
|
*/
|
|
6701
6864
|
/** {en}
|
|
6702
6865
|
* @brief The playback resource ID.
|
|
@@ -6972,6 +7135,12 @@ declare namespace live {
|
|
|
6972
7135
|
*/
|
|
6973
7136
|
Warn = "Warn"
|
|
6974
7137
|
}
|
|
7138
|
+
/** {zh}
|
|
7139
|
+
* @id ErrorCodeRaw
|
|
7140
|
+
*/
|
|
7141
|
+
/** {en}
|
|
7142
|
+
* @id ErrorCodeRaw
|
|
7143
|
+
*/
|
|
6975
7144
|
enum ErrorCode {
|
|
6976
7145
|
/** {zh}
|
|
6977
7146
|
* @brief 视频解析错误
|
|
@@ -6979,7 +7148,7 @@ declare namespace live {
|
|
|
6979
7148
|
*/
|
|
6980
7149
|
/** {en}
|
|
6981
7150
|
* @brief Video parsing error.
|
|
6982
|
-
* @solution Please contact
|
|
7151
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
6983
7152
|
*/
|
|
6984
7153
|
MANIFEST_HLS_ERROR = 1100,
|
|
6985
7154
|
/** {zh}
|
|
@@ -6988,7 +7157,7 @@ declare namespace live {
|
|
|
6988
7157
|
*/
|
|
6989
7158
|
/** {en}
|
|
6990
7159
|
* @brief Video parsing error.
|
|
6991
|
-
* @solution Please contact
|
|
7160
|
+
* @solution Please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
6992
7161
|
*/
|
|
6993
7162
|
MANIFEST_DASH_ERROR = 1200,
|
|
6994
7163
|
/** {zh}
|
|
@@ -7042,7 +7211,7 @@ declare namespace live {
|
|
|
7042
7211
|
*/
|
|
7043
7212
|
/** {en}
|
|
7044
7213
|
* @brief Video parsing error.
|
|
7045
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
7214
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7046
7215
|
*/
|
|
7047
7216
|
DEMUX_FLV_ERROR = 3100,
|
|
7048
7217
|
/** {zh}
|
|
@@ -7051,7 +7220,7 @@ declare namespace live {
|
|
|
7051
7220
|
*/
|
|
7052
7221
|
/** {en}
|
|
7053
7222
|
* @brief Video parsing error.
|
|
7054
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
7223
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7055
7224
|
*/
|
|
7056
7225
|
DEMUX_HLS_ERROR = 3200,
|
|
7057
7226
|
/** {zh}
|
|
@@ -7061,8 +7230,7 @@ declare namespace live {
|
|
|
7061
7230
|
*/
|
|
7062
7231
|
/** {en}
|
|
7063
7232
|
* @brief Video parsing error.
|
|
7064
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
7065
|
-
*
|
|
7233
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7066
7234
|
*/
|
|
7067
7235
|
DEMUX_MP4_ERROR = 3300,
|
|
7068
7236
|
/** {zh}
|
|
@@ -7072,8 +7240,7 @@ declare namespace live {
|
|
|
7072
7240
|
*/
|
|
7073
7241
|
/** {en}
|
|
7074
7242
|
* @brief Video parsing error.
|
|
7075
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
7076
|
-
*
|
|
7243
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7077
7244
|
*/
|
|
7078
7245
|
DEMUX_FMP4_ERROR = 3400,
|
|
7079
7246
|
/** {zh}
|
|
@@ -7083,8 +7250,7 @@ declare namespace live {
|
|
|
7083
7250
|
*/
|
|
7084
7251
|
/** {en}
|
|
7085
7252
|
* @brief Video parsing error.
|
|
7086
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
7087
|
-
*
|
|
7253
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7088
7254
|
*/
|
|
7089
7255
|
DEMUX_SIDX_ERROR = 3410,
|
|
7090
7256
|
/** {zh}
|
|
@@ -7094,8 +7260,7 @@ declare namespace live {
|
|
|
7094
7260
|
*/
|
|
7095
7261
|
/** {en}
|
|
7096
7262
|
* @brief Video parsing error.
|
|
7097
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
7098
|
-
*
|
|
7263
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7099
7264
|
*/
|
|
7100
7265
|
REMUX_FMP4_ERROR = 4100,
|
|
7101
7266
|
/** {zh}
|
|
@@ -7105,8 +7270,7 @@ declare namespace live {
|
|
|
7105
7270
|
*/
|
|
7106
7271
|
/** {en}
|
|
7107
7272
|
* @brief Video parsing error.
|
|
7108
|
-
* @solution Check whether the pull stream address is valid, or contact
|
|
7109
|
-
*
|
|
7273
|
+
* @solution Check whether the pull stream address is valid, or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7110
7274
|
*/
|
|
7111
7275
|
REMUX_MP4_ERROR = 4200,
|
|
7112
7276
|
/** {zh}
|
|
@@ -7136,10 +7300,9 @@ declare namespace live {
|
|
|
7136
7300
|
*/
|
|
7137
7301
|
/** {en}
|
|
7138
7302
|
* @brief An error occurred to the browser while decoding the media resources.
|
|
7139
|
-
* @solution
|
|
7140
|
-
*
|
|
7141
|
-
*
|
|
7142
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
7303
|
+
* @solution 1. Check whether there is any issue with the original video.
|
|
7304
|
+
* 2. Re-transcode the video and play it again.
|
|
7305
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7143
7306
|
*/
|
|
7144
7307
|
MEDIA_ERR_DECODE = 5103,
|
|
7145
7308
|
/** {zh}
|
|
@@ -7151,10 +7314,9 @@ declare namespace live {
|
|
|
7151
7314
|
*/
|
|
7152
7315
|
/** {en}
|
|
7153
7316
|
* @brief The video cannot be loaded due to unsupported video format or server or network issues.
|
|
7154
|
-
* @solution
|
|
7155
|
-
*
|
|
7156
|
-
*
|
|
7157
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
7317
|
+
* @solution 1. Check whether there is any issue with the browser's request.
|
|
7318
|
+
* 2. Check whether the browser and the current page support the video format.
|
|
7319
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7158
7320
|
*/
|
|
7159
7321
|
MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
|
|
7160
7322
|
/** {zh}
|
|
@@ -7166,10 +7328,9 @@ declare namespace live {
|
|
|
7166
7328
|
*/
|
|
7167
7329
|
/** {en}
|
|
7168
7330
|
* @brief The current browser does not support video decoding.
|
|
7169
|
-
* @solution
|
|
7170
|
-
*
|
|
7171
|
-
*
|
|
7172
|
-
* 3. If the error persists, please contact your [technical support](https://www.byteplus.com/en/support).
|
|
7331
|
+
* @solution 1. Check whether there is any issue with the browser's request.
|
|
7332
|
+
* 2. Check whether the browser and the current page support the video format.
|
|
7333
|
+
* 3. If the error persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7173
7334
|
*/
|
|
7174
7335
|
MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
|
|
7175
7336
|
/** {zh}
|
|
@@ -7187,7 +7348,7 @@ declare namespace live {
|
|
|
7187
7348
|
*/
|
|
7188
7349
|
/** {en}
|
|
7189
7350
|
* @brief A playback issue occurred.
|
|
7190
|
-
* @solution Check the live stream source or contact
|
|
7351
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7191
7352
|
*/
|
|
7192
7353
|
MEDIA_MSE_ADD_SB = 5200,
|
|
7193
7354
|
/** {zh}
|
|
@@ -7196,7 +7357,7 @@ declare namespace live {
|
|
|
7196
7357
|
*/
|
|
7197
7358
|
/** {en}
|
|
7198
7359
|
* @brief A playback issue occurred.
|
|
7199
|
-
* @solution Check the live stream source or contact
|
|
7360
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7200
7361
|
*/
|
|
7201
7362
|
MEDIA_MSE_APPEND_BUFFER = 5201,
|
|
7202
7363
|
/** {zh}
|
|
@@ -7205,7 +7366,7 @@ declare namespace live {
|
|
|
7205
7366
|
*/
|
|
7206
7367
|
/** {en}
|
|
7207
7368
|
* @brief A playback issue occurred.
|
|
7208
|
-
* @solution Check the live stream source or contact
|
|
7369
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7209
7370
|
*/
|
|
7210
7371
|
MEDIA_MSE_OTHER = 5202,
|
|
7211
7372
|
/** {zh}
|
|
@@ -7214,7 +7375,7 @@ declare namespace live {
|
|
|
7214
7375
|
*/
|
|
7215
7376
|
/** {en}
|
|
7216
7377
|
* @brief A playback issue occurred.
|
|
7217
|
-
* @solution Check the live stream source or contact
|
|
7378
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7218
7379
|
*/
|
|
7219
7380
|
MEDIA_MSE_FULL = 5203,
|
|
7220
7381
|
/** {zh}
|
|
@@ -7223,7 +7384,7 @@ declare namespace live {
|
|
|
7223
7384
|
*/
|
|
7224
7385
|
/** {en}
|
|
7225
7386
|
* @brief A playback issue occurred.
|
|
7226
|
-
* @solution Check the live stream source or contact
|
|
7387
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7227
7388
|
*/
|
|
7228
7389
|
MEDIA_MSE_HIJACK = 5204,
|
|
7229
7390
|
/** {zh}
|
|
@@ -7232,25 +7393,29 @@ declare namespace live {
|
|
|
7232
7393
|
*/
|
|
7233
7394
|
/** {en}
|
|
7234
7395
|
* @brief A playback issue occurred.
|
|
7235
|
-
* @solution Check the live stream source or contact
|
|
7396
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7236
7397
|
*/
|
|
7237
7398
|
MEDIA_EME_HIJACK = 5301,
|
|
7238
7399
|
/** {zh}
|
|
7239
7400
|
* @brief DRM 权限校验失败
|
|
7240
7401
|
* @hidden
|
|
7402
|
+
* @solution 请检查权限配置,确保播放权限正确。
|
|
7241
7403
|
*/
|
|
7242
7404
|
/** {en}
|
|
7243
7405
|
* @brief DRM authentication failed.
|
|
7244
7406
|
* @hidden
|
|
7407
|
+
* @solution Verify the authentication and ensure proper playback permissions.
|
|
7245
7408
|
*/
|
|
7246
7409
|
DRM_LICENSE = 7100,
|
|
7247
7410
|
/** {zh}
|
|
7248
7411
|
* @brief DRM 权限校验失败
|
|
7249
7412
|
* @hidden
|
|
7413
|
+
* @solution 请检查自定义 DRM 权限。
|
|
7250
7414
|
*/
|
|
7251
7415
|
/** {en}
|
|
7252
7416
|
* @brief DRM authentication failed.
|
|
7253
7417
|
* @hidden
|
|
7418
|
+
* @solution Please check the custom DRM authentication.
|
|
7254
7419
|
*/
|
|
7255
7420
|
DRM_CUSTOM_LICENSE = 7200,
|
|
7256
7421
|
/** {zh}
|
|
@@ -7259,7 +7424,7 @@ declare namespace live {
|
|
|
7259
7424
|
*/
|
|
7260
7425
|
/** {en}
|
|
7261
7426
|
* @brief A playback issue occurred.
|
|
7262
|
-
* @solution Check the live stream source or contact
|
|
7427
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7263
7428
|
*/
|
|
7264
7429
|
OTHER = 8000,
|
|
7265
7430
|
/** {zh}
|
|
@@ -7268,7 +7433,7 @@ declare namespace live {
|
|
|
7268
7433
|
*/
|
|
7269
7434
|
/** {en}
|
|
7270
7435
|
* @brief A playback issue occurred.
|
|
7271
|
-
* @solution Check the live stream source or contact
|
|
7436
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7272
7437
|
*/
|
|
7273
7438
|
RUNTIME_NO_CANPLAY_ERROR = 9001,
|
|
7274
7439
|
/** {zh}
|
|
@@ -7277,7 +7442,7 @@ declare namespace live {
|
|
|
7277
7442
|
*/
|
|
7278
7443
|
/** {en}
|
|
7279
7444
|
* @brief A playback issue occurred.
|
|
7280
|
-
* @solution Check the live stream source or contact
|
|
7445
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7281
7446
|
*/
|
|
7282
7447
|
RUNTIME_BUFFERBREAK_ERROR = 9002,
|
|
7283
7448
|
/** {zh}
|
|
@@ -7286,7 +7451,7 @@ declare namespace live {
|
|
|
7286
7451
|
*/
|
|
7287
7452
|
/** {en}
|
|
7288
7453
|
* @brief A playback issue occurred.
|
|
7289
|
-
* @solution Check the live stream source or contact
|
|
7454
|
+
* @solution Check the live stream source or [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7290
7455
|
*/
|
|
7291
7456
|
RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
|
|
7292
7457
|
// veplayer 报错
|
|
@@ -7303,9 +7468,11 @@ declare namespace live {
|
|
|
7303
7468
|
MODULE_LOAD_ERROR = 110,
|
|
7304
7469
|
/** {zh}
|
|
7305
7470
|
* @hidden
|
|
7471
|
+
* @solution 请重试操作,如仍未解决,请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
|
|
7306
7472
|
*/
|
|
7307
7473
|
/** {en}
|
|
7308
7474
|
* @hidden
|
|
7475
|
+
* @solution Please retry the operation. If the issue persists, please [contact support](https://console.byteplus.com/auth/login?redirectURI=%2Fworkorder%2Fcreate).
|
|
7309
7476
|
*/
|
|
7310
7477
|
UNKNOWN = "UNKNOWN"
|
|
7311
7478
|
}
|
|
@@ -7455,6 +7622,14 @@ declare namespace live {
|
|
|
7455
7622
|
*
|
|
7456
7623
|
*/
|
|
7457
7624
|
fallbackUrls?: string[];
|
|
7625
|
+
/** {zh}
|
|
7626
|
+
* @hidden
|
|
7627
|
+
* @brief 自定义播放地址类型标识。可用于区分不同来源的播放地址。
|
|
7628
|
+
*/
|
|
7629
|
+
/** {en}
|
|
7630
|
+
* @hidden
|
|
7631
|
+
* @brief Custom identifier for the playback address type. Can be used to distinguish different stream sources.
|
|
7632
|
+
*/
|
|
7458
7633
|
type?: string;
|
|
7459
7634
|
}
|
|
7460
7635
|
/** {zh}
|
|
@@ -9449,8 +9624,7 @@ declare namespace live {
|
|
|
9449
9624
|
* @brief 缓存部分进度条底色。
|
|
9450
9625
|
*/
|
|
9451
9626
|
/** {en}
|
|
9452
|
-
* @brief
|
|
9453
|
-
* @brief The background color of the progress bar for the cached portion of video playback.
|
|
9627
|
+
* @brief The background color of the buffered portion of the progress bar.
|
|
9454
9628
|
*/
|
|
9455
9629
|
cachedColor?: string;
|
|
9456
9630
|
/** {zh}
|
|
@@ -9869,11 +10043,15 @@ declare namespace live {
|
|
|
9869
10043
|
*/
|
|
9870
10044
|
fallbackToFirstDefinition?: boolean;
|
|
9871
10045
|
/** {zh}
|
|
9872
|
-
* @brief
|
|
10046
|
+
* @brief 是否启用无缝切换。
|
|
10047
|
+
* - `true`:启用无缝切换,保证播放过程中不中断。
|
|
10048
|
+
* - `false`:不启用无缝切换,可能会出现播放中断。
|
|
9873
10049
|
* @default false
|
|
9874
10050
|
*/
|
|
9875
10051
|
/** {en}
|
|
9876
|
-
* @brief Whether seamless switching
|
|
10052
|
+
* @brief Whether seamless switching is enabled.
|
|
10053
|
+
* - `true`: Enables seamless switching, ensuring no interruption during playback.
|
|
10054
|
+
* - `false`: Disables seamless switching, which may cause interruptions during playback.
|
|
9877
10055
|
*/
|
|
9878
10056
|
seamless?: boolean;
|
|
9879
10057
|
}): Promise<ExposedDefinition>;
|
|
@@ -9958,7 +10136,7 @@ declare namespace live {
|
|
|
9958
10136
|
*/
|
|
9959
10137
|
on(event: string, callback: (data?: any) => any): void;
|
|
9960
10138
|
/** {zh}
|
|
9961
|
-
* @brief
|
|
10139
|
+
* @brief 调用此方法开始播放。
|
|
9962
10140
|
*/
|
|
9963
10141
|
/** {en}
|
|
9964
10142
|
* @brief Starts playback.
|
|
@@ -10002,20 +10180,24 @@ declare namespace live {
|
|
|
10002
10180
|
*/
|
|
10003
10181
|
focus(data?: {
|
|
10004
10182
|
/** {zh}
|
|
10005
|
-
* @brief
|
|
10183
|
+
* @brief 是否需要自动失焦。
|
|
10184
|
+
* - `true`:启用自动失焦,经过指定的延迟时间后,自动调用 `blur()` 方法进行失焦。
|
|
10185
|
+
* - `false`:禁用自动失焦,不会在延迟时间后自动调用 `blur()` 方法。
|
|
10006
10186
|
* @default true
|
|
10007
10187
|
*/
|
|
10008
10188
|
/** {en}
|
|
10009
|
-
* @brief Whether
|
|
10189
|
+
* @brief Whether auto-blur is enabled.
|
|
10190
|
+
* - `true`: Enables auto-blur, meaning `blur()` will be automatically called after the specified delay time.
|
|
10191
|
+
* - `false`: Disables auto-blur, meaning `blur()` will not be automatically called after the delay.
|
|
10010
10192
|
* @default true
|
|
10011
10193
|
*/
|
|
10012
10194
|
autoHide?: boolean;
|
|
10013
10195
|
/** {zh}
|
|
10014
|
-
* @brief
|
|
10196
|
+
* @brief 自动失焦的延迟时间,单位为毫秒。在 `autoHide` 为 `true` 时生效。
|
|
10015
10197
|
* @default 3000
|
|
10016
10198
|
*/
|
|
10017
10199
|
/** {en}
|
|
10018
|
-
* @brief
|
|
10200
|
+
* @brief Delay duration (in milliseconds) before auto-blur is triggered. This takes effect only when `autoHide` is set to `true`.
|
|
10019
10201
|
* @default 3000
|
|
10020
10202
|
*/
|
|
10021
10203
|
delay?: number;
|
|
@@ -10030,11 +10212,11 @@ declare namespace live {
|
|
|
10030
10212
|
*/
|
|
10031
10213
|
blur(data?: {
|
|
10032
10214
|
/** {zh}
|
|
10033
|
-
* @brief
|
|
10215
|
+
* @brief 播放器在暂停时是否保留焦点状态。默认值为 `true`,即播放器暂停时不会自动失焦。
|
|
10034
10216
|
* @default false
|
|
10035
10217
|
*/
|
|
10036
10218
|
/** {en}
|
|
10037
|
-
* @brief Whether
|
|
10219
|
+
* @brief Whether the player retains focus when paused. The default is `true`, meaning the player will not automatically lose focus during pause.
|
|
10038
10220
|
* @default false
|
|
10039
10221
|
*/
|
|
10040
10222
|
ignorePaused?: boolean;
|
|
@@ -10732,16 +10914,22 @@ declare namespace live {
|
|
|
10732
10914
|
*/
|
|
10733
10915
|
INVALID_PARAMETER = 210,
|
|
10734
10916
|
/**
|
|
10917
|
+
* @brief 缺少 RTM 降级参数
|
|
10918
|
+
* @solution 请检查是否设置 `playlist` 传入 `rtm` 降级协议地址
|
|
10919
|
+
* @hidden
|
|
10920
|
+
*/
|
|
10921
|
+
/** {en}
|
|
10922
|
+
* @brief Missing RTM fallback parameter.
|
|
10735
10923
|
* @hidden
|
|
10736
10924
|
*/
|
|
10737
10925
|
EMPTY_RTM_FALLBACK_PARAMETER = 211,
|
|
10738
10926
|
/** {zh}
|
|
10739
10927
|
* @brief 日志错误
|
|
10740
|
-
* @solution 未正确配置质量日志参数,请参考
|
|
10928
|
+
* @solution 未正确配置质量日志参数,请参考[播放日志上报](https://www.volcengine.com/docs/6469/1548575)进行配置。
|
|
10741
10929
|
*/
|
|
10742
10930
|
/** {en}
|
|
10743
10931
|
* @brief Log errors.
|
|
10744
|
-
* @solution Log options not configured correctly. Please refer to this document
|
|
10932
|
+
* @solution Log options not configured correctly. Please refer to this [document](https://docs.byteplus.com/en/docs/byteplus-media-live/docs-feature-implementation).
|
|
10745
10933
|
*/
|
|
10746
10934
|
INVALID_LOGGER = 220
|
|
10747
10935
|
}
|
|
@@ -10753,12 +10941,14 @@ declare namespace live {
|
|
|
10753
10941
|
* @name ErrorCode
|
|
10754
10942
|
* @id ErrorCode
|
|
10755
10943
|
* @structure errorCode
|
|
10944
|
+
* @brief 错误码。
|
|
10756
10945
|
*/
|
|
10757
10946
|
/** {en}
|
|
10758
10947
|
* @detail error
|
|
10759
10948
|
* @name ErrorCode
|
|
10760
10949
|
* @id ErrorCode
|
|
10761
10950
|
* @structure errorCode
|
|
10951
|
+
* @brief Error code.
|
|
10762
10952
|
*/
|
|
10763
10953
|
const ErrorCode$0: {
|
|
10764
10954
|
[x: number]: string;
|
|
@@ -10970,9 +11160,40 @@ declare namespace live {
|
|
|
10970
11160
|
Error = "Error",
|
|
10971
11161
|
Stall = "Stall"
|
|
10972
11162
|
}
|
|
11163
|
+
/** {zh}
|
|
11164
|
+
* @list option
|
|
11165
|
+
* @kind property
|
|
11166
|
+
*/
|
|
11167
|
+
/** {en}
|
|
11168
|
+
* @list option
|
|
11169
|
+
* @kind property
|
|
11170
|
+
*/
|
|
10973
11171
|
interface ErrorFallbackStrategy {
|
|
11172
|
+
/** {zh}
|
|
11173
|
+
* @brief 降级类型,定义是否自动降级或手动控制。
|
|
11174
|
+
* @hidden
|
|
11175
|
+
*/
|
|
11176
|
+
/** {en}
|
|
11177
|
+
* @brief Type of fallback. Specifies whether fallback is automatic or manually controlled.
|
|
11178
|
+
*/
|
|
10974
11179
|
type?: FallbackKind;
|
|
11180
|
+
/** {zh}
|
|
11181
|
+
* @brief 降级黑名单。若错误码命中该列表,则不会触发降级逻辑。
|
|
11182
|
+
*/
|
|
11183
|
+
/** {en}
|
|
11184
|
+
* @brief List of error codes to ignore for fallback. If the error code is in this list, fallback will not be triggered.
|
|
11185
|
+
*/
|
|
10975
11186
|
excludeList?: ErrorCode$0[];
|
|
11187
|
+
/** {zh}
|
|
11188
|
+
* @brief 自定义降级策略。返回值为:
|
|
11189
|
+
* - `true`:执行降级。
|
|
11190
|
+
* - `false`:不执行降级。
|
|
11191
|
+
*/
|
|
11192
|
+
/** {en}
|
|
11193
|
+
* @brief Custom fallback logic. Returns:<br>
|
|
11194
|
+
* - `true`: fallback will occur<br>
|
|
11195
|
+
* - `false`: no fallback
|
|
11196
|
+
*/
|
|
10976
11197
|
shouldFallback?: (type: string, params: {
|
|
10977
11198
|
error: VeError$1;
|
|
10978
11199
|
}) => boolean;
|
|
@@ -11106,14 +11327,14 @@ declare namespace live {
|
|
|
11106
11327
|
*/
|
|
11107
11328
|
ad?: AdConfig;
|
|
11108
11329
|
/** {zh}
|
|
11109
|
-
* @brief 为播放器设置直播时移配置,接入方法请参见[
|
|
11330
|
+
* @brief 为播放器设置直播时移配置,接入方法请参见[直播时移](https://www.volcengine.com/docs/6469/1548574)。
|
|
11110
11331
|
*/
|
|
11111
11332
|
/** {en}
|
|
11112
11333
|
* @brief Configurations for time shifting.
|
|
11113
11334
|
*/
|
|
11114
11335
|
timeShift?: TimeShiftConfig;
|
|
11115
11336
|
/** {zh}
|
|
11116
|
-
* @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[
|
|
11337
|
+
* @brief 日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数,接入方法请参见[播放日志上报](https://www.volcengine.com/docs/6469/1548575)。
|
|
11117
11338
|
*/
|
|
11118
11339
|
/** {en}
|
|
11119
11340
|
* @brief Configurations for log upload. Supports enabling/disabling log upload and setting log parameters.
|
|
@@ -11140,16 +11361,84 @@ declare namespace live {
|
|
|
11140
11361
|
* @brief Digital Rights Management (DRM) configurations.
|
|
11141
11362
|
*/
|
|
11142
11363
|
drm?: Drm;
|
|
11364
|
+
/** {zh}
|
|
11365
|
+
* @brief 设置播放器的播放延迟模式。
|
|
11366
|
+
* - `standard`:标准延迟,稳定性高。
|
|
11367
|
+
* - `low`:低延迟,适用于互动场景。
|
|
11368
|
+
* @hidden
|
|
11369
|
+
*/
|
|
11370
|
+
/** {en}
|
|
11371
|
+
* @brief Sets the playback latency mode of the player. Optional values:
|
|
11372
|
+
* - `standard`: Standard latency with higher stability.
|
|
11373
|
+
* - `low`: Low latency, suitable for interactive scenarios.
|
|
11374
|
+
* @hidden
|
|
11375
|
+
*/
|
|
11143
11376
|
latencyMode?: "standard" | "low";
|
|
11377
|
+
/** {zh}
|
|
11378
|
+
* @brief 配置协议降级参数。当播放失败或卡顿时,可根据策略降级使用其他协议。
|
|
11379
|
+
*/
|
|
11380
|
+
/** {en}
|
|
11381
|
+
* @brief Configure protocol downgrade parameters. When playback fails or stutters, other protocols can be downgraded according to the strategy.
|
|
11382
|
+
*/
|
|
11144
11383
|
fallback?: Fallback;
|
|
11145
11384
|
}
|
|
11385
|
+
/** {zh}
|
|
11386
|
+
* @list option
|
|
11387
|
+
* @kind property
|
|
11388
|
+
*/
|
|
11389
|
+
/** {en}
|
|
11390
|
+
* @list option
|
|
11391
|
+
* @kind property
|
|
11392
|
+
*/
|
|
11146
11393
|
interface Fallback {
|
|
11394
|
+
/** {zh}
|
|
11395
|
+
* @brief 是否开启协议降级功能。
|
|
11396
|
+
* @hidden
|
|
11397
|
+
*/
|
|
11398
|
+
/** {en}
|
|
11399
|
+
* @brief Whether to enable protocol fallback.
|
|
11400
|
+
*/
|
|
11147
11401
|
enableFallback?: boolean;
|
|
11148
|
-
|
|
11149
|
-
|
|
11150
|
-
|
|
11151
|
-
|
|
11152
|
-
|
|
11402
|
+
/** {zh}
|
|
11403
|
+
* @brief 协议选择优先级顺序。
|
|
11404
|
+
* @listtip - 配置多个协议时,按该顺序选择当前浏览器环境支持的协议。
|
|
11405
|
+
* - 播放失败时根据 `fallbackStrategy` 判断需要降级时,按该顺序选择下一个协议。
|
|
11406
|
+
*/
|
|
11407
|
+
/** {en}
|
|
11408
|
+
* @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`.
|
|
11409
|
+
*/
|
|
11410
|
+
fallbackOrder?: Array<"rtm" | "flv" | "hls">;
|
|
11411
|
+
/** {zh}
|
|
11412
|
+
* @brief 协议降级策略配置。
|
|
11413
|
+
* @listtip - 默认为 RTM 播放出错时触发降级。
|
|
11414
|
+
* - 若所有协议采用同一策略,可通过设置 `all` 实现统一配置。
|
|
11415
|
+
* - 若同时配置了 `all` 和某个协议(如 `rtm`),将优先使用协议自身的配置,即 `rtm` 策略优先级高于 `all`。
|
|
11416
|
+
*/
|
|
11417
|
+
/** {en}
|
|
11418
|
+
* @listtip - By default, fallback is triggered when RTM playback fails.
|
|
11419
|
+
* - Use `all` to apply the same strategy across all protocols.
|
|
11420
|
+
* - If both `all` and a specific protocol (e.g., `rtm`) are set, the specific protocol strategy takes precedence.
|
|
11421
|
+
* @brief Strategy for protocol fallback.
|
|
11422
|
+
*/
|
|
11423
|
+
fallbackStrategy?: Record<"rtm" | "flv" | "hls" | "all", FallbackStrategy>;
|
|
11424
|
+
}
|
|
11425
|
+
/** {zh}
|
|
11426
|
+
* @list option
|
|
11427
|
+
* @kind property
|
|
11428
|
+
*/
|
|
11429
|
+
/** {en}
|
|
11430
|
+
* @list option
|
|
11431
|
+
* @kind property
|
|
11432
|
+
*/
|
|
11433
|
+
interface FallbackStrategy {
|
|
11434
|
+
/** {zh}
|
|
11435
|
+
* @brief 拉流报错时降级策略
|
|
11436
|
+
*/
|
|
11437
|
+
[FallbackKind.Error]?: ErrorFallbackStrategy;
|
|
11438
|
+
/**
|
|
11439
|
+
* @hidden
|
|
11440
|
+
*/
|
|
11441
|
+
[FallbackKind.Stall]?: StallFallbackStrategy;
|
|
11153
11442
|
}
|
|
11154
11443
|
/** {zh}
|
|
11155
11444
|
* @list option
|
|
@@ -11478,7 +11767,7 @@ declare namespace live {
|
|
|
11478
11767
|
* - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
|
|
11479
11768
|
* - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
|
|
11480
11769
|
* @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
|
|
11481
|
-
* - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM
|
|
11770
|
+
* - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 协议拉流](https://www.volcengine.com/docs/6469/1548474)。
|
|
11482
11771
|
*/
|
|
11483
11772
|
/** {en}
|
|
11484
11773
|
* @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`.
|
|
@@ -11525,8 +11814,7 @@ declare namespace live {
|
|
|
11525
11814
|
* @brief Whether to enable automatic transcoding when the player requests to pull an RTM stream.
|
|
11526
11815
|
* - `true`: Enable;
|
|
11527
11816
|
* - `false`: Disable.
|
|
11528
|
-
* @listtip
|
|
11529
|
-
* If you want to use the automatic transcoding feature when playing an RTM stream, contact your [technical support](https://www.byteplus.com/en/support).
|
|
11817
|
+
* @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).
|
|
11530
11818
|
* @default false
|
|
11531
11819
|
*/
|
|
11532
11820
|
enableRTMAutoTranscode?: boolean;
|
|
@@ -11575,9 +11863,18 @@ declare namespace live {
|
|
|
11575
11863
|
* @brief RTM 协议缓冲区延迟,单位为秒。
|
|
11576
11864
|
*/
|
|
11577
11865
|
/** {en}
|
|
11578
|
-
* @brief buffer delay to handle network jitter, in seconds
|
|
11866
|
+
* @brief buffer delay to handle network jitter, in seconds.
|
|
11579
11867
|
*/
|
|
11580
11868
|
delayHint?: number;
|
|
11869
|
+
/** {zh}
|
|
11870
|
+
* @brief RTM 建联后将在达到该阈值后检测数据接受是否异常,如果异常则播放器报错,单位毫秒。。
|
|
11871
|
+
* @default 5000
|
|
11872
|
+
*/
|
|
11873
|
+
/** {en}
|
|
11874
|
+
* @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.
|
|
11875
|
+
* @default 5000
|
|
11876
|
+
*/
|
|
11877
|
+
checkStatsErrorDelay?: number;
|
|
11581
11878
|
}
|
|
11582
11879
|
/** {zh}
|
|
11583
11880
|
* @list option
|
|
@@ -12053,10 +12350,12 @@ declare namespace live {
|
|
|
12053
12350
|
/** {zh}
|
|
12054
12351
|
* @list option
|
|
12055
12352
|
* @kind property
|
|
12353
|
+
* @brief HLS、FLV 协议播放基础信息。
|
|
12056
12354
|
*/
|
|
12057
12355
|
/** {en}
|
|
12058
12356
|
* @list option
|
|
12059
12357
|
* @kind property
|
|
12358
|
+
* @brief Basic information for HLS and FLV protocol playback.
|
|
12060
12359
|
*/
|
|
12061
12360
|
interface Stats$0 {
|
|
12062
12361
|
/** {zh}
|
|
@@ -12177,7 +12476,7 @@ declare namespace live {
|
|
|
12177
12476
|
/** {zh}
|
|
12178
12477
|
* @list option
|
|
12179
12478
|
* @kind property
|
|
12180
|
-
* @brief FLV
|
|
12479
|
+
* @brief 除了 Stats 基础信息,FLV 直播流额外播放信息。
|
|
12181
12480
|
*/
|
|
12182
12481
|
/** {en}
|
|
12183
12482
|
* @list option
|
|
@@ -12211,6 +12510,12 @@ declare namespace live {
|
|
|
12211
12510
|
* @inheritdoc
|
|
12212
12511
|
*/
|
|
12213
12512
|
class VePlayerLive extends VePlayerBase {
|
|
12513
|
+
/** {en}
|
|
12514
|
+
* @hidden
|
|
12515
|
+
*/
|
|
12516
|
+
/** {zh}
|
|
12517
|
+
* @hidden
|
|
12518
|
+
*/
|
|
12214
12519
|
_protocolManager?: ProtocolManager;
|
|
12215
12520
|
/** {zh}
|
|
12216
12521
|
* @hidden
|
|
@@ -12281,10 +12586,11 @@ declare namespace live {
|
|
|
12281
12586
|
closeAbr(): void;
|
|
12282
12587
|
/** {zh}
|
|
12283
12588
|
* @brief 调用此方法更新 DRM 配置。
|
|
12589
|
+
* @param config DRM 配置对象,包含 Fairplay DRM 的相关设置。
|
|
12284
12590
|
*/
|
|
12285
12591
|
/** {en}
|
|
12286
12592
|
* @brief Use this method to update DRM configuration.
|
|
12287
|
-
* @param config
|
|
12593
|
+
* @param config A configuration object containing settings for Fairplay DRM.
|
|
12288
12594
|
*/
|
|
12289
12595
|
updateDrmConfig(config: FairplayDrmConfig): void;
|
|
12290
12596
|
/** {zh}
|
|
@@ -12299,13 +12605,13 @@ declare namespace live {
|
|
|
12299
12605
|
switchAbr(options: {
|
|
12300
12606
|
/** {zh}
|
|
12301
12607
|
* @brief 是否开启 ABR 功能。
|
|
12302
|
-
* - true
|
|
12303
|
-
* - false
|
|
12608
|
+
* - `true`:开启
|
|
12609
|
+
* - `false`:关闭
|
|
12304
12610
|
*/
|
|
12305
12611
|
/** {en}
|
|
12306
12612
|
* @brief Whether to enable the ABR function.
|
|
12307
|
-
* - true
|
|
12308
|
-
* - false
|
|
12613
|
+
* - `true`: Enabled ;
|
|
12614
|
+
* - `false`: Disabled
|
|
12309
12615
|
* @default -
|
|
12310
12616
|
*/
|
|
12311
12617
|
enable: boolean;
|
|
@@ -12349,11 +12655,26 @@ declare namespace live {
|
|
|
12349
12655
|
* @brief Obtain the playback information of HLS pull streaming.
|
|
12350
12656
|
*/
|
|
12351
12657
|
getHLSStats(): Stats$0;
|
|
12658
|
+
/** {en}
|
|
12659
|
+
* @brief This method is used to update the playlist, supporting updates to source, resolution, and related information.
|
|
12660
|
+
* @param playlist The playlist, consisting of multiple `Source` type elements.
|
|
12661
|
+
* @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.
|
|
12662
|
+
* @param needUpdateProtocol Whether the protocol needs to be updated.
|
|
12663
|
+
*
|
|
12664
|
+
* - `true`: Forces the protocol update to ensure compatibility with the playback configuration or source.
|
|
12665
|
+
* - `false`: Does not update the protocol and continues to use the current configuration.
|
|
12666
|
+
*/
|
|
12667
|
+
/** {zh}
|
|
12668
|
+
* @brief 调用此方法更新播放列表,支持更新源、清晰度等相关信息。
|
|
12669
|
+
* @param playlist 播放列表,包含多个 `Source` 类型的元素。
|
|
12670
|
+
* @param target 可选的目标配置项,可以指定清晰度或源。提供这些信息可以帮助更新特定清晰度或线路的播放源。
|
|
12671
|
+
* @param needUpdateProtocol 是否需要更新协议。
|
|
12672
|
+
* - `true`:强制更新协议,以确保播放配置或源的兼容性。
|
|
12673
|
+
* - `false`:不更新协议,继续使用当前配置。
|
|
12674
|
+
*/
|
|
12352
12675
|
updatePlaylist(playlist: ExposedSource[], target?: string | {
|
|
12353
12676
|
/** {zh}
|
|
12354
12677
|
* @brief 清晰度唯一标识。
|
|
12355
|
-
* @default 无
|
|
12356
|
-
*
|
|
12357
12678
|
*/
|
|
12358
12679
|
/** {en}
|
|
12359
12680
|
* @brief The resolution ID.
|
|
@@ -12362,8 +12683,6 @@ declare namespace live {
|
|
|
12362
12683
|
definition?: string;
|
|
12363
12684
|
/** {zh}
|
|
12364
12685
|
* @brief 线路的唯一标识。
|
|
12365
|
-
* @default 无
|
|
12366
|
-
*
|
|
12367
12686
|
*/
|
|
12368
12687
|
/** {en}
|
|
12369
12688
|
* @brief The playback resource ID.
|