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

package/index.d.ts

@@ -2101,7 +2101,7 @@ export interface ISubtitleInfoList {
 	Version: string;
 	Vid: string;
 }
-export interface IThumbInfoList {
+export interface IThumbInfoItem {
 	CaptureNum: number;
 	CellHeight: number;
 	CellWidth: number;
@@ -2121,9 +2121,20 @@ export interface IBarrageMaskInfo {
 	Bitrate: number;
 	HeadLen: number;
 }
+export interface DashAdaptiveInfo {
+	AdaptiveType: string;
+	BackupPlayUrl: string;
+	MainPlayUrl: string;
+}
+export interface ABRInfo {
+	AbrFormat: string;
+	BackupPlayUrl: string;
+	MainPlayUrl: string;
+}
 export interface IGetPlayInfoRes {
 	Vid: string;
-	AdaptiveInfo?: any;
+	AdaptiveInfo?: DashAdaptiveInfo;
+	AdaptiveBitrateStreamingInfo?: ABRInfo;
 	BarrageMaskInfo?: IBarrageMaskInfo;
 	BarrageMaskUrl: string;
 	Duration: number;
@@ -2133,7 +2144,7 @@ export interface IGetPlayInfoRes {
 	PosterUrl: string;
 	Status: number;
 	SubtitleInfoList: ISubtitleInfoList[];
-	ThumbInfoList: IThumbInfoList[];
+	ThumbInfoList: IThumbInfoItem[];
 	TotalCount: number;
 	Version: number;
 }
@@ -3069,6 +3080,16 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 */
 	autoBitrateOpts?: IAutoBitrateOpts;
+	/** {zh}
+	 * @brief Range拆分（动态Buffer）
+	 * @default -
+	 */
+	adaptRange?: IAdaptRange;
+	/** {zh}
+	 * @brief 视频时长
+	 * @default -
+	 */
+	duration?: number;
 	/** {zh}
 	 * @brief 外挂字幕配置。
 	 * @default -
@@ -3598,12 +3619,16 @@ declare enum StrategyNames {
 	/**
 	 * 预加载
 	 */
-	PRELOAD = "preload"
+	PRELOAD = "preload",
+	/**
+	 * Range拆分-动态Buffer
+	 */
+	ADAPT_RANGE = "adaptRange"
 }
 /**{zh}
  * @hidden
  * h265策略配置
- * @detail detail
+ * @detail Options
  */
 export declare type IH265Config = {
 	/**
@@ -3617,7 +3642,7 @@ export declare type IH265Config = {
 } & VeStrategyH265Config;
 /**{zh}
  * 预加载初始配置
- * @detail detail
+ * @detail Options
  */
 export declare type IPreloadConfig = {
 	/**
@@ -3655,12 +3680,25 @@ export declare type IPreloadConfig = {
 	disabled?: boolean;
 };
 /**{zh}
- * 高级能力（策略）配置
+ * Range拆分（动态Buffer）策略初始配置
  * @detail detail
  */
+export declare type IAdaptRangeConfig = {
+	/**
+	 * 预加载依赖Module
+	 */
+	Strategy?: any;
+	/**
+	 * 是否禁用Range拆分策略
+	 */
+	disabled?: boolean;
+};
+/**{zh}
+ * 高级能力（策略）配置
+ * @detail Options
+ */
 export declare type StrategyConfigOptions = {
 	/**
-	 * @hidden
 	 * h265策略配置
 	 */
 	[StrategyNames.H265]?: boolean | IH265Config;
@@ -3668,10 +3706,14 @@ export declare type StrategyConfigOptions = {
 	 * 预加载配置
 	 */
 	[StrategyNames.PRELOAD]?: boolean | IPreloadConfig;
+	/**
+	 * Range拆分（动态Buffer）
+	 */
+	[StrategyNames.ADAPT_RANGE]?: boolean | IAdaptRangeConfig;
 };
 /**{zh}
  * 播放器预初始化配置
- * @detail detail
+ * @detail Options
  */
 export declare type StrategyInitOptions = {
 	/**
@@ -3697,7 +3739,7 @@ export declare type StrategyInitOptions = {
 };
 /**{zh}
  * 预加载实例，通过预加载实例可执行一些高级方法
- * @detail detail
+ * @detail Options
  */
 export declare type PreloaderManager = {
 	/**
@@ -3733,7 +3775,7 @@ declare enum PreloaderStatus {
 }
 /**{zh}
  * 预加载配置更新
- * @detail detail
+ * @detail Options
  */
 export declare type IPreloadUpdateConfig = {
 	/**
@@ -3747,7 +3789,7 @@ export declare type IPreloadUpdateConfig = {
 };
 /**{zh}
  * 预加载视频资源
- * @detail detail
+ * @detail Options
  */
 export declare type IPreloadStream = {
 	/**
@@ -3812,12 +3854,79 @@ 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;
+export declare type IRes = IGetPlayInfoRes & {
+	Data: IGetPlayInfoRes & {
+		VideoID?: string;
+	};
+};
+export interface IDefItem extends Stream {
+	vid: string;
+	lineId?: number;
+	lineName?: string;
+	url: string;
+	streamType: string;
+	backupUrl: string;
+	backUrlList: string[];
+	fileType?: "video" | "audio" | "evideo" | "eaudio";
+	format: string;
+	bitrate?: number;
+	size?: number;
+	kid?: string;
+	vwidth?: number;
+	vheight?: number;
+}
+export interface VideoInfoRes {
+	playList: IDefItem[];
+	type?: string;
+	poster: string;
+	vid: string;
+	duration: number;
+	dashOpts: IRes | {
+		Data: IRes;
+	};
+	thumbs: IThumbInfoItem[];
+	barrageMaskUrl: string;
+	enableAdaptive?: boolean;
+	adaptiveBitrateStreamingInfo?: ABRInfo;
+}
+declare function isMSESupport(mime?: string): boolean;
+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: any);
+	abstract canOpenAbr(): 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;
@@ -3861,6 +3970,8 @@ declare class PlayerData {
 		urlExpireDiff: number;
 		urlCheckExpireInterval: number;
 	};
+	private isAutoBitrateEnable;
+	adapter: AbstractBaseAdapter;
 	isBusinessDrm: boolean;
 	isEncrypt: boolean;
 	dashOpts: {
@@ -3873,6 +3984,12 @@ declare class PlayerData {
 	 */
 	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;
@@ -3889,12 +4006,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;
@@ -3948,7 +4066,6 @@ declare class PlayerData {
 	 */
 	updatePlayList(): void;
 }
-declare function isMSESupport(mime?: string): boolean;
 /**
  * @hidden
  * @brief 移动端交互面板配置
@@ -3998,6 +4115,7 @@ declare enum UmdKeys {
 	VeStrategy = "vestrategy",
 	VeStrategyH265 = "vestrategy_h265",
 	VeStrategyPreload = "vestrategy_preload",
+	VeStrategyAdaptRange = "vestrategy_adapt_range",
 	DashAbralgo = "DashAbralgo",
 	Preloader = "preloader"
 }
@@ -4165,6 +4283,7 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	sdkUmdLoader: umdLoader;
+	private adapter;
 	/**
 	 * @hidden
 	 */
@@ -4183,33 +4302,33 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	static sdkVersion: string;
-	/**{zh}
-	 * @brief 播放器预初始化配置
+	/** {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}
+	/** {zh}
 	 * @brief 获取预加载实例，可通过预加载实例执行高级方法，需在VePlayer.prepare Promise执行完成之后才能获取到预加载实例
 	 * @returns 预加载实例，详情见{@link PreloaderManager}
 	 */
 	static get preloader(): PreloaderManager | undefined;
-	/**{zh}
+	/** {zh}
 	 * @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[]}
 	 */
@@ -4518,9 +4637,7 @@ declare class VePlayer {
 	 * @notes 更换后，会从更换前的时间点继续播放。
 	 * @param url 视频播放地址。
 	 */
-	switchURL(url: Url, options?: {
-		seamless?: boolean;
-	}): Promise<void>;
+	switchURL(url: Url): Promise<void>;
 	/** {zh}
 	 * @memberof VePlayer
 	 * @brief 针对不同格式的视频，重建播放器内核播放下一个视频。