@volcengine/veplayer 1.9.2 → 1.10.0-rc.0

package/index.d.ts

@@ -2053,18 +2053,21 @@ export declare class MemoryPlay extends Plugin {
 	getTimeByStorage(memoryId: string): string | 0;
 	destroy(): void;
 }
+declare enum EDRMTYPE {
+	DRM_ENCRYPT = "drm_encrypt"
+}
 export interface IPlayInfoListItem {
 	BackupPlayUrl: string;
 	BackupUrlExpire: string;
 	BarrageMaskOffset: string;
 	Bitrate: number;
 	CheckInfo: string;
-	Codec: string;
+	Codec: CodecType;
 	Definition: string;
 	Duration: number;
 	FileId: string;
 	FileType: string;
-	Format: string;
+	Format: EVideoFormat | EAudioFormat;
 	Height: number;
 	IndexRange: string;
 	InitRange: string;
@@ -2079,16 +2082,85 @@ export interface IPlayInfoListItem {
 	Size: number;
 	Volume?: number;
 	Width: number;
+	DrmType?: EDRMTYPE;
+}
+export interface ISubtitleInfoList {
+	CreateTime: string;
+	FileId: string;
+	Format: string;
+	Language: string;
+	LanguageId: number;
+	Source: string;
+	Status: string;
+	StoreUri: string;
+	SubtitleId: string;
+	SubtitleUrl: string;
+	Tag: string;
+	Title: string;
+	Version: string;
+	Vid: string;
+}
+export interface IThumbInfoList {
+	CaptureNum: number;
+	CellHeight: number;
+	CellWidth: number;
+	Format: string;
+	ImgXLen: number;
+	ImgYLen: number;
+	Interval: number;
+	StoreUrls: string[];
+}
+export interface IBarrageMaskInfo {
+	Version: string;
+	BarrageMaskUrl: string;
+	FileId: string;
+	FileSize: number;
+	FileHash: string;
+	UpdatedAt: string;
+	Bitrate: number;
+	HeadLen: number;
+}
+export interface IGetPlayInfoRes {
+	Vid: string;
+	AdaptiveInfo?: any;
+	BarrageMaskInfo?: IBarrageMaskInfo;
+	BarrageMaskUrl: string;
+	Duration: number;
+	EnableAdaptive: boolean;
+	FileType: string;
+	PlayInfoList: IPlayInfoListItem[];
+	PosterUrl: string;
+	Status: number;
+	SubtitleInfoList: ISubtitleInfoList[];
+	ThumbInfoList: IThumbInfoList[];
+	TotalCount: number;
+	Version: number;
 }
 declare enum CodecType {
+	/** {zh}
+	 * @brief H.264
+	 */
+	H264 = "h264",
 	/** {zh}
 	 * @brief H.265
 	 */
 	H265 = "h265",
 	/** {zh}
-	 * @brief H.264
+	 * @brief H.266
 	 */
-	H264 = "h264",
+	H266 = "h266",
+	/** {zh}
+	 * @brief 音频AAC，含 heaacv2
+	 */
+	AAC = "aac",
+	/** {zh}
+	 * @brief 音频MP3
+	 */
+	MP3 = "mp3",
+	/** {zh}
+	 * @brief 音频OPUS
+	 */
+	OPUS = "opus",
 	/** {zh}
 	 * @brief 未知编码格式
 	 */
@@ -2097,6 +2169,19 @@ declare enum CodecType {
 declare enum RTMCodec {
 	H264 = "h264"
 }
+declare enum EVideoFormat {
+	MP4 = "mp4",
+	DASH = "dash",
+	HLS = "hls"
+}
+declare enum EAudioFormat {
+	M4A = "m4a",
+	MP4 = "mp4",
+	MP3 = "mp3",
+	DASH = "dash",
+	HLS = "hls",
+	OGG = "ogg"
+}
 /** {zh}
  * @brief 区域类型：
  *        - `'cn'`：中国内地
@@ -2350,12 +2435,42 @@ export interface Condition {
 /** {en}
  * @hidden
  */
-export interface Current {
+export interface Current extends Partial<Stream> {
+	/**
+	 * @brief 清晰度
+	 * @default -
+	 */
 	definition: string;
+	/**
+	 * @brief 视频格式/协议
+	 * @default -
+	 */
 	streamType: string;
+	/**
+	 * @brief 视频流语言
+	 * @default -
+	 */
 	language: string;
+	/**
+	 * @brief 视频流id
+	 * @default -
+	 */
 	lineId?: number | string;
+	/**
+	 * @brief 视频编码格式
+	 * @default unknown
+	 */
 	codec?: CodecType;
+	/**
+	 * @brief 视频为加密视频时的密钥KeyId
+	 * @default -
+	 */
+	kid?: string;
+	/**
+	 * @brief 视频为加密视频时的加密类型
+	 * @default -
+	 */
+	drmType?: string;
 	/**
 	 * @brief 地址的过期时间戳，vid模式下不用输入，播放器自动获取。如果是火山引擎的CDN分发地址，在不传入过期时间戳时，则需指定urlType，支持{@link https://www.volcengine.com/docs/4/177191 A-E类型}，其他云厂商或者业务服务器存储的地址不支持。
 	 * @default -
@@ -3126,6 +3241,22 @@ export interface IPlayAuthTokenConfig {
 	 * @default -
 	 */
 	getDrmAuthToken?: (playAuthIds: string, vid: string, unionInfo: string) => Promise<string>;
+	/**
+	 * @brief 商业DRM 获取license的token
+	 * @default -
+	 */
+	thirdPartyDrmAuthToken?: string;
+	/**
+	 * @brief 商业DRM，获取fairplay证书的地址
+	 * @default -
+	 */
+	serverCertificatePath?: string;
+	/**
+	 * @brief 商业DRM播放时，是否开启防录屏
+	 * @notice 如果开启后，但当前环境不支持，则报错
+	 * @default true
+	 */
+	unRecord?: boolean;
 	/** {zh}
 	 * @brief 可携带aid等透传参数，如:
 	 * {aid: 1234}，以playAuthToken下发的参数的优先级最高。
@@ -3679,7 +3810,7 @@ declare const _default: VeStrategyWrapper;
 declare class PlayerData {
 	id?: string;
 	root?: HTMLElement;
-	configs: any;
+	configs: IPlayerConfig;
 	strategyConfig?: StrategyConfigOptions;
 	type: string;
 	isLive: boolean;
@@ -3719,6 +3850,11 @@ declare class PlayerData {
 		urlExpireDiff: number;
 		urlCheckExpireInterval: number;
 	};
+	isBusinessDrm: boolean;
+	isEncrypt: boolean;
+	dashOpts: {
+		Data: IGetPlayInfoRes;
+	};
 	constructor(configs: IPlayerConfig);
 	/**
 	 * 初始化播放数据
@@ -3745,12 +3881,12 @@ declare class PlayerData {
 	/**
 	 * @description: 获取当前的streamType
 	 */
-	getCurrentStreamType(): any;
-	getStreamType(): any;
+	getCurrentStreamType(): string;
+	getStreamType(): string;
 	isOpenABR(streamType?: string): boolean;
 	showRealDefinition(): boolean;
 	isAutoDefinition(def: any): boolean;
-	isPlayAutoDefinition(def?: string): any;
+	isPlayAutoDefinition(def?: string): boolean;
 	isDefinitionMatch(pre: any, next: any): boolean;
 	/**
 	 * @description: 获取满足当前直播条件的流
@@ -4066,7 +4202,7 @@ declare class VePlayer {
 	private vodLogCommon;
 	/**
 	 * @hidden
-	 * 延时触发的events，即保证在palyer创建之后才触发
+	 * 延时触发的events，即保证在player创建之后才触发
 	 */
 	delayEvents: Array<{
 		name: string;
@@ -4563,6 +4699,11 @@ declare class VePlayer {
 	 * @param pluginName 插件名。
 	 */
 	getPlugin(pluginName: string): null | BasePlugin;
+	/**
+	 * @brief 当前浏览器环境是否支持商业drm防录屏
+	 * @return boolean 是否支持商业drm防录屏
+	 */
+	isDrmSupportUnRecord(): Promise<boolean>;
 	/** {zh}
 	 * @memberof VePlayer
 	 * @brief 销毁当前播放器实例。
@@ -5427,6 +5568,34 @@ export declare const Events: {
 	 * @brief UMD 加载失败。
 	 */
 	UMD_LOAD_FAIL: string;
+	/** {zh}
+	 * @brief 切换下一个视频，playNext方法调用后触发
+	 */
+	PLAYNEXT: string;
+	/** {zh}
+	 * @brief 视频地址为空
+	 */
+	URL_NULL: string;
+	/** {zh}
+	 * @brief 鼠标移出
+	 */
+	LEAVE_PLAYER: string;
+	/** {zh}
+	 * @brief 鼠标移出
+	 */
+	ENTER_PLAYER: string;
+	/** {zh}
+	 * @brief 播放器状态重置
+	 */
+	RESET: string;
+	/** {zh}
+	 * @brief <source> 加载错误，表示<source>不支持或播放失败
+	 */
+	SOURCE_ERROR: string;
+	/** {zh}
+	 * @brief <source> 加载成功
+	 */
+	SOURCE_SUCCESS: string;
 	/** {zh}
 	 * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
 	 */
@@ -5716,6 +5885,34 @@ export declare const Event: {
 		 * @brief UMD 加载失败。
 		 */
 		UMD_LOAD_FAIL: string;
+		/** {zh}
+		 * @brief 切换下一个视频，playNext方法调用后触发
+		 */
+		PLAYNEXT: string;
+		/** {zh}
+		 * @brief 视频地址为空
+		 */
+		URL_NULL: string;
+		/** {zh}
+		 * @brief 鼠标移出
+		 */
+		LEAVE_PLAYER: string;
+		/** {zh}
+		 * @brief 鼠标移出
+		 */
+		ENTER_PLAYER: string;
+		/** {zh}
+		 * @brief 播放器状态重置
+		 */
+		RESET: string;
+		/** {zh}
+		 * @brief <source> 加载错误，表示<source>不支持或播放失败
+		 */
+		SOURCE_ERROR: string;
+		/** {zh}
+		 * @brief <source> 加载成功
+		 */
+		SOURCE_SUCCESS: string;
 	};
 	PluginEvents: {
 		/** {zh}