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

package/index.d.ts

@@ -780,53 +780,81 @@ export interface ITextItem {
 /**
  * @brief 清晰度自动降级配置
  * @list Options
- * @hidden
- *
- * @export
- * @interface IDefinitionDemotePlugin
+ * @kind property
  */
 export interface IDefinitionDemotePlugin {
 	/**
-	 * 超时重试次数
-	 * 默认：3
+	 * @brief 是否自动触发降级
+	 * @default true
 	 *
-	 * @type {number}
-	 * @memberof IDefinitionDemotePlugin
 	 */
-	oftenWaitingCount?: number;
+	isNeedAutoDemote?: boolean;
 	/**
-	 * 设置经常超时时间
-	 * 默认：5000
+	 * @brief 降级顺序，按照数组 顺序依次降级，数组 中的元素与playList 中的 definition 相对应
+	 * @default []
 	 *
-	 * @type {number}
+	 * @type {string[]}
 	 * @memberof IDefinitionDemotePlugin
 	 */
-	oftenWaitingTime?: number;
+	demotePriority?: string[];
 	/**
-	 * 设置超时时间
-	 * 默认5000
+	 * @brief 长时间卡顿的时间阈值，单位为ms。卡顿超过该值，即为长时间卡顿
+	 * @default 5000
 	 *
-	 * @type {number}
-	 * @memberof IDefinitionDemotePlugin
 	 */
 	longWaitingTime?: number;
 	/**
-	 * 是否自动触发降级
-	 * 默认：false
+	 * @brief 频繁卡顿的次数阈值。OftenWaitingTime 内卡顿次数大于等于阈值时，触发often_waiting事件，即表示发生了频繁卡顿
+	 * @default 3
 	 *
-	 * @type {boolean}
-	 * @memberof IDefinitionDemotePlugin
 	 */
-	isNeedAutoDemote?: boolean;
+	oftenWaitingCount?: number;
 	/**
-	 *
-	 * 降级顺序，按照数组顺序依次降级，数字元素对应playList中的definition
-	 * 默认: ['uhd', 'hd', 'sd', 'ld', 'ao']
-	 *
-	 * @type {string[]}
-	 * @memberof IDefinitionDemotePlugin
+	 * @brief 频繁卡顿的时间范围。OftenWaitingTime 内卡顿次数大于等于阈值时，触发often_waiting事件，即表示发生了频繁卡顿
+	 * @default 5000
 	 */
-	demotePriority?: string[];
+	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 播放配置。
@@ -1631,7 +1659,186 @@ export declare class PlayListPlugin extends Plugin {
 	get disable(): boolean;
 	render(): string;
 }
-export interface IPlayInfoList {
+/**
+ * @brief 动态水印配置。
+ * @list Options
+ * @kind property
+ */
+/** {en}
+ * @brief watermark config
+ */
+export interface IWatermarkConfig {
+	/**
+	 * @brief 是否开启水印
+	 * @default false
+	 */
+	enable: boolean;
+	/**
+	 * @brief 水印文案内容
+	 * @default -
+	 */
+	content: string;
+	/**
+	 * @brief 水印展示形式
+	 * - 0: 固定位置
+	 * - 1: 全屏滚动
+	 * - 2: 随机闪烁
+	 * @default 1
+	 */
+	displayType: 0 | 1 | 2;
+	/**
+	 * @brief 水印字体大小，number类型时单位为px，string类型需要携带单位
+	 * @default 12
+	 */
+	fontSize: number | string;
+	/**
+	 * @brief 水印字体颜色
+	 * @brief #FFFFFF
+	 */
+	fontColor: string;
+	/**
+	 * @brief 不透明度
+	 * @default 0.3
+	 */
+	opacity: number;
+	/**
+	 * @brief 水印闪烁速度
+	 * @default MODERATE
+	 * - MODERATE: 适中
+	 * - FAST: 较快
+	 * - SLOW: 较慢
+	 */
+	tickerSpeed?: "SLOW" | "MODERATE" | "FAST";
+	/**
+	 * @brief 水印字体类型
+	 * @default -
+	 */
+	fontFamily?: string;
+	/**
+	 * @brief 水印相对于播放容器顶部起始位置，单位px
+	 * @default 0
+	 */
+	top?: number;
+	/**
+	 * @brief 水印相对于播放容器左侧起始位置，单位px
+	 * @default 0
+	 */
+	left?: number;
+	/**
+	 * @brief 水印相对于播放容器底部起始位置，单位px
+	 * @default -
+	 */
+	bottom?: number;
+	/**
+	 * @brief 水印相对于播放容器右侧起始位置，单位px
+	 * @default -
+	 */
+	right?: number;
+}
+export declare class DynamicWatermarkPlugin extends Plugin {
+	private wm;
+	static get pluginName(): string;
+	static get defaultConfig(): IWatermarkConfig & {
+		position: string;
+	};
+	constructor(props: any);
+	afterCreate(): void;
+	start(): void;
+	pause(): void;
+	resume(): void;
+	resize(): void;
+	_initWatermark(): void;
+	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;
@@ -1813,7 +2020,7 @@ export interface IMusicConfig {
  * @export
  * @interface Stream
  */
-export interface Stream extends Partial<IPlayInfoList> {
+export interface Stream extends Partial<IPlayInfoListItem> {
 	/** {zh}
 	 * @type {('rtm' | 'flv' | 'mp4' | 'hls')}
 	 * @memberof IPlayerConfig
@@ -1837,6 +2044,12 @@ export interface Stream extends Partial<IPlayInfoList> {
 	 * @brief 清晰度 key
 	 */
 	definition?: string;
+	/** {zh}
+	 * @type {string}
+	 * @memberof Stream
+	 * @brief 映射清晰度 key
+	 */
+	mapDefinition?: string;
 	/** {zh}
 	 * @type {string}
 	 * @memberof Stream
@@ -1980,7 +2193,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	autoplay?: boolean;
 	/** {zh}
-	 * @brief 视频封面图片的 URL。
+	 * @brief 视频封面图配置。
 	 */
 	poster?: string | IPoster;
 	/** {zh}
@@ -2345,6 +2558,12 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 */
 	disableVodLogOptsCheck?: boolean;
+	/** {zh}
+	 * @hidden
+	 * @brief 是否打开日志打印
+	 * @default false
+	 */
+	debug?: boolean;
 	/** {zh}
 	 * @brief 播放器报错信息。支持配置播放异常时显示的异常文案、图片以及是否提供刷新按钮等。
 	 * @default -
@@ -2364,7 +2583,6 @@ export interface IPlayerConfig extends IPlayerOptions {
 	DanmuPlugin?: IDanmuConfig | boolean;
 	/** {zh}
 	 * @brief 清晰度自动降级配置
-	 * @hidden
 	 * @notes 需要先引入DefinitionDemotePlugin插件，plugins: [VePlayer.DefinitionDemotePlugin]
 	 */
 	DefinitionDemotePlugin?: IDefinitionDemotePlugin;
@@ -2425,6 +2643,16 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 播放列表配置。
 	 */
 	playListPlugin?: IPlayListConfig;
+	/** {zh}
+	 * @brief 动态水印配置
+	 * @default -
+	 */
+	dynamicwatermark?: IWatermarkConfig;
+	/** {zh}
+	 * @brief 进度条预览缩略图配置
+	 * @default -
+	 */
+	thumbnail?: IThumbnailConfig;
 }
 /** {zh}
  * @hidden
@@ -2603,6 +2831,18 @@ export interface IPlayAuthTokenConfig {
 	 * @default 1
 	 */
 	retryCount?: number;
+	/** {zh}
+	 * @brief 清晰度自动降级开启时的自动档位，对应{@link https://www.volcengine.com/docs/4/2918 GetPlayInfo}返回的Definition字段
+	 * @notice 如果指定的清晰度，playAuthToken从服务端返回的清晰度列表中不存在该清晰度，则此参数无效。
+	 * @default -
+	 */
+	autoDemoteDefinition?: string;
+	/** {zh}
+	 * @brief 清晰度自动降级开启时的自动档位对应的多语言文案key，即languages字段中对应语种的相应key
+	 * @notice 如果指定的清晰度，playAuthToken从服务端返回的清晰度列表中不存在该清晰度，则此参数无效。
+	 * @default -
+	 */
+	autoDemoteDefinitionTextKey?: string;
 }
 /** {zh}
  * @list Options
@@ -2673,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 插件按钮位置
  */
@@ -2913,6 +3124,58 @@ export interface IPoster {
 	 */
 	fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
 }
+/** {zh}
+ * @list Options
+ * @brief 进度条预览缩略图配置
+ * @kind property
+ */
+export interface IThumbnailConfig {
+	/** {zh}
+	 * @brief 雪碧图截图地址数组
+	 * @default -
+	 */
+	urls: Array<string>;
+	/** {zh}
+	 * @brief 雪碧图中小图总数目
+	 * @default -
+	 */
+	pic_num: number;
+	/** {zh}
+	 * @brief 雪碧图每张大图中小图列数
+	 * @default -
+	 */
+	col: number;
+	/** {zh}
+	 * @brief 雪碧图每张大图中小图行数
+	 * @default -
+	 */
+	row: number;
+	/** {zh}
+	 * @brief 雪碧图每张小图的高度
+	 * @default -
+	 */
+	height?: number;
+	/** {zh}
+	 * @brief 雪碧图每张小图的宽度
+	 * @default -
+	 */
+	width?: number;
+	/** {zh}
+	 * @brief 显示缩放比例
+	 * @default 1
+	 */
+	scale?: 1;
+	/** {zh}
+	 * @brief 额外添加在dom上的class
+	 * @default -
+	 */
+	className?: string;
+	/** {zh}
+	 * @brief 是否在竖屏的时候隐藏
+	 * @default false
+	 */
+	hidePortrait?: false;
+}
 /**
  * @brief api map
  * @hidden
@@ -3039,9 +3302,10 @@ declare class PlayerData {
 	getUrlList(condition: Condition): Stream[];
 	/**
 	 * @description: 获取当期清晰的上一级清晰度或下一级清晰度
-	 * @param {boolean} isDown
+	 * @param {boolean} isDown 是否取下一级清晰度
+	 * @param {string[]} demotePriority 清晰度降级顺序
 	 */
-	getNextDefinition(isDown: boolean, demotePriority: any): Stream[];
+	getNextDefinition(isDown: boolean, demotePriority: string[]): Stream[];
 	/**
 	 * 获取api map
 	 * @return { ApiMapConfig }
@@ -3180,7 +3444,7 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
-	mountingDom: any;
+	mountingDom: Element;
 	/** {zh}
 	 * @hidden
 	 *
@@ -4078,73 +4342,6 @@ export declare class Subtitle extends Plugin {
 	destroy(): void;
 	render(): string;
 }
-export interface WatermarkConfig {
-	enable: boolean;
-	content: string;
-	displayType: 0 | 1 | 2;
-	fontSize: number | string;
-	fontColor: string;
-	opacity: number;
-	tickerSpeed?: "SLOW" | "MODERATE" | "FAST";
-	fontFamily?: string;
-	top?: number;
-	left?: number;
-	bottom?: number;
-	right?: number;
-}
-export declare class DynamicWatermarkPlugin extends Plugin {
-	private wm;
-	static get pluginName(): string;
-	static get defaultConfig(): WatermarkConfig & {
-		position: string;
-	};
-	constructor(props: any);
-	afterCreate(): void;
-	start(): void;
-	pause(): void;
-	resume(): void;
-	resize(): void;
-	_initWatermark(): void;
-	destroy(): void;
-	render(): string | HTMLElement;
-}
-export declare class DefinitionDemotePlugin extends Plugin {
-	static get pluginName(): string;
-	waitings: number[];
-	timer: any;
-	longWaitingEmitTime: number;
-	waitingStartTime: number;
-	playerData: any;
-	isNeedShowTips: boolean;
-	static get defaultConfig(): {
-		oftenWaitingCount: number;
-		oftenWaitingTime: number;
-		longWaitingTime: number;
-		isNeedAutoDemote: boolean;
-		demotePriority: any[];
-	};
-	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: any): void;
-	showToast(definition: any): void;
-	destroy(): void;
-}
 export declare class TimeShiftPlugin extends Plugin {
 	static get pluginName(): string;
 	static get defaultConfig(): {
@@ -4257,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;