@byteplus/veplayer 1.11.0-rc.6 → 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.
Files changed (3) hide show
  1. package/index.d.ts +12 -196
  2. package/index.min.js +2 -2
  3. 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 for often waiting? The values are as follows:
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
- isNeedAutoDemoteWhenOftenWaiting?: boolean;
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,35 +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
- private lastSeekingTime;
1009
- fallbackState: {
1010
- retryTimes: number;
1011
- idx: number;
1012
- };
1013
- isDemoting: boolean;
1014
874
  static get defaultConfig(): IDefinitionDemotePlugin;
1015
875
  constructor(args: any);
1016
876
  registerLanguageTexts(): {
@@ -1029,21 +889,8 @@ export declare class DefinitionDemotePlugin extends Plugin {
1029
889
  _time(): void;
1030
890
  _clearTime(): void;
1031
891
  clearState(): void;
1032
- demote(reason: FALLBACK_REASON): void;
1033
- executeDemoteFallbackFirst(reason: FALLBACK_REASON): void;
1034
- executeDemoteDefinitionFirst(reason: FALLBACK_REASON): void;
1035
- private _emitFallbackEventAndReportTea;
1036
- getRetryListForCurrentDefinition(): {
1037
- urls: any[];
1038
- sources: (string | number)[];
1039
- };
1040
- getRetryListForCurrentDefinitionAcrossAllLines(): {
1041
- urls: any[];
1042
- sources: any[];
1043
- };
1044
- resetTimes(): void;
1045
- changeMainOrBackup(reason: FALLBACK_REASON): boolean;
1046
- changeUrl(url: Url, source: string | number): void;
892
+ demote(): void;
893
+ changeUrl(url: Url): void;
1047
894
  showToast(definition: Stream): void;
1048
895
  destroy(): void;
1049
896
  }
@@ -3655,7 +3502,7 @@ export interface IPlayAuthTokenConfig {
3655
3502
  */
3656
3503
  autoDemoteDefinition?: string;
3657
3504
  /** {zh}
3658
- * @brief 开启清晰度自动降级(`isNeedAutoDemoteWhenLongWaiting` 为 `true`)时的自动档位对应的多语言文案 key,取值对应 `languages` 字段中各语种的 `key`。
3505
+ * @brief 开启清晰度自动降级(`isNeedAutoDemote` 为 `true`)时的自动档位对应的多语言文案 key,取值对应 `languages` 字段中各语种的 `key`。
3659
3506
  * @notes 如果指定的清晰度,playAuthToken从服务端返回的清晰度列表中不存在该清晰度,则此参数无效。
3660
3507
  * @default -
3661
3508
  */
@@ -4441,7 +4288,6 @@ declare class PlayerData {
4441
4288
  * @description: 获取满足当前直播条件的流
4442
4289
  */
4443
4290
  getCurrentStreams(): Stream[];
4444
- getStreamsMatchCurrentDefinition(): Stream[];
4445
4291
  /**
4446
4292
  * @description: 获取根据线路ID去重的流,用于获取有几个线路
4447
4293
  */
@@ -4456,7 +4302,6 @@ declare class PlayerData {
4456
4302
  * @param {number} lineId
4457
4303
  */
4458
4304
  getDefinitionListByLineId(lineId: number | string): Stream[];
4459
- getDefinitionListForAllLines(): Stream[];
4460
4305
  /**
4461
4306
  * @description: 根据条件筛选符合条件的流list
4462
4307
  * @param {Condition} condition
@@ -4467,10 +4312,7 @@ declare class PlayerData {
4467
4312
  * @param {boolean} isDown 是否取下一级清晰度
4468
4313
  * @param {string[]} demotePriority 清晰度降级顺序
4469
4314
  */
4470
- getNextDefinition(isDown: boolean, demotePriority: string[], allowDemoteToDifferentLine?: boolean): {
4471
- urls: Stream[];
4472
- lineId: string | number;
4473
- };
4315
+ getNextDefinition(isDown: boolean, demotePriority: string[]): Stream[];
4474
4316
  /**
4475
4317
  * 获取api map
4476
4318
  * @return { ApiMapConfig }
@@ -5912,11 +5754,11 @@ export declare const Events: {
5912
5754
  */
5913
5755
  REFRESH_CLICK: string;
5914
5756
  /** {zh}
5915
- * @brief 发生报错,卡顿时,在同清晰度等级下,触发降级至 fallbackUrl。
5757
+ * @brief 报错时触发降级。
5916
5758
  */
5917
5759
  PLAY_BACKUP_CHANGE: string;
5918
5760
  /** {zh}
5919
- * @brief 发生报错,卡顿时,在同清晰度等级下,触发降级至 fallbackUrl, 所有可执行降级结束,无可用 fallbackUrl
5761
+ * @brief 报错时触发的降级结束。
5920
5762
  */
5921
5763
  PLAY_BACKUP_CHANGE_FINISH: string;
5922
5764
  /** {zh}
@@ -5947,15 +5789,6 @@ export declare const Events: {
5947
5789
  * @brief 清晰度降级。
5948
5790
  */
5949
5791
  DEFINITION_DEMOTE: string;
5950
- /** {zh}
5951
- * @brief 已降至最低清晰度。
5952
- */
5953
- DEFINITION_DEMOTE_ALL_DONE: string;
5954
- /** {zh}
5955
- * @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级,
5956
- * 无论两者哪个优先级更高,待所有可执行的降级操作均执行完毕,会触发该事件。
5957
- */
5958
- DEMOTE_ALL_DONE: string;
5959
5792
  /** {zh}
5960
5793
  * @hidden
5961
5794
  */
@@ -6238,10 +6071,6 @@ export declare const Events: {
6238
6071
  * @brief `<source>` 加载成功。
6239
6072
  */
6240
6073
  SOURCE_SUCCESS: string;
6241
- /** {zh}
6242
- * @brief 降级事件。
6243
- */
6244
- FALLBACK: string;
6245
6074
  /** {zh}
6246
6075
  * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
6247
6076
  */
@@ -6561,10 +6390,6 @@ export declare const Event: {
6561
6390
  * @brief `<source>` 加载成功。
6562
6391
  */
6563
6392
  SOURCE_SUCCESS: string;
6564
- /** {zh}
6565
- * @brief 降级事件。
6566
- */
6567
- FALLBACK: string;
6568
6393
  };
6569
6394
  PluginEvents: {
6570
6395
  /** {zh}
@@ -6592,11 +6417,11 @@ export declare const Event: {
6592
6417
  */
6593
6418
  REFRESH_CLICK: string;
6594
6419
  /** {zh}
6595
- * @brief 发生报错,卡顿时,在同清晰度等级下,触发降级至 fallbackUrl。
6420
+ * @brief 报错时触发降级。
6596
6421
  */
6597
6422
  PLAY_BACKUP_CHANGE: string;
6598
6423
  /** {zh}
6599
- * @brief 发生报错,卡顿时,在同清晰度等级下,触发降级至 fallbackUrl, 所有可执行降级结束,无可用 fallbackUrl
6424
+ * @brief 报错时触发的降级结束。
6600
6425
  */
6601
6426
  PLAY_BACKUP_CHANGE_FINISH: string;
6602
6427
  /** {zh}
@@ -6627,15 +6452,6 @@ export declare const Event: {
6627
6452
  * @brief 清晰度降级。
6628
6453
  */
6629
6454
  DEFINITION_DEMOTE: string;
6630
- /** {zh}
6631
- * @brief 已降至最低清晰度。
6632
- */
6633
- DEFINITION_DEMOTE_ALL_DONE: string;
6634
- /** {zh}
6635
- * @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级,
6636
- * 无论两者哪个优先级更高,待所有可执行的降级操作均执行完毕,会触发该事件。
6637
- */
6638
- DEMOTE_ALL_DONE: string;
6639
6455
  /** {zh}
6640
6456
  * @hidden
6641
6457
  */