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

package/index.d.ts

@@ -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 {
 	/**
@@ -2420,6 +2424,16 @@ export interface Stream extends Partial<IPlayInfoListItem> {
 	 * @brief 多语言词典中对应的 key。比如 `lineTextKey: LINE_ONE`。
 	 */
 	lineTextKey?: string;
+	/**
+	 * @brief 该码流视频的宽度，单位为 px
+	 * @default -
+	 */
+	width?: number;
+	/**
+	 * @brief 该码流视频的高度，单位为 px
+	 * @default -
+	 */
+	height?: number;
 	/**
 	 * @brief 码流的平均码率
 	 * @default -
@@ -2522,7 +2536,7 @@ export declare type Url = string | Array<{
  * @brief 播放器实例化配置。
  */
 /** {en}
- * @brief Player Instance Configuration
+ * @brief Player instantiation configuration.
  */
 export interface IPlayerConfig extends IPlayerOptions {
 	/** {zh}
@@ -2530,6 +2544,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default false
 	 * @hidden
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	isLive?: boolean;
 	/** {zh}
 	 * @brief 播放器容器 ID。播放器将被插入在该容器中。
@@ -2807,6 +2824,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default 无
 	 * @hidden 直播目前没用到
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	commonStyle?: ICommonStyle;
 	/** {zh}
 	 * @brief 是否开启音乐播放模式。开启后，您可还通过 `music` 参数对音乐播放器进行配置。取值如下：
@@ -2823,6 +2843,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @type {boolean}
 	 * @memberof IPlayerConfig
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	enableContextmenu?: boolean;
 	/** {zh}
 	 * @brief 是否关闭 `video` 标签的事件冒泡。取值如下：
@@ -2840,54 +2863,95 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	enableMenu?: boolean;
 	/**
-	 * @brief 是否关闭pc端单击播放器区域切换播放/暂停
+	 * @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}
@@ -2931,11 +2995,17 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 默认配置
 	 * @hidden
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	defaultConfig?: IDefaultConfig;
 	/** {zh}
 	 * @hidden
 	 * @brief 模拟mobile
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	isMobile?: boolean;
 	/** {zh}
 	 * @brief UMD 依赖备用地址。用于依赖的 CDN 发生网络错误时的降级备用地址。支持的依赖如下：
@@ -3013,6 +3083,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 播放源过期的回调函数。可用来更新播放源数据。
 	 * @default -
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	onMediaExpired?: () => Promise<SourceConfig>;
 	/** {zh}
 	 * @brief 临时播放 Token 过期时的回调函数，可用来更新临时播放 Token。
@@ -3024,12 +3097,18 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 禁用点播日志配置检测，默认开启，如果未配置line_app_id则会播放报错
 	 * @default -
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	disableVodLogOptsCheck?: boolean;
 	/** {zh}
 	 * @hidden
 	 * @brief 是否打开日志打印
 	 * @default false
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	debug?: boolean;
 	/** {zh}
 	 * @brief 播放器报错信息。支持配置播放异常时显示的异常文案、图片以及是否提供刷新按钮等。
@@ -3042,6 +3121,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 * @hidden
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	rtm?: IRtmConfig;
 	/** {zh}
 	 * @brief 弹幕及面板配置。支持配置弹幕文字大小、透明度、展示区域等参数。
@@ -3058,6 +3140,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief DASH 播放配置项
 	 * @default -
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	DASHPlugin?: Partial<IDashPluginConfig>;
 	/** {zh}
 	 * @brief HLS 加密播放配置。
@@ -3074,6 +3159,9 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief mp4加密播放配置项
 	 * @default -
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
 	/** {zh}
 	 * @brief 自适应码率配置。
@@ -3083,11 +3171,19 @@ export interface IPlayerConfig extends IPlayerOptions {
 	/** {zh}
 	 * @brief Range拆分（动态Buffer）
 	 * @default -
+	 * @hidden
+	 */
+	/** {en}
+	 * @hidden
 	 */
 	adaptRange?: IAdaptRange;
 	/** {zh}
-	 * @brief 视频时长
+	 * @brief 视频时长。
 	 * @default -
+	 * @hidden
+	 */
+	/** {en}
+	 * @hidden
 	 */
 	duration?: number;
 	/** {zh}
@@ -3137,6 +3233,9 @@ export declare type SourceConfig = Pick<IPlayerConfig, "url" | "playList" | "get
 /** {zh}
  * @hidden
  */
+/** {en}
+ * @hidden
+ */
 export interface IDefaultConfig {
 	/** {zh}
 	 * @brief “点播”还是“直播”
@@ -3276,17 +3375,20 @@ export interface IPlayAuthTokenConfig {
 	/**
 	 * @brief 商业DRM 获取license的token
 	 * @default -
+	 * @hidden
 	 */
 	thirdPartyDrmAuthToken?: string;
 	/**
 	 * @brief 商业DRM，获取fairplay证书的地址
 	 * @default -
+	 * @hidden
 	 */
 	serverCertificatePath?: string;
 	/**
 	 * @brief 商业DRM播放时，是否开启防录屏检测
 	 * @notice 如果开启后检测到当前环境不支持，则报错
 	 * @default true
+	 * @hidden
 	 */
 	unRecord?: boolean;
 	/** {zh}
@@ -3643,6 +3745,10 @@ export declare type IH265Config = {
 /**{zh}
  * 预加载初始配置
  * @detail Options
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export declare type IPreloadConfig = {
 	/**
@@ -3682,6 +3788,10 @@ export declare type IPreloadConfig = {
 /**{zh}
  * Range拆分（动态Buffer）策略初始配置
  * @detail detail
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export declare type IAdaptRangeConfig = {
 	/**
@@ -3696,6 +3806,10 @@ export declare type IAdaptRangeConfig = {
 /**{zh}
  * 高级能力（策略）配置
  * @detail Options
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export declare type StrategyConfigOptions = {
 	/**
@@ -3714,6 +3828,10 @@ export declare type StrategyConfigOptions = {
 /**{zh}
  * 播放器预初始化配置
  * @detail Options
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export declare type StrategyInitOptions = {
 	/**
@@ -3740,6 +3858,7 @@ export declare type StrategyInitOptions = {
 /**{zh}
  * 预加载实例，通过预加载实例可执行一些高级方法
  * @detail Options
+ * @hidden
  */
 export declare type PreloaderManager = {
 	/**
@@ -3776,6 +3895,7 @@ declare enum PreloaderStatus {
 /**{zh}
  * 预加载配置更新
  * @detail Options
+ * @hidden
  */
 export declare type IPreloadUpdateConfig = {
 	/**
@@ -3790,6 +3910,10 @@ export declare type IPreloadUpdateConfig = {
 /**{zh}
  * 预加载视频资源
  * @detail Options
+ * @hidden
+ */
+/** {en}
+ * @hidden
  */
 export declare type IPreloadStream = {
 	/**
@@ -3915,8 +4039,12 @@ declare abstract class AbstractBaseAdapter {
 	isLive: boolean;
 	playerData: PlayerData;
 	streamType: string;
-	constructor(options: any);
-	abstract canOpenAbr(): boolean;
+	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;
@@ -3977,7 +4105,8 @@ declare class PlayerData {
 	dashOpts: {
 		Data: IGetPlayInfoRes;
 	};
-	constructor(configs: IPlayerConfig);
+	sdk: VePlayer;
+	constructor(configs: IPlayerConfig, sdk: VePlayer);
 	/**
 	 * 初始化播放数据
 	 * @param configs { IPlayerConfig } 播放器配置
@@ -4065,6 +4194,7 @@ declare class PlayerData {
 	 * 更新playList
 	 */
 	updatePlayList(): void;
+	isVidPlay(): boolean;
 }
 /**
  * @hidden
@@ -4199,6 +4329,9 @@ declare class VePlayer {
 	 * @type {PlayerData}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	playerData: PlayerData;
 	/** {zh}
 	 * @brief 播放器内核实例，详情参考{@link https://www.volcengine.com/docs/4/1249083 播放器内核}。
@@ -4212,6 +4345,9 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	mountingDom: Element;
 	/** {zh}
 	 * @hidden
@@ -4219,6 +4355,9 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	playerContainer: any;
 	/** {zh}
 	 * @hidden
@@ -4226,6 +4365,9 @@ declare class VePlayer {
 	 * @type {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	mobilePanel: any;
 	/** {zh}
 	 *
@@ -4314,13 +4456,15 @@ declare class VePlayer {
 	 */
 	static setPreloadScene(preloadScene: PreloadScene, options?: IPreloadUpdateConfig): void;
 	/** {zh}
-	 * @brief 获取预加载实例，可通过预加载实例执行高级方法，需在VePlayer.prepare Promise执行完成之后才能获取到预加载实例
-	 * @returns 预加载实例，详情见{@link PreloaderManager}
+	 * @hidden
+	 * @brief 获取预加载实例，可通过预加载实例执行高级方法，需在 `VePlayer.prepare` 的 Promise 执行完成之后才能获取到预加载实例。
+	 * @returns 预加载实例，详见 {@link PreloaderManager}
 	 */
 	static get preloader(): PreloaderManager | undefined;
 	/** {zh}
-	 * @brief 获取当前预加载实例状态
-	 * @returns 预加载实例状态，详情见{@link PreloaderStatus}
+	 * @hidden
+	 * @brief 获取当前预加载实例状态。
+	 * @returns 预加载实例状态，详见 {@link PreloaderStatus}
 	 */
 	static get preloaderStatus(): PreloaderStatus;
 	/** {zh}
@@ -4437,6 +4581,9 @@ declare class VePlayer {
 	 *
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	renderDom(): void;
 	/** {zh}
 	 * @hidden
@@ -4444,6 +4591,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	renderPoster(): void;
 	/**
 	 * @brief 获取西瓜的definition的配置，用于在创建player或者在playNext()时传入definition，
@@ -4457,6 +4607,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	createPlayer(): Promise<PlayerCore>;
 	/** {zh}
 	 * @hidden
@@ -4465,6 +4618,9 @@ declare class VePlayer {
 	 * @return {void}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	setPluginConfig(finalOptions: IPlayerConfig): void;
 	/** {zh}
 	 * @hidden
@@ -4472,6 +4628,9 @@ declare class VePlayer {
 	 * @param {string} url 地址
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	detectCodec(url: string): Promise<void>;
 	/** {zh}
 	 * @hidden
@@ -4480,6 +4639,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	setDefaultConfigOptions(options: any): void;
 	/** {zh}
 	 * @brief 获取当前播放视频数据
@@ -4487,6 +4649,9 @@ declare class VePlayer {
 	 * @return {any}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	getCurrentPlayerConfig(): {
 		type?: "vod" | "live";
 		isLive?: boolean;
@@ -4595,6 +4760,9 @@ declare class VePlayer {
 	 * @param {*} pluginName
 	 * @param {*} IsShow
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	changePluginsIcon(pluginName: any, IsShow: any): void;
 	/** {zh}
 	 * @hidden
@@ -4604,18 +4772,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>;
@@ -4645,12 +4818,16 @@ 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 成功更换视频源后，默认是暂停状态，如果设置了自动播放，则会自动播放。
+	 * @notes - 成功更换视频源后，默认是暂停状态。如果设置了自动播放，则会自动播放。
+	 *        - 此接口不支持切换火山引擎私有加密视频。
 	 * @param config 播放器实例化配置。
 	 * @param isNewVideo 是否为新视频。为 `false` 时，更换后，会从更换前的时间点继续播放。
 	 */
@@ -4669,6 +4846,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	getPlayerInstance(): PlayerCore;
 	/** {zh}
 	 * @hidden
@@ -4676,6 +4856,9 @@ declare class VePlayer {
 	 * @return {*}
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	getSoftDecodingOption(isOpenSoftDecoding: boolean, url: string, type: string): Promise<{
 		mediaType?: string;
 		innerDegrade?: number;
@@ -4688,6 +4871,9 @@ declare class VePlayer {
 	 * @brief  获取h265软解播放时的播放列表
 	 * @memberof VePlayer
 	 */
+	/** {en}
+	 * @hidden
+	 */
 	setH265SoftPlayList(): void;
 	/** {zh}
 	 * @brief 切换清晰度