@volcengine/veplayer 1.9.8-rc.0 → 1.9.8-rc.2

package/index.d.ts

@@ -2,7 +2,7 @@ import VeStrategy from '@byted/volcengine-vestrategy';
 import { StrategyRecommendation } from '@byted/volcengine-vestrategy';
 import { VeStrategyH265Config } from '@byted/volcengine-vestrategy-h265';
 import { PreloaderManager as PreloaderManagerOrigin } from '@byted/volcengine-vestrategy-preload';
-import VodLogger from '@byted/xgplayer-app-logger/es/logger';
+import VodLogger from '@byted/xgplayer-app-logger/es/logger.js';
 import EventEmitter from 'eventemitter3';
 import Player from 'xgplayer';
 import { BasePlugin, I18N, IXGI18nText, Plugin } from 'xgplayer';
@@ -1253,75 +1253,6 @@ 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
  */
@@ -1440,6 +1371,10 @@ export declare type IPlayerOptions = {
 };
 /**
  * @brief mobile端交互配置。
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export interface IMobileConfig {
 	/**
@@ -1456,7 +1391,7 @@ export interface IMobileConfig {
 	 */
 	gestureX?: boolean;
 	/**
-	 * @brief 是否启用垂直手势处理，默认不启用, 垂直手势包括屏幕右侧和屏幕左侧，默认左侧调节亮度，右侧调节音量，左右范围比例通过scopeL和scopeR设置
+	 * @brief 是否启用垂直手势处理, 垂直手势包括屏幕右侧和屏幕左侧，默认左侧调节亮度，右侧调节音量，左右范围比例通过scopeL和scopeR设置
 	 * @default false
 	 */
 	gestureY?: boolean;
@@ -1548,6 +1483,10 @@ export interface IMobileConfig {
 }
 /**
  * @brief 播放器中间切换暂停/播放的按钮。
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export interface IStartConfig {
 	/**
@@ -2123,9 +2062,7 @@ export declare class MemoryPlay extends Plugin {
  */
 export declare const enum EDRMTYPE {
 	DRM_ENCRYPT = "drm_encrypt",
-	PRIVATE_ENCRYPT = "private_encrypt",
-	PRIVATE_ENCRYPT_UPGRADE = "private_encrypt_upgrade",
-	STANDARD_ENCRYPT = "standard_encrypt"
+	PRIVATE_ENCRYPT = "private_encrypt"
 }
 /** {zh}
  * @hidden
@@ -2873,7 +2810,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
 	/** {zh}
 	 * @brief 视频画面填充模式。取值如下：
-	 *        - `fillWidth`: 填充宽度，高度溢出则裁剪高度。
+	 *        - `fillwidth`: 填充宽度，高度溢出则裁剪高度。
 	 *        - `fillHeight`: 填充高度，宽度溢出则裁剪宽度。
 	 *        - `fill`: 拉伸视频以填充容器。
 	 *        - `cover`: 保持视频宽高比的同时填充元素的整个内容框。
@@ -3287,11 +3224,6 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 */
 	thumbnail?: IThumbnailConfig;
-	/** {zh}
-	 * @brief 进度条标记配置
-	 * @default -
-	 */
-	progressDot?: IDot[];
 }
 /**
  * @brief 播放源数据。支持传入视频播放地址 `url`、播放列表 `playList` 或者 `vid` 和 `playAuthToken`，还需包含新地址的过期时间戳 `urlExpireTimestamp`。
@@ -3340,11 +3272,12 @@ export interface IDefaultConfig {
 	 */
 	startTime?: number;
 	/** {zh}
-	 * @brief 音量配置，如果为数字则表示默认音量大小，取值0-1，
-	 * 如果是对象则可以对音量控制插件进行各型特性单独配置
-	 * @default 0.6
+	 * @brief 音量
+	 *
+	 * @type {number}
+	 * @memberof IDefaultConfig
 	 */
-	volume?: IVolume;
+	volume?: number;
 	/** {zh}
 	 * @brief 弹幕插件配置
 	 *
@@ -3528,48 +3461,6 @@ 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类插件基础配置
  */
@@ -4151,6 +4042,51 @@ declare class VeStrategyWrapper {
 	private initPreloaderConfig;
 }
 declare const _default: VeStrategyWrapper;
+/** {zh}
+ * @hidden
+ */
+export declare type IRes = IGetPlayInfoRes & {
+	Data: IGetPlayInfoRes & {
+		VideoID?: string;
+	};
+};
+/** {zh}
+ * @hidden
+ */
+export interface IDefItem extends Stream {
+	vid: string;
+	lineId?: number;
+	lineName?: string;
+	url: string;
+	streamType: string;
+	backupUrl: string;
+	backUrlList: string[];
+	fileType?: "video" | "audio" | "evideo" | "eaudio";
+	format: string;
+	bitrate?: number;
+	size?: number;
+	kid?: string;
+	vwidth?: number;
+	vheight?: number;
+}
+/** {zh}
+ * @hidden
+ */
+export interface VideoInfoRes {
+	playList: IDefItem[];
+	type?: string;
+	poster: string;
+	vid: string;
+	duration: number;
+	dashOpts: IRes | {
+		Data: IRes;
+	};
+	thumbs: IThumbInfoItem[];
+	barrageMaskUrl: string;
+	enableAdaptive?: boolean;
+	adaptiveBitrateStreamingInfo?: ABRInfo;
+}
+declare function isMSESupport(mime?: string): boolean;
 /** {zh}
  * @hidden
  */
@@ -4244,7 +4180,9 @@ declare class PlayerData {
 		Data: IGetPlayInfoRes;
 	};
 	sdk: VePlayer;
-	constructor(configs: IPlayerConfig, sdk: VePlayer);
+	constructor(configs: IPlayerConfig & {
+		licensSupportModuleList: string[];
+	}, sdk: VePlayer);
 	/**
 	 * 初始化播放数据
 	 * @param configs { IPlayerConfig } 播放器配置
@@ -4444,6 +4382,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_PARAM_PACKAGENAME = 401
+}
+export interface ILicenseConfig {
+	license: string | IlicenseContent;
+	autoUpload?: boolean;
+	expireDiffTime?: number;
+	expireCallback?: (expireDiffTime?: number) => void;
+}
 /** {zh}
  * @hidden
  */
@@ -4582,10 +4548,6 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	static sdkVersion: string;
-	/**
-	 * @hidden
-	 */
-	private veErrorIns;
 	/** {zh}
 	 * @brief 播放策略预初始化配置
 	 * @param options 初始化配置，详情见{@link StrategyInitOptions}
@@ -4627,7 +4589,14 @@ declare class VePlayer {
 	static isRTMSupportCodec: (codec: RTMCodec, options: {
 		targetProfileLevel?: string;
 	}) => Promise<boolean>;
-	private vodLogCommon;
+	static setLicenseConfig(config: ILicenseConfig): void;
+	static checkLicense(): Promise<LicenseEdition>;
+	static checkModuleList(): Promise<string[]>;
+	static checLicenseStatus(): Promise<LicenseStatus>;
+	static checkLicenseModuleAuth(module: string, featureName: LicenseFeature): Promise<boolean>;
+	private static vodLogCommon;
+	private static hasInitVeStrategy;
+	private _originConfigs;
 	/**
 	 * @hidden
 	 * 延时触发的events，即保证在player创建之后才触发
@@ -4752,7 +4721,8 @@ declare class VePlayer {
 	/** {en}
 	 * @hidden
 	 */
-	createPlayer: () => Promise<PlayerCore>;
+	createPlayer(): Promise<PlayerCore>;
+	private checkLicenseCallback;
 	/** {zh}
 	 * @hidden
 	 * @brief 设置合并开发者的插件配置，如果开发者从初始化的configs里传了插件配置，则只用开发者的配置，并补齐其他参数
@@ -4800,7 +4770,7 @@ declare class VePlayer {
 		lineId?: string | number;
 		definition?: string;
 		startTime?: number;
-		volume?: IVolume;
+		volume?: number;
 		DanmuPlugin?: any;
 		LiveSubtitlesIconPlugin?: any;
 	};
@@ -4830,7 +4800,6 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	afterPlayerCreate(): void;
-	_setVeError(): void;
 	/**
 	 * @hidden
 	 *
@@ -4844,11 +4813,6 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	private _setPlayerInfo;
-	/**
-	 * @hidden
-	 * @private
-	 */
-	private getVtype;
 	/**
 	 *
 	 *
@@ -4864,7 +4828,6 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	private _bindPlayerEvents;
-	_proxyError: (veError: any) => void;
 	private _onError;
 	/** {zh}
 	 * @private
@@ -4955,7 +4918,6 @@ declare class VePlayer {
 	 */
 	set src(url: Url);
 	/** {zh}
-	 * @hidden
 	 * @brief 播放时更换视频 URL，以更换视频源。
 	 * @notes 更换后，会从更换前的时间点继续播放。
 	 * @param url 视频播放地址。
@@ -6071,6 +6033,10 @@ export declare const Events: {
 	 * @brief `<source>` 加载成功。
 	 */
 	SOURCE_SUCCESS: string;
+	/** {zh}
+	 * @brief license 提醒
+	 */
+	LICENSE_STATUS: string;
 	/** {zh}
 	 * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
 	 */
@@ -6390,6 +6356,10 @@ export declare const Event: {
 		 * @brief `<source>` 加载成功。
 		 */
 		SOURCE_SUCCESS: string;
+		/** {zh}
+		 * @brief license 提醒
+		 */
+		LICENSE_STATUS: string;
 	};
 	PluginEvents: {
 		/** {zh}