@volcengine/veplayer 1.15.3-rc.14 → 1.15.3-rc.16

package/index.d.ts

@@ -4148,6 +4148,174 @@ export interface ApiMapConfig {
 	playDomain: string;
 	backupPlayDomain?: string;
 }
+/**
+ * @list Options
+ * @brief 字幕项。
+ * @kind property
+ */
+/** {en}
+ * @brief 字幕项配置
+ */
+export interface ISubTitleItem {
+	/**
+	 * @brief 字幕语言。
+	 * @default -
+	 */
+	/** {en}
+	 * @brief 字幕语言
+	 */
+	language?: string | number;
+	/**
+	 * @brief 字幕 ID。
+	 * @default -
+	 */
+	/** {en}
+	 * @brief 字幕id
+	 */
+	id?: number | string;
+	/**
+	 * @brief 是否为默认选择的字幕。
+	 * @default false
+	 */
+	/** {en}
+	 * @brief 是否是默认选择的字幕
+	 */
+	isDefault?: boolean;
+	/**
+	 * @brief 字幕名称。
+	 * @default -
+	 */
+	/** {en}
+	 * @brief 字幕名称
+	 */
+	text?: string;
+	/**
+	 * @brief 字幕名称。兼容 xgplayer-subtitles 的 label 字段。
+	 * @default -
+	 */
+	label?: string | number;
+	/**
+	 * @brief 外挂字幕 URL 地址。
+	 * @default -
+	 */
+	/** {en}
+	 * @brief 外挂字幕地址
+	 */
+	url?: string;
+	/**
+	 * stringContent
+	 * @default 无
+	 * @hidden
+	 * @type {string}
+	 * @memberof ISubTitleItem
+	 */
+	stringContent?: string;
+	/**
+	 * 字幕内容列表，非url形式时使用
+	 * @default 无
+	 * @type {Array<Object>}
+	 * @memberof ISubTitleItem
+	 * @brief 字幕内容列表。非 `url` 形式时使用。
+	 */
+	/** {en}
+	 * @brief 字幕内容列表，非url形式时使用
+	 */
+	list?: IListItem[];
+}
+/**
+ * @brief 字幕内容项。
+ * @list Options
+ * @kind property
+ * @export
+ * @interface IListItem
+ */
+/** {en}
+ * @brief 字幕内容项配置
+ */
+export interface IListItem {
+	/**
+	 * 开始时间
+	 * @type {number}
+	 * @brief 开始时间，单位为秒。
+	 */
+	/** {en}
+	 * @brief 开始时间
+	 */
+	start: number;
+	/**
+	 * 结束时间
+	 * @type {number}
+	 * @brief 结束时间，单位为秒。
+	 */
+	/** {en}
+	 * @brief 结束时间
+	 */
+	end: number;
+	/**
+	 * 字幕数据列表
+	 * @type {Array<ITextItem>}
+	 * @brief 字幕数据列表。
+	 */
+	/** {en}
+	 * @brief 字幕数据列表
+	 */
+	list: Array<ITextItem>;
+	/**
+	 * @default 无
+	 * @hidden
+	 * @type {any}
+	 */
+	[propName: string]: any;
+}
+/**
+ * @breif 字幕文案配置
+ * @list Options
+ * @kind property
+ */
+export interface ITextItem {
+	/**
+	 * @default 无
+	 * @hidden
+	 * @type {any}
+	 */
+	[propName: string]: any;
+	/**
+	 * 开始时间
+	 * @type {number}
+	 * @brief 开始时间，单位为秒。
+	 */
+	/** {en}
+	 * @brief 开始时间
+	 */
+	start: number;
+	/**
+	 * 结束时间
+	 * @type {number}
+	 * @brief 结束时间，单位为秒。
+	 */
+	/** {en}
+	 * @brief 结束时间
+	 */
+	end: number;
+	/**
+	 * 字幕文案数组
+	 * @type {string[]}
+	 * @brief 字幕文案数组。
+	 */
+	/** {en}
+	 * @brief 字幕文案数组
+	 */
+	text: string[];
+	/**
+	 * 字幕顺序
+	 * @type {number}
+	 * @brief 字幕顺序。
+	 */
+	/** {en}
+	 * @brief 字幕顺序
+	 */
+	index?: number;
+}
 export type TLogChannel = "cn" | "va" | "sg";
 declare enum PreloadScene {
 	/**
@@ -4586,6 +4754,8 @@ export declare type UMDMap = Record<UmdKeys, {
 declare class UMDLoader {
 	private static jsLoadMap;
 	private static jsLoadPromiseMap;
+	/** 清除指定插件的加载缓存，使下次 loadPlugins 重新触发加载（用于修复首次加载失败的情况） */
+	clearPluginCache(pluginName: UmdKeys): void;
 	umdMap: UMDMap;
 	backupUmdUrlMap: Record<string, string>;
 	failCallback: (umdName: string, err: any) => any;
@@ -6050,6 +6220,32 @@ declare class VePlayer {
 	 * @param pluginName 插件名。
 	 */
 	getPlugin(pluginName: string): null | BasePlugin;
+	/** {zh}
+	 * @brief 获取字幕列表。需配置 `Subtitle` 插件后调用。
+	 * @return 当前字幕列表，每项包含 `id`、`language`、`text`（显示名称）等字段。列表为空时返回空数组。
+	 * @memberof VePlayer
+	 */
+	getSubtitleList(): ISubTitleItem[];
+	/** {zh}
+	 * @brief 切换字幕。需配置 `Subtitle` 插件后调用。
+	 * @param subtitle 目标字幕的 id 或 language，任意一个非空即可定位字幕项。
+	 * @return 切换成功时 resolve，失败（未找到、切换被中止）时 reject。
+	 * @memberof VePlayer
+	 */
+	switchSubtitle(subtitle: {
+		id?: string | number;
+		language?: string | number;
+	}): Promise<void>;
+	/** {zh}
+	 * @brief 开启字幕展示。恢复上次选中的字幕项；若从未选中过则默认选第一项。需配置 `Subtitle` 插件后调用。
+	 * @memberof VePlayer
+	 */
+	showSubtitle(): void;
+	/** {zh}
+	 * @brief 关闭字幕展示。字幕数据保留，可通过 `showSubtitle` 重新开启。需配置 `Subtitle` 插件后调用。
+	 * @memberof VePlayer
+	 */
+	hideSubtitle(): void;
 	/** {zh}
 	 * @memberof VePlayer
 	 * @brief 销毁当前播放器实例。