@volcengine/veplayer 1.10.0-rc.9 → 1.12.0-rc.0

package/index.d.ts

@@ -1253,6 +1253,75 @@ export declare type IDefinition = {
 		[propName: string]: any;
 	};
 };
+/**
+ * @brief 音量配置。
+ * @list Options
+ * @kind property
+ */
+export declare type IVolume = number | {
+	/**
+	 * @brief 插件Dom挂载的位置，默认播放器底部控制栏右侧
+	 * @default POSITIONS.CONTROLS_RIGHT
+	 */
+	position?: POSITIONS;
+	/**
+	 * @brief 插件在挂载的位置的排序权重
+	 * @default 1
+	 */
+	index?: number;
+	/**
+	 * @brief 是否禁用插件交互行为，即是否隐藏音量调节按钮
+	 * @default false
+	 */
+	disable?: boolean;
+	/**
+	 * @brief 是否在音量调节slider上方显示当前音量数值
+	 * @default false
+	 */
+	showValueLabel?: boolean;
+	/**
+	 * @brief 默认音量大小，取值范围0-1
+	 * @default 0.6
+	 */
+	default?: number;
+	/**
+	 * @brief 静音恢复的时候最小音量
+	 * @default 0.2
+	 */
+	miniVolume?: number;
+};
+/**
+ * @brief 进度条标记点配置。
+ * @list Options
+ * @kind property
+ */
+export interface IDot {
+	/**
+	 * @brief 进度条标记点
+	 * @default 1
+	 */
+	id: string | number;
+	/**
+	 * @brief 标记点所在的播放时间
+	 * @default 0
+	 */
+	time: number;
+	/**
+	 * @brief 进度条自定义文案
+	 * @default -
+	 */
+	text?: string;
+	/**
+	 * @brief 标记点持续的时间，单位秒
+	 * @default 1
+	 */
+	duration?: number;
+	/**
+	 * @brief 进度条自定义的CSS Style样式
+	 * @default -
+	 */
+	style?: CSSStyleDeclaration;
+}
 /**
  * @hidden
  */
@@ -1371,10 +1440,6 @@ export declare type IPlayerOptions = {
 };
 /**
  * @brief mobile端交互配置。
- * @hidden
- */
-/** {en}
- * @hidden
  */
 export interface IMobileConfig {
 	/**
@@ -1391,7 +1456,7 @@ export interface IMobileConfig {
 	 */
 	gestureX?: boolean;
 	/**
-	 * @brief 是否启用垂直手势处理, 垂直手势包括屏幕右侧和屏幕左侧，默认左侧调节亮度，右侧调节音量，左右范围比例通过scopeL和scopeR设置
+	 * @brief 是否启用垂直手势处理，默认不启用, 垂直手势包括屏幕右侧和屏幕左侧，默认左侧调节亮度，右侧调节音量，左右范围比例通过scopeL和scopeR设置
 	 * @default false
 	 */
 	gestureY?: boolean;
@@ -1483,10 +1548,6 @@ export interface IMobileConfig {
 }
 /**
  * @brief 播放器中间切换暂停/播放的按钮。
- * @hidden
- */
-/** {en}
- * @hidden
  */
 export interface IStartConfig {
 	/**
@@ -2811,12 +2872,12 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
 	/** {zh}
-	 * @brief 视频画面填充模式。取值如下：
-	 *        - `fillwidth`: 填充宽度，高度溢出则裁剪高度。
-	 *        - `fillHeight`: 填充高度，宽度溢出则裁剪宽度。
-	 *        - `fill`: 拉伸视频以填充容器。
-	 *        - `cover`: 保持视频宽高比的同时填充元素的整个内容框。
-	 *        - `auto`: 使用浏览器默认的视频画面填充模式。
+	 * @brief 视频画面填充模式，等同于设置{@link https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit CSS object-fit}属性。取值如下：
+	 *        - `auto`: 使用浏览器默认的视频画面填充模式，注意设置此值时，在视频的宽高与播放器容器的宽高不匹配时会出现黑边。
+	 *        - `fill`: 拉伸视频以填充播放器容器，等同于设置 CSS `object-fit: fill`，注意设置此值时，视频画面会被被拉伸变形。
+	 *        - `cover`: 保持视频宽高比的同时填充整个播放器容器，等同于设置 CSS `object-fit: cover`，注意设置此值时，视频画面会被被部分裁剪。
+	 *        - `fillWidth`: 填充宽度，高度溢出则裁剪高度，当播放器容器宽高比小于视频的宽高比，等同于设置CSS `object-fit: cover`。
+	 *        - `fillHeight`: 填充高度，宽度溢出则裁剪宽度，当播放器容器宽高比大于视频的宽高比，等同于设置CSS `object-fit: cover`。
 	 * @default auto
 	 */
 	videoFillMode?: "auto" | "fillHeight" | "fillWidth" | "fill" | "cover";
@@ -3226,6 +3287,11 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 */
 	thumbnail?: IThumbnailConfig;
+	/** {zh}
+	 * @brief 进度条标记配置
+	 * @default -
+	 */
+	progressDot?: IDot[];
 }
 /**
  * @brief 播放源数据。支持传入视频播放地址 `url`、播放列表 `playList` 或者 `vid` 和 `playAuthToken`，还需包含新地址的过期时间戳 `urlExpireTimestamp`。
@@ -3274,12 +3340,11 @@ export interface IDefaultConfig {
 	 */
 	startTime?: number;
 	/** {zh}
-	 * @brief 音量
-	 *
-	 * @type {number}
-	 * @memberof IDefaultConfig
+	 * @brief 音量配置，如果为数字则表示默认音量大小，取值0-1，
+	 * 如果是对象则可以对音量控制插件进行各型特性单独配置
+	 * @default 0.6
 	 */
-	volume?: number;
+	volume?: IVolume;
 	/** {zh}
 	 * @brief 弹幕插件配置
 	 *
@@ -3463,6 +3528,48 @@ export interface definitionItem {
 	 */
 	definitionTextKey?: string;
 }
+/** {zh}
+ * @brief 插件按钮位置
+ */
+export declare const enum POSITIONS {
+	/** {zh}
+	 * @brief 播放器根节点
+	 */
+	ROOT = "root",
+	/** {zh}
+	 * @brief 播放器根节点左侧
+	 */
+	ROOT_LEFT = "rootLeft",
+	/** {zh}
+	 * @brief 播放器根节点右侧
+	 */
+	ROOT_RIGHT = "rootRight",
+	/** {zh}
+	 * @brief 播放器根节点顶部
+	 */
+	ROOT_TOP = "rootTop",
+	/** {zh}
+	 * @brief 播控栏左侧
+	 */
+	CONTROLS_LEFT = "controlsLeft",
+	/** {zh}
+	 * @brief 播控栏左侧
+	 */
+	CONTROLS_RIGTH = "controlsRight",
+	/** {zh}
+	 * @brief 播控栏右侧
+	 */
+	CONTROLS_RIGHT = "controlsRight",
+	/** {zh}
+	 * @brief 播控栏中间
+	 */
+	CONTROLS_CENTER = "controlsCenter",
+	/** {zh}
+	 * @hidden
+	 * @brief 播控栏左侧
+	 */
+	CONTROLS = "controls"
+}
 /**
  * @brief Plugin类插件基础配置
  */
@@ -4071,6 +4178,10 @@ declare abstract class AbstractBaseAdapter {
 		playerData: PlayerData;
 		streamType: string;
 	});
+	/**
+	 * @description 是否使用原生video的abr能力
+	 */
+	abstract useNativeAbr(): boolean;
 	abstract canOpenAbr(vidPlayInfo?: VideoInfoRes): boolean;
 	abstract applyAbrPluginConfig(_finalOptions: any, _autoBitrateOpts: any): void;
 	abstract prepareAbrModule(_playerData: any, _sdkUmdLoader: any): void;
@@ -4133,7 +4244,9 @@ declare class PlayerData {
 		Data: IGetPlayInfoRes;
 	};
 	sdk: VePlayer;
-	constructor(configs: IPlayerConfig, sdk: VePlayer);
+	constructor(configs: IPlayerConfig & {
+		licensSupportModuleList: string[];
+	}, sdk: VePlayer);
 	/**
 	 * 初始化播放数据
 	 * @param configs { IPlayerConfig } 播放器配置
@@ -4333,6 +4446,34 @@ declare class umdLoader {
 	 */
 	loadPlugins(pluginName: UmdKeys, successCallback?: () => void): Promise<any>;
 }
+export interface IlicenseContent {
+	content: string;
+	sign: string;
+	mainUrl?: string;
+}
+declare enum LicenseEdition {
+	EDITION_STANDARD = "standard_edition",
+	EDITION_PREMIUM = "premium_edition",
+	EDITION_NONE = "none_edition"
+}
+declare enum LicenseFeature {
+	H265 = "h265",
+	PRELOAD = "preload",
+	ADAPT_RANGE = "adaptRange",
+	ABR = "abr"
+}
+declare enum LicenseStatus {
+	LICENSE_STATUS_INVALID = 0,
+	LICENSE_STATUS_OK = 1,
+	LICENSE_STATUS_EXPIRED = 2,
+	LICENSE_STATUS_ERROR_DOMAIN_NOT_MATCH = 401
+}
+export interface ILicenseConfig {
+	license: string | IlicenseContent;
+	autoUpload?: boolean;
+	expireDiffTime?: number;
+	expireCallback?: (expireDiffTime?: number) => void;
+}
 /** {zh}
  * @hidden
  */
@@ -4341,13 +4482,17 @@ declare class umdLoader {
  */
 export declare type PlayerCore = Player & {
 	sdk?: VePlayer;
-	changePluginsIcon?: (name: any, isShow: any) => void;
+	changePluginsIcon?: (name: string, isShow: boolean) => void;
 	playerData?: PlayerData;
 	playerType?: string;
 	playerVersion?: string;
 	panel?: MobilePlayerPanel;
 	emitExpireTimestamp?: number;
 	vodLogger?: VodLogger;
+	licenseLogInfo?: {
+		licenseStatus: LicenseStatus;
+		licenseType: LicenseEdition;
+	};
 };
 declare class VePlayer {
 	/** {zh}
@@ -4516,7 +4661,19 @@ declare class VePlayer {
 	static isRTMSupportCodec: (codec: RTMCodec, options: {
 		targetProfileLevel?: string;
 	}) => Promise<boolean>;
-	private vodLogCommon;
+	static setLicenseConfig(config: ILicenseConfig): Promise<void>;
+	static checkLicense(): Promise<LicenseEdition>;
+	static checkModuleList(): Promise<string[]>;
+	static checkLicenseStatus(): Promise<LicenseStatus>;
+	static checkLicenseModuleAuth(module: string, featureName: LicenseFeature): Promise<boolean>;
+	private static vodLogCommon;
+	private static hasInitVeStrategy;
+	/**
+	 * @hidden
+	 * 延时触发的events，即保证在player创建之后才触发
+	 */
+	private _isVolcengine;
+	private _originConfigs;
 	/**
 	 * @hidden
 	 * 延时触发的events，即保证在player创建之后才触发
@@ -4641,7 +4798,8 @@ declare class VePlayer {
 	/** {en}
 	 * @hidden
 	 */
-	createPlayer(): Promise<PlayerCore>;
+	createPlayer: () => Promise<PlayerCore>;
+	private checkLicenseCallback;
 	/** {zh}
 	 * @hidden
 	 * @brief 设置合并开发者的插件配置，如果开发者从初始化的configs里传了插件配置，则只用开发者的配置，并补齐其他参数
@@ -4689,7 +4847,7 @@ declare class VePlayer {
 		lineId?: string | number;
 		definition?: string;
 		startTime?: number;
-		volume?: number;
+		volume?: IVolume;
 		DanmuPlugin?: any;
 		LiveSubtitlesIconPlugin?: any;
 	};
@@ -4733,6 +4891,11 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	private _setPlayerInfo;
+	/**
+	 * @hidden
+	 * @private
+	 */
+	private getVtype;
 	/**
 	 *
 	 *
@@ -4748,6 +4911,7 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	private _bindPlayerEvents;
+	private _proxyError;
 	private _onError;
 	/** {zh}
 	 * @private
@@ -4838,6 +5002,7 @@ declare class VePlayer {
 	 */
 	set src(url: Url);
 	/** {zh}
+	 * @hidden
 	 * @brief 播放时更换视频 URL，以更换视频源。
 	 * @notes 更换后，会从更换前的时间点继续播放。
 	 * @param url 视频播放地址。
@@ -5773,17 +5938,17 @@ export declare const Events: {
 	 */
 	URL_CHANGE: string;
 	/** {zh}
-	 * @brief 播放器聚焦。
+	 * @brief 播放器聚焦，同时会展示 Control 栏控件，包含播放按钮、进度条等。
 	 */
 	/** {en}
-	 * @brief The player has focus.
+	 * @brief The player is active and the control bar will appear showing options like play button, progress bar, and other controls.
 	 */
 	PLAYER_FOCUS: string;
 	/** {zh}
-	 * @brief 播放器失焦。
+	 * @brief 播放器失焦，同时会隐藏 Control 栏控件，包含播放按钮、进度条等。
 	 */
 	/** {en}
-	 * @brief The player loses focus.
+	 * @brief The player is inactive and the control bar will vanish, hiding options such as the play button, progress bar, and other controls.
 	 */
 	PLAYER_BLUR: string;
 	/** {zh}
@@ -5873,7 +6038,7 @@ export declare const Events: {
 	SHORTCUT: string;
 	/** {zh}
 	 * @deprecated
-	 * @brief SEI 信息解析。
+	 * @brief （已废弃）SEI 信息解析。
 	 */
 	/** {en}
 	 * @deprecated
@@ -5953,6 +6118,10 @@ export declare const Events: {
 	 * @brief `<source>` 加载成功。
 	 */
 	SOURCE_SUCCESS: string;
+	/** {zh}
+	 * @brief license 提醒
+	 */
+	LICENSE_STATUS_WARNING: string;
 	/** {zh}
 	 * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
 	 */
@@ -6092,17 +6261,17 @@ export declare const Event: {
 		 */
 		URL_CHANGE: string;
 		/** {zh}
-		 * @brief 播放器聚焦。
+		 * @brief 播放器聚焦，同时会展示 Control 栏控件，包含播放按钮、进度条等。
 		 */
 		/** {en}
-		 * @brief The player has focus.
+		 * @brief The player is active and the control bar will appear showing options like play button, progress bar, and other controls.
 		 */
 		PLAYER_FOCUS: string;
 		/** {zh}
-		 * @brief 播放器失焦。
+		 * @brief 播放器失焦，同时会隐藏 Control 栏控件，包含播放按钮、进度条等。
 		 */
 		/** {en}
-		 * @brief The player loses focus.
+		 * @brief The player is inactive and the control bar will vanish, hiding options such as the play button, progress bar, and other controls.
 		 */
 		PLAYER_BLUR: string;
 		/** {zh}
@@ -6192,7 +6361,7 @@ export declare const Event: {
 		SHORTCUT: string;
 		/** {zh}
 		 * @deprecated
-		 * @brief SEI 信息解析。
+		 * @brief （已废弃）SEI 信息解析。
 		 */
 		/** {en}
 		 * @deprecated
@@ -6272,6 +6441,10 @@ export declare const Event: {
 		 * @brief `<source>` 加载成功。
 		 */
 		SOURCE_SUCCESS: string;
+		/** {zh}
+		 * @brief license 提醒
+		 */
+		LICENSE_STATUS_WARNING: string;
 	};
 	PluginEvents: {
 		/** {zh}