@volcengine/veplayer 1.7.0 → 1.7.1-rc.0

package/index.d.ts

@@ -2,7 +2,7 @@ import VodLogger from '@byted/xgplayer-app-logger/es/logger.js';
 import { Property } from 'dom-helpers/esm/types';
 import EventEmitter from 'eventemitter3';
 import Player from 'xgplayer';
-import { I18N, IXGI18nText, Plugin } from 'xgplayer';
+import { Events as XgEvents, I18N, IXGI18nText, Plugin } from 'xgplayer';
 
 declare enum POSITIONS {
 	ROOT = "root",
@@ -1090,14 +1090,6 @@ export declare type IPlayerOptions = {
 		volumeColor?: string;
 	};
 };
-declare enum PlatformEnum {
-	VOLC_ENGINE = "volcengine",
-	BYTE_PLUS = "byteplus"
-}
-export interface apiMapItem {
-	playDomain: string;
-	backupPlayDomain?: string;
-}
 export interface IAutoplayPluginConfig {
 	position?: string;
 	enableDegradeMuteAutoplay?: boolean;
@@ -1105,14 +1097,43 @@ export interface IAutoplayPluginConfig {
 	userActionDom?: Node;
 	enableUserActionAutoplay?: boolean;
 }
+export interface IPlayInfoList {
+	BackupPlayUrl: string;
+	BackupUrlExpire: string;
+	BarrageMaskOffset: string;
+	Bitrate: number;
+	CheckInfo: string;
+	Codec: string;
+	Definition: string;
+	Duration: number;
+	FileId: string;
+	FileType: string;
+	Format: string;
+	Height: number;
+	IndexRange: string;
+	InitRange: string;
+	KeyFrameAlignment: string;
+	LogoType: string;
+	MainPlayUrl: string;
+	MainUrlExpire: string;
+	Md5: string;
+	PlayAuth: string;
+	PlayAuthId: string;
+	Quality: string;
+	Size: number;
+	Volume?: number;
+	Width: number;
+}
 declare enum CodecType {
 	H265 = "h265",
-	H264 = "h264"
+	H264 = "h264",
+	UNKNOWN = "unknown"
 }
 declare enum RTMCodec {
 	H264 = "h264"
 }
-export declare type PLAY_MODE_TYPE = "order" | "sloop" | "loop" | "random";
+export declare type TRegionType = "cn" | "va" | "sg";
+export declare type PlayModeType = "order" | "sloop" | "loop" | "random";
 export interface IMusicListItem {
 	/**
 	 * 音乐地址
@@ -1196,7 +1217,7 @@ export interface IMusicConfig {
 	 * @type {('order' | 'sloop' | 'loop' | 'random')}
 	 * @memberof IMusicConfig
 	 */
-	mode?: PLAY_MODE_TYPE;
+	mode?: PlayModeType;
 	/**
 	 * 播放列表
 	 *
@@ -1213,7 +1234,7 @@ export interface IMusicConfig {
  * @export
  * @interface Stream
  */
-export interface Stream {
+export interface Stream extends IPlayInfoList {
 	/**
 	 * url类型，可以选值为“rtm”/“flv”/“mp4”/“hls”
 	 *
@@ -1342,12 +1363,14 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	streamType?: "mp4" | "hls" | "dash" | "rtm" | "flv";
 	/**
-	 * 点播服务平台，可选值为'volcengine' 和 'byteplus'，默认为'volcengine'即火山引擎视频点播
-	 * 设定此参数会指定默认的服务接口
-	 * @type {('volcengine' | 'byteplus')}
-	 * @memberof playerConfig
+	 * 区域，影响服务接口和日志上报
+	 * @volcengine/veplayer默认区域为cn， @byteplus/veplayer默认区域为sg
+	 * 火山引擎海外区域播放时请填写'sg'
+	 *
+	 * @type {TRegionType}
+	 * @memberof IPlayerConfig
 	 */
-	platform?: PlatformEnum;
+	region?: TRegionType;
 	/**
 	 * 是否音乐播放器模式
 	 *
@@ -1356,7 +1379,7 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 */
 	isMusic?: boolean;
 	/**
-	 * 右键是否可用
+	 * 是否开启播放器原生控件菜单（右键触发）
 	 *
 	 * @type {boolean}
 	 * @memberof IPlayerConfig
@@ -1369,6 +1392,13 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @memberof IPlayerConfig
 	 */
 	closeVideoStopPropagation?: boolean;
+	/**
+	 * 右键菜单是否可用,启用后enableContextmenu强制为false
+	 *
+	 * @type {boolean}
+	 * @memberof IPlayerConfig
+	 */
+	enableMenu?: boolean;
 	/**
 	 * 是否开启hls的MSE模式，仅移动端生效，开启后采用MSE方式播放HLS，默认在移动端使用原生video播放hls
 	 *
@@ -1925,6 +1955,10 @@ export interface IMemoryPlayConfig {
 	 */
 	getTime: (id: number | string) => number | Promise<number>;
 }
+export interface ApiMapConfig {
+	playDomain: string;
+	backupPlayDomain?: string;
+}
 declare class PlayerData {
 	id?: string;
 	root?: HTMLElement;
@@ -1949,13 +1983,14 @@ declare class PlayerData {
 	expireDetectType: Array<"xhrStatus" | "urlExpire" | "getUrlTime">;
 	onMediaExpired: () => Promise<IPlayerConfig>;
 	onTokenExpired: () => Promise<IPlayAuthTokenConfig>;
-	platform: PlatformEnum;
-	apiMap: apiMapItem;
 	unionId?: string;
 	unionInfo?: string;
 	isMusic?: boolean;
 	sdkPlugins: any[];
 	useHlsPluginForSafari: boolean;
+	enableMenu: boolean;
+	region: TRegionType;
+	playDomainDegrade: boolean;
 	constructor(configs: IPlayerConfig);
 	initPlayData(configs: any): void;
 	initPlaylistAndGetCurrent(configs: IPlayerConfig): any;
@@ -2002,6 +2037,16 @@ declare class PlayerData {
 	 * @param {boolean} isDown
 	 */
 	getNextDefinition(isDown: boolean, demotePriority: any): Stream[];
+	/**
+	 * 获取api map
+	 * @return { ApiMapConfig }
+	 */
+	get apiMap(): ApiMapConfig;
+	/**
+	 * 获取播放域名
+	 */
+	get playDomain(): string;
+	setVodTeaId(): void;
 }
 declare function isMSESupport(mime?: string): boolean;
 export interface IConfig {
@@ -2182,7 +2227,7 @@ declare class VePlayer {
 	initCheckExpire(): void;
 	/**
 	 * @hidden
-	 * @description 更新umd的备用地址
+	 * @description 更新umdLoader 的配置
 	 * @memberof VePlayer
 	 */
 	private initUmdLoader;
@@ -2274,8 +2319,8 @@ declare class VePlayer {
 	/**
 	 * @hidden
 	 *
-	 * @param {*} finalOptions
-	 * @return {*}
+	 * @param {IPlayerConfig} finalOptions
+	 * @return {void}
 	 * @memberof VePlayer
 	 */
 	setPluginConfig(finalOptions: IPlayerConfig): void;
@@ -2520,17 +2565,17 @@ declare class VePlayer {
 	/**
 	 * 获取音乐播放模式
 	 * @notes 仅音乐播放模式有效
-	 * @return {PLAY_MODE_TYPE}
+	 * @return {PlayModeType}
 	 * @memberof VePlayer
 	 */
-	get musicMode(): PLAY_MODE_TYPE;
+	get musicMode(): PlayModeType;
 	/**
 	 * 设置音乐播放模式
 	 * @notes 仅音乐播放模式有效
 	 * @memberof VePlayer
-	 * @param {PLAY_MODE_TYPE} val 模式值
+	 * @param {PlayModeType} val 模式值
 	 */
-	set musicMode(val: PLAY_MODE_TYPE);
+	set musicMode(val: PlayModeType);
 	/**
 	 * 获取音乐播放快进快退时间跨度
 	 * @notes 仅音乐播放模式有效
@@ -2630,8 +2675,15 @@ declare class VePlayer {
 	/**
 	 * 获取质量日志上报的用户id
 	 * @return {string | undefined}
+	 * @memberof VePlayer
 	 */
-	getLogUserId(): any;
+	getLogUserId(): string;
+	/**
+	 * 获取当前配置的region
+	 * @return {TRegionType}
+	 * @memberof VePlayer
+	 */
+	get region(): TRegionType;
 	/**
 	 * 销毁当前播放器SDK实例
 	 *
@@ -2787,6 +2839,26 @@ export declare class LiveSubtitlesIconPlugin extends Plugin {
 	destroy(): void;
 	render(): string;
 }
+declare class NativeSubTitle extends EventEmitter {
+	_media: any;
+	_list: any[];
+	_languages: string;
+	curIndex: number;
+	constructor(media: any);
+	_init(): void;
+	_onChange: (e: any) => void;
+	/**
+	 * @description 切换字幕
+	 * @param { null | {
+	 *  id: any,
+	 *  language: any
+	 * }} data
+	 * @return {Promise<{code: number}>}
+	 */
+	switch(data: any): Promise<unknown>;
+	switchOff(): void;
+	destroy(): void;
+}
 export interface IPanelItem {
 	showText: string;
 	selected: boolean;
@@ -2826,6 +2898,9 @@ export declare class Subtitle extends Plugin {
 	subTitles: any;
 	curIndex: number;
 	curItem: ISubTitleItem;
+	player: Player & {
+		_subTitles?: NativeSubTitle;
+	};
 	afterCreate(): void;
 	/**
 	 * @description 初始化原生字幕
@@ -2900,7 +2975,10 @@ export declare class Subtitle extends Plugin {
 	 * @param { boolean } needRemove 是否移除原来的字幕
 	 */
 	updateSubtitles(list?: any[], needRemove?: boolean): void;
-	updateList(data?: {}): void;
+	updateList(data?: {
+		list?: any[];
+		isOpen?: boolean;
+	}): void;
 	changeTipText(): void;
 	showMobilePanel(): void;
 	updatePanel(): void;
@@ -3245,6 +3323,359 @@ export declare class SdkPlugin {
 	 */
 	__destroy(): void;
 }
+export declare const Events: {
+	/**
+	 * 弹幕配置发生变化
+	 */
+	DANMU_CHANGE: string;
+	/**
+	 * @hidden
+	 */
+	TIME_SHIFT_CHANGE: string;
+	/**
+	 * @hidden
+	 */
+	AI_SUBTITLE_LANG_CHANGE: string;
+	/**
+	 * @hidden
+	 */
+	AI_SUBTITLE_MATCH: string;
+	/**
+	 * 取消静音
+	 */
+	CANCEL_UNMUTE: string;
+	/**
+	 * 处罚刷新
+	 */
+	REFRESH_CLICK: string;
+	/**
+	 * 报错时触发降级
+	 */
+	PLAY_BACKUP_CHANGE: string;
+	/**
+	 * 报错时触发所有降级结束
+	 */
+	PLAY_BACKUP_CHANGE_FINISH: string;
+	/**
+	 * 报错时触发重试
+	 */
+	PLAY_ERROR_BUTTON_CLICK: string;
+	/**
+	 * 播放url改变
+	 */
+	PlAY_URL_CHANGE: string;
+	/**
+	 * 展示报错
+	 */
+	SHOW_PLAY_ERROR: string;
+	/**
+	 * @hidden
+	 */
+	PLAYER_EXTEND_BUTTON: string;
+	/**
+	 * 长时间waiting
+	 */
+	LONG_WAITING: string;
+	/**
+	 * 频繁waiting
+	 */
+	OFTEN_WAITING: string;
+	/**
+	 * 清晰度降级
+	 */
+	DEFINITION_DEMOTE: string;
+	/**
+	 *@hidden
+	 */
+	LARKWINDOW_CHANGE: string;
+	/**
+	 * @hidden
+	 */
+	PANEL_MODE_CHANGE: string;
+	/**
+	 * 清晰度切换
+	 */
+	INNER_DEFINITION_CHANGE: string;
+	/**
+	 * 线路切换
+	 */
+	LINE_CHANGE: string;
+	/**
+	 * playAuthToken获取url失败
+	 */
+	GET_PLAY_URL_ERR: string;
+	/**
+	 * 资源过期
+	 */
+	MEDIA_EXPIRED: string;
+	/**
+	 * 开启镜像
+	 */
+	MIRROR_CHANGE: string;
+	/**
+	 * 音乐播放器快进快退跨度
+	 */
+	TIME_SCALE_CHANGE: string;
+	/**
+	 * 音乐播放器播放模式改变
+	 */
+	MUSIC_MODE_CHANGE: string;
+	/**
+	 * 音乐播放器切换音乐
+	 */
+	MUSIC_CHANGE: string;
+	/**
+	 * 音乐播放列表发生变化
+	 */
+	MUSIC_LIST_CHANGE: string;
+	/**
+	 * 自动播放成功
+	 */
+	AUTOPLAY_SUCCESS: string;
+	/**
+	 * 自动播放失败
+	 */
+	AUTOPLAY_FAILED: string;
+	/**
+	 * 右键菜单事件，事件data中包含具体信息
+	 */
+	MENU_LOG: string;
+	/**
+	 * 点击了右键菜单的反馈按钮
+	 */
+	MENU_REPORT: string;
+	/**
+	 * 播放器完成创建
+	 */
+	PLAYER_CREATED_FINISH: string;
+	/**
+	 * 播放器重建
+	 */
+	PLAYER_REBUILD: string;
+	/**
+	 * 硬解不支持
+	 */
+	NOT_SUPPORT_HARDWARE_DECODER: string;
+	/**
+	 * 软解不支持
+	 */
+	NOT_SUPPORT_SOFT_DECODER: string;
+	/**
+	 * playAuthToken 过期
+	 */
+	TOKEN_EXPIRED: string;
+	/**
+	 * umd 加载失败
+	 */
+	UMD_LOAD_FAIL: string;
+	PLAY: "play";
+	PLAYING: "playing";
+	ENDED: "ended";
+	PAUSE: "pause";
+	ERROR: "error";
+	SEEKING: "seeking";
+	SEEKED: "seeked";
+	TIME_UPDATE: "timeupdate";
+	WAITING: "waiting";
+	CANPLAY: "canplay";
+	CANPLAY_THROUGH: "canplaythrough";
+	DURATION_CHANGE: "durationchange";
+	VOLUME_CHANGE: "volumechange";
+	LOADED_DATA: "loadeddata";
+	LOADED_METADATA: "loadedmetadata";
+	RATE_CHANGE: "ratechange";
+	PROGRESS: "progress";
+	LOAD_START: "loadstart";
+	EMPTIED: "emptied";
+	STALLED: "stalled";
+	SUSPEND: "suspend";
+	ABORT: "abort";
+	BUFFER_CHANGE: "bufferedChange";
+	PLAYER_FOCUS: "focus";
+	PLAYER_BLUR: "blur";
+	READY: "ready";
+	URL_NULL: "urlNull";
+	AUTOPLAY_STARTED: "autoplay_started";
+	AUTOPLAY_PREVENTED: "autoplay_was_prevented";
+	COMPLETE: "complete";
+	REPLAY: "replay";
+	DESTROY: "destroy";
+	URL_CHANGE: "urlchange";
+	DOWNLOAD_SPEED_CHANGE: "download_speed_change";
+	FULLSCREEN_CHANGE: "fullscreen_change";
+	CSS_FULLSCREEN_CHANGE: "cssFullscreen_change";
+	MINI_STATE_CHANGE: "mini_state_change";
+	DEFINITION_CHANGE: "definition_change";
+	BEFORE_DEFINITION_CHANGE: "before_definition_change";
+	AFTER_DEFINITION_CHANGE: "after_definition_change";
+	SEI_PARSED: "SEI_PARSED";
+	RETRY: "retry";
+	VIDEO_RESIZE: "video_resize";
+	PIP_CHANGE: "pip_change";
+	ROTATE: "rotate";
+	SCREEN_SHOT: "screenShot";
+	PLAYNEXT: "playnext";
+	SHORTCUT: "shortcut";
+	XGLOG: "xglog";
+	USER_ACTION: "user_action";
+	RESET: "reset";
+	SOURCE_ERROR: "source_error";
+	SOURCE_SUCCESS: "source_success";
+	SWITCH_SUBTITLE: "switch_subtitle";
+	VIDEO_EVENTS: string[];
+	STATS_EVENTS: typeof XgEvents.STATS_EVENTS;
+	FPS_STUCK: "fps_stuck";
+};
+export declare const Event: {
+	SDKEvents: {
+		/**
+		 * 播放器完成创建
+		 */
+		PLAYER_CREATED_FINISH: string;
+		/**
+		 * 播放器重建
+		 */
+		PLAYER_REBUILD: string;
+		/**
+		 * 硬解不支持
+		 */
+		NOT_SUPPORT_HARDWARE_DECODER: string;
+		/**
+		 * 软解不支持
+		 */
+		NOT_SUPPORT_SOFT_DECODER: string;
+		/**
+		 * playAuthToken 过期
+		 */
+		TOKEN_EXPIRED: string;
+		/**
+		 * umd 加载失败
+		 */
+		UMD_LOAD_FAIL: string;
+	};
+	PluginEvents: {
+		/**
+		 * 弹幕配置发生变化
+		 */
+		DANMU_CHANGE: string;
+		/**
+		 * @hidden
+		 */
+		TIME_SHIFT_CHANGE: string;
+		/**
+		 * @hidden
+		 */
+		AI_SUBTITLE_LANG_CHANGE: string;
+		/**
+		 * @hidden
+		 */
+		AI_SUBTITLE_MATCH: string;
+		/**
+		 * 取消静音
+		 */
+		CANCEL_UNMUTE: string;
+		/**
+		 * 处罚刷新
+		 */
+		REFRESH_CLICK: string;
+		/**
+		 * 报错时触发降级
+		 */
+		PLAY_BACKUP_CHANGE: string;
+		/**
+		 * 报错时触发所有降级结束
+		 */
+		PLAY_BACKUP_CHANGE_FINISH: string;
+		/**
+		 * 报错时触发重试
+		 */
+		PLAY_ERROR_BUTTON_CLICK: string;
+		/**
+		 * 播放url改变
+		 */
+		PlAY_URL_CHANGE: string;
+		/**
+		 * 展示报错
+		 */
+		SHOW_PLAY_ERROR: string;
+		/**
+		 * @hidden
+		 */
+		PLAYER_EXTEND_BUTTON: string;
+		/**
+		 * 长时间waiting
+		 */
+		LONG_WAITING: string;
+		/**
+		 * 频繁waiting
+		 */
+		OFTEN_WAITING: string;
+		/**
+		 * 清晰度降级
+		 */
+		DEFINITION_DEMOTE: string;
+		/**
+		 *@hidden
+		 */
+		LARKWINDOW_CHANGE: string;
+		/**
+		 * @hidden
+		 */
+		PANEL_MODE_CHANGE: string;
+		/**
+		 * 清晰度切换
+		 */
+		INNER_DEFINITION_CHANGE: string;
+		/**
+		 * 线路切换
+		 */
+		LINE_CHANGE: string;
+		/**
+		 * playAuthToken获取url失败
+		 */
+		GET_PLAY_URL_ERR: string;
+		/**
+		 * 资源过期
+		 */
+		MEDIA_EXPIRED: string;
+		/**
+		 * 开启镜像
+		 */
+		MIRROR_CHANGE: string;
+		/**
+		 * 音乐播放器快进快退跨度
+		 */
+		TIME_SCALE_CHANGE: string;
+		/**
+		 * 音乐播放器播放模式改变
+		 */
+		MUSIC_MODE_CHANGE: string;
+		/**
+		 * 音乐播放器切换音乐
+		 */
+		MUSIC_CHANGE: string;
+		/**
+		 * 音乐播放列表发生变化
+		 */
+		MUSIC_LIST_CHANGE: string;
+		/**
+		 * 自动播放成功
+		 */
+		AUTOPLAY_SUCCESS: string;
+		/**
+		 * 自动播放失败
+		 */
+		AUTOPLAY_FAILED: string;
+		/**
+		 * 右键菜单事件，事件data中包含具体信息
+		 */
+		MENU_LOG: string;
+		/**
+		 * 点击了右键菜单的反馈按钮
+		 */
+		MENU_REPORT: string;
+	};
+};
 export * from "xgplayer";
 
 export {