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

package/index.d.ts

@@ -669,6 +669,11 @@ export interface ISubTitleItem {
 	 * @brief 字幕名称
 	 */
 	text?: string;
+	/**
+	 * @brief 字幕名称。兼容 xgplayer-subtitles 的 label 字段。
+	 * @default -
+	 */
+	label?: string | number;
 	/**
 	 * @brief 外挂字幕 URL 地址。
 	 * @default -
@@ -697,6 +702,16 @@ export interface ISubTitleItem {
 	 */
 	list?: IListItem[];
 }
+export declare type IAutoSubtitleSourceItem = Record<string, any> | string;
+export declare type IAutoSubtitleFormatterResult = string | number | boolean | null | undefined | {
+	label?: string | number;
+	text?: string | number;
+	show?: boolean;
+	visible?: boolean;
+	/** 排序权重，值越小越靠前。未指定时保持原始顺序。 */
+	order?: number;
+};
+export declare type IAutoSubtitleItemFormatter = (item: IAutoSubtitleSourceItem, index: number) => IAutoSubtitleFormatterResult;
 /**
  * @brief 字幕内容项。
  * @list Options
@@ -2185,6 +2200,7 @@ export interface ISubtitleInfoList {
 	Version: string;
 	Vid: string;
 }
+export declare type ISubtitleInfoListItem = ISubtitleInfoList | string;
 /** {zh}
  * @hidden
  */
@@ -2243,7 +2259,7 @@ export interface IGetPlayInfoRes {
 	PlayInfoList: IPlayInfoListItem[];
 	PosterUrl: string;
 	Status: number;
-	SubtitleInfoList: ISubtitleInfoList[];
+	SubtitleInfoList?: ISubtitleInfoListItem[];
 	ThumbInfoList: IThumbInfoItem[];
 	TotalCount: number;
 	Version: number;
@@ -2320,7 +2336,7 @@ export interface IJSBCallbackResult {
 			episode_cover: string;
 			episode_description: string;
 		};
-		video_info: IGetPlayInfoRes;
+		video_info: IGetPlayInfoRes | Record<string, any>;
 	};
 }
 /** {zh}
@@ -2849,6 +2865,16 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 */
 	onGetMediaInfo?: (payload: IGetMediaInfoCallbackPayload) => void;
+	/** {zh}
+	 * @brief 是否自动使用 `playAuthToken` 或短剧信息返回的字幕列表。
+	 * @default false
+	 */
+	autoSubtitle?: boolean;
+	/** {zh}
+	 * @brief 自动字幕项格式化回调。返回字符串或数字时作为字幕名称；返回 `false` 或 `{ show: false }` 时不展示该项。
+	 * @default -
+	 */
+	formatAutoSubtitleItem?: IAutoSubtitleItemFormatter;
 	/** {zh}
 	 * @brief 视频加密类型
 	 * @default -
@@ -4816,6 +4842,13 @@ declare class AuthToken extends SdkPlugin {
 	getPrivateDrmInfo(playList: Stream[], vid: string, streamType: string): Promise<void>;
 	getThumbnailConfig(thumbs: IThumbInfoItem[]): void;
 	getBarrageMaskUrl(url: string): void;
+	setSubtitleConfig(mediaInfo: VideoInfoRes | undefined): void;
+	getAutoSubtitleList(mediaInfo: VideoInfoRes): ISubTitleItem[];
+	getSubtitleSourceData(mediaInfo: VideoInfoRes): any;
+	getAutoSubtitleItem(item: any, index: number): ISubTitleItem | undefined;
+	getStringAutoSubtitleItem(item: string, index: number): ISubTitleItem;
+	getObjectAutoSubtitleItem(item: any, index: number): ISubTitleItem | undefined;
+	formatAutoSubtitleItem(subtitleItem: ISubTitleItem, rawItem: any, index: number): ISubTitleItem | undefined;
 	getDrmConfig(videoInfo: IVideoInfo): void;
 	/**
 	 * 是否处于短剧 Minis 环境（通过剧 ID + 剧集 ID 获取视频）