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

package/lite.d.ts

@@ -1,5 +1,83 @@
 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>>;
+/** Video and audio codec names supported by the player. */
+export declare const CodecType: {
+	readonly H264: "h264";
+	readonly H265: "h265";
+	readonly H266: "h266";
+	readonly AAC: "aac";
+	readonly MP3: "mp3";
+	readonly OPUS: "opus";
+	readonly UNKNOWN: "unknown";
+};
+/** MIME type mapping for the supported MSE video codecs. */
+export declare const ContentType: {
+	readonly h265: string;
+	readonly h264: string;
+};
+export declare enum EVideoFormat {
+	MP4 = "mp4",
+	DASH = "dash",
+	HLS = "hls"
+}
+export declare enum EAudioFormat {
+	M4A = "m4a",
+	MP4 = "mp4",
+	MP3 = "mp3",
+	DASH = "dash",
+	HLS = "hls",
+	OGG = "ogg"
+}
+export declare const enum EDRMTYPE {
+	DRM_ENCRYPT = "drm_encrypt",
+	PRIVATE_ENCRYPT = "private_encrypt",
+	PRIVATE_ENCRYPT_UPGRADE = "private_encrypt_upgrade",
+	STANDARD_ENCRYPT = "standard_encrypt"
+}
+/** Plugin placement values compatible with the Full entry. */
+export declare const enum POSITIONS {
+	ROOT = "root",
+	ROOT_LEFT = "rootLeft",
+	ROOT_RIGHT = "rootRight",
+	ROOT_TOP = "rootTop",
+	CONTROLS_LEFT = "controlsLeft",
+	CONTROLS_RIGTH = "controlsRight",
+	CONTROLS_RIGHT = "controlsRight",
+	CONTROLS_CENTER = "controlsCenter",
+	CONTROLS = "controls"
+}
+/** Public event-name map shared by Lite and Full UMD constructors. */
+export interface LiteEvents {
+	readonly READY: "ready";
+	readonly [eventName: string]: string;
+}
+/** Legacy grouped event-name map. */
+export interface LiteEvent {
+	readonly SDKEvents: LiteEvents;
+	readonly PluginEvents: Record<string, string>;
+}
+export declare const Events: LiteEvents;
+export declare const Event: LiteEvent;
 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 +116,174 @@ 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;
+}
+/** Lite-safe media information cache settings. */
+export interface LiteMediaInfoCacheConfig {
+	enable?: boolean;
+	cacheType?: "memory" | "localStorage";
+	expireTime?: number;
+	maxEntries?: number;
+}
+/** Current media information cache settings, with defaults resolved. */
+export interface LiteMediaInfoCacheState {
+	enable: boolean;
+	cacheType: "memory" | "localStorage";
+	expireTime: number;
+	maxEntries: number;
+}
+/** Minimal preloader operations available from the Lite static surface. */
+export interface LitePreloaderManager {
+	removeAll(): void;
+	removeAllPreloadTask(): void;
+	clearPreloadList(): void;
+}
+/** Lite preloader lifecycle states. */
+export type LitePreloaderStatus = 0 | 1 | 2 | 3;
+/** Lite-safe view of the strategy controller exposed by the player. */
+export interface LiteVeStrategy {
+	readonly preloader?: LitePreloaderManager;
+	readonly preloaderStatus: LitePreloaderStatus;
+}
+/** Encryption metadata generated by a registered encryption module. */
+export type LiteEncryptInfo = Record<string, unknown>;
+/** 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;
@@ -341,12 +587,28 @@ type CollectorConstructor = new (name: string) => any;
 export interface LiteVePlayerConstructor {
 	readonly prototype: LiteVePlayer;
 	readonly sdkVersion: string;
+	readonly Events: LiteEvents;
+	readonly Event: LiteEvent;
+	readonly veStrategy: LiteVeStrategy;
+	readonly ttDramaEnv: LiteTTDramaEnv | null;
+	readonly preloader: LitePreloaderManager | undefined;
+	readonly preloaderStatus: LitePreloaderStatus;
 	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;
 	setCollector(Collector?: CollectorConstructor): void;
 	setDebug(enable: boolean): void;
+	setMediaInfoCacheConfig(config: LiteMediaInfoCacheConfig): void;
+	getMediaInfoCacheConfig(): LiteMediaInfoCacheState;
+	clearMediaInfoCache(): void;
+	generateEncryptInfo(unionId: string, streamType: "hls" | "mp4" | "dash"): Promise<LiteEncryptInfo | undefined>;
 }
 declare const LiteVePlayer: LiteVePlayerConstructor;
 export declare const Subtitle: LitePluginConstructor;