@volcengine/veplayer 1.9.7-rc.2 → 1.9.7-rc.3

package/index.d.ts

@@ -2057,10 +2057,16 @@ export declare class MemoryPlay extends Plugin {
 	getTimeByStorage(memoryId: string): string | 0;
 	destroy(): void;
 }
+/** {zh}
+ * @hidden
+ */
 export declare const enum EDRMTYPE {
 	DRM_ENCRYPT = "drm_encrypt",
 	PRIVATE_ENCRYPT = "private_encrypt"
 }
+/** {zh}
+ * @hidden
+ */
 export interface IPlayInfoListItem {
 	BackupPlayUrl: string;
 	BackupUrlExpire: string;
@@ -2089,6 +2095,10 @@ export interface IPlayInfoListItem {
 	Width: number;
 	DrmType?: EDRMTYPE;
 }
+/** {zh}
+ * @hidden
+ * @brief 音频封装格式
+ */
 export interface ISubtitleInfoList {
 	CreateTime: string;
 	FileId: string;
@@ -2105,6 +2115,9 @@ export interface ISubtitleInfoList {
 	Version: string;
 	Vid: string;
 }
+/** {zh}
+ * @hidden
+ */
 export interface IThumbInfoItem {
 	CaptureNum: number;
 	CellHeight: number;
@@ -2115,6 +2128,10 @@ export interface IThumbInfoItem {
 	Interval: number;
 	StoreUrls: string[];
 }
+/** {zh}
+ * @brief 蒙版弹幕信息
+ * @hidden
+ */
 export interface IBarrageMaskInfo {
 	Version: string;
 	BarrageMaskUrl: string;
@@ -2125,16 +2142,25 @@ 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?: DashAdaptiveInfo;
@@ -2176,15 +2202,15 @@ export declare const 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}
@@ -2867,45 +2893,72 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	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 播放器中间切换暂停/播放的按钮插件配置
@@ -3056,7 +3109,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	disableVodLogOptsCheck?: boolean;
 	/** {zh}
-	 * @brief 是否打开日志打印
+	 * @brief 是否开启日志打印。
 	 * @default false
 	 */
 	debug?: boolean;
@@ -3114,12 +3167,12 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
 	/** {zh}
-	 * @brief 自适应码率配置。
+	 * @brief 多码率自适应播放配置。
 	 * @default -
 	 */
 	autoBitrateOpts?: IAutoBitrateOpts;
 	/** {zh}
-	 * @brief Range拆分（动态Buffer）
+	 * @brief 动态 Buffer 配置。
 	 * @default -
 	 */
 	adaptRange?: IAdaptRange;
@@ -3656,24 +3709,31 @@ 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
 	 */
 	ADAPT_RANGE = "adaptRange"
 }
-/**{zh}
+/** {zh}
  * @hidden
  * h265策略配置
  * @detail Options
@@ -3688,7 +3748,7 @@ export declare type IH265Config = {
 	 */
 	disabled?: boolean;
 } & VeStrategyH265Config;
-/**{zh}
+/** {zh}
  * 预加载初始配置
  * @detail Options
  */
@@ -3701,11 +3761,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;
 	/**
@@ -3720,6 +3788,10 @@ export declare type IPreloadConfig = {
 	preloadMaxCacheCount?: number;
 	/**
 	 * 预加载依赖Module
+	 * @brief 预加载依赖 Module
+	 */
+	/** {en}
+	 * @brief 预加载依赖Module
 	 */
 	Strategy?: any;
 	/**
@@ -3727,53 +3799,81 @@ export declare type IPreloadConfig = {
 	 */
 	disabled?: boolean;
 };
-/**{zh}
- * Range拆分（动态Buffer）策略初始配置
- * @detail detail
+/** {zh}
+ * @hidden
+ * @detail Options
+ * @brief Range 拆分（动态Buffer）策略初始配置
+ * @notes adaptRange策略配置结构较复杂，暂不开放Range默认配置自定义，使用策略下发
  */
 export declare type IAdaptRangeConfig = {
-	/**
-	 * 预加载依赖Module
+	/** {zh}
+	 * @brief 预加载依赖Module
 	 */
 	Strategy?: any;
-	/**
-	 * 是否禁用Range拆分策略
+	/** {zh}
+	 * @brief 是否禁用Range拆分策略
 	 */
 	disabled?: boolean;
 };
-/**{zh}
- * 高级能力（策略）配置
+/** {zh}
  * @detail Options
+ * @brief 策略配置。
  */
 export declare type StrategyConfigOptions = {
 	/**
 	 * 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 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;
 	/**
@@ -3782,10 +3882,14 @@ export declare type StrategyInitOptions = {
 	plugins?: any[];
 	/**
 	 * 策略Module，默认自动加载
+	 * @brief 策略 Module，默认自动加载
+	 */
+	/** {en}
+	 * @brief 策略Module，默认自动加载
 	 */
 	Module?: typeof VeStrategy;
 };
-/**{zh}
+/** {zh}
  * 预加载实例，通过预加载实例可执行一些高级方法
  * @detail Options
  * @hidden
@@ -3822,7 +3926,7 @@ declare enum PreloaderStatus {
 	 */
 	FAILED = 3
 }
-/**{zh}
+/** {zh}
  * 预加载配置更新
  * @detail Options
  * @hidden
@@ -3837,17 +3941,25 @@ export declare type IPreloadUpdateConfig = {
 	 */
 	nextCount?: number;
 };
-/**{zh}
+/** {zh}
  * 预加载视频资源
  * @detail Options
  */
 export declare type IPreloadStream = {
 	/**
 	 * 视频唯一ID
+	 * @brief 视频 ID
+	 */
+	/** {en}
+	 * @brief 视频唯一ID
 	 */
 	vid: string;
 	/**
 	 * 播放地址
+	 * @brief 视频播放地址
+	 */
+	/** {en}
+	 * @brief 播放地址
 	 */
 	url: string;
 	/**
@@ -3856,22 +3968,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;
 };
@@ -3910,11 +4042,17 @@ declare class VeStrategyWrapper {
 	private initPreloaderConfig;
 }
 declare const _default: VeStrategyWrapper;
+/** {zh}
+ * @hidden
+ */
 export declare type IRes = IGetPlayInfoRes & {
 	Data: IGetPlayInfoRes & {
 		VideoID?: string;
 	};
 };
+/** {zh}
+ * @hidden
+ */
 export interface IDefItem extends Stream {
 	vid: string;
 	lineId?: number;
@@ -3931,6 +4069,9 @@ export interface IDefItem extends Stream {
 	vwidth?: number;
 	vheight?: number;
 }
+/** {zh}
+ * @hidden
+ */
 export interface VideoInfoRes {
 	playList: IDefItem[];
 	type?: string;
@@ -3946,6 +4087,9 @@ export interface VideoInfoRes {
 	adaptiveBitrateStreamingInfo?: ABRInfo;
 }
 declare function isMSESupport(mime?: string): boolean;
+/** {zh}
+ * @hidden
+ */
 export interface IAdaptRangeDefaultOptions {
 	maxTargetCacheDur: number;
 	minTargetCacheDur: number;
@@ -4754,7 +4898,7 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 * @notes - 成功更换视频源后，默认是暂停状态。如果设置了自动播放，则会自动播放。
 	 *        - 此接口不支持切换火山引擎私有加密视频。
-	 * @param config 播放器实例化配置。
+	 * @param config 播放器实例化配置。此接口仅支持 `IPlayerConfig` 中的 `url`、`playList`、`poster`、`getVideoByToken` 字段。。
 	 * @param isNewVideo 是否为新视频。为 `false` 时，更换后，会从更换前的时间点继续播放。
 	 */
 	playNext(config: IPlayerConfig, isNewVideo?: boolean): Promise<any>;
@@ -5582,7 +5726,7 @@ export declare const Events: {
 	 */
 	LINE_CHANGE: string;
 	/** {zh}
-	 * @brief `playAuthToken` 获取 URL 失败。
+	 * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
 	 */
 	GET_PLAY_URL_ERR: string;
 	/** {zh}
@@ -5634,15 +5778,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}
@@ -5812,7 +5956,7 @@ export declare const Events: {
 	 */
 	NOT_SUPPORT_SOFT_DECODER: string;
 	/** {zh}
-	 * @brief `playAuthToken` 过期
+	 * @brief `playAuthToken` 过期。
 	 */
 	TOKEN_EXPIRED: string;
 	/** {zh}
@@ -5820,31 +5964,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}
@@ -5865,11 +6009,11 @@ export declare const Events: {
 	DURATION_CHANGE: string;
 	/** {zh}
 	 * @deprecated
-	 * @brief 媒体被清空（初始化）时触发。
+	 * @brief （已废弃）媒体被清空时触发，通常是由于初始化。
 	 */
 	EMPITED: string;
 	/** {zh}
-	 * @brief 媒体被清空（初始化）时触发。
+	 * @brief 媒体被清空时触发，通常是由于初始化。
 	 */
 	EMPTIED: string;
 	/** {zh}
@@ -6131,7 +6275,7 @@ export declare const Event: {
 		 */
 		NOT_SUPPORT_SOFT_DECODER: string;
 		/** {zh}
-		 * @brief `playAuthToken` 过期
+		 * @brief `playAuthToken` 过期。
 		 */
 		TOKEN_EXPIRED: string;
 		/** {zh}
@@ -6139,31 +6283,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;
 	};
@@ -6245,7 +6389,7 @@ export declare const Event: {
 		 */
 		LINE_CHANGE: string;
 		/** {zh}
-		 * @brief `playAuthToken` 获取 URL 失败。
+		 * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
 		 */
 		GET_PLAY_URL_ERR: string;
 		/** {zh}
@@ -6297,15 +6441,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;
 	};