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

package/index.d.ts

@@ -787,31 +787,21 @@ export interface ITextItem {
  */
 export interface IDefinitionDemotePlugin {
 	/**
-	 * 是否开启自动降级
-	 * 默认：false
+	 * 超时重试次数
+	 * 默认：3
 	 *
-	 * @type {boolean}
+	 * @type {number}
 	 * @memberof IDefinitionDemotePlugin
 	 */
-	isNeedAutoDemote?: boolean;
-	/**
-	 * @brief 卡顿时是否展示toast
-	 * @default true
-	 */
-	isNeedShowTips?: boolean;
-	/**
-	 * @brief 提醒降级的toast显示持续时间
-	 */
-	toastShowTime?: number;
+	oftenWaitingCount?: number;
 	/**
+	 * 设置经常超时时间
+	 * 默认：5000
 	 *
-	 * 降级顺序，按照数组顺序依次降级，数字元素对应playList中的definition
-	 * 默认: ['uhd', 'hd', 'sd', 'ld', 'ao']
-	 *
-	 * @type {string[]}
+	 * @type {number}
 	 * @memberof IDefinitionDemotePlugin
 	 */
-	demotePriority?: string[];
+	oftenWaitingTime?: number;
 	/**
 	 * 设置超时时间
 	 * 默认5000
@@ -821,21 +811,22 @@ export interface IDefinitionDemotePlugin {
 	 */
 	longWaitingTime?: number;
 	/**
-	 * 超时重试次数
-	 * 默认：3
+	 * 是否自动触发降级
+	 * 默认：false
 	 *
-	 * @type {number}
+	 * @type {boolean}
 	 * @memberof IDefinitionDemotePlugin
 	 */
-	oftenWaitingCount?: number;
+	isNeedAutoDemote?: boolean;
 	/**
-	 * 设置经常超时时间
-	 * 默认：5000
 	 *
-	 * @type {number}
+	 * 降级顺序，按照数组顺序依次降级，数字元素对应playList中的definition
+	 * 默认: ['uhd', 'hd', 'sd', 'ld', 'ao']
+	 *
+	 * @type {string[]}
 	 * @memberof IDefinitionDemotePlugin
 	 */
-	oftenWaitingTime?: number;
+	demotePriority?: string[];
 }
 /**
  * @brief DASH 播放配置。
@@ -1640,7 +1631,7 @@ export declare class PlayListPlugin extends Plugin {
 	get disable(): boolean;
 	render(): string;
 }
-export interface IPlayInfoListItem {
+export interface IPlayInfoList {
 	BackupPlayUrl: string;
 	BackupUrlExpire: string;
 	BarrageMaskOffset: string;
@@ -1667,98 +1658,6 @@ export interface IPlayInfoListItem {
 	Volume?: number;
 	Width: number;
 }
-/**
- * @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 enum CodecType {
 	/** {zh}
 	 * @brief H.265
@@ -1914,7 +1813,7 @@ export interface IMusicConfig {
  * @export
  * @interface Stream
  */
-export interface Stream extends Partial<IPlayInfoListItem> {
+export interface Stream extends Partial<IPlayInfoList> {
 	/** {zh}
 	 * @type {('rtm' | 'flv' | 'mp4' | 'hls')}
 	 * @memberof IPlayerConfig
@@ -1938,12 +1837,6 @@ export interface Stream extends Partial<IPlayInfoListItem> {
 	 * @brief 清晰度 key
 	 */
 	definition?: string;
-	/** {zh}
-	 * @type {string}
-	 * @memberof Stream
-	 * @brief 映射清晰度 key
-	 */
-	mapDefinition?: string;
 	/** {zh}
 	 * @type {string}
 	 * @memberof Stream
@@ -2087,7 +1980,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	autoplay?: boolean;
 	/** {zh}
-	 * @brief 视频封面图配置。
+	 * @brief 视频封面图片的 URL。
 	 */
 	poster?: string | IPoster;
 	/** {zh}
@@ -2452,11 +2345,6 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 */
 	disableVodLogOptsCheck?: boolean;
-	/** {zh}
-	 * @brief 是否开启调试模式
-	 * @default false
-	 */
-	debug?: boolean;
 	/** {zh}
 	 * @brief 播放器报错信息。支持配置播放异常时显示的异常文案、图片以及是否提供刷新按钮等。
 	 * @default -
@@ -2476,6 +2364,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	DanmuPlugin?: IDanmuConfig | boolean;
 	/** {zh}
 	 * @brief 清晰度自动降级配置
+	 * @hidden
 	 * @notes 需要先引入DefinitionDemotePlugin插件，plugins: [VePlayer.DefinitionDemotePlugin]
 	 */
 	DefinitionDemotePlugin?: IDefinitionDemotePlugin;
@@ -2536,16 +2425,6 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 播放列表配置。
 	 */
 	playListPlugin?: IPlayListConfig;
-	/** {zh}
-	 * @brief 动态水印配置
-	 * @default -
-	 */
-	dynamicwatermark?: IWatermarkConfig;
-	/** {zh}
-	 * @brief 进度条预览缩略图配置
-	 * @default -
-	 */
-	thumbnail?: IThumbnailConfig;
 }
 /** {zh}
  * @hidden
@@ -2724,18 +2603,6 @@ 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
@@ -2828,12 +2695,12 @@ export interface IMemoryPlayConfig {
 	 * @type {(id: number | string, time: number) => unknown}
 	 * @memberof IMemoryPlayConfig
 	 */
-	saveTime?: (id: number | string, time: number) => unknown;
+	saveTime: (id: number | string, time: number) => unknown;
 	/** {zh}
 	 * @brief 获取最后一次播放时间函数
 	 * @default -
 	 */
-	getTime?: (id: number | string) => number | Promise<number>;
+	getTime: (id: number | string) => number | Promise<number>;
 }
 /** {zh}
  * @brief 插件按钮位置
@@ -3046,58 +2913,6 @@ 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
@@ -3224,10 +3039,9 @@ declare class PlayerData {
 	getUrlList(condition: Condition): Stream[];
 	/**
 	 * @description: 获取当期清晰的上一级清晰度或下一级清晰度
-	 * @param {boolean} isDown 是否取下一级清晰度
-	 * @param {string[]} demotePriority 清晰度降级顺序
+	 * @param {boolean} isDown
 	 */
-	getNextDefinition(isDown: boolean, demotePriority: string[]): Stream[];
+	getNextDefinition(isDown: boolean, demotePriority: any): Stream[];
 	/**
 	 * 获取api map
 	 * @return { ApiMapConfig }
@@ -3366,7 +3180,7 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
-	mountingDom: Element;
+	mountingDom: any;
 	/** {zh}
 	 * @hidden
 	 *
@@ -4264,15 +4078,51 @@ 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: ReturnType<typeof setTimeout>;
-	toastId: number;
+	timer: any;
 	longWaitingEmitTime: number;
 	waitingStartTime: number;
-	playerData: PlayerData;
-	static get defaultConfig(): IDefinitionDemotePlugin;
+	playerData: any;
+	isNeedShowTips: boolean;
+	static get defaultConfig(): {
+		oftenWaitingCount: number;
+		oftenWaitingTime: number;
+		longWaitingTime: number;
+		isNeedAutoDemote: boolean;
+		demotePriority: any[];
+	};
 	constructor(args: any);
 	registerLanguageTexts(): {
 		definition_demote_txt: {
@@ -4291,8 +4141,8 @@ export declare class DefinitionDemotePlugin extends Plugin {
 	_clearTime(): void;
 	clearState(): void;
 	demote(): void;
-	changeUrl(url: string): void;
-	showToast(definition: Stream): void;
+	changeUrl(url: any): void;
+	showToast(definition: any): void;
 	destroy(): void;
 }
 export declare class TimeShiftPlugin extends Plugin {