@volcengine/veplayer 1.9.6-rc.8 → 1.9.6

package/index.d.ts

@@ -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'
@@ -2425,12 +2425,12 @@ export interface Stream extends Partial<IPlayInfoListItem> {
 	 */
 	lineTextKey?: string;
 	/**
-	 * @brief 该码流视频的宽度，单位为 px
+	 * @brief 该码流视频的宽度，单位为像素
 	 * @default -
 	 */
 	width?: number;
 	/**
-	 * @brief 该码流视频的高度，单位为 px
+	 * @brief 该码流视频的高度，单位为像素
 	 * @default -
 	 */
 	height?: number;
@@ -2821,11 +2821,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	"x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
 	/** {zh}
 	 * @brief 为播放器配置关键点样式。
-	 * @default 无
-	 * @hidden 直播目前没用到
-	 */
-	/** {en}
-	 * @hidden
+	 * @default -
 	 */
 	commonStyle?: ICommonStyle;
 	/** {zh}
@@ -2865,93 +2861,55 @@ export interface IPlayerConfig extends IPlayerOptions {
 	/**
 	 * @brief 是否禁用 PC 端点击播放器区域切换播放和暂停功能。
 	 * @default false
-	 * @hidden
 	 */
 	/** {en}
 	 * @brief Whether to disable the ability to toggle play and pause by clicking on the player area on PC.
-	 * @hidden
 	 */
 	closeVideoClick?: boolean;
 	/**
 	 * @brief pc端: 是否关闭双击播放器进入全屏的能力
 	 * mobile端: 是否关闭双击切换暂停/播放的能力
 	 * @default pc端: true， mobile端: false
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	closeVideoDblclick?: boolean;
 	/**
 	 * @brief 是否关闭播放器自动失焦（只在pc端生效）
 	 * @default false
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	closeDelayBlur?: boolean;
 	/**
 	 * @brief 播放器focus状态自动消失延迟时长，单位为ms
 	 * @default pc端: 2000， mobile端: 3000
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	inactive?: number;
 	/**
 	 * @brief 用户鼠标离开播放器区域之后，控制栏隐藏延时时间，如果想要鼠标移出播放器区域就隐藏，则配置为0（只在pc端生效）
 	 * @default 0
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	leavePlayerTime?: number;
 	/**
 	 * @brief 是否关闭play时触发player焦点状态
 	 * @default pc端：true, mobile端：false
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	closePlayVideoFocus?: boolean;
 	/**
 	 * @brief 是否关闭pause时触发player焦点状态，会强制呼出控制栏
 	 * @default false
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	closePauseVideoFocus?: boolean;
 	/**
 	 * @brief 是否需要在退出全屏后滚动定位到全屏之前的位置。（一般安卓下退出全屏后页面会滚动）
 	 * @default false
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	needFullscreenScroll?: boolean;
 	/**
 	 * @brief 移动端交互插件配置
 	 * @default -
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	mobile?: IMobileConfig;
 	/**
 	 * @brief 播放器中间切换暂停/播放的按钮插件配置
 	 * @default -
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	start?: IStartConfig;
 	/** {zh}
@@ -3079,13 +3037,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	urlCheckExpireInterval?: number;
 	/** {zh}
-	 * @hidden
 	 * @brief 播放源过期的回调函数。可用来更新播放源数据。
 	 * @default -
 	 */
-	/** {en}
-	 * @hidden
-	 */
 	onMediaExpired?: () => Promise<SourceConfig>;
 	/** {zh}
 	 * @brief 临时播放 Token 过期时的回调函数，可用来更新临时播放 Token。
@@ -3102,13 +3056,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	disableVodLogOptsCheck?: boolean;
 	/** {zh}
-	 * @hidden
 	 * @brief 是否打开日志打印
 	 * @default false
 	 */
-	/** {en}
-	 * @hidden
-	 */
 	debug?: boolean;
 	/** {zh}
 	 * @brief 播放器报错信息。支持配置播放异常时显示的异常文案、图片以及是否提供刷新按钮等。
@@ -3171,10 +3121,6 @@ export interface IPlayerConfig extends IPlayerOptions {
 	/** {zh}
 	 * @brief Range拆分（动态Buffer）
 	 * @default -
-	 * @hidden
-	 */
-	/** {en}
-	 * @hidden
 	 */
 	adaptRange?: IAdaptRange;
 	/** {zh}
@@ -3745,10 +3691,6 @@ export declare type IH265Config = {
 /**{zh}
  * 预加载初始配置
  * @detail Options
- * @hidden
- */
-/** {en}
- * @hidden
  */
 export declare type IPreloadConfig = {
 	/**
@@ -3788,10 +3730,6 @@ export declare type IPreloadConfig = {
 /**{zh}
  * Range拆分（动态Buffer）策略初始配置
  * @detail detail
- * @hidden
- */
-/** {en}
- * @hidden
  */
 export declare type IAdaptRangeConfig = {
 	/**
@@ -3806,10 +3744,6 @@ export declare type IAdaptRangeConfig = {
 /**{zh}
  * 高级能力（策略）配置
  * @detail Options
- * @hidden
- */
-/** {en}
- * @hidden
  */
 export declare type StrategyConfigOptions = {
 	/**
@@ -3828,10 +3762,6 @@ export declare type StrategyConfigOptions = {
 /**{zh}
  * 播放器预初始化配置
  * @detail Options
- * @hidden
- */
-/** {en}
- * @hidden
  */
 export declare type StrategyInitOptions = {
 	/**
@@ -3910,10 +3840,6 @@ export declare type IPreloadUpdateConfig = {
 /**{zh}
  * 预加载视频资源
  * @detail Options
- * @hidden
- */
-/** {en}
- * @hidden
  */
 export declare type IPreloadStream = {
 	/**