@byteplus/veplayer 1.18.0-rc.8 → 1.18.0

package/index.d.ts

@@ -7000,6 +7000,54 @@ export declare type IPreloadAuthTokenStream = {
 	defaultDefinition?: string;
 	getVideoByToken: IPlayAuthTokenConfig;
 };
+/** {zh}
+ * @brief 媒体信息预取源，支持 playAuthToken 和短剧剧集配置，不支持直接 URL。
+ * @detail ref
+ */
+/** {en}
+ * @brief Media info prefetch source. Supports playAuthToken and short-drama episode configs, but not direct URLs.
+ * @detail ref
+ */
+export declare type IMediaInfoPrefetchSource = IPreloadAuthTokenStream | IPreloadDramaStream;
+/** {zh}
+ * @brief 媒体信息预取成功结果。
+ * @detail ref
+ */
+/** {en}
+ * @brief Successful media info prefetch result.
+ * @detail ref
+ */
+export declare type IMediaInfoPrefetchSuccess = {
+	status: "fulfilled";
+	source: IMediaInfoPrefetchSource;
+	data: IGetMediaInfoCallbackPayload["data"];
+	fromCache: boolean;
+};
+/** {zh}
+ * @brief 媒体信息预取失败结果。
+ * @detail ref
+ */
+/** {en}
+ * @brief Failed media info prefetch result.
+ * @detail ref
+ */
+export declare type IMediaInfoPrefetchFailure = {
+	status: "rejected";
+	source: IMediaInfoPrefetchSource;
+	error: {
+		code: number;
+		message: string;
+	};
+};
+/** {zh}
+ * @brief 单个媒体信息预取结果。批量请求按输入顺序返回，单项失败不会中断其他项。
+ * @detail ref
+ */
+/** {en}
+ * @brief Result for one media info prefetch item. Batch results preserve input order, and one failure does not interrupt other items.
+ * @detail ref
+ */
+export declare type IMediaInfoPrefetchResult = IMediaInfoPrefetchSuccess | IMediaInfoPrefetchFailure;
 export declare type IPreloadStream = IPreloadResolvedStream | IPreloadDramaStream | IPreloadAuthTokenStream;
 /** {zh}
  * @list Options
@@ -7842,6 +7890,33 @@ declare class VePlayer {
 	 * @brief Clear media info cache from both memory cache and localStorage cache.
 	 */
 	static clearMediaInfoCache(): void;
+	/** {zh}
+	 * @brief 提前请求并缓存 playAuthToken 或短剧剧集的媒体信息，不下载视频数据。批量结果与输入顺序一致，单项失败不会中断其他项。
+	 * @list Api
+	 * @param sources 媒体信息预取源列表，详情见 {@link IMediaInfoPrefetchSource}。
+	 * @returns 每项媒体信息的成功或失败结果，详情见 {@link IMediaInfoPrefetchResult}。
+	 * @example
+	 * ``` javascript
+	 * const results = await VePlayer.prefetchMediaInfo([
+	 *   { getVideoByToken: { playAuthToken } },
+	 *   { albumId: 'album-id', episodeId: 'episode-id' }
+	 * ]);
+	 * ```
+	 */
+	/** {en}
+	 * @brief Request and cache media information for playAuthToken or short-drama episodes without downloading video data. Batch results preserve input order, and one failure does not interrupt other items.
+	 * @list Api
+	 * @param sources Media info prefetch sources. See {@link IMediaInfoPrefetchSource}.
+	 * @returns A success or failure result for each source. See {@link IMediaInfoPrefetchResult}.
+	 * @example
+	 * ``` javascript
+	 * const results = await VePlayer.prefetchMediaInfo([
+	 *   { getVideoByToken: { playAuthToken } },
+	 *   { albumId: 'album-id', episodeId: 'episode-id' }
+	 * ]);
+	 * ```
+	 */
+	static prefetchMediaInfo(sources: IMediaInfoPrefetchSource[]): Promise<IMediaInfoPrefetchResult[]>;
 	/** {zh}
 	 * @brief 设置全局日志开关。开启后会输出 VE_DEBUG.log 级别日志。
 	 * @param enable 是否开启详细日志
@@ -9165,6 +9240,91 @@ export declare class Subtitle extends Plugin {
 	destroy(): void;
 	render(): string;
 }
+export declare type InfoItem = {
+	key: string;
+	label: string;
+	labelTextKey?: string;
+	value?: any;
+	render?: (key: any) => string;
+	type?: string;
+	dom?: Element;
+};
+/**
+ * 直播信息面板
+ */
+export declare class LiveInfoPanel extends Plugin {
+	private _pollTimer;
+	private _infoItems;
+	static get pluginName(): string;
+	static get defaultConfig(): {
+		visible: boolean;
+		showH265Info: boolean;
+	};
+	get streamType(): any;
+	afterCreate(): void;
+	registerLanguageTexts(): {
+		DECODEFPS: {
+			en: string;
+			zh: string;
+		};
+		DECODECOST: {
+			en: string;
+			zh: string;
+		};
+		FORMAT: {
+			en: string;
+			zh: string;
+		};
+		FPS: {
+			en: string;
+			zh: string;
+		};
+		BITRATE: {
+			en: string;
+			zh: string;
+		};
+		GOP: {
+			en: string;
+			zh: string;
+		};
+		RESOLUTION: {
+			en: string;
+			zh: string;
+		};
+		ENCODETYPE: {
+			en: string;
+			zh: string;
+		};
+		BUFFEREND: {
+			en: string;
+			zh: string;
+		};
+		CURRENTTIME: {
+			en: string;
+			zh: string;
+		};
+	};
+	_getDefaultInfo(data: any): Record<string, InfoItem>;
+	_init(): void;
+	_getStats(): any;
+	_getInfoListData(): Record<string, InfoItem>;
+	_initDom(infoItems: any): any;
+	_updateTitle(rowDom: Element, item: InfoItem): void;
+	_updateDom(rowdom: Element, newItem: InfoItem): void;
+	_renderLabel(item: InfoItem): any;
+	_renderValue(item: InfoItem): any;
+	_handleDataChange(): void;
+	_tick(): void;
+	_poll(): void;
+	destroy(): void;
+	_handleError(): void;
+	_handleLoadedData(): void;
+	_open(): void;
+	_close(): void;
+	open(): void;
+	close(): void;
+	render(): string;
+}
 export declare class TimeShiftPlugin extends Plugin {
 	static get pluginName(): string;
 	static get defaultConfig(): {
@@ -10479,6 +10639,7 @@ export declare const Event: {
 export * from "xgplayer";
 
 export {
+	LiveSubTitlesPlugin as LiveSubtitlesPlugin,
 	MusicPreset as Music,
 	VePlayer as default,
 };