@byteplus/veplayer 1.11.0-rc.0 → 1.11.0-rc.2

package/index.d.ts

@@ -79,8 +79,21 @@ export interface ISdkErrorConfig {
 	 * @hidden
 	 */
 	isNeedDemoteBack?: boolean;
+	/**
+	 * @brief 是否允许回退到同清晰度不同线路的 fallbackurl：
+	 *        - `false`：只能在当前 defintion 范围内 fallback。
+	 *        - `true`：允许 fallback 相同清晰度，不同的线路的 fallbackurl。
+	 * @default true
+	 *
+	 */
+	/** {en}
+	 * @brief Is demote to different line enabled? The values are as follows:
+	 *        - `false`: only demote in current definition line.
+	 *        - `true`: allow demote to different line.
+	 */
+	allowDemoteToDifferentLine?: boolean;
 	/** {zh}
-	 * @brief 报错后重试次数。
+	 * @brief 报错后重试轮数。
 	 * @default 1
 	 */
 	retryLoopNum?: number;
@@ -798,18 +811,125 @@ export interface ITextItem {
  */
 export interface IDefinitionDemotePlugin {
 	/**
-	 * @brief 是否开启自动降级，取值如下：
+	 * @brief 长卡顿情况下是否开启自动降级，取值如下：
 	 *        - `false`：关闭自动降级。
 	 *        - `true`：开启自动降级。
 	 * @default true
 	 *
 	 */
 	/** {en}
-	 * @brief Is automatic downgrade enabled? The values are as follows:
+	 * @brief Is automatic downgrade enabled for long waiting? The values are as follows:
+	 *        - `false`: automatic downgrade is disabled.
+	 *        - `true`: automatic downgrade is enabled.
+	 */
+	isNeedAutoDemoteWhenLongWaiting?: boolean;
+	/**
+	 * @brief 频繁卡顿情况下是否开启自动降级，取值如下：
+	 *        - `false`：关闭自动降级。
+	 *        - `true`：开启自动降级。
+	 * @default true
+	 *
+	 */
+	/** {en}
+	 * @brief Is automatic downgrade enabled for often waiting? The values are as follows:
 	 *        - `false`: automatic downgrade is disabled.
 	 *        - `true`: automatic downgrade is enabled.
 	 */
-	isNeedAutoDemote?: boolean;
+	isNeedAutoDemoteWhenOftenWaiting?: boolean;
+	/**
+	 * @brief 长卡顿情况下，当用户开启 fallbackUrl 降级（降级到备用线路) 时，优先降级清晰度还是 fallbackUrl，取值如下：
+	 *        - `false`：优先在同一个清晰度的所有 fallback 之间切换, 都有问题的情况下，再降低到下一个清晰度
+	 *        - `true`：优先降级清晰度, 清晰度降到最低之后，再在最后一个清晰度的 fallbackUrl 之间切换
+	 * @default false
+	 *
+	 */
+	/** {en}
+	 * @brief Is demote quality first? The values are as follows:
+	 *        - `false`: not demote quality first.
+	 *        - `true`: demote quality first.
+	 */
+	shouldDemoteDefinitionFirstWhenLongWaiting?: boolean;
+	/**
+	 * @brief 频繁卡顿情况下，当用户开启 fallbackUrl 降级（降级到备用线路) 时，优先降级清晰度还是 fallbackUrl，取值如下：
+	 *        - `false`：优先在同一个清晰度的所有 fallback 之间切换, 都有问题的情况下，再降低到下一个清晰度
+	 *        - `true`：优先降级清晰度, 清晰度降到最低之后，再在最后一个清晰度的 fallbackUrl 之间切换
+	 * @default false
+	 *
+	 */
+	/** {en}
+	 * @brief Is demote quality first? The values are as follows:
+	 *        - `false`: not demote quality first.
+	 *        - `true`: demote quality first.
+	 */
+	shouldDemoteDefinitionFirstWhenOftenWaiting?: boolean;
+	/**
+	 * @brief 长卡顿情况下是否开启 fallbackUrl 降级：
+	 *        - `false`：不尝试降级到备用线路。
+	 *        - `true`：尝试降级到备用线路。
+	 * @default true
+	 *
+	 */
+	/** {en}
+	 * @brief Is automatic downgrade enabled? The values are as follows:
+	 *        - `false`: not try to play fallbackUrl first.
+	 *        - `true`: try to play fallbackUrl first before demote definition.
+	 */
+	isNeedDemoteBackWhenLongWaiting?: boolean;
+	/**
+	 * @brief 频繁卡顿情况下是否开启 fallbackUrl 降级：
+	 *        - `false`：不尝试降级到备用线路。
+	 *        - `true`：尝试降级到备用线路。
+	 * @default true
+	 *
+	 */
+	/** {en}
+	 * @brief Is automatic downgrade enabled? The values are as follows:
+	 *        - `false`: not try to play fallbackUrl first.
+	 *        - `true`: try to play fallbackUrl first before demote definition.
+	 */
+	isNeedDemoteBackWhenOftenWaiting?: boolean;
+	/**
+	 * @brief 长卡顿情况下是否允许回退到同清晰度不同线路的 fallbackurl：
+	 *        - `false`：只能在当前 defintion 范围内 fallback。
+	 *        - `true`：允许 fallback 相同清晰度，不同的线路的 fallbackurl。
+	 * @default true
+	 *
+	 */
+	/** {en}
+	 * @brief Is demote to different line enabled? The values are as follows:
+	 *        - `false`: only demote in current definition line.
+	 *        - `true`: allow demote to different line.
+	 */
+	allowDemoteToDifferentLineWhenLongWaiting?: boolean;
+	/**
+	 * @brief 频繁卡顿情况下是否允许回退到同清晰度不同线路的 fallbackurl：
+	 *        - `false`：只能在当前 defintion 范围内 fallback。
+	 *        - `true`：允许 fallback 相同清晰度，不同的线路的 fallbackurl。
+	 * @default true
+	 *
+	 */
+	/** {en}
+	 * @brief Is demote to different line enabled? The values are as follows:
+	 *        - `false`: only demote in current definition line.
+	 *        - `true`: allow demote to different line.
+	 */
+	allowDemoteToDifferentLineWhenOftenWaiting?: boolean;
+	/**
+	 * @brief 同一清晰度降级至 fallbackurl 的重试轮数。
+	 * @default 1
+	 */
+	/** {en}
+	 * @brief The retry loop number for all available fallbackUrl.
+	 */
+	retryLoopNum?: number;
+	/**
+	 * @brief 在降级时到下一个definition 时，是否显示 toast 提示。
+	 * @default 1
+	 */
+	/** {en}
+	 * @brief Whether to show toast when demote to next definition.
+	 */
+	bumpToastWhenDemoteToNextDefinition?: boolean;
 	/**
 	 * @brief 清晰度降级顺序。数组中的元素需与 `playList` 中的 `definition` 相对应。
 	 * @default []
@@ -862,15 +982,34 @@ export interface IDefinitionDemotePlugin {
 	 * @brief 提醒降级的toast显示持续时间,单位ms
 	 */
 	toastShowTime?: number;
+	/**
+	 * @brief 记录清除时间阈值，单位为毫秒。
+	 * @default 3 * 60 * 1000
+	 */
+	/** {en}
+	 * @brief Record clear time threshold, unit is ms.
+	 */
+	clearRecordThreshold?: number;
+}
+declare enum FALLBACK_REASON {
+	LONG_STALL = "long_stall",
+	OFTEN_STALL = "often_stall",
+	ERROR = "error"
 }
 export declare class DefinitionDemotePlugin extends Plugin {
 	static get pluginName(): string;
 	waitings: number[];
 	timer: ReturnType<typeof setTimeout>;
+	clearRecordTimer: ReturnType<typeof setTimeout>;
 	toastId: number;
 	longWaitingEmitTime: number;
 	waitingStartTime: number;
 	playerData: PlayerData;
+	fallbackState: {
+		retryTimes: number;
+		idx: number;
+	};
+	isDemoting: boolean;
 	static get defaultConfig(): IDefinitionDemotePlugin;
 	constructor(args: any);
 	registerLanguageTexts(): {
@@ -889,8 +1028,21 @@ export declare class DefinitionDemotePlugin extends Plugin {
 	_time(): void;
 	_clearTime(): void;
 	clearState(): void;
-	demote(): void;
-	changeUrl(url: Url): void;
+	demote(reason: FALLBACK_REASON): void;
+	executeDemoteFallbackFirst(reason: FALLBACK_REASON): void;
+	executeDemoteDefinitionFirst(reason: FALLBACK_REASON): void;
+	private _emitFallbackEventAndReportTea;
+	getRetryListForCurrentDefinition(): {
+		urls: any[];
+		sources: (string | number)[];
+	};
+	getRetryListForCurrentDefinitionAcrossAllLines(): {
+		urls: any[];
+		sources: any[];
+	};
+	resetTimes(): void;
+	changeMainOrBackup(reason: FALLBACK_REASON): boolean;
+	changeUrl(url: Url, source: string | number): void;
 	showToast(definition: Stream): void;
 	destroy(): void;
 }
@@ -3502,7 +3654,7 @@ export interface IPlayAuthTokenConfig {
 	 */
 	autoDemoteDefinition?: string;
 	/** {zh}
-	 * @brief 开启清晰度自动降级（`isNeedAutoDemote` 为 `true`）时的自动档位对应的多语言文案 key，取值对应 `languages` 字段中各语种的 `key`。
+	 * @brief 开启清晰度自动降级（`isNeedAutoDemoteWhenLongWaiting` 为 `true`）时的自动档位对应的多语言文案 key，取值对应 `languages` 字段中各语种的 `key`。
 	 * @notes 如果指定的清晰度，playAuthToken从服务端返回的清晰度列表中不存在该清晰度，则此参数无效。
 	 * @default -
 	 */
@@ -4288,6 +4440,7 @@ declare class PlayerData {
 	 * @description: 获取满足当前直播条件的流
 	 */
 	getCurrentStreams(): Stream[];
+	getStreamsMatchCurrentDefinition(): Stream[];
 	/**
 	 * @description: 获取根据线路ID去重的流，用于获取有几个线路
 	 */
@@ -4302,6 +4455,7 @@ declare class PlayerData {
 	 * @param {number} lineId
 	 */
 	getDefinitionListByLineId(lineId: number | string): Stream[];
+	getDefinitionListForAllLines(): Stream[];
 	/**
 	 * @description: 根据条件筛选符合条件的流list
 	 * @param {Condition} condition
@@ -4312,7 +4466,10 @@ declare class PlayerData {
 	 * @param {boolean} isDown 是否取下一级清晰度
 	 * @param {string[]} demotePriority 清晰度降级顺序
 	 */
-	getNextDefinition(isDown: boolean, demotePriority: string[]): Stream[];
+	getNextDefinition(isDown: boolean, demotePriority: string[], allowDemoteToDifferentLine?: boolean): {
+		urls: Stream[];
+		lineId: string | number;
+	};
 	/**
 	 * 获取api map
 	 * @return { ApiMapConfig }
@@ -5754,11 +5911,11 @@ export declare const Events: {
 	 */
 	REFRESH_CLICK: string;
 	/** {zh}
-	 * @brief 报错时触发降级。
+	 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl。
 	 */
 	PLAY_BACKUP_CHANGE: string;
 	/** {zh}
-	 * @brief 报错时触发的降级结束。
+	 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl, 所有可执行降级结束，无可用 fallbackUrl
 	 */
 	PLAY_BACKUP_CHANGE_FINISH: string;
 	/** {zh}
@@ -5789,6 +5946,15 @@ export declare const Events: {
 	 * @brief 清晰度降级。
 	 */
 	DEFINITION_DEMOTE: string;
+	/** {zh}
+	 * @brief 已降至最低清晰度。
+	 */
+	DEFINITION_DEMOTE_ALL_DONE: string;
+	/** {zh}
+	 * @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级，
+	 * 无论两者哪个优先级更高，待所有可执行的降级操作均执行完毕，会触发该事件。
+	 */
+	DEMOTE_ALL_DONE: string;
 	/** {zh}
 	 * @hidden
 	 */
@@ -6071,6 +6237,10 @@ export declare const Events: {
 	 * @brief `<source>` 加载成功。
 	 */
 	SOURCE_SUCCESS: string;
+	/** {zh}
+	 * @brief 降级事件。
+	 */
+	FALLBACK: string;
 	/** {zh}
 	 * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
 	 */
@@ -6390,6 +6560,10 @@ export declare const Event: {
 		 * @brief `<source>` 加载成功。
 		 */
 		SOURCE_SUCCESS: string;
+		/** {zh}
+		 * @brief 降级事件。
+		 */
+		FALLBACK: string;
 	};
 	PluginEvents: {
 		/** {zh}
@@ -6417,11 +6591,11 @@ export declare const Event: {
 		 */
 		REFRESH_CLICK: string;
 		/** {zh}
-		 * @brief 报错时触发降级。
+		 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl。
 		 */
 		PLAY_BACKUP_CHANGE: string;
 		/** {zh}
-		 * @brief 报错时触发的降级结束。
+		 * @brief 发生报错，卡顿时，在同清晰度等级下，触发降级至 fallbackUrl, 所有可执行降级结束，无可用 fallbackUrl
 		 */
 		PLAY_BACKUP_CHANGE_FINISH: string;
 		/** {zh}
@@ -6452,6 +6626,15 @@ export declare const Event: {
 		 * @brief 清晰度降级。
 		 */
 		DEFINITION_DEMOTE: string;
+		/** {zh}
+		 * @brief 已降至最低清晰度。
+		 */
+		DEFINITION_DEMOTE_ALL_DONE: string;
+		/** {zh}
+		 * @brief 所有可执行的降级操作均执行完毕。如果用户同时开启了 definition 降级和 fallbackUrl 降级，
+		 * 无论两者哪个优先级更高，待所有可执行的降级操作均执行完毕，会触发该事件。
+		 */
+		DEMOTE_ALL_DONE: string;
 		/** {zh}
 		 * @hidden
 		 */