@byteplus/veplayer 1.15.3-rc.31 → 1.15.3-rc.32

package/lite.d.ts

@@ -1,5 +1,25 @@
 import { I18N } from 'xgplayer';
 
+/** UMD modules that can be loaded or explicitly pre-registered. */
+export declare enum UmdKeys {
+	HLS = "hls",
+	FLV = "flv",
+	XGVideo = "XGVideo",
+	HLSEncrypt = "hlsEncrypt",
+	DASH = "dash",
+	MP4Encrypt = "mp4Encrypt",
+	DanmuJS = "danmujs",
+	DanmuMask = "danmuMask",
+	StreamProbe = "streamprobe",
+	VeStrategy = "vestrategy",
+	VeStrategyH265 = "vestrategy_h265",
+	VeStrategyPreload = "vestrategy_preload",
+	VeStrategyAdaptRange = "vestrategy_adapt_range",
+	DashAbralgo = "DashAbralgo",
+	Preloader = "preloader"
+}
+/** Resolved UMD module values keyed by their public UMD key. */
+export type UmdModules = Partial<Record<UmdKeys, unknown>>;
 export type LiteStreamType = "mp4" | "hls" | "dash" | "flv";
 export type LiteCodecType = "h264" | "h265" | "h266" | "aac" | "mp3" | "opus" | "unknown";
 export type LiteDrmType = "drm_encrypt" | "private_encrypt" | "private_encrypt_upgrade" | "standard_encrypt";
@@ -38,6 +58,145 @@ export interface LitePlayAuthTokenConfig {
 	autoDemoteDefinitionTextKey?: string;
 	urlQueryParams?: Record<string, string>;
 }
+/** Lite-only preloading scene values supported by the player runtime. */
+export type LitePreloadScene = 0 | 1;
+/** Lite-safe preload strategy configuration. */
+export interface LitePreloadStrategyConfig {
+	preloadScene?: LitePreloadScene;
+	prevCount?: number;
+	nextCount?: number;
+	preloadTime?: number;
+	preloadMaxCacheCount?: number;
+	Strategy?: unknown;
+	disabled?: boolean;
+}
+/** Lite strategy initialization. Full strategy names are deliberately absent. */
+export interface LiteStrategyInitOptions {
+	/** Optional for a configured short-drama environment. */
+	appId?: number;
+	region?: "cn" | "mya" | "va" | "sg";
+	strategies: {
+		preload?: true | LitePreloadStrategyConfig;
+	};
+	deviceId?: string;
+	plugins?: unknown[];
+	Module?: unknown;
+}
+/** Runtime updates supported for Lite preload scenes. */
+export interface LitePreloadUpdateConfig {
+	prevCount?: number;
+	nextCount?: number;
+}
+/** A direct media entry accepted by Lite preload APIs. */
+export interface LitePreloadResolvedStream {
+	vid: string;
+	url: string;
+	definition: string;
+	streamType: "mp4";
+	codec: "h264";
+	bitrate: number;
+	duration: number;
+	size: number;
+}
+/** A short-drama episode accepted by Lite preload APIs. */
+export interface LitePreloadDramaStream {
+	vid?: string;
+	albumId: string;
+	episodeId: string;
+	defaultDefinition?: string;
+	getVideoByToken?: LitePlayAuthTokenConfig;
+}
+/** A token-resolved VOD item accepted by Lite preload APIs. */
+export interface LitePreloadAuthTokenStream {
+	vid?: string;
+	defaultDefinition?: string;
+	getVideoByToken: LitePlayAuthTokenConfig;
+}
+/** Lite preload entries do not expose Full strategy stream contracts. */
+export type LitePreloadStream = LitePreloadResolvedStream | LitePreloadDramaStream | LitePreloadAuthTokenStream;
+/** Request passed by the host short-drama bridge. */
+export interface LiteDramaInfoRequest {
+	clientKey: string;
+	albumId: string;
+	episodeId: string;
+	vid: string;
+}
+/** Error returned by the host short-drama bridge. */
+export interface LiteDramaInfoError {
+	error_code: number;
+	error_msg: string;
+	error_extra?: unknown;
+}
+/** Safe VOD fields exposed from a short-drama video result. */
+export interface LiteDramaVideoInfo {
+	version?: number;
+	vid?: string;
+	status?: number;
+	poster_url?: string;
+	duration?: number;
+	file_type?: string;
+	enable_adaptive?: boolean;
+	total_count?: number;
+	adaptive_info?: unknown;
+	adaptive_bitrate_streaming_info?: unknown;
+	play_info_list?: Array<{
+		file_id?: string;
+		md5?: string;
+		file_type?: string;
+		format?: string;
+		codec?: string;
+		definition?: string;
+		main_play_url?: string;
+		backup_play_url?: string;
+		bitrate?: number;
+		width?: number;
+		height?: number;
+		size?: number;
+		duration?: number;
+		drm_type?: string;
+	}>;
+	thumb_info_list?: unknown[];
+	subtitle_info_list?: unknown[];
+}
+/** Short-drama bridge result with only Lite-safe media data. */
+export interface LiteDramaInfoResponse {
+	is_success: number | boolean;
+	error?: LiteDramaInfoError;
+	data?: {
+		status: number;
+		drama_info: {
+			album_id: string;
+			drama_name: string;
+			drama_cover: string;
+			drama_description: string;
+		};
+		episode_info: {
+			episode_id: string;
+			episode_name: string;
+			episode_cover: string;
+			episode_description: string;
+		};
+		video_info: LiteDramaVideoInfo;
+		perf_info?: {
+			prepare_cost?: number;
+			request_cost?: number;
+			parse_cost?: number;
+			total_cost?: number;
+		};
+	};
+}
+/** Host callbacks required by Lite short-drama playback. */
+export interface LiteTTDramaEnv {
+	channel?: "volcengine" | "byteplus";
+	appVersion: string;
+	clientKey: string;
+	canIUseGetDramaInfo: boolean;
+	canAndroidBatchGetDramaInfo?: boolean;
+	getDramaInfo: (callback: (res: LiteDramaInfoResponse) => void, options: LiteDramaInfoRequest) => void;
+	videoSecurityModule?: unknown;
+	sendLog: (eventName: string, params: Record<string, unknown>) => void;
+	getTokenVerifySecret?: () => Promise<string>;
+}
 export interface LiteDefaultConfig {
 	type?: "vod";
 	isLive?: false;
@@ -342,6 +501,12 @@ export interface LiteVePlayerConstructor {
 	readonly prototype: LiteVePlayer;
 	readonly sdkVersion: string;
 	new <MediaUrl extends LiteMediaUrl = LiteMediaUrl, StreamUrl extends LiteMediaUrl = LiteMediaUrl>(configs: LitePlayerConfig<MediaUrl, StreamUrl>): LiteVePlayer;
+	prepare(options: LiteStrategyInitOptions): Promise<void>;
+	registerModules(modules: UmdModules): void;
+	setTTDramaEnv(env: LiteTTDramaEnv): void;
+	setPreloadScene(preloadScene: LitePreloadScene, options?: LitePreloadUpdateConfig): void;
+	addPreloadList(list: LitePreloadStream[]): Promise<void>;
+	setPreloadList(list: LitePreloadStream[]): Promise<void>;
 	getAppendVideoUrlTimestamp(): boolean;
 	isMSESupported(): boolean;
 	setAppendVideoUrlTimestamp(enable?: boolean): void;