@volcengine/veplayer 1.8.1 → 1.8.2-rc.0

package/index.d.ts

@@ -2,10 +2,9 @@ import VodLogger from '@byted/xgplayer-app-logger/es/logger.js';
 import VeStrategy from '@volcengine/vestrategy';
 import { StrategyRecommendation, VeStrategyInitOptions } from '@volcengine/vestrategy';
 import { VeStrategyH265Config } from '@volcengine/vestrategy-h265';
-import { Property } from 'dom-helpers/esm/types';
 import EventEmitter from 'eventemitter3';
 import Player from 'xgplayer';
-import { BasePlugin, Events as XgEvents, I18N, IXGI18nText, Plugin } from 'xgplayer';
+import { BasePlugin, I18N, IXGI18nText, Plugin } from 'xgplayer';
 
 declare enum POSITIONS {
 	ROOT = "root",
@@ -17,76 +16,83 @@ declare enum POSITIONS {
 	CONTROLS_CENTER = "controlsCenter"
 }
 /**
- * @detail Options
- *
- *
- * @export
- * @interface ISdkErrorConfig
+ * @brief 发错错误时的UI表现配置
+ * @list Options
+ * @kind property
  */
 export interface ISdkErrorConfig {
-	/**
-	 * 报错时是否显示提示图片
-	 * 默认：true
-	 *
-	 * @type {boolean}
-	 * @memberof ISdkErrorConfig
+	/** {zh}
+	 * @brief 报错时是否显示提示图片
+	 * @default true
 	 */
 	errorImg?: boolean;
-	/**
-	 * 报错时是否展示
-	 * 默认：true
-	 *
-	 * @type {boolean}
-	 * @memberof ISdkErrorConfig
+	/** {zh}
+	 * @brief 报错时是否展示
+	 * @default true
 	 */
 	errorTips?: boolean;
-	/**
-	 * 报错时是否展示“刷新”按钮
-	 * 默认：true
-	 *
-	 * @type {boolean}
-	 * @memberof ISdkErrorConfig
+	/** {zh}
+	 * @brief 报错时是否展示“刷新”按钮
+	 * @default ture
 	 */
 	isNeedRefreshButton?: boolean;
-	/**
-	 * 报错后是否进行降级，true则降级到playlist中相应 backUrlList字段（type为 rtm 不能设置true）
-	 * 默认：false
-	 *
-	 * @type {boolean}
-	 * @memberof ISdkErrorConfig
+	/** {zh}
+	 * @brief 报错后是否进行降级，true则降级到playlist中相应 backUrlList字段（type为 rtm 不能设置true）
+	 * @default false
+	 * @hidden
 	 */
 	isNeedDemoteBack?: boolean;
-	/**
-	 *
-	 * 报错后重试次数
-	 * 默认: 1
-	 *
-	 * @type {number}
-	 * @memberof ISdkErrorConfig
+	/** {zh}
+	 * @brief 报错后重试次数
+	 * @default 1
 	 */
 	retryLoopNum?: number;
-	/**
-	 *
-	 * 报错后提示文案
-	 * 默认：播放发生错误，点击刷新试试吧
-	 *
-	 * @type {(HTMLElement | string)}
-	 * @memberof ISdkErrorConfig
+	/** {zh}
+	 * @brief 报错后提示文案
+	 * @default 播放发生错误，点击刷新试试吧
 	 */
-	errorTipsText?: HTMLElement | string;
-	/**
-	 * 播放器中所处的位置
+	/** {en}
+	 * @brief Prompt copy after error
+	 * @default An error occurred while playing, click refresh to try
+	 */
+	errorTipsText?: TipsTextConfig;
+	/** {zh}
 	 * @hidden
-	 * @type {string}
-	 * @memberof ISdkErrorConfig
+	 * @brief 播放器中所处的位置
 	 */
 	position?: POSITIONS;
 }
 /**
- * @detail Options
- *
- *
- * @export
+ * @list Options
+ * @brief 错误文案配置
+ * @kind property
+ */
+export interface TipsTextConfig {
+	/**
+	 * @brief 中文错误文案
+	 * @default 播放发生错误，点击刷新试试吧
+	 */
+	zh?: HTMLElement | string;
+	/**
+	 * @brief 英文错误文案
+	 * @default An error occurred while playing, click refresh to try
+	 */
+	en?: HTMLElement | string;
+	/**
+	 * @brief 日文错误文案
+	 * @default 再生中にエラーが発生しました。[更新]をクリックして試してください
+	 */
+	jp?: HTMLElement | string;
+	/**
+	 * @brief 香港繁体中文错误文案。
+	 * @default 播放發生錯誤，點擊刷新試試吧
+	 */
+	"zh-hk"?: HTMLElement | string;
+}
+/**
+ * @hidden
+ * @brief rtm配置
+ * @list Options
  * @interface IRtmConfig
  */
 export interface IRtmConfig {
@@ -140,87 +146,58 @@ export interface IRtmConfig {
 	backupStreamType: "hls" | "flv";
 }
 /**
- * @detail Options
  * @brief 弹幕相关设置
- *
- * @export
- * @interface InitConfig
+ * @list Options
+ * @kind property
  */
-export interface InitConfig {
+export interface IDanmuConfig {
 	/**
-	 * 透明度, 枚举值[0, 33, 66, 99], 实际对应0, 0.33, 0.66, 1
-	 * 默认：99
-	 *
-	 * @type {number}
-	 * @memberof InitConfig
+	 * @brief 透明度, 枚举值[0, 33, 66, 99], 实际对应0, 0.33, 0.66, 1
+	 * @default 99
 	 */
 	opacity?: number;
 	/**
-	 * 枚举值[0, 33, 66, 99] 实际对应1/4, 1/2, 3/4, 1
-	 * 默认：99
-	 *
-	 * @type {number}
-	 * @memberof InitConfig
+	 * @brief 枚举值[0, 33, 66, 99] 实际对应1/4, 1/2, 3/4, 1
+	 * @default 99
 	 */
 	area?: number;
 	/**
-	 * 速度, 枚举值[0, 20, 40, 60, 80, 100]， 实际对应1/4, 1/2,1,5/4,3/2,2
-	 * 默认：40
-	 *
-	 * @type {number}
-	 * @memberof InitConfig
+	 * @brief 速度, 枚举值[0, 20, 40, 60, 80, 100]， 实际对应1/4, 1/2,1,5/4,3/2,2
+	 * @default 40
 	 */
 	speed?: number;
 	/**
-	 * 字体大小， 枚举值[0, 50, 100]，实际对应14px 16px 20px
-	 * 默认：50
-	 *
-	 * @type {number}
-	 * @memberof InitConfig
+	 * @brief 字体大小， 枚举值[0, 50, 100]，实际对应14px 16px 20px
+	 * @default 50
 	 */
 	fontSize?: number;
 	/**
-	 * 是否打开面板
-	 * 默认：false
-	 *
-	 * @type {boolean}
-	 * @memberof InitConfig
+	 * @brief 是否打开面板
+	 * @default false
 	 */
 	active?: boolean;
 	/**
-	 * 是否展示弹幕设置面板
-	 * 默认: true
-	 *
-	 * @type {boolean}
-	 * @memberof InitConfig
+	 * @brief 是否展示弹幕设置面板
+	 * @default true
 	 */
 	usePanel?: boolean;
 	/**
-	 * 弹幕列表
-	 *
-	 * @type {DanmuItem[]}
-	 * @memberof InitConfig
+	 * @brief 弹幕列表
+	 * @default -
 	 */
 	danmuItems?: DanmuItem[];
 	/**
 	 * @hidden
-	 *
 	 * @type {ExternalItem[]}
-	 * @memberof InitConfig
+	 * @memberof IDanmuConfig
 	 */
 	external?: ExternalItem[];
 	/**
 	 * @hidden
-	 *
-	 * @type {IMaskConfig}
-	 * @memberof InitConfig
 	 */
 	maskConfig?: IMaskConfig;
 	/**
 	 * @hidden
-	 *
-	 * @type {boolean}
-	 * @memberof InitConfig
 	 */
 	maskActive?: boolean;
 }
@@ -235,9 +212,9 @@ export interface Lang {
 	[props: string]: string;
 }
 /**
- * @detail Options
- *
- *
+ * @brief 弹幕项配置
+ * @list Options
+ * @kind property
  * @export
  * @interface DanmuItem
  */
@@ -258,9 +235,7 @@ export interface DanmuItem {
 	txt: string;
 	/**
 	 * 弹幕出现时间, 单位为ms
-	 *
-	 * @type {number}
-	 * @memberof DanmuItem
+	 * @default 0
 	 */
 	start?: number;
 	/**
@@ -272,6 +247,7 @@ export interface DanmuItem {
 	prior?: boolean;
 	/**
 	 * 弹幕持续显示时间, 单位为ms
+	 * @default 5000
 	 *
 	 * @type {number}
 	 * @memberof DanmuItem
@@ -279,16 +255,18 @@ export interface DanmuItem {
 	duration?: number;
 	/**
 	 * 弹幕样式
+	 * @example
+	 * ``` javascript
 	 * style : {
 	 *    color: '#ff9500',
 	 *    fontSize: '20px',
 	 *    padding: '2px 11px'
 	 * }
-	 *
+	 *```
 	 * @type {Partial<Record<Property, string>>}
 	 * @memberof DanmuItem
 	 */
-	style?: Partial<Record<Property, string>>;
+	style?: CSSStyleDeclaration;
 }
 export interface ExternalItem {
 	key: string;
@@ -297,10 +275,9 @@ export interface ExternalItem {
 	lang?: Lang;
 }
 /**
- * @detail Options
- *
- * @export
- * @interface ISubtitleConfig
+ * @brief 外挂字幕配置
+ * @list Options
+ * @kind property
  */
 export interface ISubtitleConfig {
 	/**
@@ -309,192 +286,164 @@ export interface ISubtitleConfig {
 	 */
 	[propName: string]: any;
 	/**
-	 * 图标位置
-	 * 默认值：controlsRight
-	 * @type {string}
-	 * @memberof ISubtitleConfig
+	 * @brief 图标位置
+	 * @default controlsRight
 	 */
 	position?: string;
 	/**
-	 * 图标排列权重
-	 * 默认值：6
-	 * @type {number}
-	 * @memberof ISubtitleConfig
+	 * @brief 图标排列权重
+	 * @default 6
 	 */
 	index?: number;
 	/**
-	 * 字幕列表
-	 * 默认值：无
-	 * @type {Array<SubTitleItem>}
-	 * @memberof ISubtitleConfig
+	 * @brief 字幕列表
+	 * @default -
 	 */
 	list?: Array<ISubTitleItem>;
 	/**
-	 * 是否默认打开
-	 * 默认值：true
-	 * @type {boolean}
-	 * @memberof ISubtitleConfig
+	 * @brief 是否默认打开
+	 * @default true
 	 */
 	isDefaultOpen?: boolean;
 	/**
-	 * 是否显示图标
-	 * 默认值：true
-	 * @type {boolean}
-	 * @memberof ISubtitleConfig
+	 * @brief 是否显示图标
+	 * @default true
 	 */
 	isShowIcon?: boolean;
 	/**
-	 * 字幕渲染模式，外挂字幕或原生字幕
-	 * 默认值：external
-	 * @type {string}
-	 * @memberof ISubtitleConfig
+	 * @brief 字幕渲染模式，外挂字幕或原生字幕
+	 * @default external
 	 */
 	mode?: "external" | "native";
 	/**
-	 * 字幕更新模式，默认vod
-	 * 默认值：vod
-	 * @type {string}
-	 * @memberof ISubtitleConfig
+	 * @brief 字幕更新模式，默认vod
+	 * @default vod
 	 */
 	updateMode?: "vod" | "live";
 	/**
-	 * 字幕样式
-	 * 默认值：无
-	 * @type {ISubtitleStyle}
-	 * @memberof ISubtitleConfig
+	 * @brief 字幕样式
+	 * @default -
 	 */
 	style?: ISubtitleStyle;
 }
 /**
- * @detail Options
- *
- * @export
- * @interface ISubtitleStyle
+ * @list Options
+ * @brief 字幕样式配置
+ * @kind property
  */
 export interface ISubtitleStyle {
 	/**
 	 * 是否跟随控制栏调整位置
-	 * 默认值：true
+	 * @default true
 	 * @type {boolean | null}
 	 * @memberof ISubtitleStyle
 	 */
 	follow: boolean | null;
 	/**
 	 * 字体显示模式，默认是描边
-	 * 默认值：'stroke'
+	 * @default 'stroke'
 	 * @type {'stroke' | 'bg'}
 	 * @memberof ISubtitleStyle
 	 */
 	mode?: "stroke" | "bg";
 	/**
 	 * 跟随底部控制栏的高度
-	 * 默认值：50
+	 * @default 50
 	 * @type {number}
 	 * @memberof ISubtitleStyle
 	 */
 	followBottom?: number;
 	/**
 	 * 是否跟随视频自动调整字号
-	 * 默认值：true
+	 * @default true
 	 * @type {boolean}
 	 * @memberof ISubtitleStyle
 	 */
 	fitVideo?: boolean;
 	/**
 	 * 字幕距离画面底部百分比
-	 * 默认值：4
+	 * @default 4
 	 * @type {number}
 	 * @memberof ISubtitleStyle
 	 */
 	offsetBottom?: number;
 	/**
 	 * 横屏视频适配基准字号
-	 * 默认值：49
+	 * @default 49
 	 * @type {number}
 	 * @memberof ISubtitleStyle
 	 */
 	baseSizeX?: number;
 	/**
 	 * 竖屏视频适配基准字号
-	 * 默认值：28
+	 * @default 28
 	 * @type {number}
 	 * @memberof ISubtitleStyle
 	 */
 	baseSizeY?: number;
 	/**
 	 * pc端最小字号
-	 * 默认值：16
+	 * @default 16
 	 * @type {number}
 	 * @memberof ISubtitleStyle
 	 */
 	minSize?: number;
 	/**
 	 * 移动端最小字号
-	 * 默认值：13
+	 * @default 13
 	 * @type {number}
 	 * @memberof ISubtitleStyle
 	 */
 	minMobileSize?: number;
 	/**
 	 * 最大显示行数
-	 * 默认值：'double'
+	 * @default double
 	 * @type {'double' | 'single' | 'three'}
 	 * @memberof ISubtitleStyle
 	 */
 	line?: "double" | "single" | "three";
 	/**
 	 * 字体颜色, 16位颜色值或rgb值
-	 * 默认值：'#fff'
+	 * @default #fff
 	 * @type {string}
 	 * @memberof ISubtitleStyle
 	 */
 	fontColor?: string;
 }
 /**
- * @detail Options
- *
- * @export
- * @interface ISubTitleItem
+ * @list Options
+ * @brief 字幕项配置
+ * @kind property
  */
 export interface ISubTitleItem {
 	/**
-	 * 字幕语言
-	 * 默认值：无
-	 * @type {string | number}
-	 * @memberof ISubTitleItem
+	 * @brief 字幕语言
+	 * @default -
 	 */
 	language?: string | number;
 	/**
-	 * 字幕id
-	 * 默认值：无
-	 * @type {string | number}
-	 * @memberof ISubTitleItem
+	 * @brief 字幕id
+	 * @default -
 	 */
 	id?: number | string;
 	/**
-	 * 是否是默认选择的字幕
-	 * 默认值：false
-	 * @type {boolean}
-	 * @memberof ISubTitleItem
+	 * @brief 是否是默认选择的字幕
+	 * @default false
 	 */
 	isDefault?: boolean;
 	/**
-	 * 字幕名称
-	 * 默认值：无
-	 * @type {any}
-	 * @memberof ISubTitleItem
+	 * @brief 字幕名称
+	 * @default -
 	 */
-	text?: any;
+	text?: string;
 	/**
-	 * 外挂字幕地址
-	 * 默认值：false
-	 * @type {string}
-	 * @memberof ISubTitleItem
+	 * @brief 外挂字幕地址
+	 * @default -
 	 */
 	url?: string;
 	/**
 	 * stringContent
-	 * 默认值：无
+	 * @default 无
 	 * @hidden
 	 * @type {string}
 	 * @memberof ISubTitleItem
@@ -502,15 +451,16 @@ export interface ISubTitleItem {
 	stringContent?: string;
 	/**
 	 * 字幕内容列表，非url形式时使用
-	 * 默认值：无
+	 * @default 无
 	 * @type {Array<Object>}
 	 * @memberof ISubTitleItem
 	 */
 	list?: IListItem[];
 }
 /**
- * @detail Options
- *
+ * @brief 字幕内容项配置
+ * @list Options
+ * @kind property
  * @export
  * @interface IListItem
  */
@@ -531,21 +481,20 @@ export interface IListItem {
 	 */
 	list: Array<ITextItem>;
 	/**
-	 * 默认值：无
+	 * @default 无
 	 * @hidden
 	 * @type {any}
 	 */
 	[propName: string]: any;
 }
 /**
- * @detail Options
- *
- * @export
- * @interface ITextItem
+ * @breif 字幕文案配置
+ * @list Options
+ * @kind property
  */
 export interface ITextItem {
 	/**
-	 * 默认值：无
+	 * @default 无
 	 * @hidden
 	 * @type {any}
 	 */
@@ -572,8 +521,9 @@ export interface ITextItem {
 	index?: number;
 }
 /**
- * @detail Options
- *
+ * @brief 清晰度自动降级配置
+ * @list Options
+ * @hidden
  *
  * @export
  * @interface IDefinitionDemotePlugin
@@ -622,38 +572,30 @@ export interface IDefinitionDemotePlugin {
 	demotePriority?: string[];
 }
 /**
- * @detail Options
- * @brief 更多options
- * @id 2
- *
-
-/**
- * dash播放配置想
- *
- * @detail Options
- * @export
- * @interface IDashPluginConfig
+ * @brief DASH 播放配置项
+ * @list Options
+ * @kind property
  */
 export interface IDashPluginConfig {
 	/**
-	 * 视频vid
-	 * 默认：无
-	 * 播放加密视频时必选
+	 * @brief 视频vid
+	 * @default -
+	 * @notice 播放加密视频时必选
 	 */
 	vid?: string;
 	/**
-	 * 播放类型
-	 * 默认：`TOP`
-	 * 非必选
+	 * @hidden
+	 * @brief 播放类型
+	 * @default TOP
 	 */
 	playInfoType: "TOP";
 	/**
-	 * 清晰度映射文案
-	 * 默认：无
-	 * 非必选
+	 * @brief 清晰度映射文案
+	 * @default -
 	 * @example
 	 * ``` javascript
-	 * { 360p: "流畅 360p",
+	 * {
+	 *   360p: "流畅 360p",
 	 *   480p: "清晰 480p",
 	 *   720p: "高清 720p",
 	 *   1080p: "超高清 1080p"
@@ -662,26 +604,19 @@ export interface IDashPluginConfig {
 	 */
 	definitionText: Record<string, string>;
 	/**
-	 * 默认清晰度
-	 * 默认：列表第一个
-	 * 非必选
-	 * @example
-	 * ``` javascript
-	 * { 360p: "流畅 360p",
-	 *   480p: "清晰 480p",
-	 *   720p: "高清 720p",
-	 *   1080p: "超高清 1080p"
-	 * }
-	 * ```
+	 * @brief 默认清晰度
+	 * @default 列表第一个
 	 */
 	defaultDefinition?: string;
 	/**
+	 * @hidden
 	 * 获取证书地址
 	 * 默认：`//i.snssdk.com/video/drm/v1/play_licenses`
 	 * 播放加密视频时必选
 	 */
 	getLicenseUrl?: string;
 	/**
+	 * @hidden
 	 * dash播放信息，由`Service.url`服务接口获取
 	 * 默认：无
 	 * 必选
@@ -690,17 +625,16 @@ export interface IDashPluginConfig {
 		Data: any;
 	};
 	/**
-	 * 兜底的mp4播放列表，由`Service.url`服务接口获取
-	 * 默认：无
-	 * 非必选
+	 * @brief 兜底的mp4播放列表，由`Service.url`服务接口获取
+	 * @default -
+	 * @hidden
 	 */
 	mp4Opts: {
 		mp4List: mp4OptsItem[];
 	};
 	/**
 	 * 预加载时间，单位ms
-	 * 默认：undefined
-	 * 非必选
+	 * @default 50
 	 */
 	preloadTime?: number;
 	/**
@@ -728,11 +662,9 @@ export interface IDashPluginConfig {
 	url_range_domains?: string[];
 }
 /**
- * dash播放的mp4兜底播放列表配置
- *
- * @detail Options
- * @export
- * @interface mp4OptsItem
+ * @brief dash播放的mp4兜底播放列表配置
+ * @list Options
+ * @hidden
  */
 export interface mp4OptsItem {
 	/**
@@ -749,217 +681,207 @@ export interface mp4OptsItem {
 	url: string;
 }
 /**
- * DASH播放配置
- *
- * @detail Options
- * @export
- * @interface IDashPluginConfig
+ * @brief HLS加密播放配置
+ * @list Options
+ * @kind property
  */
 export interface IEncryptHlsPluginConfig {
-	/**
-	 * 播放地址请求域名
-	 * 默认：无
-	 * 必选
+	/** {zh}
+	 * @brief 获取播放地址的请求域名。
+	 * @default https://vod.volcengineapi.com
 	 */
-	playDomain: string;
-	/**
-	 * 请求类型，固定值 'TOP'
-	 * 默认： 无
+	/** {en}
+	 * @brief Get the requested domain name of the playback address
+	 * @default https://vod.byteplusapi.com
 	 */
-	getKeyType: string;
+	playDomain?: string;
 	/**
-	 * 密钥请求域名
-	 * 默认：无
-	 * 必选
+	 * @hidden
+	 * @brief 请求类型，固定值 'TOP'
+	 * @default TOP
 	 */
-	keyDomain: string;
+	getKeyType?: string;
 	/**
-	 * 播放地址获取token，由服务端生成下发，详见{@link https://www.volcengine.com/docs/4/67350#%E4%B8%B4%E6%97%B6%E5%AE%89%E5%85%A8%E5%87%AD%E8%AF%81%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E 播放临时安全凭证（PlayAuthToken）}
-	 * 默认：无
-	 * 必选
+	 * @hidden
+	 * @brief 密钥请求域名
+	 * @default https://vod.volcengineapi.com
 	 */
-	playAuthToken: string;
+	keyDomain?: string;
 	/**
-	 * 密钥获取token，由服务端生成下发，详见{@link https://www.volcengine.com/docs/4/65659#%E7%AD%BE%E5%8F%91-hls-%E6%A0%87%E5%87%86%E5%8A%A0%E5%AF%86-authtoken%EF%BC%88sha1hlsdrmauthtoken%EF%BC%89 签发 Hls 标准加密AuthToken}
-	 * 默认：无
-	 * 必选
+	 * @brief 播放地址获取token，由服务端生成下发，详见{@link https://www.volcengine.com/docs/4/67350#%E4%B8%B4%E6%97%B6%E5%AE%89%E5%85%A8%E5%87%AD%E8%AF%81%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E 播放临时安全凭证（PlayAuthToken）}
+	 * @default -
 	 */
-	keyToken: string;
+	playAuthToken?: string;
 	/**
-	 * hls加密播放地址
-	 * 默认：无
+	 * @brief 密钥获取token，由服务端生成下发，详见{@link https://www.volcengine.com/docs/4/65659#%E7%AD%BE%E5%8F%91-hls-%E6%A0%87%E5%87%86%E5%8A%A0%E5%AF%86-authtoken%EF%BC%88sha1hlsdrmauthtoken%EF%BC%89 签发 Hls 标准加密AuthToken}
+	 * @default -
 	 */
-	url?: string;
+	keyToken: string;
 }
 /**
- * 质量日志配置
- *
- * @detail Options
- * @export
- * @interface IVodLogOptsConfig
+ * @brief 质量日志配置
+ * @list Options
+ * @kind property
  */
 export interface IVodLogOptsConfig {
 	/**
-	 * 表示业务来源，使用业务自己的appid即可
-	 * 默认：无
-	 * 必选
+	 * @brief 视频点播应用 ID。您可在视频{@link https://console.volcengine.com/vod/region:vod+cn-north-1/sdk/app/ 点播控制台 > 点播SDK > 应用管理}页面获取应用 ID（App ID）。
+	 * @default -
 	 */
 	line_app_id: number;
 	/**
-	 * 用于识别单一用户的id
-	 * 默认：无
-	 * 必选
+	 * @brief 用于识别单一用户的 ID，可在{@link https://www.volcengine.com/docs/4/75736#qoe-%E6%8C%87%E6%A0%87%E8%AF%B4%E6%98%8E QoE指标}中用于用户维度的筛选，也可以用于{@link https://www.volcengine.com/docs/4/106093 单点追查} 查找单用户的播放日志
+	 * 用户 ID 对应于单点追查功能的查询条件中的设备 ID 维度。如不设置用户 ID，VePlayer 将根据用户浏览器随机生成一个值，该值会在浏览器端缓存。
+	 * @notice 强烈建议您使用与业务相关的用户 ID，以便在发生播放错误时通过{@link https://console.volcengine.com/vod/region:vod+cn-north-1/quality_control/SingleTracing/?Tab=play 点播控制台 > 质量平台 > 单点追查}功能排查故障。
+	 * @default -
 	 */
 	line_user_id: string | number;
 	/**
-	 * 视频类型
-	 * 默认：无
-	 * 必选
+	 * @hidden
+	 * @brief 视频类型
+	 * @default MP4
 	 */
 	vtype?: "MP4" | "HLS" | "DASH" | "FLV";
 	/**
-	 * 自定义标签，对应控制台"业务维类型"维度
-	 * 默认：`default`
-	 * 必选
+	 * @brief 业务标签。对应于质量平台上的业务类型维度，其作用是区分业务中的不同场景，以便进行多维度分析。举例来说，假设您的应用中包含短视频和长视频两个场景，则可分别将 `tag` 设为 `short` 和 `long`。这样一来，您就能够在{@link https://www.volcengine.com/docs/4/120175 质量平台}上通过业务标签维度查询或过滤不同场景的数据。
+	 * @notice 如需自定义配置 tag 值在点播控制台上的展示文案，请联系{@link https://www.volcengine.com/docs/4/108992#%E5%94%AE%E5%90%8E%E6%94%AF%E6%8C%81 技术支持}
+	 * @default 普通视频
 	 */
 	tag?: string;
 	/**
-	 * 自定义子标签，对应控制台"自定义标签"维度
-	 * 默认：`default`
-	 * 必选
+	 * @brief 自定义子标签。对应于质量平台上的自定义标签维度，与 `tag` 配合使用，可用于区分同一业务类型下更为细分的音视频类型，比如加密视频、非加密视频、音频等。
+	 * @default -
 	 */
 	subtag?: string;
 	/**
-	 * 视频解码器类型名称
-	 * 默认：`h264`
-	 * 必选
+	 * @brief 视频编码类型，取值如下
+	 * - `h264`：H.264
+	 * - `h265`：H.265
+	 * @default unknown
 	 */
 	codec_type?: "h264" | "h265";
 	/**
-	 * 是否加密，0:非drm视频，1：drm视频
-	 * 默认：`0`
-	 * 可选
+	 * @brief 是否加密，0:非drm视频，1：drm视频
+	 * @hidden
+	 * @default 0
 	 */
 	drm_type?: 0 | 1;
 	/**
-	 * 播放内核版本号
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 播放内核版本号
 	 */
 	playerCoreVersion?: string;
 	/**
-	 * 播放器版本号
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 播放器版本号
 	 */
 	playerVersion?: string;
 	/**
-	 * DASH播放的封装类型
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief DASH播放的封装类型
 	 */
 	dynamic_type?: "segment_base" | "segment_template";
 	/**
-	 * 是否使用bash，0:不使用，1：使用
-	 * 默认：`0`
-	 * 可选
+	 * @hidden
+	 * @brief 是否使用bash，0:不使用，1：使用
+	 * @default 0
 	 */
 	enable_bash?: 0 | 1;
 	/**
-	 * 发送的埋点日志是本地缓存的时候回调
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 发送的埋点日志是本地缓存的时候回调
+	 * @default -
 	 */
 	sendLocalCallback?: (event: any, data: any) => void;
 	/**
-	 * 是否禁用localStorage暂时缓存onPlay逻辑
-	 * 默认：`false`
-	 * 可选
+	 * @hidden
+	 * @brief 是否禁用localStorage暂时缓存onPlay逻辑
+	 * @default false
 	 */
 	disableLocalCache?: boolean;
 	/**
-	 * 数据上报渠道，可选值：cn(国内)、va(美东) 、sg(新加坡)
-	 * 默认：`cn`
-	 * 可选
+	 * @hidden
+	 * @brief 数据上报渠道，可选值：cn(国内)、va(美东) 、sg(新加坡)
+	 * @default cn
 	 */
 	channel?: "cn" | "va" | "sg";
 	/**
-	 * 是否关闭清晰度切换埋点
-	 * 默认：`false`
-	 * 可选
+	 * @hidden
+	 * @brief 是否关闭清晰度切换埋点
+	 * @default false
 	 */
 	closeResolutionLog?: boolean;
 	/**
-	 * 关闭seek相关埋点
-	 * 默认：`false`
-	 * 可选
+	 * @hidden
+	 * @brief 关闭seek相关埋点
+	 * @default false
 	 */
 	closeSeekLog?: boolean;
 	/**
-	 * 队列超过多少条日志的时候发送
-	 * 默认：`5`
-	 * 可选
+	 * @hidden
+	 * @brief 队列超过多少条日志的时候发送
+	 * @default 5
 	 */
 	maxQueueCount?: number;
 }
 /**
- * mp4加密日志配置项
- *
- * @detail Options
- * @export
- * @interface IMp4EncryptPlayerConfig
+ * @brief mp4加密日志配置项
+ * @list Options
+ * @hidden
  */
 export interface IMp4EncryptPlayerConfig {
 	/**
-	 * 是否加密
-	 * 默认：`false`
-	 * 可选
+	 * @hidden
+	 * @brief 是否加密
+	 * @default false
 	 */
 	isEncrypt?: boolean;
 	/**
-	 * 视频vid
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 视频vid
+	 * @default -
 	 */
 	vid?: string;
 	/**
-	 * 视频密钥 id
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 视频密钥 id
+	 * @default -
 	 */
 	kid?: string;
 	/**
-	 * 获取密钥凭证地址
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 获取密钥凭证地址
+	 * @default -
 	 */
 	getLicenseUrl?: string;
 	/**
-	 * 是否使用EME
-	 * 默认：`false`
-	 * 可选
+	 * @hidden
+	 * @brief 是否使用EME
+	 * @default false
 	 */
 	useEME?: boolean;
 	/**
-	 * 视频密钥值
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 视频密钥值
+	 * @default -
 	 */
 	keyValue?: string;
 	/**
-	 * 加密后的视频密钥值
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief 加密后的视频密钥值
+	 * @default -
 	 */
 	secretKey?: string;
 	/**
-	 * 是否携带cookie
+	 * @hidden
+	 * @brief 是否携带cookie
+	 * @default false
 	 */
 	withCredentials?: boolean;
 	/**
-	 * drm内容
-	 * 默认：无
-	 * 可选
+	 * @hidden
+	 * @brief drm内容
+	 * @default -
 	 */
 	drm?: {
 		clearKeys: {
@@ -967,6 +889,9 @@ export interface IMp4EncryptPlayerConfig {
 		};
 	};
 }
+/**
+ * @hidden
+ */
 export declare type IDefinition = {
 	[propName: string]: any;
 	url: any;
@@ -980,6 +905,9 @@ export declare type IDefinition = {
 		[propName: string]: any;
 	};
 };
+/**
+ * @hidden
+ */
 export declare type IPlayerOptions = {
 	[propName: string]: any;
 	id?: string;
@@ -1093,11 +1021,35 @@ export declare type IPlayerOptions = {
 		volumeColor?: string;
 	};
 };
+/**
+ * @brief 自动播放配置
+ * @list Options
+ * @kind property
+ */
 export interface IAutoplayPluginConfig {
+	/**
+	 * @hidden
+	 */
 	position?: string;
+	/**
+	 * @brief 有声音自动播放失败时是否降级成静音自动播放
+	 * @default false
+	 */
 	enableDegradeMuteAutoplay?: boolean;
+	/**
+	 * @brief 启用微信jsBridge方式的自动播放
+	 * @default false
+	 */
 	enableWxJsBridgeAutoplay?: boolean;
+	/**
+	 * @brief 用户触发自动播放的目标dom
+	 * @default window.document.body
+	 */
 	userActionDom?: Node;
+	/**
+	 * @brief 开启任意点击/触摸的用户行为触发自动播放
+	 * @default false
+	 */
 	enableUserActionAutoplay?: boolean;
 }
 declare class PlayList {
@@ -1123,6 +1075,11 @@ export declare const enum TOGGLE_MODES {
 	CLICK = "click",
 	HOVER = "hover"
 }
+/**
+ * @list Options
+ * @brief 播放列表项配置，支持 DirectUrl 和 Vid + playAuthToken 两种播放模式。
+ * @kind property
+ */
 export interface IPlayListItem {
 	url?: string;
 	playAuthToken?: string;
@@ -1134,14 +1091,51 @@ declare enum EPlayMode {
 	ORDER = "order",
 	LOOP = "loop"
 }
+/**
+ * @list Options
+ * @brief 播放列表插件配置项
+ * @kind property
+ */
 export interface IPlayListConfig {
+	/**
+	 * @brief 图标位置
+	 * @default controlsLeft 控制栏左侧
+	 */
 	position?: string;
+	/**
+	 * @brief 图标位置权重
+	 * @default 20
+	 */
 	index?: number;
+	/**
+	 * @brief 列表数据
+	 * @default []
+	 */
 	list: IPlayListItem[];
+	/**
+	 * @brief 循环模式
+	 * @default order
+	 */
 	mode?: EPlayMode;
+	/**
+	 * @brief 默认起始播放序号
+	 * @default order
+	 */
 	defaultIndex?: number;
+	/**
+	 * @brief 列表点击之后是否隐藏列表
+	 * @default true
+	 */
 	isItemClickHide?: boolean;
+	/**
+	 * @brief 列表行为触发模式
+	 * @default click 点击
+	 */
 	toggleMode?: TOGGLE_MODES;
+	/**
+	 * @brief 是否显示图标
+	 * @default true
+	 */
 	isShowIcon?: boolean;
 }
 export declare class PlayListPlugin extends Plugin {
@@ -1251,8 +1245,17 @@ export interface IPlayInfoList {
 	Width: number;
 }
 declare enum CodecType {
+	/**
+	 * @brief H.265
+	 */
 	H265 = "h265",
+	/**
+	 * @brief H.264
+	 */
 	H264 = "h264",
+	/**
+	 * @brief 未知编码
+	 */
 	UNKNOWN = "unknown"
 }
 declare enum RTMCodec {
@@ -1265,7 +1268,6 @@ export interface IMusicListItem {
 	 * 音乐地址
 	 *
 	 * @type {string}
-	 * @memberof IMusicListItem
 	 */
 	src: string;
 	/**
@@ -1289,11 +1291,20 @@ export interface IMusicListItem {
 	 * @memberof IMusicListItem
 	 */
 	title?: string;
+	/**
+	 * @hidden
+	 */
 	[propName: string]: any;
 }
+/**
+ * @brief 循环播放配置
+ * @list Options
+ * @kind property
+ */
 export interface IABCycle {
 	/**
 	 * AB循环段开始时间
+	 * @default 0
 	 *
 	 * @type {boolean}
 	 * @memberof IABCycle
@@ -1301,6 +1312,7 @@ export interface IABCycle {
 	start: number;
 	/**
 	 * AB循环段结束时间
+	 * @default 音乐结束时间点
 	 *
 	 * @type {boolean}
 	 * @memberof IABCycle
@@ -1308,16 +1320,26 @@ export interface IABCycle {
 	end: number;
 	/**
 	 * AB段是否循环播放
+	 * @default false
 	 *
 	 * @type {boolean}
 	 * @memberof IABCycle
 	 */
 	loop?: boolean;
+	/**
+	 * @hidden
+	 */
 	[propName: string]: any;
 }
+/**
+ * @list Options
+ * @brief 音乐播放模式配置
+ * @kind property
+ */
 export interface IMusicConfig {
 	/**
 	 * 是否启用离线下载播放
+	 * @default false
 	 *
 	 * @type {boolean}
 	 * @memberof IMusicConfig
@@ -1325,6 +1347,7 @@ export interface IMusicConfig {
 	offline?: boolean;
 	/**
 	 * AB循环设置
+	 * @default null
 	 *
 	 * @type {IABCycle}
 	 * @memberof IMusicConfig
@@ -1332,6 +1355,7 @@ export interface IMusicConfig {
 	abCycle?: IABCycle | null;
 	/**
 	 * 快进快退时间跨度
+	 * @default 15
 	 *
 	 * @type {number}
 	 * @memberof IMusicConfig
@@ -1339,6 +1363,7 @@ export interface IMusicConfig {
 	timeScale?: number;
 	/**
 	 * 循环模式
+	 * @default order
 	 *
 	 * @type {('order' | 'sloop' | 'loop' | 'random')}
 	 * @memberof IMusicConfig
@@ -1346,16 +1371,21 @@ export interface IMusicConfig {
 	mode?: PlayModeType;
 	/**
 	 * 播放列表
+	 * @default []
 	 *
 	 * @type {Array<IMusicListItem>}
 	 * @memberof IMusicConfig
 	 */
 	list?: Array<IMusicListItem>;
+	/**
+	 * @hidden
+	 */
 	[propName: string]: any;
 }
 /**
- * @detail Options
+ * @list Options
  * @brief 播放地址列表， 可配置多线路和多清晰度
+ * @kind property
  *
  * @export
  * @interface Stream
@@ -1398,17 +1428,12 @@ export interface Stream extends Partial<IPlayInfoList> {
 	 */
 	definitionTextKey?: string;
 	/**
-	 * 编码格式
-	 *
-	 * @type {('h265' | 'h264')}
-	 * @memberof Stream
+	 * @brief 编码格式
+	 * @default unknown
 	 */
 	codec?: CodecType;
 	/**
 	 * 线路唯一id
-	 *
-	 * @type {(number | string)}
-	 * @memberof Stream
 	 */
 	lineId?: number | string;
 	/**
@@ -1426,14 +1451,24 @@ export interface Stream extends Partial<IPlayInfoList> {
 	 * @memberof Stream
 	 */
 	lineTextKey?: string;
+	/**
+	 * @hidden
+	 */
 	[propName: string]: any;
 }
+/**
+ * @hidden
+ */
 export interface Condition {
 	definition?: string;
 	lineId?: number | string;
+	/**
+	 * @hidden
+	 */
 	[propName: string]: any;
 }
 /**
+ * @hidden
  * @description 播放器当前状态
  */
 export interface Current {
@@ -1442,110 +1477,295 @@ export interface Current {
 	language: string;
 	lineId?: number | string;
 	codec?: CodecType;
+	/**
+	 * @hidden
+	 */
 	[propName: string]: any;
 }
 /**
- * @detail Options
- * @id 1
- * @brief options参数列表:
- * 本文档是介绍火山引擎直播和点播播放器VePlayer的相关参数和Api。
+ * @list Options
+ * @kind property
+ * @brief 实例化参数配置项
  */
 export interface IPlayerConfig extends IPlayerOptions {
-	/**
-	 * 是否是直播，默认为false
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 是否是直播，默认为false
+	 * @default false
+	 * @hidden
 	 */
 	isLive?: boolean;
-	/**
-	 * 播放器容器id，VePlayer将被插入在该容器中
-	 *
-	 * @notes id和root必填一个
-	 * @type {string}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 播放器容器id，VePlayer将被插入在该容器中
+	 * @notes `id`和`root`参数至少传入 1 个。
+	 * @default -
 	 */
 	id?: string;
-	/**
-	 * 播放器容器，VePlayer将被插入在该容器中
-	 *
-	 * @type {HTMLElement}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 播放器容器DOM元素，VePlayer将被插入在该容器中
+	 * @notes `id`和`root`参数至少传入 1 个。
+	 * @default -
 	 */
 	root?: HTMLElement;
-	/**
-	 * 播放地址
-	 * 直播可通过 {@link https://console.volcengine.com/live/main/locationGenerate 视频直播控制台} 生成
-	 *
-	 * @type {string}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 视频地址
+	 * @default -
 	 */
 	url?: string;
-	/**
-	 * 播放地址类型，可以选值为“rtm”/“flv”/“mp4”/“hls”
-	 * @notes 播放地址带后缀的则streamType非必填，否则为必填
+	/** {zh}
+	 * @brief vid播放配置项
+	 * @notes 需要业务方服务端通过vid生成临时playAuthToken
 	 *
-	 * @type {(''mp4' | 'hls' | 'dash' | 'rtm' | 'flv')}
+	 * @type {IPlayAuthTokenConfig}
 	 * @memberof IPlayerConfig
 	 */
+	getVideoByToken?: IPlayAuthTokenConfig;
+	/** {zh}
+	 * @brief 视频格式/协议类型。取值如下：
+	 *  - `mp4`
+	 *  - `hls`
+	 *  - `dash`
+	 *  - `flv`
+	 * @notes 如果`url`参数视频地址不包含文件格式后缀，则`streamType`必传。
+	 */
 	streamType?: "mp4" | "hls" | "dash" | "rtm" | "flv";
-	/**
-	 * 是否总是显示清晰度切换控件，即只有一个清晰度时也显示清晰度切换控件
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 播放器宽度，可以是数字或者css width 属性值，是数字时单位是`px`
+	 * @default 100%
+	 */
+	width?: number | string;
+	/** {zh}
+	 * @brief 播放器高度，可以是数字或者css width 属性值，是数字时单位是`px`
+	 * @default 100%
+	 */
+	height?: number | string;
+	/** {zh}
+	 * @brief 默认音量
+	 * @default 0.6
+	 */
+	volume?: number;
+	/** {zh}
+	 * @brief 是否自动播放。取值如下：
+	 *  - `true`：是
+	 *  - `false`：否
+	 * @default false
+	 * @notice 受限制于浏览器策略，自动播放不一定能成功，取决于浏览器环境、用户行为、浏览器配置等，详细参考自动播放 @link https://www.volcengine.com/docs/4/68693#%E8%87%AA%E5%8A%A8%E6%92%AD%E6%94%BE
+	 */
+	autoplay?: boolean;
+	poster?: string | IPoster;
+	/** {zh}
+	 * @brief 是否开启静音自动播放。取值如下：
+	 *  - `true`：是
+	 *  - `false`：否
+	 *  @default false
+	 */
+	autoplayMuted?: boolean;
+	/** {zh}
+	 * @brief 有声音自动播放失败时是否降级成静音自动播放，默认不降级
+	 *  - `true`：是，降级
+	 *  - `false`：否，不降级
+	 * @default false
+	 */
+	enableDegradeMuteAutoplay?: boolean;
+	/** {zh}
+	 * @brief 启用微信jsBridge方式的自动播放，默认不开启
+	 *  - `true`：是，降级
+	 *  - `false`：否，不降级
+	 * @default false
+	 */
+	enableWxJsBridgeAutoplay?: boolean;
+	/** {zh}
+	 * @brief 开启任意点击的用户行为触发自动播放，默认不开启
+	 *  - `true`：是，开启
+	 *  - `false`：否，不开启
+	 * @default false
+	 */
+	enableUserActionAutoplay?: boolean;
+	/** {zh}
+	 * @brief 是否开启循环播放。
+	 *  - `true`：是，开启
+	 *  - `false`：否，不开启
+	 *  @default false
+	 */
+	loop?: boolean;
+	/** {zh}
+	 * @brief 默认起播倍速。参考值 0.5/0.75/1/1.5/2
+	 * @default 1
+	 */
+	defaultPlaybackRate?: number;
+	/** {zh}
+	 * @brief 国际化语言。支持自定义，默认语言类型包括：
+	 * - `zh` 或 `zh-cn`
+	 * - `en`
+	 * - `jp`
+	 * - `zh-hk`
+	 * @default zh
+	 */
+	lang?: "zh" | "zh-cn" | "en" | "jp" | "zh-hk";
+	/** {zh}
+	 * @brief 自定义多语言词典。可设置每个语种的词典 `{ [key: string]: Object; }`。例如：
+	 * ```javascript
+	 * {
+	 *    zh: {
+	 *        PIP: '画中画'
+	 *    },
+	 *    en: {
+	 *        PIP: 'pip'
+	 *    }
+	 * }
+	 * ```
+	 * @notice
+	 * @see 了解更多，请参见{@link https://www.volcengine.com/docs/6469/127529 默认词典}。
+	 */
+	languages?: {
+		[key: string]: Record<string, any>;
+	};
+	/** {zh}
+	 * @brief 画中画配置
+	 * @default PC: {position: 'controlsRight', index: 2.5, showIcon: true}; mobile：false
+	 * @notice 画中画功能由浏览器提供，如果本身浏览器不支持，即使有该配置也不显示画中画按钮
+	 */
+	pip?: IPIPConfig | boolean;
+	/** {zh}
+	 * @brief 全屏相关配置
+	 * @default {position: 'controlsRight', index: 0, rotateFullscreen: false, useCssFullscreen: false, target: null, switchCallback: null, disable: false, needBackIcon: false }
+	 */
+	fullscreen?: IFullscreenConfig;
+	/** {zh}
+	 * @breif 是否总是显示清晰度切换控件，即只有一个清晰度时也显示清晰度切换控件
+	 * @default false
 	 */
 	alwaysShowDefinition?: boolean;
-	/**
-	 * url对应视频的清晰度文案，仅alwaysShowDefinition为true时有效
-	 *
-	 * @type {string}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @breif url对应视频的清晰度文案，仅`alwaysShowDefinition`为`true`时有效
+	 * @default HD
 	 */
 	definitionText?: string;
-	/**
-	 * url对应视频的清晰度文案的多语言key，对应参数 languages 中相对应的文案，仅alwaysShowDefinition为true时有效，优先级高于definitionText
-	 *
-	 * @type {string}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief url对应视频的清晰度文案的多语言key，对应参数 languages 中相对应的文案，仅alwaysShowDefinition为true时有效，优先级高于definitionText
+	 * @default -
 	 */
 	definitionTextKey?: string;
-	/**
-	 * 视频编码方式
+	/** {zh}
+	 * @brief 视频编码方式
 	 * 软解useSoftDecoding设置为true时，提供codec可提升软解初始效率
-	 *
-	 * @type {CodecType}
-	 * @memberof IPlayerConfig
+	 * @notice 在已知视频编码方式的情况下推荐传入，以方便日志分析
 	 */
-	codec?: CodecType;
-	/**
-	 * 区域，影响服务接口和日志上报
-	 * @volcengine/veplayer默认区域为cn， @byteplus/veplayer默认区域为sg
-	 * 火山引擎海外区域播放时请填写'sg'
-	 *
-	 * @type {TRegionType}
-	 * @memberof IPlayerConfig
+	codec?: `${CodecType}`;
+	/** {zh}
+	 * @brief 点播服务所在区域，影响服务接口和日志上报
+	 * @default cn
+	 * @notice 火山引擎海外区域播放时请填写'mya'
+	 * @hidden
+	 */
+	/** {en}
+	 * @brief The area where the on-demand service is located affects the service interface and log reporting.
+	 * @default sg
+	 * @hidden
 	 */
 	region?: TRegionType;
-	/**
-	 * 多语言配置key，影响播放器文案的语言种类
-	 * @type {'zh' | 'zh-cn' | 'en' | 'jp' | 'zh-hk'}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 插件加载公共路径，用于指定插件的加载路径，或者本地文件服务加载插件
+	 * @default https://lf-unpkg.volccdn.com/obj/vcloudfe/sdk/@volcengine/veplayer/${version}/plugin
+	 * @notice 可将插件文件夹置于业务方服务器上，指定插件的地址即可
 	 */
-	lang?: "zh" | "zh-cn" | "en" | "jp" | "zh-hk";
-	/**
-	 * 插件加载公共路径，用于指定插件的加载路径，或者本地文件服务加载插件
-	 *
-	 * @type {(string)}
-	 * @memberof IPlayerConfig
+	/** {en}
+	 * @brief plug loading public path, used to specify the loading path of the plug-in, or the local file service to load the plug-in
+	 * @default https://sf-unpkg.bytepluscdn.com/obj/byteplusfe-sg/sdk/@byteplus/veplayer/${version}/plugin
+	 * @notice can place the plug-in folder on the business server and specify the address of the plug-in.
 	 */
 	pluginPublicPath?: string;
 	/**
-	 * 是否音乐播放器模式
+	 * @brief 开始播放时间
+	 * @default -
+	 */
+	startTime?: number;
+	/** {zh}
+	 * @brief 为播放器设置是否启用内联播放模式。playsinline 属性是 HTML5 视频标签的一个属性，用于指定视频是否应在页面文档内播放。
+	 * - `true`：启用，表示视频将在页面文档内播放；
+	 * - `false`：停用，默认浏览器播放行为。</br>
 	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	 * 该配置项只在移动端生效，当取值为 true 的时候，会在初始化 video 或 audio 对象的时候，将 playsinline、webkit-playsinline、x5-playsinline 三个属性设置为 true，请参考 [New Policies for iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/) 了解内联模式相关知识。
+	 * @listtip
+	 * - iOS 10 及以上系统 Safari 浏览器支持配置内联播放模式；
+	 * - iOS 10 以下系统 Safari 浏览器不支持配置内联播放模式 ，默认播放即进入系统全屏。
+	 * @default true
+	 */
+	playsinline?: boolean;
+	/** {zh}
+	 * @brief 为播放器设置 video 标签扩展属性，初始化时会设置在 videoElement 或 audioElement 对象上，请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
+	 * @default 无
+	 */
+	videoAttributes?: Partial<HTMLVideoElement>;
+	/** {zh}
+	 * @brief 为播放器设置是否启用流式布局，启用流式布局后播放器会根据屏幕的宽度进行调整，保持在不同屏幕尺寸上都有良好的显示效果。
+	 * - `true`：启用
+	 * - `false`：停用
+	 * @listtip
+	 * 启用流式布局时：
+	 * - 如果 `width` 和 `height` 是 `Number` 类型，则按照其数值计算播放器宽高比；
+	 * - 如果 `width` 和 `height` 不是 `Number` 类型，默认使用 16:9 比例。
+	 * @default false
+	 */
+	fluid?: boolean;
+	/** {zh}
+	 * @brief 为播放器设置尺寸适配方式，在视频资源初始化之后，根据获取到的 videoWidth 和 videoHeight 值对播放器容器宽高比例进行调整，可选项有：
+	 * - `fixed`: 保持容器宽/高，不做适配；
+	 * - `fixWidth`: 保持容器宽度，适配高度；
+	 * - `fixHeight`: 保持容器高度，适配宽度。
+	 *
+	 * @default fixed
+	 */
+	fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
+	/** {zh}
+	 * @brief 为播放器设置视频画面填充模式，可选项有：
+	 * - `fillwidth`: 填充宽度，高度溢出则裁剪高度；
+	 * - `fillHeight`: 填充高度，宽度溢出则裁剪宽度；
+	 * - `fill`: 拉伸视频以填充容器；
+	 * - `cover`: 保持其宽高比的同时填充元素的整个内容框；
+	 * - `auto`: 使用浏览器默认的视频画面填充模式。
+	 * @default auto
+	 */
+	videoFillMode?: "auto" | "fillHeight" | "fillWidth" | "fill" | "cover";
+	/** {zh}
+	 * @brief 是否开启画面和控制栏分离模式。设置为开启时，控制栏将会常驻，与视频画面不重叠。
+	 * - `true`：开启
+	 * - `false`：关闭
+	 * @default false
+	 */
+	marginControls?: boolean;
+	/** {zh}
+	 *  @brief 启用x5内核浏览器的同层播放。
+	 * @default 无
+	 */
+	"x5-video-player-type"?: string;
+	/** {zh}
+	 *  @brief 是否启用x5内核浏览器的全屏播放模式。
+	 * - `true`：启用
+	 * - `false`：停用
+	 * @default 无
+	 */
+	"x5-video-player-fullscreen"?: boolean;
+	/** {zh}
+	 *  @brief x5内核浏览器的横竖屏控制，支持如下取值：
+	 * - `landscape`：横屏
+	 * - `portrait`：竖屏
+	 * - `landscape|portrait`：跟随手机自动旋转
+	 * @default mobile：`landscape|portrait`，pc：-
+	 */
+	"x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
+	/** {zh}
+	 * @brief 为播放器配置关键点样式。
+	 * @default 无
+	 * @hidden 直播目前没用到
+	 */
+	commonStyle?: ICommonStyle;
+	/** {zh}
+	 * @brief 是否启用音乐播放器模式
+	 * @default `false`
 	 */
 	isMusic?: boolean;
-	/**
+	/** {zh}
+	 * @hidden
 	 * 是否开启播放器原生控件菜单（右键触发）
 	 * @default false 默认不开启
 	 *
@@ -1553,249 +1773,177 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @memberof IPlayerConfig
 	 */
 	enableContextmenu?: boolean;
-	/**
-	 * 关闭video上的阻止事件传播
-	 * @default false 默认不阻止
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 是否关闭video上的阻止事件传播
+	 * @default `false`
 	 */
 	closeVideoStopPropagation?: boolean;
-	/**
-	 * 右键菜单是否可用，启用后enableContextmenu强制为false
-	 * @default false 默认不可用
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 右键菜单是否可用
+	 * @default `false`
 	 */
 	enableMenu?: boolean;
-	/**
-	 * 是否开启hls的MSE模式，仅移动端生效，开启后采用MSE方式播放HLS，默认在移动端使用原生video播放hls
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 是否开启hls的MSE模式，
+	 * @notice 仅移动端生效，开启后采用MSE方式播放HLS，默认在移动端使用原生video播放hls
 	 */
 	enableHlsMSE?: boolean;
-	/**
-	 * 在PC Safari上是否不使用hls插件播放，默认true。true: 启用；false: 不启用
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 在PC Safari上是否使用hls插件播放
+	 * - true: 使用；
+	 * - false: 不使用
+	 * @default `true`
 	 */
 	useHlsPluginForSafari?: boolean;
-	/**
-	 * 是否开启mp4的MSE模式，开启后采用MSE方式播放MP4，
-	 * 同时带来精确的seek加载、视频的无缝切换、流量节省等功能
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 是否开启mp4的MSE模式，开启后采用MSE方式播放MP4，
+	 * mp4的MSE模式具有精确的seek加载、视频的无缝切换、流量节省等功能
+	 * @default `false`
 	 */
 	enableMp4MSE?: boolean;
-	/**
-	 * 播放列表
+	/** {zh}
+	 * @brief 播放列表
 	 * @notes url和playList必填一个，二者都传入时， url必须在playList中。
-	 *
-	 * @type {Stream[]}
-	 * @memberof IPlayerConfig
+	 * @default -
 	 */
 	playList?: Stream[];
-	/**
-	 * 插件，可自行选择高级插件。
-	 * 目前支持的高级插件为： DefinitionDemotePlugin
-	 *
-	 * @type {any[]}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 插件，可自行选择安装的插件，支持{@link https://h5player.bytedance.com/plugins/ 西瓜播放器插件}。
+	 * @default -
 	 */
 	plugins?: any[];
-	/**
-	 * 默认配置
+	/** {zh}
+	 * @brief 忽略加载的插件，用于禁用默认加载的插件，传入插件名称数组，名称不区分大小写
+	 * @default []
+	 */
+	ignores?: string[];
+	/** {zh}
+	 * @brief 默认配置
 	 * @hidden
-	 *
-	 * @type {IDefaultConfig}
-	 * @memberof IPlayerConfig
 	 */
 	defaultConfig?: IDefaultConfig;
-	/**
-	 * 设置多语言词典，可设置每个语言的多语言词典，
-	 * 例如:
-	 * {
-	 *    zh: {
-	 *        PIP: '画中画'
-	 *    },
-	 *    en: {
-	 *        PIP: 'pip'
-	 *    }
-	 * }
-	 *
-	 * @type {{ [key: string]: Record<string, any> }}
-	 * @memberof IPlayerConfig
-	 */
-	languages?: {
-		[key: string]: Record<string, any>;
-	};
-	/**
+	/** {zh}
 	 * @hidden
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	 * @brief 模拟mobile
 	 */
 	isMobile?: boolean;
-	/**
-	 * umd依赖备用地址
-	 * 用于依赖的CDN发生网络错误时的降级备用地址
+	/** {zh}
+	 * @brief umd插件依赖备用地址
+	 * 用于依赖的插件所在CDN发生网络错误时的进行安全降级的备用地址，可以是相对地址
 	 * 支持的依赖有hls（非加密hls播放）、flv（flv播放）、XGVideo（软解播放）、hlsEncrypt（加密hls播放）、dash（dash播放）、mp4Encrypt（加密np4播放）、danmujs（弹幕）、danmuMask（蒙版弹幕）、subtitle（外挂字幕）
+	 * @example 以配置hls插件的备用地址为例
+	 * ```
+	 * const playerSdkIns = new VePlayer({
+	 *  url: 'demo.m3u8',
+	 *  id: 'video',
+	 *  umdUrlMap: {
+	 *    hls: '/VePlayerPlugin/hls.js'
+	 *  }
+	 * })
+	 * ```
+	 * @default -
+	 * @notice 插件可以从{@link https://www.volcengine.com/docs/4/67077 集成SDK} 章节中下载SDK离线包获取
 	 */
 	umdUrlMap?: Record<string, string>;
 	/**
-	 * 是否启用软解
-	 * 默认: false
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	 * @brief 唯一id，用于私有DRM加密
+	 * @default -
+	 */
+	unionId?: string;
+	/** {zh}
+	 * @brief 是否启用软解
+	 * @default `false`
 	 */
 	useSoftDecoding?: boolean;
-	/**
-	 * 是否开H265播放降级，即H.265硬解不支持时自动降级为软解
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief 是否开H265播放降级，即H.265硬解不支持时自动降级为软解
+	 * @default `false`
 	 */
 	enableH265Degrade?: boolean;
-	/**
-	 * 资源过期时的回调函数，用来更新视频资源
-	 *
-	 * @type {(any) => Promise<IPlayerConfig>}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @hidden
+	 * @brief 资源过期时的回调函数，用来更新视频资源
+	 * @default -
 	 */
 	onMediaExpired?: () => Promise<IPlayerConfig>;
-	/**
-	 * playAuthToken过期时的回调函数，用来更新playAuthToken
-	 *
-	 * @type {(any) => Promise<IPlayAuthTokenConfig>}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @brief playAuthToken过期时的回调函数，用来更新playAuthToken
+	 * @default -
 	 */
 	onTokenExpired?: () => Promise<IPlayAuthTokenConfig>;
-	/**
-	 * 定期检查资源过期的周期，单位秒，默认400
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @hidden
+	 * @brief 定期检查资源过期的周期，单位秒
+	 * @default `400`
 	 */
 	checkExpireInterval?: number;
-	/**
-	 * 定期检查资源过期的方式，支持三种类型
-	 * urlExpire 根据url的过期时间判断
-	 * xhrStatus 发送资源请求，根据资源xhr状态判断
-	 * getUrlTime 根据估算的地址获取时间判断
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
-	 */
-	expireDetectType?: Array<"xhrStatus" | "getUrlTime">;
-	/**
-	 * 有声音自动播放失败时是否降级成静音自动播放，默认不降级
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
-	 */
-	enableDegradeMuteAutoplay?: boolean;
-	/**
-	 * 启用微信jsBridge方式的自动播放，默认不开启
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
-	 */
-	enableWxJsBridgeAutoplay?: boolean;
-	/**
-	 * 开启任意点击的用户行为触发自动播放，默认不开启
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	/** {zh}
+	 * @hidden
+	 * @brief 定期检查资源过期的方式，支持三种类型
+	 * - `urlExpire`: 根据url的过期时间判断
+	 * - `xhrStatus`: 发送资源请求，根据资源xhr状态判断
+	 * - `getUrlTime`: 根据估算的地址获取时间判断
 	 */
-	enableUserActionAutoplay?: boolean;
-	/**
-	 * 禁用点播日志配置检测，默认开启，如果未配置line_app_id则会播放报错
-	 *
-	 * @type {boolean}
-	 * @memberof IPlayerConfig
+	expireDetectType?: Array<"urlExpire" | "xhrStatus" | "getUrlTime">;
+	/** {zh}
+	 * @hidden
+	 * @brief 禁用点播日志配置检测，默认开启，如果未配置line_app_id则会播放报错
+	 * @default -
 	 */
 	disableVodLogOptsCheck?: boolean;
-	/**
-	 * 播放器报错展示配置, 可以配置播放异常时的播放器显示的异常文案、图片，以及是否提供刷新按钮等
-	 *
+	/** {zh}
+	 * @brief 播放器报错展示配置, 可以配置播放异常时的播放器显示的异常文案、图片，以及是否提供刷新按钮等
+	 * @default -
 	 */
 	sdkErrorPlugin?: ISdkErrorConfig;
-	/**
-	 * rtm配置，配置rtm拉流参数
+	/** {zh}
+	 * @brief rtm配置，配置rtm拉流参数
 	 * @notes 传入rtm流url时才生效
-	 *
-	 * @type {IRtmConfig}
-	 * @memberof IPlayerConfig
+	 * @default -
 	 */
-	rtm?: IRtmConfig;
-	/**
-	 * 弹幕及面板配置，可配置弹幕的一些参数，如弹幕文字大小、透明度、展示区域等，
-	 *
-	 * @type {InitConfig | boolean}
-	 * @memberof IPlayerConfig
-	 */
-	DanmuPlugin?: InitConfig | boolean;
-	/**
-	 * 清晰度自动降级配置
-	 * @notes 需要先引入DefinitionDemotePlugin插件，plugins: [window.VePlayer.DefinitionDemotePlugin]
-	 *
-	 * @type {IDefinitionDemotePlugin}
-	 * @memberof IPlayerConfig
-	 */
-	DefinitionDemotePlugin?: IDefinitionDemotePlugin;
+	rtm?: IRtmConfig;
 	/**
-	 * 唯一id，用于私有DRM加密
-	 *
-	 * @type {string}
-	 * @memberof IPlayerConfig
+	 * @brief 弹幕及面板配置，可配置弹幕的一些参数，如弹幕文字大小、透明度、展示区域等
+	 * @default -
 	 */
-	unionId?: string;
+	DanmuPlugin?: IDanmuConfig | boolean;
 	/**
-	 * vid播放配置项
-	 * @notes 需要业务方服务端通过vid生成临时playAuthToken
-	 *
-	 * @type {IPlayAuthTokenConfig}
-	 * @memberof IPlayerConfig
+	 * @brief 清晰度自动降级配置
+	 * @hidden
+	 * @notes 需要先引入DefinitionDemotePlugin插件，plugins: [VePlayer.DefinitionDemotePlugin]
 	 */
-	getVideoByToken?: IPlayAuthTokenConfig;
+	DefinitionDemotePlugin?: IDefinitionDemotePlugin;
 	/**
-	 * dash 播放配置项
-	 * @type {Partial<IDashPluginConfig>}
-	 * @memberof IPlayerConfig
+	 * @hidden
+	 * @brief DASH 播放配置项
+	 * @default -
 	 */
 	DASHPlugin?: Partial<IDashPluginConfig>;
 	/**
-	 * hls 加密播放配置项
-	 * @type {Partial<IEncryptHlsPluginConfig> | boolean}
-	 * @memberof IPlayerConfig
+	 * @brief HLS 加密播放配置项
+	 * @default -
 	 */
 	EncryptHlsPlugin?: Partial<IEncryptHlsPluginConfig> | boolean;
 	/**
-	 * 质量日志配置项
-	 * @type {Partial<IVodLogOptsConfig>}
-	 * @memberof IPlayerConfig
+	 * @brief 质量日志配置项
+	 * @default -
 	 */
 	vodLogOpts?: Partial<IVodLogOptsConfig>;
 	/**
-	 * mp4加密播放配置项
-	 * @type {Partial<IMp4EncryptPlayerConfig> | boolean}
-	 * @memberof IPlayerConfig
+	 * @hidden
+	 * @brief mp4加密播放配置项
+	 * @default -
 	 */
 	Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
 	/**
-	 * 自适应码率配置项
-	 * @type {IAutoBitrateOptsConfig}
-	 * @memberof IPlayerConfig
+	 * @hidden
+	 * @brief 自适应码率配置项
+	 * @default -
 	 */
 	autoBitrateOpts?: IAutoBitrateOptsConfig;
 	/**
-	 * 外挂字幕配置项
-	 * @type {ISubtitleConfig}
-	 * @memberof IPlayerConfig
+	 * @brief 外挂字幕配置项
+	 * @default -
 	 */
 	Subtitle?: ISubtitleConfig;
 	/**
@@ -1888,105 +2036,80 @@ export interface IDefaultConfig {
 	LiveSubtitlesIconPlugin?: any;
 }
 /**
- * vid播放配置信息
- *
- * @detail Options
- * @description PlayAuthToken获取视频信息配置
- * @export
- * @interface IPlayAuthTokenConfig
+ * @brief vid播放配置信息
+ * @list Options
+ * @kind property
  */
 export interface IPlayAuthTokenConfig {
-	/**
-	 * 服务端生成的临时playAuthToken
-	 *
-	 * @type {string}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @brief 服务端生成的临时播放凭证。
+	 * @default -
 	 */
 	playAuthToken: string;
-	/**
-	 * 默认清晰度
-	 *
+	/** {zh}
+	 * @brief 默认清晰度
+	 * @default -
 	 * @notes 为空时默认为最大码率的清晰度
-	 * @type {string}
-	 * @memberof IPlayAuthTokenConfig
 	 */
 	defaultDefinition?: string;
-	/**
-	 * 求地址接口域名
-	 *
-	 * @notes 默认为`//vod.volcengineapi.com`
-	 * @type {string}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @brief 获取播放地址的请求域名。
+	 * @default`https://vod.volcengineapi.com`
+	 */
+	/** {en}
+	 * @brief Get the requested domain name of the playback address
+	 * @default `https://vod.byteplusapi.com`
 	 */
 	playDomain?: string;
-	/**
-	 * 是否启用控制台设置的封面图，默认false
-	 * @type {boolean}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @brief 是否启用控制台设置的封面图
+	 * @default `false`
 	 */
 	needPoster?: boolean;
-	/**
-	 * 是否启用控制台设置的雪碧图，默认false
-	 * @type {boolean}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @brief 是否启用控制台设置的截图中的雪碧图
+	 * @default `false`
 	 */
 	needThumbs?: boolean;
-	/**
-	 * 是否启用控制台设置的蒙版弹幕，默认false
-	 * @type {boolean}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @brief 是否启用控制台设置的蒙版弹幕
+	 * @default `false`
 	 */
 	needBarrageMask?: boolean;
-	/**
-	 * 是否需要多清晰度，默认为true
-	 * @type {boolean}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @brief 是否需要多清晰度
+	 * @default `true`
 	 */
 	needDefinitionList?: boolean;
-	/**
-	 * hls标准加密播放所用的keyToken
-	 * @type {boolean}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @briefhls标准加密播放所需要的keyToken
+	 * @default -
 	 */
 	keyToken?: string;
-	/**
-	 * 密钥请求域名
-	 * @type {string}
-	 * @memberof IPlayAuthTokenConfig
-	 */
-	keyDomain?: string;
-	/**
-	 * 获取key方式，默认'TOP'
-	 * @type {string}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @hidden
+	 * @brief 获取key方式，默认'TOP'
+	 * @default `'TOP'`
 	 */
 	getKeyType?: string;
-	/**
-	 * 获取privateDrmAuthToken的异步回调，
-	 * @type {(
-	 *     playAuthIds: string,
-	 *     vid: string,
-	 *     unionInfo: string,
-	 *   ) => Promise<string>}
+	/** {zh}
+	 * @brief 获取`PrivateDrmAuthToken`的异步回调，
 	 * 回调入参：
-	 * playAuthIds 视频的密钥 KeyID，对应OpenAPI GetPlayInfo{@link https://www.volcengine.com/docs/4/2918#%E8%AF%B7%E6%B1%82%E8%AF%B4%E6%98%8E} 返回视频信息中的PlayAuthId，当有多个KeyID时以英文逗号相连
-	 * vid 视频vid
-	 * unionInfo 由unionId生成的unionInfo，以用来加密PrivateDrmAuthToken
-	 * @memberof IPlayAuthTokenConfig
-	 *
+	 * - `playAuthIds`: 视频的密钥 KeyID，对应OpenAPI GetPlayInfo{@link https://www.volcengine.com/docs/4/2918#%E8%AF%B7%E6%B1%82%E8%AF%B4%E6%98%8E} 返回视频信息中的PlayAuthId，当有多个KeyID时以英文逗号相连
+	 * - `vid`: 视频vid
+	 * - `unionInfo`: 由`unionId`生成的`unionInfo`，以用来加密`PrivateDrmAuthToken`
+	 * @default -
 	 */
 	getDrmAuthToken?: (playAuthIds: string, vid: string, unionInfo: string) => Promise<string>;
-	/**
-	 * 可携带aid等透传参数，如
+	/** {zh}
+	 * @brief 可携带aid等透传参数，如:
 	 * {aid: 1234}，以playAuthToken下发的参数的优先级最高。
 	 * 具体可传参数见{@link https://www.volcengine.com/docs/4/65659 签发 PlayAuthToken}
-	 *
-	 * @type {Record<string, number | string | boolean>}
-	 * @memberof IPlayAuthTokenConfig
+	 * @default -
 	 */
 	reqParams?: Record<string, number | string | boolean>;
-	/**
-	 * 定义清晰度的映射
+	/** {zh}
+	 * @brief 定义清晰度的映射
 	 *
 	 * @example   如：
 	 * ``` javascript
@@ -2009,21 +2132,19 @@ export interface IPlayAuthTokenConfig {
 	 * }
 	 * ```
 	 * `definitionTextKey`用来指定多语言的key
-	 * @type {Record<string, string | definitionItem>}
-	 * @memberof IPlayAuthTokenConfig
+	 * @default -
 	 */
 	definitionMap?: Record<string, string | definitionItem>;
-	/**
-	 * 服务502错误时重试次数,默认为1
-	 * @type {number}
-	 * @memberof IPlayAuthTokenConfig
+	/** {zh}
+	 * @brief 点播服务502错误时重试次数
+	 * @default 1
 	 */
 	retryCount?: number;
 }
 /**
  * 清晰度定义
  *
- * @detail Options
+ * @list Options
  * @export
  * @interface definitionItem
  */
@@ -2095,9 +2216,9 @@ export interface IAutoBitrateOptsConfig {
 	module?: any;
 }
 /**
- * 初始配置
- *
- * @export
+ * @brief 记忆播放配置项
+ * @kind property
+ * @list Options
  * @interface IMemoryPlayConfig
  */
 export interface IMemoryPlayConfig {
@@ -2123,6 +2244,180 @@ export interface IMemoryPlayConfig {
 	 */
 	getTime: (id: number | string) => number | Promise<number>;
 }
+export declare const enum POSITIONS {
+	ROOT = "root",
+	ROOT_LEFT = "rootLeft",
+	ROOT_RIGHT = "rootRight",
+	ROOT_TOP = "rootTop",
+	CONTROLS_LEFT = "controlsLeft",
+	CONTROLS_RIGTH = "controlsRight",
+	CONTROLS_RIGHT = "controlsRight",
+	CONTROLS_CENTER = "controlsCenter",
+	CONTROLS = "controls"
+}
+export interface IIconPluginConfig {
+	position?: POSITIONS;
+	index?: number;
+}
+/**
+ * @brief 画中画配置项
+ * @list Options
+ * @kind property
+ */
+export interface IPIPConfig extends IIconPluginConfig {
+	/** {zh}
+	 * @brief 是否显示画中画按钮
+	 *  - `true`：是，显示
+	 *  - `false`：否，不显示
+	 *  @default `false`
+	 */
+	showIcon?: boolean;
+	/** {zh}
+	 * @brief 是否优先采用文档画中画，仅浏览器支持 DocumentPictureInPicture 才生效
+	 * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/DocumentPictureInPicture DocumentPictureInPicture}
+	 *  - `true`：是，优先使用文档画中画
+	 *  - `false`：否
+	 *  @default `false`
+	 */
+	preferDocument?: boolean;
+	/** {zh}
+	 * @brief 文档画中画窗口的宽度
+	 * @default -
+	 */
+	width?: number;
+	/** {zh}
+	 * @brief 文档画中画窗口的高度
+	 * @default -
+	 */
+	height?: number;
+	/** {zh}
+	 * @brief 文档画中画窗口的根节点
+	 * @default -
+	 */
+	docPiPNode?: HTMLElement;
+	/** {zh}
+	 * @brief 文档画中画窗口的css style
+	 * @default -
+	 */
+	docPiPStyle?: ((...arg: any) => string) | string;
+}
+/**
+ * @brief 全屏配置
+ * @list Options
+ * @kind property
+ */
+export interface IFullscreenConfig {
+	/** {zh}
+	 * @brief 是否使用页面全屏代替全屏功能。取值如下：
+	 - `true`：页面全屏；
+	 - `false`：系统全屏。
+	 * @default `false`
+	 */
+	useCssFullscreen?: boolean;
+	/** {zh}
+	 * @brief 是否使用旋转横屏。取值如下：
+	 * - `false`：否。
+	 * - `true`：是，即全屏将会在竖屏状态下把 dom 旋转 90 度实现横屏效果。
+	 * @default `false`
+	 * @notice
+	 * - 该配置优先于 `useCssFullscreen` 配置。
+	 * - 该配置一般在移动端使用。
+	 */
+	rotateFullscreen?: boolean;
+	/** {zh}
+	 * @brief 自定义全屏作用的dom，默认是播放器根节点, 该配置项必须是player.root的父辈节点，使用场景是解决全屏下和player.root同级的dom需要显示的场景
+	 * @default `null`
+	 */
+	target?: HTMLElement;
+	/** {zh}
+	 * @brief 是否禁用全凭按钮功能，禁用后不渲染全屏按钮
+	 * - `true`：禁用；
+	 * - `false`：不禁用。
+	 * @default `false`
+	 */
+	disable?: boolean;
+	/** {zh}
+	 * @brief 全屏的时候是否使用右上角返回按钮
+	 * - `true`：显示；
+	 * - `false`：不显示。
+	 * @default `false`
+	 * @notice 该配置一般在移动端开启
+	 */
+	needBackIcon?: boolean;
+	/** {zh}
+	 * @brief 全屏切换自定义实现，该函数配置相当于完全替代插件内部的切换逻辑
+	 * @default `null`
+	 */
+	switchCallback?: (...arg: any) => any;
+}
+/**
+ * @list Options
+ * @kind property
+ */
+export interface ICommonStyle {
+	/** {zh}
+	 * @brief 进度条底色
+	 * @default 无
+	 */
+	progressColor?: string;
+	/** {zh}
+	 * @brief 播放完成部分进度条底色
+	 * @default 无
+	 */
+	playedColor?: string;
+	/** {zh}
+	 * @brief 缓存部分进度条底色
+	 * @default 无
+	 */
+	cachedColor?: string;
+	/** {zh}
+	 * @brief 进度条滑块样式
+	 * @default 无
+	 */
+	sliderBtnStyle?: CSSStyleDeclaration;
+	/** {zh}
+	 * @brief 音量颜色
+	 * @default 无
+	 */
+	volumeColor?: string;
+}
+/**
+ * @list Options
+ * @brief 封面配置
+ * @kind property
+ */
+export interface IPoster {
+	/** {zh}
+	 * @brief 封面图地址
+	 * @default -
+	 */
+	poster: string;
+	/**
+	 * @brief 是否在播放结束之后显示
+	 * @default `true`
+	 */
+	isEndedShow?: boolean;
+	/**
+	 * @brief 是否播放后隐藏
+	 * - `true`：播放后才隐藏，在视频地址更新后会重新显示poster
+	 * - `false`：在play事件触发后隐藏poster
+	 * @default `false`
+	 */
+	hideCanplay?: boolean;
+	/**
+	 * @brief 是否一直显示
+	 * @default `false`
+	 */
+	notHidden?: boolean;
+	/**
+	 * @brief 封面图填充方式
+	 * - `fixWidth`：宽度方向填充，不会被拉伸压缩
+	 * - `fixHeight`：高度方向完全填充，不会被拉伸压缩
+	 * - `cover`：方式完全覆盖容器，多余但部分会被裁剪
+	 * - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩
+	 */
+	fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+}
 export interface ApiMapConfig {
 	playDomain: string;
 	backupPlayDomain?: string;
@@ -2343,15 +2638,14 @@ declare class umdLoader {
 }
 declare class VePlayer {
 	/**
-	 * 播放相关配置数据
+	 * @brief 播放相关配置数据
 	 * @hidden
-	 *
 	 * @type {PlayerData}
 	 * @memberof VePlayer
 	 */
 	playerData: PlayerData;
 	/**
-	 * 播放器内核实例
+	 * @brief 播放器内核实例
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
@@ -2459,10 +2753,21 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	sdkUmdLoader: umdLoader;
+	/**
+	 * @hidden
+	 */
 	static isMSESupported: typeof isMSESupport;
 	static isRTMSupported: typeof import("@byted/xgplayer-rts").RtsPlugin.isSupported;
+	/**
+	 * @hidden
+	 */
 	static veStrategy: typeof VeStrategy;
 	static sdkVersion: string;
+	/**
+	 * @hidden
+	 * @param codec
+	 * @param options
+	 */
 	static isRTMSupportCodec: (codec: RTMCodec, options: {
 		targetProfileLevel?: string;
 	}) => Promise<boolean>;
@@ -2470,7 +2775,7 @@ declare class VePlayer {
 	constructor(configs: IPlayerConfig);
 	/**
 	 *
-	 *
+	 * @hidden
 	 * @private
 	 * @param {IPlayerConfig} configs 播放器配置
 	 * @memberof VePlayer
@@ -2494,6 +2799,10 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	private initUmdLoader;
+	/**
+	 * @hidden
+	 * @private
+	 */
 	private checkVodLogOptions;
 	/**
 	 * @hidden
@@ -2509,28 +2818,28 @@ declare class VePlayer {
 	onRepeat(): void;
 	/**
 	 * @hidden
-	 * @description 触发过期事件
+	 * @brief  触发过期事件
 	 * @memberof VePlayer
 	 */
 	emitExpireEvent(): void;
 	/**
 	 * @hidden
-	 * @description 地址获取时间
+	 * @brief  地址获取时间
 	 * @memberof VePlayer
 	 */
 	getUrlTimestamp(url: string): void;
 	/**
-	 * @description 监听sdk事件
+	 * @brief  监听sdk事件
 	 *
-	 * @param {string} action
+	 * @param action 监听的事件名
 	 * @param {(...args: any[]) => void} func
 	 * @memberof VePlayer
 	 */
 	on(action: string, func: (...args: any[]) => void): void;
 	/**
-	 * @description 触发sdk事件
+	 * @brief  触发sdk事件
 	 *
-	 * @param {string} action
+	 * @param {string} action 监听的事件名
 	 * @param {*} [payload]
 	 * @memberof VePlayer
 	 */
@@ -2633,6 +2942,10 @@ declare class VePlayer {
 	 */
 	beforePlayerCreate(): Promise<void>;
 	private prepareStrategies;
+	/**
+	 * @hidden
+	 * @brief 更新播放策略
+	 */
 	updateConfigByStrategy(): void;
 	/**
 	 * @hidden
@@ -2714,14 +3027,14 @@ declare class VePlayer {
 	/**
 	 * @hidden
 	 *
-	 * @description 对外提供获取SDK插件实例的方法
+	 * @brief  对外提供获取SDK插件实例的方法
 	 * @param { string } name
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
 	getSdkPlugin(name: any): any;
 	/**
-	 * @description 更换playAuthToken的方法
+	 * @brief  更换playAuthToken的方法
 	 * @notes 这里指同一个视频切换视频源，不能用来切换不同类型的视频
 	 * @param { IPlayAuthTokenConfig } config authToken配置
 	 * @param { boolean } isNewVideo 是否是新视频，默认true。若未false即表示同一个视频切换token播放，会在切换前时间点继续播放
@@ -2729,18 +3042,18 @@ declare class VePlayer {
 	 */
 	switchAuthToken(config: IPlayAuthTokenConfig, isNewVideo?: boolean): Promise<void>;
 	/**
-	 * @description 更新playAuthToken的方法，用来更新视频地址
+	 * @brief  更新playAuthToken的方法，用来更新视频地址
 	 * @param { IPlayAuthTokenConfig } config
 	 * @memberof VePlayer
 	 */
 	updateAuthToken(config: IPlayAuthTokenConfig): Promise<void>;
 	/**
-	 * @description 返回当前视频的地址
+	 * @brief  返回当前视频的地址
 	 * @memberof VePlayer
 	 */
 	get src(): any;
 	/**
-	 * @description 设置当前视频的地址
+	 * @brief  设置当前视频的地址
 	 * @notes 会重新拉取新的视频，从0开始起播
 	 * @memberof VePlayer
 	 */
@@ -2766,7 +3079,7 @@ declare class VePlayer {
 	 *
 	 * @param {IPlayerConfig} config
 	 * @param { boolean } isNewVideo 是否是新视频，默认true。若为false即表示同一个视频切换地址播放，会在切换前的时间点继续播放
-	 * @description 默认切换后是暂停状态，如果设置了自动播放，则会自动播放
+	 * @brief  默认切换后是暂停状态，如果设置了自动播放，则会自动播放
 	 * @return{Promise<any>}
 	 * @memberof VePlayer
 	 */
@@ -2816,7 +3129,7 @@ declare class VePlayer {
 	/**
 	 * @hidden
 	 *
-	 * @description 获取h265软解播放时的播放列表
+	 * @brief  获取h265软解播放时的播放列表
 	 * @memberof VePlayer
 	 */
 	setH265SoftPlayList(): void;
@@ -3262,6 +3575,36 @@ 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[];
@@ -3723,6 +4066,154 @@ export declare const Events: {
 	 * 播放列表播放项变更
 	 */
 	PLAY_LIST_ITEM_CHANGE: string;
+	/** {zh}
+	 * 播放器完成实例化
+	 */
+	/** {en}
+	 * The player is instantiated.
+	 */
+	READY: string;
+	/** {zh}
+	 * 播放器创建video完成，可以开始播放
+	 */
+	/** {en}
+	 * The player has created the video and the playback is ready to start.
+	 */
+	COMPLETE: string;
+	/** {zh}
+	 * 播放资源发生变化
+	 */
+	/** {en}
+	 * The playback address changes.
+	 */
+	URL_CHANGE: string;
+	/** {zh}
+	 * 播放器聚焦
+	 */
+	/** {en}
+	 * The player has focus.
+	 */
+	PLAYER_FOCUS: string;
+	/** {zh}
+	 * 播放器失焦
+	 */
+	/** {en}
+	 * The player loses focus.
+	 */
+	PLAYER_BLUR: string;
+	/** {zh}
+	 * 系统全屏状态切换
+	 */
+	/** {en}
+	 * The player switches to or from full-window mode, in which the player covers the entire desktop.
+	 */
+	FULLSCREEN_CHANGE: string;
+	/** {zh}
+	 * 网页样式全屏状态切换
+	 */
+	/** {en}
+	 * The player switches to or from full-screen mode, in which the player covers the browser window.
+	 */
+	CSS_FULLSCREEN_CHANGE: string;
+	/**
+	 * @brief 画中画播放模式切换
+	 */
+	MINI_STATE_CHANGE: string;
+	/** {zh}
+	 * 播放器销毁
+	 */
+	/** {en}
+	 * The player is destroyed.
+	 */
+	DESTROY: string;
+	/** {zh}
+	 * 播放器重新播放
+	 */
+	/** {en}
+	 * Replay starts.
+	 */
+	REPLAY: string;
+	/**
+	 * @brief 重试
+	 */
+	RETRY: string;
+	/** {zh}
+	 * 清晰度发生变化
+	 */
+	/** {en}
+	 * The video resolution changes.
+	 */
+	DEFINITION_CHANGE: string;
+	/** {zh}
+	 * @hidden
+	 */
+	/** {en}
+	 * @hidden
+	 */
+	Before_DEFINITION_CHANGE: string;
+	/** {zh}
+	 * @hidden
+	 */
+	/** {en}
+	 * @hidden
+	 */
+	AFTER_DEFINITION_CHANGE: string;
+	/** {zh}
+	 * 播放器容器尺寸发生变化
+	 */
+	/** {en}
+	 * The size of the player container changes.
+	 */
+	VIDEO_RESIZE: string;
+	/** {zh}
+	 * 画中画状态切换
+	 */
+	/** {en}
+	 * The player switches to or from Picture-in-Picture (PIP) mode.
+	 */
+	PIP_CHANGE: string;
+	/** {zh}
+	 * 播放器被旋转
+	 */
+	/** {en}
+	 * The player is rotated.
+	 */
+	ROTATE: string;
+	/** {zh}
+	 * 播放器内置快捷键事件触发
+	 */
+	/** {en}
+	 * A built-in shortcut event occurs within the player.
+	 */
+	SHORTCUT: string;
+	/** {zh}
+	 * SEI 信息解析
+	 */
+	/** {en}
+	 * The player parses the SEI information.
+	 */
+	SEI_PARSED: string;
+	/** {zh}
+	 * 内置插件用户行为触发，所有内置插件用户行为交互都会下发该事件，可用于用户行为埋点
+	 */
+	/** {en}
+	 * A user event occurs within a built-in plug-in. This event applies to all built-in plug-ins and can be used for tracking user behaviors.
+	 */
+	USER_ACTION: string;
+	/** {zh}
+	 * 自动播放成功
+	 */
+	/** {en}
+	 * Autoplay starts successfully.
+	 */
+	AUTOPLAY_STARTED: string;
+	/** {zh}
+	 * 自动播放失败
+	 */
+	/** {en}
+	 * Autoplay fails to start.
+	 */
+	AUTOPLAY_PREVENTED: string;
 	/**
 	 * 播放器完成创建
 	 */
@@ -3747,66 +4238,267 @@ export declare const Events: {
 	 * umd 加载失败
 	 */
 	UMD_LOAD_FAIL: string;
-	PLAY: "play";
-	PLAYING: "playing";
-	ENDED: "ended";
-	PAUSE: "pause";
-	ERROR: "error";
-	SEEKING: "seeking";
-	SEEKED: "seeked";
-	TIME_UPDATE: "timeupdate";
-	WAITING: "waiting";
-	CANPLAY: "canplay";
-	CANPLAY_THROUGH: "canplaythrough";
-	DURATION_CHANGE: "durationchange";
-	VOLUME_CHANGE: "volumechange";
-	LOADED_DATA: "loadeddata";
-	LOADED_METADATA: "loadedmetadata";
-	RATE_CHANGE: "ratechange";
-	PROGRESS: "progress";
-	LOAD_START: "loadstart";
-	EMPTIED: "emptied";
-	STALLED: "stalled";
-	SUSPEND: "suspend";
-	ABORT: "abort";
-	BUFFER_CHANGE: "bufferedChange";
-	PLAYER_FOCUS: "focus";
-	PLAYER_BLUR: "blur";
-	READY: "ready";
-	URL_NULL: "urlNull";
-	AUTOPLAY_STARTED: "autoplay_started";
-	AUTOPLAY_PREVENTED: "autoplay_was_prevented";
-	COMPLETE: "complete";
-	REPLAY: "replay";
-	DESTROY: "destroy";
-	URL_CHANGE: "urlchange";
-	DOWNLOAD_SPEED_CHANGE: "download_speed_change";
-	FULLSCREEN_CHANGE: "fullscreen_change";
-	CSS_FULLSCREEN_CHANGE: "cssFullscreen_change";
-	MINI_STATE_CHANGE: "mini_state_change";
-	DEFINITION_CHANGE: "definition_change";
-	BEFORE_DEFINITION_CHANGE: "before_definition_change";
-	AFTER_DEFINITION_CHANGE: "after_definition_change";
-	SEI_PARSED: "SEI_PARSED";
-	RETRY: "retry";
-	VIDEO_RESIZE: "video_resize";
-	PIP_CHANGE: "pip_change";
-	ROTATE: "rotate";
-	SCREEN_SHOT: "screenShot";
-	PLAYNEXT: "playnext";
-	SHORTCUT: "shortcut";
-	XGLOG: "xglog";
-	USER_ACTION: "user_action";
-	RESET: "reset";
-	SOURCE_ERROR: "source_error";
-	SOURCE_SUCCESS: "source_success";
-	SWITCH_SUBTITLE: "switch_subtitle";
-	VIDEO_EVENTS: string[];
-	STATS_EVENTS: typeof XgEvents.STATS_EVENTS;
-	FPS_STUCK: "fps_stuck";
+	/**
+	 * @brief 在播放被终止时触发。例如：当播放中的视频重新开始播放。
+	 */
+	ABORT: string;
+	/** {zh}
+	 * @brief在媒体数据已经有足够的数据（至少播放数帧）可供播放时触发。
+	 **/
+	CANPLAY: string;
+	/** {zh}
+	 * @brief表明媒体可以在保持当前的下载速度的情况下不被中断地播放完毕。
+	 * @notice 手动设置currentTime会使得firefox触发一次canplaythrough事件，其他浏览器或许不会如此。
+	 */
+	CANPLAY_THROUGH: string;
+	/** {zh}
+	 * @brief表明媒体的长度发生了改变。例如：在媒体已被加载足够的长度从而得知总长度时会触发这个事件。
+	 */
+	DURATION_CHANGE: string;
+	/**
+	 * @brief 媒体被清空（初始化）时触发
+	 */
+	EMPITED: string;
+	/** {zh}
+	 * 视频播放完毕
+	 */
+	/** {en}
+	 * Video playback ends.
+	 */
+	ENDED: string;
+	/** {zh}
+	 * 发生错误
+	 */
+	ERROR: string;
+	/** {zh}
+	 * @brief媒体的第一帧已经加载完毕
+	 */
+	LOADED_DATA: string;
+	/**
+	 * 媒体的元数据已经加载完毕，playerSdkIns.player.video 可获取所有的video属性
+	 */
+	LOADED_META_DATA: string;
+	/** {zh}
+	 * 媒体内容开始加载
+	 */
+	LOAD_START: string;
+	/** {zh}
+	 * 视频暂停播放
+	 */
+	/** {en}
+	 * Video playback pauses.
+	 */
+	PAUSE: string;
+	/** {zh}
+	 * @brief 视频开始播放
+	 */
+	/** {en}
+	 * @brief Video playback starts.
+	 */
+	PLAY: string;
+	/** {zh}
+	 * 恢复播放（包括暂停后恢复播放或卡顿后恢复播放）
+	 */
+	/** {en}
+	 * Video playback resumes after a pause or freeze.
+	 */
+	PLAYING: string;
+	/**
+	 * 媒体下载进度，即已缓存播放数据进度
+	 */
+	PROGRESS: string;
+	/**
+	 * 播放速率变化
+	 */
+	RATE_CHANGE: string;
+	/**
+	 * 在跳跃（seek）操作完成时触发
+	 */
+	SEEKED: string;
+	/**
+	 * 在跳跃（seek）操作开始时触发
+	 */
+	SEEKING: string;
+	/**
+	 * 在尝试获取媒体数据，但数据不可用时触发。
+	 */
+	STALLED: string;
+	/**
+	 * 在媒体资源加载终止时触发，这可能是因为下载已完成或因为其他原因暂停。
+	 */
+	SUSPEND: string;
+	/** {zh}
+	 * 视频播放时间更新
+	 */
+	/** {en}
+	 * The video playback time is updated.
+	 */
+	TIME_UPDATE: string;
+	/** {zh}
+	 * 视频音量发生变化
+	 */
+	/** {en}
+	 * The video volume changes.
+	 */
+	VOLUME_CHANGE: string;
+	/** {zh}
+	 * 等待加载数据
+	 */
+	/** {en}
+	 * The player is loading data.
+	 */
+	WAITING: string;
 };
 export declare const Event: {
 	SDKEvents: {
+		/** {zh}
+		 * 播放器完成实例化
+		 */
+		/** {en}
+		 * The player is instantiated.
+		 */
+		READY: string;
+		/** {zh}
+		 * 播放器创建video完成，可以开始播放
+		 */
+		/** {en}
+		 * The player has created the video and the playback is ready to start.
+		 */
+		COMPLETE: string;
+		/** {zh}
+		 * 播放资源发生变化
+		 */
+		/** {en}
+		 * The playback address changes.
+		 */
+		URL_CHANGE: string;
+		/** {zh}
+		 * 播放器聚焦
+		 */
+		/** {en}
+		 * The player has focus.
+		 */
+		PLAYER_FOCUS: string;
+		/** {zh}
+		 * 播放器失焦
+		 */
+		/** {en}
+		 * The player loses focus.
+		 */
+		PLAYER_BLUR: string;
+		/** {zh}
+		 * 系统全屏状态切换
+		 */
+		/** {en}
+		 * The player switches to or from full-window mode, in which the player covers the entire desktop.
+		 */
+		FULLSCREEN_CHANGE: string;
+		/** {zh}
+		 * 网页样式全屏状态切换
+		 */
+		/** {en}
+		 * The player switches to or from full-screen mode, in which the player covers the browser window.
+		 */
+		CSS_FULLSCREEN_CHANGE: string;
+		/**
+		 * @brief 画中画播放模式切换
+		 */
+		MINI_STATE_CHANGE: string;
+		/** {zh}
+		 * 播放器销毁
+		 */
+		/** {en}
+		 * The player is destroyed.
+		 */
+		DESTROY: string;
+		/** {zh}
+		 * 播放器重新播放
+		 */
+		/** {en}
+		 * Replay starts.
+		 */
+		REPLAY: string;
+		/**
+		 * @brief 重试
+		 */
+		RETRY: string;
+		/** {zh}
+		 * 清晰度发生变化
+		 */
+		/** {en}
+		 * The video resolution changes.
+		 */
+		DEFINITION_CHANGE: string;
+		/** {zh}
+		 * @hidden
+		 */
+		/** {en}
+		 * @hidden
+		 */
+		Before_DEFINITION_CHANGE: string;
+		/** {zh}
+		 * @hidden
+		 */
+		/** {en}
+		 * @hidden
+		 */
+		AFTER_DEFINITION_CHANGE: string;
+		/** {zh}
+		 * 播放器容器尺寸发生变化
+		 */
+		/** {en}
+		 * The size of the player container changes.
+		 */
+		VIDEO_RESIZE: string;
+		/** {zh}
+		 * 画中画状态切换
+		 */
+		/** {en}
+		 * The player switches to or from Picture-in-Picture (PIP) mode.
+		 */
+		PIP_CHANGE: string;
+		/** {zh}
+		 * 播放器被旋转
+		 */
+		/** {en}
+		 * The player is rotated.
+		 */
+		ROTATE: string;
+		/** {zh}
+		 * 播放器内置快捷键事件触发
+		 */
+		/** {en}
+		 * A built-in shortcut event occurs within the player.
+		 */
+		SHORTCUT: string;
+		/** {zh}
+		 * SEI 信息解析
+		 */
+		/** {en}
+		 * The player parses the SEI information.
+		 */
+		SEI_PARSED: string;
+		/** {zh}
+		 * 内置插件用户行为触发，所有内置插件用户行为交互都会下发该事件，可用于用户行为埋点
+		 */
+		/** {en}
+		 * A user event occurs within a built-in plug-in. This event applies to all built-in plug-ins and can be used for tracking user behaviors.
+		 */
+		USER_ACTION: string;
+		/** {zh}
+		 * 自动播放成功
+		 */
+		/** {en}
+		 * Autoplay starts successfully.
+		 */
+		AUTOPLAY_STARTED: string;
+		/** {zh}
+		 * 自动播放失败
+		 */
+		/** {en}
+		 * Autoplay fails to start.
+		 */
+		AUTOPLAY_PREVENTED: string;
 		/**
 		 * 播放器完成创建
 		 */