@byteplus/veplayer 1.18.0-rc.6 → 1.18.0-rc.7

package/index.d.ts

@@ -3176,6 +3176,8 @@ export interface ITTDramaEnv {
 	 * @type {boolean}
 	 */
 	canIUseGetDramaInfo: boolean;
+	/** 是否支持在 getDramaInfo 中透传 transcodeParam */
+	canIUseGetDramaInfoTranscodeParam?: boolean;
 	/**
 	 * @brief Android 是否支持批量获取短剧信息（高版本 app）
 	 * @type {boolean}
@@ -3206,6 +3208,20 @@ export interface IGetDramaInfoOptions {
 	albumId: string;
 	episodeId: string;
 	vid: string;
+	transcodeParam?: IGetDramaInfoTranscodeParam;
+}
+/** JSB/TTOP 使用的 snake_case 转码参数。 */
+export interface IGetDramaInfoTranscodeParam {
+	format?: string;
+	codec?: string;
+	definition?: string;
+	file_type?: string;
+	need_thumbs?: string;
+	need_barrage_mask?: string;
+	union_info?: string;
+	quality?: string;
+	drm_kek?: string;
+	js_player?: string;
 }
 export interface MinisError {
 	error_code: number;
@@ -3970,6 +3986,24 @@ export interface IGetDramaInfoPerfCallbackPayload {
 	 */
 	timestamp: number;
 }
+/** {zh}
+ * @brief Minis 短剧转码参数。各字段会由 VePlayer 转换为服务端 snake_case 命名后透传。
+ */
+/** {en}
+ * @brief Minis short-drama transcoding parameters. VePlayer converts the fields to server-side snake_case names before forwarding them.
+ */
+export interface ITranscodeParam {
+	format?: string;
+	codec?: string;
+	definition?: string;
+	fileType?: string;
+	needThumbs?: string;
+	needBarrageMask?: string;
+	unionInfo?: string;
+	quality?: string;
+	drmKek?: string;
+	jsPlayer?: string;
+}
 /** {zh}
  * @list Options
  * @kind property
@@ -4041,6 +4075,13 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 剧集id，Minis 短剧播放需要
 	 */
 	episodeId?: string;
+	/** {zh}
+	 * @brief Minis 短剧转码参数。
+	 */
+	/** {en}
+	 * @brief Minis short-drama transcoding parameters.
+	 */
+	transcodeParam?: ITranscodeParam;
 	/** {zh}
 	 * @brief Vid 播放配置项。应用服务端需通过 `vid` 生成临时临时播放 Token，下发给客户端。
 	 * @type {IPlayAuthTokenConfig}
@@ -6427,7 +6468,7 @@ declare class AuthToken extends SdkPlugin {
 	playInfo?: VideoInfoRes;
 	constructor(args: any);
 	beforePlayerCreate(): Promise<void>;
-	getVideoInfo(): Promise<{
+	getVideoInfo(sourceConfigs?: IPlayerConfig): Promise<{
 		vid: string;
 		playList: Stream[];
 		codec: ICodecType;
@@ -6436,7 +6477,7 @@ declare class AuthToken extends SdkPlugin {
 	/**
 	 * 短剧 Minis 环境：通过 JSB getDramaInfo 获取媒体信息
 	 */
-	getDramaInfoViaJSB(): Promise<VideoInfoRes | undefined>;
+	getDramaInfoViaJSB(sourceConfigs?: IPlayerConfig): Promise<VideoInfoRes | undefined>;
 	/**
 	 * 将审核状态映射到短剧错误码
 	 */
@@ -6455,7 +6496,7 @@ declare class AuthToken extends SdkPlugin {
 		episodeId?: string;
 		vid?: string;
 	}): void;
-	getVideos(): Promise<any>;
+	getVideos(sourceConfigs?: IPlayerConfig): Promise<any>;
 	getPrivateDrmInfo(playList: Stream[], vid: string, streamType: string): Promise<void>;
 	getThumbnailConfig(thumbs: IThumbInfoItem[]): void;
 	getBarrageMaskUrl(url: string): void;
@@ -6472,11 +6513,11 @@ declare class AuthToken extends SdkPlugin {
 	 */
 	get isMinisDramaMode(): boolean;
 	init(): void;
-	initConfig(getVideoByToken: IPlayAuthTokenConfig): void;
+	initConfig(getVideoByToken: IPlayAuthTokenConfig, sourceConfigs?: IPlayerConfig): void;
 	/**
 	 * 剧集切换：configs 已由 player 更新 album_id/episode_id，重新拉取媒体信息
 	 */
-	updateDramaEpisode(isNewVideo: boolean): Promise<void>;
+	updateDramaEpisode(isNewVideo: boolean, candidateConfig?: IPlayerConfig): Promise<void>;
 	/**
 	 * @description 更新playAuthToken
 	 * @param {IPlayAuthTokenConfig} getVideoByToken token信息
@@ -6679,6 +6720,10 @@ declare class PlayerData {
 	 */
 	get playDomain(): string;
 	setVodTeaId(): void;
+	/**
+	 * 基于当前配置生成合并后的候选配置，不修改当前播放状态。
+	 */
+	getMergedConfigs(newConfigs: IPlayerConfig): IPlayerConfig;
 	/**
 	 * 更新configs,即更新用户的configs，常用于playNext时
 	 * @param newConfigs {IPlayerConfig} 要更新的配置
@@ -6928,7 +6973,26 @@ export declare type IPreloadDramaStream = {
 	vid?: string;
 	albumId: string;
 	episodeId: string;
+	/** {zh}
+	 * @brief 默认清晰度，仅用于从完整媒体信息中选择预加载流。
+	 */
+	/** {en}
+	 * @brief Default definition used only to select a preload stream from complete media information.
+	 */
 	defaultDefinition?: string;
+	/** {zh}
+	 * @brief Minis 短剧转码参数。
+	 */
+	/** {en}
+	 * @brief Transcoding parameters for Minis short dramas.
+	 */
+	transcodeParam?: ITranscodeParam;
+	/** {zh}
+	 * @brief Vid 播放配置。短剧预加载会复用 playAuthToken 等配置请求短剧信息。
+	 */
+	/** {en}
+	 * @brief Vid playback configuration reused by short-drama preload requests.
+	 */
 	getVideoByToken?: IPlayAuthTokenConfig;
 };
 export declare type IPreloadAuthTokenStream = {
@@ -7477,6 +7541,19 @@ export declare type NormalizedMediaInfoCacheConfig = {
 	maxEntries: number;
 };
 declare function getMediaInfoCacheConfig(): NormalizedMediaInfoCacheConfig;
+export interface DramaIdentity {
+	albumId: string | null;
+	episodeId: string | null;
+}
+export declare type PlayerPlaybackState = "creating" | "ready" | "playing" | "paused" | "buffering" | "ended" | "error" | "destroyed";
+export interface PlayerPlaybackStateSnapshot extends DramaIdentity {
+	playbackState: PlayerPlaybackState;
+	isEnded: boolean;
+	isPaused: boolean;
+	isBeforePlayerCreate: boolean;
+	duration: number;
+	currentTime: number;
+}
 /** {zh}
  * @hidden
  */
@@ -7529,6 +7606,15 @@ export interface EncryptInfo {
 	unionInfo: string;
 }
 declare class VePlayer {
+	/** {zh}
+	 * @brief 供 JSSDK 门面查询当前播放器播放状态。
+	 * @hidden
+	 */
+	/** {en}
+	 * @brief Returns the current player playback state for the JSSDK facade.
+	 * @hidden
+	 */
+	static getPlayerPlaybackState(): PlayerPlaybackStateSnapshot | null;
 	/**
 	 * 注册业务已打包的 UMD 模块，供所有后续创建的播放器共享使用。
 	 */
@@ -8021,6 +8107,7 @@ declare class VePlayer {
 	 * @memberof VePlayer
 	 */
 	createPlayer: () => Promise<PlayerCore>;
+	private _createPlayer;
 	private checkLicenseCallback;
 	/** {zh}
 	 * @hidden
@@ -8354,6 +8441,7 @@ declare class VePlayer {
 	playNext(config: IPlayerConfig, isNewVideo?: boolean): Promise<any>;
 	private updatePlayNextSubtitleConfig;
 	private _playNext;
+	private _createDramaPlayNextCandidateConfig;
 	/** 从 playerData.configs 取出短剧 id，供 XGPlayer setConfig / playNext 与切换后 configs 一致 */
 	private _getDramaConfigPatchForPlayer;
 	private _buildDramaInvalidParamError;
@@ -8736,8 +8824,15 @@ declare class VePlayer {
 	 */
 	hideSubtitle(): void;
 	/** {zh}
-	 * @memberof VePlayer
+	 * @hidden
+	 */
+	/** {en}
+	 * @hidden
+	 */
+	private _teardown;
+	/** {zh}
 	 * @brief 销毁当前播放器实例。
+	 * @memberof VePlayer
 	 */
 	/** {en}
 	 * @brief Destroy the current player instance.