@volcengine/veplayer 1.10.0-rc.0 → 1.10.0-rc.10

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.js';
+import VodLogger from '@byted/xgplayer-app-logger/es/logger';
 import EventEmitter from 'eventemitter3';
 import Player from 'xgplayer';
 import { BasePlugin, I18N, IXGI18nText, Plugin } from 'xgplayer';
@@ -500,7 +500,7 @@ export interface ISubtitleConfig {
 export interface ISubtitleStyle {
 	/**
 	 * 是否跟随控制栏调整位置
-	 * @default true
+	 * @default false
 	 * @type {boolean | null}
 	 * @memberof ISubtitleStyle
 	 * @brief 是否跟随控制栏调整位置。
@@ -508,7 +508,7 @@ export interface ISubtitleStyle {
 	/** {en}
 	 * @brief 是否跟随控制栏调整位置
 	 */
-	follow: boolean | null;
+	follow?: boolean;
 	/**
 	 * 字体显示模式，默认是描边
 	 * @default 'stroke'
@@ -1371,8 +1371,10 @@ export declare type IPlayerOptions = {
 };
 /**
  * @brief mobile端交互配置。
- * @list Options
- * @kind property
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export interface IMobileConfig {
 	/**
@@ -1481,8 +1483,10 @@ export interface IMobileConfig {
 }
 /**
  * @brief 播放器中间切换暂停/播放的按钮。
- * @list Options
- * @kind property
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export interface IStartConfig {
 	/**
@@ -2053,9 +2057,18 @@ export declare class MemoryPlay extends Plugin {
 	getTimeByStorage(memoryId: string): string | 0;
 	destroy(): void;
 }
-declare enum EDRMTYPE {
-	DRM_ENCRYPT = "drm_encrypt"
+/** {zh}
+ * @hidden
+ */
+export declare const enum EDRMTYPE {
+	DRM_ENCRYPT = "drm_encrypt",
+	PRIVATE_ENCRYPT = "private_encrypt",
+	PRIVATE_ENCRYPT_UPGRADE = "private_encrypt_upgrade",
+	STANDARD_ENCRYPT = "standard_encrypt"
 }
+/** {zh}
+ * @hidden
+ */
 export interface IPlayInfoListItem {
 	BackupPlayUrl: string;
 	BackupUrlExpire: string;
@@ -2084,6 +2097,10 @@ export interface IPlayInfoListItem {
 	Width: number;
 	DrmType?: EDRMTYPE;
 }
+/** {zh}
+ * @hidden
+ * @brief 音频封装格式
+ */
 export interface ISubtitleInfoList {
 	CreateTime: string;
 	FileId: string;
@@ -2100,7 +2117,10 @@ export interface ISubtitleInfoList {
 	Version: string;
 	Vid: string;
 }
-export interface IThumbInfoList {
+/** {zh}
+ * @hidden
+ */
+export interface IThumbInfoItem {
 	CaptureNum: number;
 	CellHeight: number;
 	CellWidth: number;
@@ -2110,6 +2130,10 @@ export interface IThumbInfoList {
 	Interval: number;
 	StoreUrls: string[];
 }
+/** {zh}
+ * @brief 蒙版弹幕信息
+ * @hidden
+ */
 export interface IBarrageMaskInfo {
 	Version: string;
 	BarrageMaskUrl: string;
@@ -2120,9 +2144,29 @@ export interface IBarrageMaskInfo {
 	Bitrate: number;
 	HeadLen: number;
 }
+/** {zh}
+ * @hidden
+ */
+export interface DashAdaptiveInfo {
+	AdaptiveType: string;
+	BackupPlayUrl: string;
+	MainPlayUrl: string;
+}
+/** {zh}
+ * @hidden
+ */
+export interface ABRInfo {
+	AbrFormat: string;
+	BackupPlayUrl: string;
+	MainPlayUrl: string;
+}
+/** {zh}
+ * @hidden
+ */
 export interface IGetPlayInfoRes {
 	Vid: string;
-	AdaptiveInfo?: any;
+	AdaptiveInfo?: DashAdaptiveInfo;
+	AdaptiveBitrateStreamingInfo?: ABRInfo;
 	BarrageMaskInfo?: IBarrageMaskInfo;
 	BarrageMaskUrl: string;
 	Duration: number;
@@ -2132,11 +2176,21 @@ export interface IGetPlayInfoRes {
 	PosterUrl: string;
 	Status: number;
 	SubtitleInfoList: ISubtitleInfoList[];
-	ThumbInfoList: IThumbInfoList[];
+	ThumbInfoList: IThumbInfoItem[];
 	TotalCount: number;
 	Version: number;
 }
-declare enum CodecType {
+/**
+ * @author bytedance
+ * @version 1.0
+ * @Description
+ * @date 2024/5/17 15:53
+ */
+/** {zh}
+ * @list Options
+ * @brief 视频编码格式。
+ */
+export declare const enum CodecType {
 	/** {zh}
 	 * @brief H.264
 	 */
@@ -2150,15 +2204,15 @@ declare enum CodecType {
 	 */
 	H266 = "h266",
 	/** {zh}
-	 * @brief 音频AAC，含 heaacv2
+	 * @brief 音频 AAC，含 heaacv2
 	 */
 	AAC = "aac",
 	/** {zh}
-	 * @brief 音频MP3
+	 * @brief 音频 MP3
 	 */
 	MP3 = "mp3",
 	/** {zh}
-	 * @brief 音频OPUS
+	 * @brief 音频 OPUS
 	 */
 	OPUS = "opus",
 	/** {zh}
@@ -2398,6 +2452,16 @@ export interface Stream extends Partial<IPlayInfoListItem> {
 	 * @brief 多语言词典中对应的 key。比如 `lineTextKey: LINE_ONE`。
 	 */
 	lineTextKey?: string;
+	/**
+	 * @brief 该码流视频的宽度，单位为像素
+	 * @default -
+	 */
+	width?: number;
+	/**
+	 * @brief 该码流视频的高度，单位为像素
+	 * @default -
+	 */
+	height?: number;
 	/**
 	 * @brief 码流的平均码率
 	 * @default -
@@ -2470,7 +2534,7 @@ export interface Current extends Partial<Stream> {
 	 * @brief 视频为加密视频时的加密类型
 	 * @default -
 	 */
-	drmType?: string;
+	drmType?: EDRMTYPE;
 	/**
 	 * @brief 地址的过期时间戳，vid模式下不用输入，播放器自动获取。如果是火山引擎的CDN分发地址，在不传入过期时间戳时，则需指定urlType，支持{@link https://www.volcengine.com/docs/4/177191 A-E类型}，其他云厂商或者业务服务器存储的地址不支持。
 	 * @default -
@@ -2500,7 +2564,7 @@ export declare type Url = string | Array<{
  * @brief 播放器实例化配置。
  */
 /** {en}
- * @brief Player Instance Configuration
+ * @brief Player instantiation configuration.
  */
 export interface IPlayerConfig extends IPlayerOptions {
 	/** {zh}
@@ -2508,6 +2572,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default false
 	 * @hidden
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	isLive?: boolean;
 	/** {zh}
 	 * @brief 播放器容器 ID。播放器将被插入在该容器中。
@@ -2782,8 +2849,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	"x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
 	/** {zh}
 	 * @brief 为播放器配置关键点样式。
-	 * @default 无
-	 * @hidden 直播目前没用到
+	 * @default -
 	 */
 	commonStyle?: ICommonStyle;
 	/** {zh}
@@ -2801,6 +2867,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @type {boolean}
 	 * @memberof IPlayerConfig
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	enableContextmenu?: boolean;
 	/** {zh}
 	 * @brief 是否关闭 `video` 标签的事件冒泡。取值如下：
@@ -2818,50 +2887,80 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	enableMenu?: boolean;
 	/**
-	 * @brief 是否关闭pc端单击播放器区域切换播放/暂停
+	 * @brief 是否禁用 PC 端点击播放器区域切换播放和暂停功能。
 	 * @default false
 	 */
+	/** {en}
+	 * @brief Whether to disable the ability to toggle play and pause by clicking on the player area on PC.
+	 */
 	closeVideoClick?: boolean;
 	/**
+	 * @brief <br>- PC 端：是否关闭双击播放器进入全屏的功能。
+	 *        - 移动端：是否关闭双击切换暂停和播放的功能。
+	 * @default PC 端为 true，移动端为 false
+	 */
+	/** {en}
 	 * @brief pc端: 是否关闭双击播放器进入全屏的能力
-	 * mobile端: 是否关闭双击切换暂停/播放的能力
+	 *        mobile端: 是否关闭双击切换暂停/播放的能力
 	 * @default pc端: true， mobile端: false
 	 */
 	closeVideoDblclick?: boolean;
 	/**
-	 * @brief 是否关闭播放器自动失焦（只在pc端生效）
+	 * @brief （仅 PC 端生效）是否关闭播放器自动失焦的功能。
 	 * @default false
 	 */
+	/** {en}
+	 * @brief 是否关闭播放器自动失焦（只在pc端生效）
+	 */
 	closeDelayBlur?: boolean;
 	/**
-	 * @brief 播放器focus状态自动消失延迟时长，单位为ms
+	 * @brief 播放器 focus 状态自动消失延迟时长，单位为毫秒。
 	 * @default pc端: 2000， mobile端: 3000
 	 */
+	/** {en}
+	 * @brief 播放器focus状态自动消失延迟时长，单位为ms
+	 */
 	inactive?: number;
 	/**
-	 * @brief 用户鼠标离开播放器区域之后，控制栏隐藏延时时间，如果想要鼠标移出播放器区域就隐藏，则配置为0（只在pc端生效）
+	 * @brief （仅 PC 端生效）用户鼠标离开播放器区域后，控制栏隐藏延时时间。若希望鼠标移出播放器区域即隐藏，可设置为 0。
 	 * @default 0
 	 */
+	/** {en}
+	 * @brief 用户鼠标离开播放器区域之后，控制栏隐藏延时时间，如果想要鼠标移出播放器区域就隐藏，则配置为0（只在pc端生效）
+	 */
 	leavePlayerTime?: number;
 	/**
+	 * @brief 是否禁用播放时触发播放器焦点状态的功能。
+	 * @default PC 端为 true，移动端为 false
+	 */
+	/** {en}
 	 * @brief 是否关闭play时触发player焦点状态
 	 * @default pc端：true, mobile端：false
 	 */
 	closePlayVideoFocus?: boolean;
 	/**
-	 * @brief 是否关闭pause时触发player焦点状态，会强制呼出控制栏
+	 * @brief 是否关闭暂停时触发播放器焦点状态的功能。这样会导致强制呼出控制栏。
 	 * @default false
 	 */
+	/** {en}
+	 * @brief 是否关闭pause时触发player焦点状态，会强制呼出控制栏
+	 */
 	closePauseVideoFocus?: boolean;
 	/**
-	 * @brief 是否需要在退出全屏后滚动定位到全屏之前的位置。（一般安卓下退出全屏后页面会滚动）
+	 * @brief 是否在退出全屏后将页面滚动定位到全屏之前的位置。通常在安卓设备上退出全屏后页面会发生滚动。
 	 * @default false
 	 */
+	/** {en}
+	 * @brief 是否需要在退出全屏后滚动定位到全屏之前的位置。（一般安卓下退出全屏后页面会滚动）
+	 */
 	needFullscreenScroll?: boolean;
 	/**
-	 * @brief 移动端交互插件配置
+	 * @brief 移动端交互插件配置。
 	 * @default -
 	 */
+	/** {en}
+	 * @brief 移动端交互插件配置
+	 */
 	mobile?: IMobileConfig;
 	/**
 	 * @brief 播放器中间切换暂停/播放的按钮插件配置
@@ -2909,11 +3008,17 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 默认配置
 	 * @hidden
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	defaultConfig?: IDefaultConfig;
 	/** {zh}
 	 * @hidden
 	 * @brief 模拟mobile
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	isMobile?: boolean;
 	/** {zh}
 	 * @brief UMD 依赖备用地址。用于依赖的 CDN 发生网络错误时的降级备用地址。支持的依赖如下：
@@ -2987,7 +3092,6 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	urlCheckExpireInterval?: number;
 	/** {zh}
-	 * @hidden
 	 * @brief 播放源过期的回调函数。可用来更新播放源数据。
 	 * @default -
 	 */
@@ -3002,10 +3106,12 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 禁用点播日志配置检测，默认开启，如果未配置line_app_id则会播放报错
 	 * @default -
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	disableVodLogOptsCheck?: boolean;
 	/** {zh}
-	 * @hidden
-	 * @brief 是否打开日志打印
+	 * @brief 是否开启日志打印。
 	 * @default false
 	 */
 	debug?: boolean;
@@ -3020,6 +3126,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 * @hidden
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	rtm?: IRtmConfig;
 	/** {zh}
 	 * @brief 弹幕及面板配置。支持配置弹幕文字大小、透明度、展示区域等参数。
@@ -3036,6 +3145,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief DASH 播放配置项
 	 * @default -
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	DASHPlugin?: Partial<IDashPluginConfig>;
 	/** {zh}
 	 * @brief HLS 加密播放配置。
@@ -3052,12 +3164,29 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief mp4加密播放配置项
 	 * @default -
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
 	/** {zh}
-	 * @brief 自适应码率配置。
+	 * @brief 多码率自适应播放配置。
 	 * @default -
 	 */
 	autoBitrateOpts?: IAutoBitrateOpts;
+	/** {zh}
+	 * @brief 动态 Buffer 配置。
+	 * @default -
+	 */
+	adaptRange?: IAdaptRange;
+	/** {zh}
+	 * @brief 视频时长。
+	 * @default -
+	 * @hidden
+	 */
+	/** {en}
+	 * @hidden
+	 */
+	duration?: number;
 	/** {zh}
 	 * @brief 外挂字幕配置。
 	 * @default -
@@ -3105,6 +3234,9 @@ export declare type SourceConfig = Pick<IPlayerConfig, "url" | "playList" | "get
 /** {zh}
  * @hidden
  */
+/** {en}
+ * @hidden
+ */
 export interface IDefaultConfig {
 	/** {zh}
 	 * @brief “点播”还是“直播”
@@ -3244,17 +3376,20 @@ export interface IPlayAuthTokenConfig {
 	/**
 	 * @brief 商业DRM 获取license的token
 	 * @default -
+	 * @hidden
 	 */
 	thirdPartyDrmAuthToken?: string;
 	/**
 	 * @brief 商业DRM，获取fairplay证书的地址
 	 * @default -
+	 * @hidden
 	 */
 	serverCertificatePath?: string;
 	/**
-	 * @brief 商业DRM播放时，是否开启防录屏
-	 * @notice 如果开启后，但当前环境不支持，则报错
+	 * @brief 商业DRM播放时，是否开启防录屏检测
+	 * @notice 如果开启后检测到当前环境不支持，则报错
 	 * @default true
+	 * @hidden
 	 */
 	unRecord?: boolean;
 	/** {zh}
@@ -3576,23 +3711,34 @@ declare enum PreloadScene {
 	NORMAL = 0,
 	/**
 	 * Feed流场景（播放器自动执行预加载）
+	 * @brief Feed 流场景（播放器自动执行预加载）
+	 */
+	/** {en}
+	 * @brief Feed流场景（播放器自动执行预加载）
 	 */
 	FEED = 1
 }
 declare enum StrategyNames {
 	/**
 	 * h265
+	 * @brief H.265 策略
 	 */
 	H265 = "h265",
 	/**
 	 * 预加载
+	 * @brief 预加载策略
+	 */
+	PRELOAD = "preload",
+	/**
+	 * Range拆分-动态Buffer
+	 * @brief 动态 Buffer
 	 */
-	PRELOAD = "preload"
+	ADAPT_RANGE = "adaptRange"
 }
-/**{zh}
+/** {zh}
  * @hidden
  * h265策略配置
- * @detail detail
+ * @detail Options
  */
 export declare type IH265Config = {
 	/**
@@ -3604,9 +3750,9 @@ export declare type IH265Config = {
 	 */
 	disabled?: boolean;
 } & VeStrategyH265Config;
-/**{zh}
+/** {zh}
  * 预加载初始配置
- * @detail detail
+ * @detail Options
  */
 export declare type IPreloadConfig = {
 	/**
@@ -3617,11 +3763,19 @@ export declare type IPreloadConfig = {
 	/**
 	 * 向前预加载视频个数，Feed流场景时生效
 	 * @default 1
+	 * @brief 向前预加载视频个数。Feed 流场景时生效。
+	 */
+	/** {en}
+	 * @brief 向前预加载视频个数，Feed流场景时生效
 	 */
 	prevCount?: number;
 	/**
 	 * 向后预加载视频个数，Feed流场景生效
 	 * @default 2
+	 * @brief 向后预加载视频个数。Feed 流场景生效
+	 */
+	/** {en}
+	 * @brief 向后预加载视频个数，Feed流场景生效
 	 */
 	nextCount?: number;
 	/**
@@ -3636,6 +3790,10 @@ export declare type IPreloadConfig = {
 	preloadMaxCacheCount?: number;
 	/**
 	 * 预加载依赖Module
+	 * @brief 预加载依赖 Module
+	 */
+	/** {en}
+	 * @brief 预加载依赖Module
 	 */
 	Strategy?: any;
 	/**
@@ -3643,36 +3801,81 @@ export declare type IPreloadConfig = {
 	 */
 	disabled?: boolean;
 };
-/**{zh}
- * 高级能力（策略）配置
- * @detail detail
+/** {zh}
+ * @hidden
+ * @detail Options
+ * @brief Range 拆分（动态Buffer）策略初始配置
+ * @notes adaptRange策略配置结构较复杂，暂不开放Range默认配置自定义，使用策略下发
+ */
+export declare type IAdaptRangeConfig = {
+	/** {zh}
+	 * @brief 预加载依赖Module
+	 */
+	Strategy?: any;
+	/** {zh}
+	 * @brief 是否禁用Range拆分策略
+	 */
+	disabled?: boolean;
+};
+/** {zh}
+ * @detail Options
+ * @brief 策略配置。
  */
 export declare type StrategyConfigOptions = {
 	/**
-	 * @hidden
 	 * h265策略配置
+	 * @hidden
+	 * @brief H.265 策略配置。
+	 */
+	/** {en}
+	 * @hidden
+	 * @brief h265策略配置
 	 */
 	[StrategyNames.H265]?: boolean | IH265Config;
 	/**
 	 * 预加载配置
+	 * @brief 预加载配置。
+	 */
+	/** {en}
+	 * @brief 预加载配置
 	 */
 	[StrategyNames.PRELOAD]?: boolean | IPreloadConfig;
+	/**
+	 * Range拆分（动态Buffer）
+	 * @brief 动态 Buffer 配置。
+	 */
+	/** {en}
+	 * @brief Range拆分（动态Buffer）
+	 */
+	[StrategyNames.ADAPT_RANGE]?: boolean | IAdaptRangeConfig;
 };
-/**{zh}
+/** {zh}
  * 播放器预初始化配置
- * @detail detail
+ * @detail Options
  */
 export declare type StrategyInitOptions = {
 	/**
 	 * 应用ID
+	 * @brief 应用 ID
+	 */
+	/** {en}
+	 * @brief 应用ID
 	 */
 	appId: number;
 	/**
 	 * 高级能力（策略）配置
+	 * @brief 策略配置
+	 */
+	/** {en}
+	 * @brief 高级能力（策略）配置
 	 */
 	strategies: StrategyConfigOptions;
 	/**
 	 * 设备ID
+	 * @brief 设备 ID
+	 */
+	/** {en}
+	 * @brief 设备ID
 	 */
 	deviceId?: string;
 	/**
@@ -3681,12 +3884,17 @@ export declare type StrategyInitOptions = {
 	plugins?: any[];
 	/**
 	 * 策略Module，默认自动加载
+	 * @brief 策略 Module，默认自动加载
+	 */
+	/** {en}
+	 * @brief 策略Module，默认自动加载
 	 */
 	Module?: typeof VeStrategy;
 };
-/**{zh}
+/** {zh}
  * 预加载实例，通过预加载实例可执行一些高级方法
- * @detail detail
+ * @detail Options
+ * @hidden
  */
 export declare type PreloaderManager = {
 	/**
@@ -3720,9 +3928,10 @@ declare enum PreloaderStatus {
 	 */
 	FAILED = 3
 }
-/**{zh}
+/** {zh}
  * 预加载配置更新
- * @detail detail
+ * @detail Options
+ * @hidden
  */
 export declare type IPreloadUpdateConfig = {
 	/**
@@ -3734,17 +3943,25 @@ export declare type IPreloadUpdateConfig = {
 	 */
 	nextCount?: number;
 };
-/**{zh}
+/** {zh}
  * 预加载视频资源
- * @detail detail
+ * @detail Options
  */
 export declare type IPreloadStream = {
 	/**
 	 * 视频唯一ID
+	 * @brief 视频 ID
+	 */
+	/** {en}
+	 * @brief 视频唯一ID
 	 */
 	vid: string;
 	/**
 	 * 播放地址
+	 * @brief 视频播放地址
+	 */
+	/** {en}
+	 * @brief 播放地址
 	 */
 	url: string;
 	/**
@@ -3753,22 +3970,42 @@ export declare type IPreloadStream = {
 	definition: string;
 	/**
 	 * 视频streamType，暂只支持 mp4
+	 * @brief 视频流类型，当前仅支持 mp4
+	 */
+	/** {en}
+	 * @brief 视频streamType，暂只支持 mp4
 	 */
 	streamType: string;
 	/**
 	 * 视频codec，暂支持 h264
+	 * @brief 视频编码格式，当前仅支持 mp4
+	 */
+	/** {en}
+	 * @brief 视频codec，暂支持 h264
 	 */
 	codec: string;
 	/**
 	 * 码率, 数据统计需要，可选填
+	 * @brief 码率, 数据统计需要，选填
+	 */
+	/** {en}
+	 * @brief 码率, 数据统计需要，可选填
 	 */
 	bitrate: number;
 	/**
 	 * 视频时长，数据统计需要，可选填
+	 * @brief 视频时长，数据统计需要，选填
+	 */
+	/** {en}
+	 * @brief 视频时长，数据统计需要，可选填
 	 */
 	duration: number;
 	/**
 	 * 视频大小，数据统计需要，可选填
+	 * @brief 视频大小，数据统计需要，选填
+	 */
+	/** {en}
+	 * @brief 视频大小，数据统计需要，可选填
 	 */
 	size: number;
 };
@@ -3801,12 +4038,50 @@ declare class VeStrategyWrapper {
 	prepare(): Promise<boolean>;
 	getDeviceId(): string;
 	isReady(): boolean;
-	getStrategyRecommendations(): StrategyRecommendation;
-	getStrategyRecommendationsAsync(): Promise<StrategyRecommendation>;
+	getStrategyRecommendations(options?: any, commonOptions?: any): StrategyRecommendation;
+	getStrategyRecommendationsAsync(options?: any, commonOptions?: any): Promise<StrategyRecommendation>;
 	isHevcRecommended(): boolean;
 	private initPreloaderConfig;
 }
 declare const _default: VeStrategyWrapper;
+/** {zh}
+ * @hidden
+ */
+export interface IAdaptRangeDefaultOptions {
+	maxTargetCacheDur: number;
+	minTargetCacheDur: number;
+	rangeMaxDuration: number;
+	rangeMinDuration: number;
+	cacheSafeFactor: number;
+	estPTcontrol: boolean;
+	estPlayTime: number;
+	minBandwidth: number;
+	minDangerThreshold: number;
+	rangeControl: boolean;
+	rangeMinSize: number;
+	safeFactor: number;
+	targetCacheControl: boolean;
+}
+declare abstract class AbstractBaseAdapter {
+	isLive: boolean;
+	playerData: PlayerData;
+	streamType: string;
+	constructor(options: {
+		configs: IPlayerConfig;
+		playerData: PlayerData;
+		streamType: string;
+	});
+	abstract canOpenAbr(vidPlayInfo?: VideoInfoRes): boolean;
+	abstract applyAbrPluginConfig(_finalOptions: any, _autoBitrateOpts: any): void;
+	abstract prepareAbrModule(_playerData: any, _sdkUmdLoader: any): void;
+	abstract needAbrAutoDefinition(): boolean;
+	abstract setAbrDefaultDefiWithAuto(): boolean;
+	abstract generatePlaylistFromServer(res: VideoInfoRes): Stream[];
+	abstract canAdaptRangeEnable(): boolean;
+	abstract adaptRangeDefaultOptions(): IAdaptRangeDefaultOptions | undefined;
+	abstract applyAdaptRangePluginConfig(_finalOptions: any, _adaptRangeOptions: any): void;
+	abstract applyAdaptRangeStrategy(_finalOptions: any, _adaptRangeOptions: any): void;
+}
 declare class PlayerData {
 	id?: string;
 	root?: HTMLElement;
@@ -3850,18 +4125,27 @@ declare class PlayerData {
 		urlExpireDiff: number;
 		urlCheckExpireInterval: number;
 	};
+	private isAutoBitrateEnable;
+	adapter: AbstractBaseAdapter;
 	isBusinessDrm: boolean;
 	isEncrypt: boolean;
 	dashOpts: {
 		Data: IGetPlayInfoRes;
 	};
-	constructor(configs: IPlayerConfig);
+	sdk: VePlayer;
+	constructor(configs: IPlayerConfig, sdk: VePlayer);
 	/**
 	 * 初始化播放数据
 	 * @param configs { IPlayerConfig } 播放器配置
 	 */
 	initPlayData(configs: IPlayerConfig): void;
 	initPlaylistAndGetCurrent(configs: IPlayerConfig): Stream;
+	checkAutoBitratePlayList(): boolean;
+	getABRStreamInfo(streamType: any, originDefaultStream: any): {
+		defaultDefinition: string;
+		defaultStream: any;
+		playList: Stream[];
+	};
 	isCurrentH265(): boolean;
 	getCurrentByDefaultConfig(): Stream;
 	initCurrent(currentStreams: Stream): void;
@@ -3878,12 +4162,13 @@ declare class PlayerData {
 	 * @description: 获取当前直播url
 	 */
 	getCurrentUrl(): Url;
+	getTargetStreamType(stream?: Stream): string;
 	/**
 	 * @description: 获取当前的streamType
 	 */
 	getCurrentStreamType(): string;
 	getStreamType(): string;
-	isOpenABR(streamType?: string): boolean;
+	isOpenABR(): boolean;
 	showRealDefinition(): boolean;
 	isAutoDefinition(def: any): boolean;
 	isPlayAutoDefinition(def?: string): boolean;
@@ -3936,8 +4221,8 @@ declare class PlayerData {
 	 * 更新playList
 	 */
 	updatePlayList(): void;
+	isVidPlay(): boolean;
 }
-declare function isMSESupport(mime?: string): boolean;
 /**
  * @hidden
  * @brief 移动端交互面板配置
@@ -3987,6 +4272,7 @@ declare enum UmdKeys {
 	VeStrategy = "vestrategy",
 	VeStrategyH265 = "vestrategy_h265",
 	VeStrategyPreload = "vestrategy_preload",
+	VeStrategyAdaptRange = "vestrategy_adapt_range",
 	DashAbralgo = "DashAbralgo",
 	Preloader = "preloader"
 }
@@ -3995,9 +4281,21 @@ declare enum UmdKeys {
  * @breif umdmap 配置
  */
 export declare type UMDMap = Record<UmdKeys, {
+	/**
+	 * umd Module 的名称，即在window下暴露的接口名称
+	 */
 	name: string;
+	/**
+	 * 对应umd文件名，只用来标记，实际不使用
+	 */
 	pluginName?: string;
+	/**
+	 * 对应npm包的名称，在打包文件时，会在libd.config.js中onPostBuild的钩子中会用于寻找对应npm包
+	 */
 	packageName: string;
+	/**
+	 * npm包中umd入口文件路径，用于打包上传到cdn目录
+	 */
 	devPath: string;
 }>;
 declare class umdLoader {
@@ -4058,6 +4356,9 @@ declare class VePlayer {
 	 * @type {PlayerData}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	playerData: PlayerData;
 	/** {zh}
 	 * @brief 播放器内核实例，详情参考{@link https://www.volcengine.com/docs/4/1249083 播放器内核}。
@@ -4071,6 +4372,9 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	mountingDom: Element;
 	/** {zh}
 	 * @hidden
@@ -4078,6 +4382,9 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	playerContainer: any;
 	/** {zh}
 	 * @hidden
@@ -4085,6 +4392,9 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	mobilePanel: any;
 	/** {zh}
 	 *
@@ -4142,6 +4452,7 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	sdkUmdLoader: umdLoader;
+	private adapter;
 	/**
 	 * @hidden
 	 */
@@ -4160,33 +4471,39 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	static sdkVersion: string;
-	/**{zh}
-	 * @brief 播放器预初始化配置
+	/**
+	 * @hidden
+	 */
+	private veErrorIns;
+	/** {zh}
+	 * @brief 播放策略预初始化配置
 	 * @param options 初始化配置，详情见{@link StrategyInitOptions}
 	 */
 	static prepare(options: StrategyInitOptions): Promise<void>;
-	/**{zh}
+	/** {zh}
 	 * @brief 设置预加载模式
 	 * @param preloadScene 预加载模式，详情见{@link PreloadScene}
 	 * @param options 预加载配置更新，详情见{@link IPreloadUpdateConfig}
 	 */
 	static setPreloadScene(preloadScene: PreloadScene, options?: IPreloadUpdateConfig): void;
-	/**{zh}
-	 * @brief 获取预加载实例，可通过预加载实例执行高级方法，需在VePlayer.prepare Promise执行完成之后才能获取到预加载实例
-	 * @returns 预加载实例，详情见{@link PreloaderManager}
+	/** {zh}
+	 * @hidden
+	 * @brief 获取预加载实例，可通过预加载实例执行高级方法，需在 `VePlayer.prepare` 的 Promise 执行完成之后才能获取到预加载实例。
+	 * @returns 预加载实例，详见 {@link PreloaderManager}
 	 */
 	static get preloader(): PreloaderManager | undefined;
-	/**{zh}
-	 * @brief 获取当前预加载实例状态
-	 * @returns 预加载实例状态，详情见{@link PreloaderStatus}
+	/** {zh}
+	 * @hidden
+	 * @brief 获取当前预加载实例状态。
+	 * @returns 预加载实例状态，详见 {@link PreloaderStatus}
 	 */
 	static get preloaderStatus(): PreloaderStatus;
-	/**{zh}
+	/** {zh}
 	 * @brief 添加待预加载视频列表
 	 * @param list 待预加载视频列表，详情见{@link IPreloadStream[]}。
 	 */
 	static addPreloadList(list: IPreloadStream[]): void;
-	/**{zh}
+	/** {zh}
 	 * @brief 设置待预加载视频列表，替换当前已设置的待预加载列表
 	 * @param list 待预加载视频列表，详情见{@link IPreloadStream[]}
 	 */
@@ -4295,6 +4612,9 @@ declare class VePlayer {
 	 *
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	renderDom(): void;
 	/** {zh}
 	 * @hidden
@@ -4302,6 +4622,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	renderPoster(): void;
 	/**
 	 * @brief 获取西瓜的definition的配置，用于在创建player或者在playNext()时传入definition，
@@ -4315,6 +4638,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	createPlayer(): Promise<PlayerCore>;
 	/** {zh}
 	 * @hidden
@@ -4323,6 +4649,9 @@ declare class VePlayer {
 	 * @return {void}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	setPluginConfig(finalOptions: IPlayerConfig): void;
 	/** {zh}
 	 * @hidden
@@ -4330,6 +4659,9 @@ declare class VePlayer {
 	 * @param {string} url 地址
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	detectCodec(url: string): Promise<void>;
 	/** {zh}
 	 * @hidden
@@ -4338,6 +4670,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	setDefaultConfigOptions(options: any): void;
 	/** {zh}
 	 * @brief 获取当前播放视频数据
@@ -4345,6 +4680,9 @@ declare class VePlayer {
 	 * @return {any}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	getCurrentPlayerConfig(): {
 		type?: "vod" | "live";
 		isLive?: boolean;
@@ -4381,6 +4719,7 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	afterPlayerCreate(): void;
+	_setVeError(): void;
 	/**
 	 * @hidden
 	 *
@@ -4453,6 +4792,9 @@ declare class VePlayer {
 	 * @param {*} pluginName
 	 * @param {*} IsShow
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	changePluginsIcon(pluginName: any, IsShow: any): void;
 	/** {zh}
 	 * @hidden
@@ -4462,18 +4804,23 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	getSdkPlugin(name: any): any;
 	/** {zh}
 	 * @brief 播放时更换临时播放 Token，以更换视频源。
 	 * @memberof VePlayer
 	 * @param config 临时播放 Token 配置。
 	 * @param isNewVideo 是否为新视频。为 `false` 时，更换后，会从更换前的时间点继续播放。
+	 * @notes 此接口不支持切换火山引擎私有加密 Token。
 	 */
 	switchAuthToken(config: IPlayAuthTokenConfig, isNewVideo?: boolean): Promise<void>;
 	/** {zh}
 	 * @brief 更新临时播放 Token。
 	 * @memberof VePlayer
-	 * @notes 播放前临时播放 Token 过期（收到 `play_auth_token_expired` 事件或者 `onTokenExpired` 回调触发）时，调用此方法更新临时播放 Token。
+	 * @notes - 播放前临时播放 Token 过期（收到 `play_auth_token_expired` 事件或者 `onTokenExpired` 回调触发）时，调用此方法更新临时播放 Token。
+	 *        - 此接口不支持切换火山引擎私有加密 Token。
 	 * @param config 临时播放 Token 配置。
 	 */
 	updateAuthToken(config: IPlayAuthTokenConfig): Promise<void>;
@@ -4503,13 +4850,17 @@ declare class VePlayer {
 	 * @param config 播放器配置。
 	 * @param isNewVideo 是否为新视频，默认为 `true`。为 `false` 时表示是同一个视频更换 token。更换后，会从更换前的时间点继续播放。
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	next(config: IPlayerConfig, isNewVideo?: boolean): Promise<void>;
 	/** {zh}
 	 * @brief 播放下一视频。
 	 * @return{Promise<any>}
 	 * @memberof VePlayer
-	 * @notes 成功更换视频源后，默认是暂停状态，如果设置了自动播放，则会自动播放。
-	 * @param config 播放器实例化配置。
+	 * @notes - 成功更换视频源后，默认是暂停状态。如果设置了自动播放，则会自动播放。
+	 *        - 此接口不支持切换火山引擎私有加密视频。
+	 * @param config 播放器实例化配置。此接口仅支持 `IPlayerConfig` 中的 `url`、`playList`、`poster`、`getVideoByToken` 字段。。
 	 * @param isNewVideo 是否为新视频。为 `false` 时，更换后，会从更换前的时间点继续播放。
 	 */
 	playNext(config: IPlayerConfig, isNewVideo?: boolean): Promise<any>;
@@ -4527,6 +4878,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	getPlayerInstance(): PlayerCore;
 	/** {zh}
 	 * @hidden
@@ -4534,6 +4888,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	getSoftDecodingOption(isOpenSoftDecoding: boolean, url: string, type: string): Promise<{
 		mediaType?: string;
 		innerDegrade?: number;
@@ -4546,6 +4903,9 @@ declare class VePlayer {
 	 * @brief  获取h265软解播放时的播放列表
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	setH265SoftPlayList(): void;
 	/** {zh}
 	 * @brief 切换清晰度
@@ -4699,11 +5059,6 @@ declare class VePlayer {
 	 * @param pluginName 插件名。
 	 */
 	getPlugin(pluginName: string): null | BasePlugin;
-	/**
-	 * @brief 当前浏览器环境是否支持商业drm防录屏
-	 * @return boolean 是否支持商业drm防录屏
-	 */
-	isDrmSupportUnRecord(): Promise<boolean>;
 	/** {zh}
 	 * @memberof VePlayer
 	 * @brief 销毁当前播放器实例。
@@ -5333,7 +5688,7 @@ export declare const Events: {
 	 */
 	LINE_CHANGE: string;
 	/** {zh}
-	 * @brief `playAuthToken` 获取 URL 失败。
+	 * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
 	 */
 	GET_PLAY_URL_ERR: string;
 	/** {zh}
@@ -5385,15 +5740,15 @@ export declare const Events: {
 	 */
 	PLAY_LIST_ITEM_CHANGE: string;
 	/** {zh}
-	 * @brief playNext开始
+	 * @brief `playNext` 开始。
 	 */
 	PLAY_NEXT_START: string;
 	/** {zh}
-	 * @brief playNext结束。
+	 * @brief `playNext` 结束。
 	 */
 	PLAY_NEXT_END: string;
 	/** {zh}
-	 * @brief 自动挡档位改变。
+	 * @brief 多码率自适应播放时，自动挡位对应的清晰度改变。
 	 */
 	ABR_AUTO_DESC_CHANGE: string;
 	/** {zh}
@@ -5517,9 +5872,11 @@ export declare const Events: {
 	 */
 	SHORTCUT: string;
 	/** {zh}
+	 * @deprecated
 	 * @brief SEI 信息解析。
 	 */
 	/** {en}
+	 * @deprecated
 	 * @brief The player parses the SEI information.
 	 */
 	SEI_PARSED: string;
@@ -5561,7 +5918,7 @@ export declare const Events: {
 	 */
 	NOT_SUPPORT_SOFT_DECODER: string;
 	/** {zh}
-	 * @brief `playAuthToken` 过期
+	 * @brief `playAuthToken` 过期。
 	 */
 	TOKEN_EXPIRED: string;
 	/** {zh}
@@ -5569,31 +5926,31 @@ export declare const Events: {
 	 */
 	UMD_LOAD_FAIL: string;
 	/** {zh}
-	 * @brief 切换下一个视频，playNext方法调用后触发
+	 * @brief 切换下一个视频。调用 `playNext` 后触发。
 	 */
 	PLAYNEXT: string;
 	/** {zh}
-	 * @brief 视频地址为空
+	 * @brief 视频地址为空。
 	 */
 	URL_NULL: string;
 	/** {zh}
-	 * @brief 鼠标移出
+	 * @brief 鼠标移出。
 	 */
 	LEAVE_PLAYER: string;
 	/** {zh}
-	 * @brief 鼠标移出
+	 * @brief 鼠标移入。
 	 */
 	ENTER_PLAYER: string;
 	/** {zh}
-	 * @brief 播放器状态重置
+	 * @brief 播放器状态重置。
 	 */
 	RESET: string;
 	/** {zh}
-	 * @brief <source> 加载错误，表示<source>不支持或播放失败
+	 * @brief `<source>` 加载错误，表示 `<source>` 不支持或播放失败。
 	 */
 	SOURCE_ERROR: string;
 	/** {zh}
-	 * @brief <source> 加载成功
+	 * @brief `<source>` 加载成功。
 	 */
 	SOURCE_SUCCESS: string;
 	/** {zh}
@@ -5614,11 +5971,11 @@ export declare const Events: {
 	DURATION_CHANGE: string;
 	/** {zh}
 	 * @deprecated
-	 * @brief 媒体被清空（初始化）时触发。
+	 * @brief （已废弃）媒体被清空时触发，通常是由于初始化。
 	 */
 	EMPITED: string;
 	/** {zh}
-	 * @brief 媒体被清空（初始化）时触发。
+	 * @brief 媒体被清空时触发，通常是由于初始化。
 	 */
 	EMPTIED: string;
 	/** {zh}
@@ -5834,9 +6191,11 @@ export declare const Event: {
 		 */
 		SHORTCUT: string;
 		/** {zh}
+		 * @deprecated
 		 * @brief SEI 信息解析。
 		 */
 		/** {en}
+		 * @deprecated
 		 * @brief The player parses the SEI information.
 		 */
 		SEI_PARSED: string;
@@ -5878,7 +6237,7 @@ export declare const Event: {
 		 */
 		NOT_SUPPORT_SOFT_DECODER: string;
 		/** {zh}
-		 * @brief `playAuthToken` 过期
+		 * @brief `playAuthToken` 过期。
 		 */
 		TOKEN_EXPIRED: string;
 		/** {zh}
@@ -5886,31 +6245,31 @@ export declare const Event: {
 		 */
 		UMD_LOAD_FAIL: string;
 		/** {zh}
-		 * @brief 切换下一个视频，playNext方法调用后触发
+		 * @brief 切换下一个视频。调用 `playNext` 后触发。
 		 */
 		PLAYNEXT: string;
 		/** {zh}
-		 * @brief 视频地址为空
+		 * @brief 视频地址为空。
 		 */
 		URL_NULL: string;
 		/** {zh}
-		 * @brief 鼠标移出
+		 * @brief 鼠标移出。
 		 */
 		LEAVE_PLAYER: string;
 		/** {zh}
-		 * @brief 鼠标移出
+		 * @brief 鼠标移入。
 		 */
 		ENTER_PLAYER: string;
 		/** {zh}
-		 * @brief 播放器状态重置
+		 * @brief 播放器状态重置。
 		 */
 		RESET: string;
 		/** {zh}
-		 * @brief <source> 加载错误，表示<source>不支持或播放失败
+		 * @brief `<source>` 加载错误，表示 `<source>` 不支持或播放失败。
 		 */
 		SOURCE_ERROR: string;
 		/** {zh}
-		 * @brief <source> 加载成功
+		 * @brief `<source>` 加载成功。
 		 */
 		SOURCE_SUCCESS: string;
 	};
@@ -5992,7 +6351,7 @@ export declare const Event: {
 		 */
 		LINE_CHANGE: string;
 		/** {zh}
-		 * @brief `playAuthToken` 获取 URL 失败。
+		 * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
 		 */
 		GET_PLAY_URL_ERR: string;
 		/** {zh}
@@ -6044,15 +6403,15 @@ export declare const Event: {
 		 */
 		PLAY_LIST_ITEM_CHANGE: string;
 		/** {zh}
-		 * @brief playNext开始
+		 * @brief `playNext` 开始。
 		 */
 		PLAY_NEXT_START: string;
 		/** {zh}
-		 * @brief playNext结束。
+		 * @brief `playNext` 结束。
 		 */
 		PLAY_NEXT_END: string;
 		/** {zh}
-		 * @brief 自动挡档位改变。
+		 * @brief 多码率自适应播放时，自动挡位对应的清晰度改变。
 		 */
 		ABR_AUTO_DESC_CHANGE: string;
 	};