@volcengine/veplayer 1.8.6-rc.15 → 1.8.6-rc.17

package/index.d.ts

@@ -780,62 +780,81 @@ export interface ITextItem {
 /**
  * @brief 清晰度自动降级配置
  * @list Options
- * @hidden
- *
- * @export
- * @interface IDefinitionDemotePlugin
+ * @kind property
  */
 export interface IDefinitionDemotePlugin {
 	/**
-	 * 是否开启自动降级
-	 * 默认：false
+	 * @brief 是否自动触发降级
+	 * @default true
 	 *
-	 * @type {boolean}
-	 * @memberof IDefinitionDemotePlugin
 	 */
 	isNeedAutoDemote?: boolean;
 	/**
-	 * @brief 卡顿时是否展示toast
-	 * @default true
-	 */
-	isNeedShowTips?: boolean;
-	/**
-	 * @brief 提醒降级的toast显示持续时间
-	 */
-	toastShowTime?: number;
-	/**
-	 *
-	 * 降级顺序，按照数组顺序依次降级，数字元素对应playList中的definition
-	 * 默认: ['uhd', 'hd', 'sd', 'ld', 'ao']
+	 * @brief 降级顺序，按照数组 顺序依次降级，数组 中的元素与playList 中的 definition 相对应
+	 * @default []
 	 *
 	 * @type {string[]}
 	 * @memberof IDefinitionDemotePlugin
 	 */
 	demotePriority?: string[];
 	/**
-	 * 设置超时时间
-	 * 默认5000
+	 * @brief 长时间卡顿的时间阈值，单位为ms。卡顿超过该值，即为长时间卡顿
+	 * @default 5000
 	 *
-	 * @type {number}
-	 * @memberof IDefinitionDemotePlugin
 	 */
 	longWaitingTime?: number;
 	/**
-	 * 超时重试次数
-	 * 默认：3
+	 * @brief 频繁卡顿的次数阈值。OftenWaitingTime 内卡顿次数大于等于阈值时，触发often_waiting事件，即表示发生了频繁卡顿
+	 * @default 3
 	 *
-	 * @type {number}
-	 * @memberof IDefinitionDemotePlugin
 	 */
 	oftenWaitingCount?: number;
 	/**
-	 * 设置经常超时时间
-	 * 默认：5000
-	 *
-	 * @type {number}
-	 * @memberof IDefinitionDemotePlugin
+	 * @brief 频繁卡顿的时间范围。OftenWaitingTime 内卡顿次数大于等于阈值时，触发often_waiting事件，即表示发生了频繁卡顿
+	 * @default 5000
 	 */
 	oftenWaitingTime?: number;
+	/**
+	 * @brief 卡顿时是否显示建议切换清晰度的提醒tips
+	 * @default true
+	 */
+	isNeedShowTips?: boolean;
+	/**
+	 * @brief 提醒降级的toast显示持续时间,单位ms
+	 * @default 3000
+	 */
+	toastShowTime?: number;
+}
+export declare class DefinitionDemotePlugin extends Plugin {
+	static get pluginName(): string;
+	waitings: number[];
+	timer: ReturnType<typeof setTimeout>;
+	toastId: number;
+	longWaitingEmitTime: number;
+	waitingStartTime: number;
+	playerData: PlayerData;
+	static get defaultConfig(): IDefinitionDemotePlugin;
+	constructor(args: any);
+	registerLanguageTexts(): {
+		definition_demote_txt: {
+			jp: string;
+			en: string;
+			zh: string;
+			"zh-hk": string;
+		};
+	};
+	afterCreate(): void;
+	bindCtx(): void;
+	bindEvents(): void;
+	_waiting(): void;
+	_count(): void;
+	_time(): void;
+	_clearTime(): void;
+	clearState(): void;
+	demote(): void;
+	changeUrl(url: string): void;
+	showToast(definition: Stream): void;
+	destroy(): void;
 }
 /**
  * @brief DASH 播放配置。
@@ -1640,33 +1659,6 @@ export declare class PlayListPlugin extends Plugin {
 	get disable(): boolean;
 	render(): string;
 }
-export interface IPlayInfoListItem {
-	BackupPlayUrl: string;
-	BackupUrlExpire: string;
-	BarrageMaskOffset: string;
-	Bitrate: number;
-	CheckInfo: string;
-	Codec: string;
-	Definition: string;
-	Duration: number;
-	FileId: string;
-	FileType: string;
-	Format: string;
-	Height: number;
-	IndexRange: string;
-	InitRange: string;
-	KeyFrameAlignment: string;
-	LogoType: string;
-	MainPlayUrl: string;
-	MainUrlExpire: string;
-	Md5: string;
-	PlayAuth: string;
-	PlayAuthId: string;
-	Quality: string;
-	Size: number;
-	Volume?: number;
-	Width: number;
-}
 /**
  * @brief 动态水印配置。
  * @list Options
@@ -1759,6 +1751,120 @@ export declare class DynamicWatermarkPlugin extends Plugin {
 	destroy(): void;
 	render(): string | HTMLElement;
 }
+declare class ToastPlugin extends Plugin {
+	static get pluginName(): string;
+	static get defaultConfig(): {
+		index: number;
+	};
+	constructor(args: any);
+	private toastNumber;
+	private toastMaps;
+	beforePlayerInit(): void;
+	afterPlayerInit(): void;
+	afterCreate(): void;
+	destroy(): void;
+	add(content: string | HTMLElement, duration?: number, isNeedCloseBt?: boolean): number;
+	remove(id: number): void;
+	renderToast(content: string | HTMLElement, isNeedCloseBt: any, id: any): HTMLElement;
+	render(): string;
+}
+/** {zh}
+ * @brief 记忆播放配置。
+ * @kind property
+ * @list Options
+ * @interface IMemoryPlayConfig
+ */
+export interface IMemoryPlayConfig {
+	/** {zh}
+	 * @brief 存储标识id
+	 * @default options.vid || options.url
+	 *
+	 * @type {number | string}
+	 * @memberof IMemoryPlayConfig
+	 */
+	memoryId: number | string;
+	/** {zh}
+	 * @brief 设置时间函数
+	 * @default -
+	 *
+	 * @type {(id: number | string, time: number) => unknown}
+	 * @memberof IMemoryPlayConfig
+	 */
+	saveTime?: (id: number | string, time: number) => unknown;
+	/** {zh}
+	 * @brief 获取最后一次播放时间函数
+	 * @default -
+	 */
+	getTime?: (id: number | string) => number | Promise<number>;
+	/** {zh}
+	 * @brief 判断是否播放了最小时间阈值，即如果播的时长太小，则不算做播放过，存储的时间进度为0
+	 * @default 1
+	 */
+	minStartTime?: number;
+	/** {zh}
+	 * @brief 判断是否播放结束的最小时间阈值，即距离结束多少时间内算作播放结束，播放结束则不存储时间进度,且清空之前的进度为0
+	 * @default 1
+	 */
+	minEndTime?: number;
+}
+export declare class MemoryPlay extends Plugin {
+	static get pluginName(): string;
+	static get defaultConfig(): IMemoryPlayConfig;
+	startTime: number;
+	saveTimeFun: (id: number | string, time: number) => unknown;
+	getTimeFun: (id: number | string) => number | Promise<number>;
+	memoryId: number | string;
+	shouldShowToast: boolean;
+	constructor(args: any);
+	registerLanguageTexts(): {
+		preText: {
+			jp: string;
+			en: string;
+			zh: string;
+			"zh-hk": string;
+		};
+	};
+	children(): {
+		toast: typeof ToastPlugin;
+	};
+	afterCreate(): void;
+	beforePlayerInit(): Promise<void>;
+	getTime(): Promise<void>;
+	saveTime(): void;
+	visibilitychangeCallback(): void;
+	setSave(): void;
+	showToast(): void;
+	saveTimeByStorage(memoryId: string, time: number): void;
+	getTimeByStorage(memoryId: string): string | 0;
+	destroy(): void;
+}
+export interface IPlayInfoListItem {
+	BackupPlayUrl: string;
+	BackupUrlExpire: string;
+	BarrageMaskOffset: string;
+	Bitrate: number;
+	CheckInfo: string;
+	Codec: string;
+	Definition: string;
+	Duration: number;
+	FileId: string;
+	FileType: string;
+	Format: string;
+	Height: number;
+	IndexRange: string;
+	InitRange: string;
+	KeyFrameAlignment: string;
+	LogoType: string;
+	MainPlayUrl: string;
+	MainUrlExpire: string;
+	Md5: string;
+	PlayAuth: string;
+	PlayAuthId: string;
+	Quality: string;
+	Size: number;
+	Volume?: number;
+	Width: number;
+}
 declare enum CodecType {
 	/** {zh}
 	 * @brief H.265
@@ -2453,7 +2559,8 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	disableVodLogOptsCheck?: boolean;
 	/** {zh}
-	 * @brief 是否开启调试模式
+	 * @hidden
+	 * @brief 是否打开日志打印
 	 * @default false
 	 */
 	debug?: boolean;
@@ -2806,35 +2913,6 @@ export interface IAutoBitrateOptsConfig {
 	 */
 	module?: any;
 }
-/** {zh}
- * @brief 记忆播放配置。
- * @kind property
- * @list Options
- * @interface IMemoryPlayConfig
- */
-export interface IMemoryPlayConfig {
-	/** {zh}
-	 * @brief 存储标识id
-	 * @default options.vid || options.url
-	 *
-	 * @type {number | string}
-	 * @memberof IMemoryPlayConfig
-	 */
-	memoryId: number | string;
-	/** {zh}
-	 * @brief 设置时间函数
-	 * @default -
-	 *
-	 * @type {(id: number | string, time: number) => unknown}
-	 * @memberof IMemoryPlayConfig
-	 */
-	saveTime?: (id: number | string, time: number) => unknown;
-	/** {zh}
-	 * @brief 获取最后一次播放时间函数
-	 * @default -
-	 */
-	getTime?: (id: number | string) => number | Promise<number>;
-}
 /** {zh}
  * @brief 插件按钮位置
  */
@@ -4264,37 +4342,6 @@ export declare class Subtitle extends Plugin {
 	destroy(): void;
 	render(): string;
 }
-export declare class DefinitionDemotePlugin extends Plugin {
-	static get pluginName(): string;
-	waitings: number[];
-	timer: ReturnType<typeof setTimeout>;
-	toastId: number;
-	longWaitingEmitTime: number;
-	waitingStartTime: number;
-	playerData: PlayerData;
-	static get defaultConfig(): IDefinitionDemotePlugin;
-	constructor(args: any);
-	registerLanguageTexts(): {
-		definition_demote_txt: {
-			jp: string;
-			en: string;
-			zh: string;
-			"zh-hk": string;
-		};
-	};
-	afterCreate(): void;
-	bindCtx(): void;
-	bindEvents(): void;
-	_waiting(): void;
-	_count(): void;
-	_time(): void;
-	_clearTime(): void;
-	clearState(): void;
-	demote(): void;
-	changeUrl(url: string): void;
-	showToast(definition: Stream): void;
-	destroy(): void;
-}
 export declare class TimeShiftPlugin extends Plugin {
 	static get pluginName(): string;
 	static get defaultConfig(): {
@@ -4407,56 +4454,6 @@ export declare class MirrorPlugin extends Plugin {
 	destroy(): void;
 	render(): string;
 }
-declare class ToastPlugin extends Plugin {
-	static get pluginName(): string;
-	static get defaultConfig(): {
-		index: number;
-	};
-	constructor(args: any);
-	private toastNumber;
-	private toastMaps;
-	beforePlayerInit(): void;
-	afterPlayerInit(): void;
-	afterCreate(): void;
-	destroy(): void;
-	add(content: string | HTMLElement, duration?: number, isNeedCloseBt?: boolean): number;
-	remove(id: number): void;
-	renderToast(content: string | HTMLElement, isNeedCloseBt: any, id: any): HTMLElement;
-	render(): string;
-}
-export declare class MemoryPlay extends Plugin {
-	static get pluginName(): string;
-	static get defaultConfig(): {
-		getTime: any;
-		saveTime: any;
-		memoryId: string;
-	};
-	startTime: number;
-	saveTimeFun: (id: number | string, time: number) => unknown;
-	getTimeFun: (id: number | string) => number | Promise<number>;
-	memoryId: number | string;
-	canJump: boolean;
-	constructor(args: any);
-	registerLanguageTexts(): {
-		preText: {
-			jp: string;
-			en: string;
-			zh: string;
-			"zh-hk": string;
-		};
-	};
-	children(): {
-		toast: typeof ToastPlugin;
-	};
-	afterCreate(): void;
-	beforePlayerInit(): Promise<void>;
-	destroy(): void;
-	getTime(): Promise<void>;
-	setSave(): void;
-	showToast(): void;
-	saveTimeByStorage(memoryId: any, time: any): void;
-	getTimeByStorage(memoryId: any): string;
-}
 export declare type InfoItem = {
 	key: string;
 	label: string;