@byteplus/veplayer 1.11.0-rc.5 → 1.11.0-rc.7
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/index.d.ts +12 -195
- package/index.min.js +2 -2
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -79,21 +79,8 @@ export interface ISdkErrorConfig {
|
|
|
79
79
|
* @hidden
|
|
80
80
|
*/
|
|
81
81
|
isNeedDemoteBack?: boolean;
|
|
82
|
-
/**
|
|
83
|
-
* @brief 是否允许回退到同清晰度不同线路的 fallbackurl:
|
|
84
|
-
* - `false`:只能在当前 defintion 范围内 fallback。
|
|
85
|
-
* - `true`:允许 fallback 相同清晰度,不同的线路的 fallbackurl。
|
|
86
|
-
* @default true
|
|
87
|
-
*
|
|
88
|
-
*/
|
|
89
|
-
/** {en}
|
|
90
|
-
* @brief Is demote to different line enabled? The values are as follows:
|
|
91
|
-
* - `false`: only demote in current definition line.
|
|
92
|
-
* - `true`: allow demote to different line.
|
|
93
|
-
*/
|
|
94
|
-
allowDemoteToDifferentLine?: boolean;
|
|
95
82
|
/** {zh}
|
|
96
|
-
* @brief
|
|
83
|
+
* @brief 报错后重试次数。
|
|
97
84
|
* @default 1
|
|
98
85
|
*/
|
|
99
86
|
retryLoopNum?: number;
|
|
@@ -811,125 +798,18 @@ export interface ITextItem {
|
|
|
811
798
|
*/
|
|
812
799
|
export interface IDefinitionDemotePlugin {
|
|
813
800
|
/**
|
|
814
|
-
* @brief
|
|
815
|
-
* - `false`:关闭自动降级。
|
|
816
|
-
* - `true`:开启自动降级。
|
|
817
|
-
* @default true
|
|
818
|
-
*
|
|
819
|
-
*/
|
|
820
|
-
/** {en}
|
|
821
|
-
* @brief Is automatic downgrade enabled for long waiting? The values are as follows:
|
|
822
|
-
* - `false`: automatic downgrade is disabled.
|
|
823
|
-
* - `true`: automatic downgrade is enabled.
|
|
824
|
-
*/
|
|
825
|
-
isNeedAutoDemoteWhenLongWaiting?: boolean;
|
|
826
|
-
/**
|
|
827
|
-
* @brief 频繁卡顿情况下是否开启自动降级,取值如下:
|
|
801
|
+
* @brief 是否开启自动降级,取值如下:
|
|
828
802
|
* - `false`:关闭自动降级。
|
|
829
803
|
* - `true`:开启自动降级。
|
|
830
804
|
* @default true
|
|
831
805
|
*
|
|
832
806
|
*/
|
|
833
807
|
/** {en}
|
|
834
|
-
* @brief Is automatic downgrade enabled
|
|
808
|
+
* @brief Is automatic downgrade enabled? The values are as follows:
|
|
835
809
|
* - `false`: automatic downgrade is disabled.
|
|
836
810
|
* - `true`: automatic downgrade is enabled.
|
|
837
811
|
*/
|
|
838
|
-
|
|
839
|
-
/**
|
|
840
|
-
* @brief 长卡顿情况下,当用户开启 fallbackUrl 降级(降级到备用线路) 时,优先降级清晰度还是 fallbackUrl,取值如下:
|
|
841
|
-
* - `false`:优先在同一个清晰度的所有 fallback 之间切换, 都有问题的情况下,再降低到下一个清晰度
|
|
842
|
-
* - `true`:优先降级清晰度, 清晰度降到最低之后,再在最后一个清晰度的 fallbackUrl 之间切换
|
|
843
|
-
* @default false
|
|
844
|
-
*
|
|
845
|
-
*/
|
|
846
|
-
/** {en}
|
|
847
|
-
* @brief Is demote quality first? The values are as follows:
|
|
848
|
-
* - `false`: not demote quality first.
|
|
849
|
-
* - `true`: demote quality first.
|
|
850
|
-
*/
|
|
851
|
-
shouldDemoteDefinitionFirstWhenLongWaiting?: boolean;
|
|
852
|
-
/**
|
|
853
|
-
* @brief 频繁卡顿情况下,当用户开启 fallbackUrl 降级(降级到备用线路) 时,优先降级清晰度还是 fallbackUrl,取值如下:
|
|
854
|
-
* - `false`:优先在同一个清晰度的所有 fallback 之间切换, 都有问题的情况下,再降低到下一个清晰度
|
|
855
|
-
* - `true`:优先降级清晰度, 清晰度降到最低之后,再在最后一个清晰度的 fallbackUrl 之间切换
|
|
856
|
-
* @default false
|
|
857
|
-
*
|
|
858
|
-
*/
|
|
859
|
-
/** {en}
|
|
860
|
-
* @brief Is demote quality first? The values are as follows:
|
|
861
|
-
* - `false`: not demote quality first.
|
|
862
|
-
* - `true`: demote quality first.
|
|
863
|
-
*/
|
|
864
|
-
shouldDemoteDefinitionFirstWhenOftenWaiting?: boolean;
|
|
865
|
-
/**
|
|
866
|
-
* @brief 长卡顿情况下是否开启 fallbackUrl 降级:
|
|
867
|
-
* - `false`:不尝试降级到备用线路。
|
|
868
|
-
* - `true`:尝试降级到备用线路。
|
|
869
|
-
* @default true
|
|
870
|
-
*
|
|
871
|
-
*/
|
|
872
|
-
/** {en}
|
|
873
|
-
* @brief Is automatic downgrade enabled? The values are as follows:
|
|
874
|
-
* - `false`: not try to play fallbackUrl first.
|
|
875
|
-
* - `true`: try to play fallbackUrl first before demote definition.
|
|
876
|
-
*/
|
|
877
|
-
isNeedDemoteBackWhenLongWaiting?: boolean;
|
|
878
|
-
/**
|
|
879
|
-
* @brief 频繁卡顿情况下是否开启 fallbackUrl 降级:
|
|
880
|
-
* - `false`:不尝试降级到备用线路。
|
|
881
|
-
* - `true`:尝试降级到备用线路。
|
|
882
|
-
* @default true
|
|
883
|
-
*
|
|
884
|
-
*/
|
|
885
|
-
/** {en}
|
|
886
|
-
* @brief Is automatic downgrade enabled? The values are as follows:
|
|
887
|
-
* - `false`: not try to play fallbackUrl first.
|
|
888
|
-
* - `true`: try to play fallbackUrl first before demote definition.
|
|
889
|
-
*/
|
|
890
|
-
isNeedDemoteBackWhenOftenWaiting?: boolean;
|
|
891
|
-
/**
|
|
892
|
-
* @brief 长卡顿情况下是否允许回退到同清晰度不同线路的 fallbackurl:
|
|
893
|
-
* - `false`:只能在当前 defintion 范围内 fallback。
|
|
894
|
-
* - `true`:允许 fallback 相同清晰度,不同的线路的 fallbackurl。
|
|
895
|
-
* @default true
|
|
896
|
-
*
|
|
897
|
-
*/
|
|
898
|
-
/** {en}
|
|
899
|
-
* @brief Is demote to different line enabled? The values are as follows:
|
|
900
|
-
* - `false`: only demote in current definition line.
|
|
901
|
-
* - `true`: allow demote to different line.
|
|
902
|
-
*/
|
|
903
|
-
allowDemoteToDifferentLineWhenLongWaiting?: boolean;
|
|
904
|
-
/**
|
|
905
|
-
* @brief 频繁卡顿情况下是否允许回退到同清晰度不同线路的 fallbackurl:
|
|
906
|
-
* - `false`:只能在当前 defintion 范围内 fallback。
|
|
907
|
-
* - `true`:允许 fallback 相同清晰度,不同的线路的 fallbackurl。
|
|
908
|
-
* @default true
|
|
909
|
-
*
|
|
910
|
-
*/
|
|
911
|
-
/** {en}
|
|
912
|
-
* @brief Is demote to different line enabled? The values are as follows:
|
|
913
|
-
* - `false`: only demote in current definition line.
|
|
914
|
-
* - `true`: allow demote to different line.
|
|
915
|
-
*/
|
|
916
|
-
allowDemoteToDifferentLineWhenOftenWaiting?: boolean;
|
|
917
|
-
/**
|
|
918
|
-
* @brief 同一清晰度降级至 fallbackurl 的重试轮数。
|
|
919
|
-
* @default 1
|
|
920
|
-
*/
|
|
921
|
-
/** {en}
|
|
922
|
-
* @brief The retry loop number for all available fallbackUrl.
|
|
923
|
-
*/
|
|
924
|
-
retryLoopNum?: number;
|
|
925
|
-
/**
|
|
926
|
-
* @brief 在降级时到下一个definition 时,是否显示 toast 提示。
|
|
927
|
-
* @default 1
|
|
928
|
-
*/
|
|
929
|
-
/** {en}
|
|
930
|
-
* @brief Whether to show toast when demote to next definition.
|
|
931
|
-
*/
|
|
932
|
-
bumpToastWhenDemoteToNextDefinition?: boolean;
|
|
812
|
+
isNeedAutoDemote?: boolean;
|
|
933
813
|
/**
|
|
934
814
|
* @brief 清晰度降级顺序。数组中的元素需与 `playList` 中的 `definition` 相对应。
|
|
935
815
|
* @default []
|
|
@@ -982,34 +862,15 @@ export interface IDefinitionDemotePlugin {
|
|
|
982
862
|
* @brief 提醒降级的toast显示持续时间,单位ms
|
|
983
863
|
*/
|
|
984
864
|
toastShowTime?: number;
|
|
985
|
-
/**
|
|
986
|
-
* @brief 记录清除时间阈值,单位为毫秒。
|
|
987
|
-
* @default 3 * 60 * 1000
|
|
988
|
-
*/
|
|
989
|
-
/** {en}
|
|
990
|
-
* @brief Record clear time threshold, unit is ms.
|
|
991
|
-
*/
|
|
992
|
-
clearRecordThreshold?: number;
|
|
993
|
-
}
|
|
994
|
-
declare enum FALLBACK_REASON {
|
|
995
|
-
LONG_STALL = "long_stall",
|
|
996
|
-
OFTEN_STALL = "often_stall",
|
|
997
|
-
ERROR = "error"
|
|
998
865
|
}
|
|
999
866
|
export declare class DefinitionDemotePlugin extends Plugin {
|
|
1000
867
|
static get pluginName(): string;
|
|
1001
868
|
waitings: number[];
|
|
1002
869
|
timer: ReturnType<typeof setTimeout>;
|
|
1003
|
-
clearRecordTimer: ReturnType<typeof setTimeout>;
|
|
1004
870
|
toastId: number;
|
|
1005
871
|
longWaitingEmitTime: number;
|
|
1006
872
|
waitingStartTime: number;
|
|
1007
873
|
playerData: PlayerData;
|
|
1008
|
-
fallbackState: {
|
|
1009
|
-
retryTimes: number;
|
|
1010
|
-
idx: number;
|
|
1011
|
-
};
|
|
1012
|
-
isDemoting: boolean;
|
|
1013
874
|
static get defaultConfig(): IDefinitionDemotePlugin;
|
|
1014
875
|
constructor(args: any);
|
|
1015
876
|
registerLanguageTexts(): {
|
|
@@ -1028,21 +889,8 @@ export declare class DefinitionDemotePlugin extends Plugin {
|
|
|
1028
889
|
_time(): void;
|
|
1029
890
|
_clearTime(): void;
|
|
1030
891
|
clearState(): void;
|
|
1031
|
-
demote(
|
|
1032
|
-
|
|
1033
|
-
executeDemoteDefinitionFirst(reason: FALLBACK_REASON): void;
|
|
1034
|
-
private _emitFallbackEventAndReportTea;
|
|
1035
|
-
getRetryListForCurrentDefinition(): {
|
|
1036
|
-
urls: any[];
|
|
1037
|
-
sources: (string | number)[];
|
|
1038
|
-
};
|
|
1039
|
-
getRetryListForCurrentDefinitionAcrossAllLines(): {
|
|
1040
|
-
urls: any[];
|
|
1041
|
-
sources: any[];
|
|
1042
|
-
};
|
|
1043
|
-
resetTimes(): void;
|
|
1044
|
-
changeMainOrBackup(reason: FALLBACK_REASON): boolean;
|
|
1045
|
-
changeUrl(url: Url, source: string | number): void;
|
|
892
|
+
demote(): void;
|
|
893
|
+
changeUrl(url: Url): void;
|
|
1046
894
|
showToast(definition: Stream): void;
|
|
1047
895
|
destroy(): void;
|
|
1048
896
|
}
|
|
@@ -3654,7 +3502,7 @@ export interface IPlayAuthTokenConfig {
|
|
|
3654
3502
|
*/
|
|
3655
3503
|
autoDemoteDefinition?: string;
|
|
3656
3504
|
/** {zh}
|
|
3657
|
-
* @brief 开启清晰度自动降级(`
|
|
3505
|
+
* @brief 开启清晰度自动降级(`isNeedAutoDemote` 为 `true`)时的自动档位对应的多语言文案 key,取值对应 `languages` 字段中各语种的 `key`。
|
|
3658
3506
|
* @notes 如果指定的清晰度,playAuthToken从服务端返回的清晰度列表中不存在该清晰度,则此参数无效。
|
|
3659
3507
|
* @default -
|
|
3660
3508
|
*/
|
|
@@ -4440,7 +4288,6 @@ declare class PlayerData {
|
|
|
4440
4288
|
* @description: 获取满足当前直播条件的流
|
|
4441
4289
|
*/
|
|
4442
4290
|
getCurrentStreams(): Stream[];
|
|
4443
|
-
getStreamsMatchCurrentDefinition(): Stream[];
|
|
4444
4291
|
/**
|
|
4445
4292
|
* @description: 获取根据线路ID去重的流,用于获取有几个线路
|
|
4446
4293
|
*/
|
|
@@ -4455,7 +4302,6 @@ declare class PlayerData {
|
|
|
4455
4302
|
* @param {number} lineId
|
|
4456
4303
|
*/
|
|
4457
4304
|
getDefinitionListByLineId(lineId: number | string): Stream[];
|
|
4458
|
-
getDefinitionListForAllLines(): Stream[];
|
|
4459
4305
|
/**
|
|
4460
4306
|
* @description: 根据条件筛选符合条件的流list
|
|
4461
4307
|
* @param {Condition} condition
|
|
@@ -4466,10 +4312,7 @@ declare class PlayerData {
|
|
|
4466
4312
|
* @param {boolean} isDown 是否取下一级清晰度
|
|
4467
4313
|
* @param {string[]} demotePriority 清晰度降级顺序
|
|
4468
4314
|
*/
|
|
4469
|
-
getNextDefinition(isDown: boolean, demotePriority: string[]
|
|
4470
|
-
urls: Stream[];
|
|
4471
|
-
lineId: string | number;
|
|
4472
|
-
};
|
|
4315
|
+
getNextDefinition(isDown: boolean, demotePriority: string[]): Stream[];
|
|
4473
4316
|
/**
|
|
4474
4317
|
* 获取api map
|
|
4475
4318
|
* @return { ApiMapConfig }
|
|
@@ -5911,11 +5754,11 @@ export declare const Events: {
|
|
|
5911
5754
|
*/
|
|
5912
5755
|
REFRESH_CLICK: string;
|
|
5913
5756
|
/** {zh}
|
|
5914
|
-
* @brief
|
|
5757
|
+
* @brief 报错时触发降级。
|
|
5915
5758
|
*/
|
|
5916
5759
|
PLAY_BACKUP_CHANGE: string;
|
|
5917
5760
|
/** {zh}
|
|
5918
|
-
* @brief
|
|
5761
|
+
* @brief 报错时触发的降级结束。
|
|
5919
5762
|
*/
|
|
5920
5763
|
PLAY_BACKUP_CHANGE_FINISH: string;
|
|
5921
5764
|
/** {zh}
|
|
@@ -5946,15 +5789,6 @@ export declare const Events: {
|
|
|
5946
5789
|
* @brief 清晰度降级。
|
|
5947
5790
|
*/
|
|
5948
5791
|
DEFINITION_DEMOTE: string;
|
|
5949
|
-
/** {zh}
|
|
5950
|
-
* @brief 已降至最低清晰度。
|
|
5951
|
-
*/
|
|
5952
|
-
DEFINITION_DEMOTE_ALL_DONE: string;
|
|
5953
|
-
/** {zh}
|
|
5954
|
-
* @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级,
|
|
5955
|
-
* 无论两者哪个优先级更高,待所有可执行的降级操作均执行完毕,会触发该事件。
|
|
5956
|
-
*/
|
|
5957
|
-
DEMOTE_ALL_DONE: string;
|
|
5958
5792
|
/** {zh}
|
|
5959
5793
|
* @hidden
|
|
5960
5794
|
*/
|
|
@@ -6237,10 +6071,6 @@ export declare const Events: {
|
|
|
6237
6071
|
* @brief `<source>` 加载成功。
|
|
6238
6072
|
*/
|
|
6239
6073
|
SOURCE_SUCCESS: string;
|
|
6240
|
-
/** {zh}
|
|
6241
|
-
* @brief 降级事件。
|
|
6242
|
-
*/
|
|
6243
|
-
FALLBACK: string;
|
|
6244
6074
|
/** {zh}
|
|
6245
6075
|
* @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
|
|
6246
6076
|
*/
|
|
@@ -6560,10 +6390,6 @@ export declare const Event: {
|
|
|
6560
6390
|
* @brief `<source>` 加载成功。
|
|
6561
6391
|
*/
|
|
6562
6392
|
SOURCE_SUCCESS: string;
|
|
6563
|
-
/** {zh}
|
|
6564
|
-
* @brief 降级事件。
|
|
6565
|
-
*/
|
|
6566
|
-
FALLBACK: string;
|
|
6567
6393
|
};
|
|
6568
6394
|
PluginEvents: {
|
|
6569
6395
|
/** {zh}
|
|
@@ -6591,11 +6417,11 @@ export declare const Event: {
|
|
|
6591
6417
|
*/
|
|
6592
6418
|
REFRESH_CLICK: string;
|
|
6593
6419
|
/** {zh}
|
|
6594
|
-
* @brief
|
|
6420
|
+
* @brief 报错时触发降级。
|
|
6595
6421
|
*/
|
|
6596
6422
|
PLAY_BACKUP_CHANGE: string;
|
|
6597
6423
|
/** {zh}
|
|
6598
|
-
* @brief
|
|
6424
|
+
* @brief 报错时触发的降级结束。
|
|
6599
6425
|
*/
|
|
6600
6426
|
PLAY_BACKUP_CHANGE_FINISH: string;
|
|
6601
6427
|
/** {zh}
|
|
@@ -6626,15 +6452,6 @@ export declare const Event: {
|
|
|
6626
6452
|
* @brief 清晰度降级。
|
|
6627
6453
|
*/
|
|
6628
6454
|
DEFINITION_DEMOTE: string;
|
|
6629
|
-
/** {zh}
|
|
6630
|
-
* @brief 已降至最低清晰度。
|
|
6631
|
-
*/
|
|
6632
|
-
DEFINITION_DEMOTE_ALL_DONE: string;
|
|
6633
|
-
/** {zh}
|
|
6634
|
-
* @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级,
|
|
6635
|
-
* 无论两者哪个优先级更高,待所有可执行的降级操作均执行完毕,会触发该事件。
|
|
6636
|
-
*/
|
|
6637
|
-
DEMOTE_ALL_DONE: string;
|
|
6638
6455
|
/** {zh}
|
|
6639
6456
|
* @hidden
|
|
6640
6457
|
*/
|