@volcengine/veplayer 1.14.0-rc.1 → 1.14.0

package/index.d.ts

@@ -6,8 +6,7 @@ import VodLogger from '@byted/xgplayer-app-logger/es/logger';
 import EventEmitter from 'eventemitter3';
 import Player from 'xgplayer';
 import { BasePlugin, I18N, IXGI18nText, Plugin } from 'xgplayer';
-import XGAdsPlugin from 'xgplayer-ads';
-import { AdsPluginConfig } from 'xgplayer-ads/es/plugin';
+import SubTitles from 'xgplayer-subtitles';
 import { IUrl } from 'xgplayer/es/defaultConfig';
 
 /**
@@ -1876,7 +1875,7 @@ export declare class PlayListPlugin extends Plugin {
 	};
 	registerIcons(): {
 		[x: string]: {
-			icon: any;
+			icon: string;
 			class: string;
 		};
 	};
@@ -2887,24 +2886,20 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @brief 点播服务所在区域，影响服务接口的请求域名
 	 * @default cn
 	 * @notes 火山引擎海外区域播放时请填写'mya'
-	 * @hidden
 	 */
 	/** {en}
 	 * @brief The area where the on-demand service is located affects the service interface and log reporting.
 	 * @default sg
-	 * @hidden
 	 */
 	region?: TRegionType;
 	/** {zh}
 	 * @brief 用户所在区域，影响日志请求的上报服务及动态依赖拉取的域名
 	 * @default cn
 	 * @notes 如果是海外用户，播放时请填写'mya'
-	 * @hidden
 	 */
 	/** {en}
 	 * @brief The region where the user is located, the domain name that affects the reporting service of the log request and the dynamic dependency pull
 	 * @default sg
-	 * @hidden
 	 */
 	userRegion?: TRegionType;
 	/** {zh}
@@ -3386,6 +3381,36 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @default -
 	 */
 	progressDot?: IDot[];
+	/** {zh}
+	 * @brief 移动端下倍速、清晰度等选择弹窗的样式
+	 *      - `0`: 从页面底部弹出
+	 *      - `1`: 从播放器容器内部右侧弹出
+	 *      - `2`: 覆盖播放器整个容器的方式弹出
+	 * @default `0`
+	 */
+	/** {en}
+	 * @brief The style of the pop-up window for selecting speed, definition, etc. on the mobile terminal
+	 *      - `0`: Pops up from the bottom of the page
+	 *      - `1`: Pops up from the right side of the player container
+	 *      - `2`: Pops up in a way that covers the entire player container
+	 * @default `0`
+	 */
+	mode?: number;
+	/** {zh}
+	 * @brief seek操作结束之后播放器的状态，如果取值为auto，则维持原播放状态, 默认是seek之后直接播放
+	 *      - `play`: 播放
+	 *      - `pause`: 暂停
+	 *      - `auto`: 保持操作前的状态
+	 * @default `play`
+	 */
+	/** {en}
+	 * @brief The state of the player after the seek operation is completed. If the value is auto, the original playback state is maintained. The default is to play directly after seeking.
+	 *      - `play`: play
+	 *      - `pause`: pause
+	 *      - `auto`: keep the status before operation
+	 * @default `play`
+	 */
+	seekedStatus?: "play" | "pause" | "auto";
 }
 /**
  * @brief 播放源数据。支持传入视频播放地址 `url`、播放列表 `playList` 或者 `vid` 和 `playAuthToken`，还需包含新地址的过期时间戳 `urlExpireTimestamp`。
@@ -3942,6 +3967,7 @@ export interface ApiMapConfig {
 	playDomain: string;
 	backupPlayDomain?: string;
 }
+export type TLogChannel = "cn" | "va" | "sg";
 declare enum PreloadScene {
 	/**
 	 * 普通场景（手动执行预加载）
@@ -4092,40 +4118,57 @@ export declare type StrategyConfigOptions = {
  * @detail Options
  */
 export declare type StrategyInitOptions = {
-	/**
+	/** {zh}
 	 * 应用ID
 	 * @brief 应用 ID
 	 */
 	/** {en}
-	 * @brief 应用ID
+	 * @brief appid
 	 */
 	appId: number;
-	/**
+	/** {zh}
+	 * @brief 用户所在区域
+	 * @default cn
+	 * @notes 如果是海外用户，播放时请填写'mya'
+	 */
+	/** {en}
+	 * @brief The region where the user is located,
+	 * @default sg
+	 */
+	region?: TRegionType;
+	/** {zh}
 	 * 高级能力（策略）配置
 	 * @brief 策略配置
 	 */
 	/** {en}
-	 * @brief 高级能力（策略）配置
+	 * @brief Advanced Capability (Strategy) Configuration
 	 */
 	strategies: StrategyConfigOptions;
-	/**
+	/** {zh}
 	 * 设备ID
 	 * @brief 设备 ID
 	 */
 	/** {en}
-	 * @brief 设备ID
+	 * @brief device id
 	 */
 	deviceId?: string;
-	/**
-	 * 手动注入依赖插件，默认自动加载
+	/** {zh}
+	 * @brief 手动注入依赖插件，默认自动加载
+	 * @default -
+	 */
+	/** {en}
+	 * @brief Manually inject dependency plugins, automatically load by default
+	 * @default -
 	 */
 	plugins?: any[];
 	/**
 	 * 策略Module，默认自动加载
 	 * @brief 策略 Module，默认自动加载
+	 * @default -
 	 */
 	/** {en}
-	 * @brief 策略Module，默认自动加载
+	 * @brief Strategy Module, automatically loaded by default
+	 * @default -
 	 */
 	Module?: typeof VeStrategy;
 };
@@ -4250,7 +4293,8 @@ export declare type IPreloadStream = {
 declare class VeStrategyWrapper {
 	private tea;
 	private static mapStrategyNameToUmdKey;
-	private static TEA_ID;
+	teaId: number;
+	teaChannel: TLogChannel;
 	preloader: PreloaderManagerOrigin | undefined;
 	preloaderStatus: PreloaderStatus;
 	private sdkUmdLoader;
@@ -5598,11 +5642,11 @@ export declare class LiveSubtitlesIconPlugin extends Plugin {
 	afterPlayerInit(): void;
 	registerIcons(): {
 		aiSubOpen: {
-			icon: any;
+			icon: string;
 			class: string;
 		};
 		aiSubClose: {
-			icon: any;
+			icon: string;
 			class: string;
 		};
 	};
@@ -5711,7 +5755,7 @@ export declare class Subtitle extends Plugin {
 	curIndex: number;
 	curItem: ISubTitleItem;
 	player: Player & {
-		_subTitles?: NativeSubTitle;
+		_subTitles?: NativeSubTitle | SubTitles;
 	};
 	afterCreate(): void;
 	/**
@@ -5740,11 +5784,11 @@ export declare class Subtitle extends Plugin {
 	}): number;
 	registerIcons(): {
 		vttSubOpen: {
-			icon: any;
+			icon: string;
 			class: string;
 		};
 		vttSubClose: {
-			icon: any;
+			icon: string;
 			class: string;
 		};
 	};
@@ -5803,59 +5847,6 @@ export declare class Subtitle extends Plugin {
 	destroy(): void;
 	render(): string;
 }
-export declare type AdRuleOffset = "pre" | "post" | `${number}:${number}:${number}`;
-export declare type AdRuleType = "linear" | "nonlinear";
-export interface AdRule {
-	offset: AdRuleOffset;
-	tag: string;
-	type: AdRuleType;
-}
-export interface AdsConfig {
-	controls?: boolean;
-	enableSCTE35?: boolean;
-	replayForSCTE35?: {
-		enable?: boolean;
-		minDurationOffset?: number;
-	};
-	adType: "ima" | "google-ima" | "ssai";
-	ima: AdsPluginConfig["ima"] & {
-		schedule?: AdRule[];
-		adTagUrlForSCTE35?: string;
-	};
-}
-export declare class AdsPlugin extends XGAdsPlugin {
-	config: AdsConfig;
-	csManager: any;
-	player: any;
-	root: any;
-	private _scte35Manager?;
-	private _ssManager?;
-	private _onPlay?;
-	private _onTimeUpdate?;
-	private _onPause?;
-	private _onError?;
-	private _onClick?;
-	static get pluginName(): string;
-	get adManager(): any;
-	afterCreate(): void;
-	afterPlayerInit(): void;
-	beforePlayerInit(): Promise<any>;
-	destroy(): void;
-	private _clearSSAIListener;
-	private _setupSSAIListener;
-	private _dispatchEvent;
-	private _init;
-	/**
-	 * Preroll广告播放完，retry重新拉流保证启播延迟
-	 */
-	/**
-	 * 如果存在midroll广告，需要将disconnectTime和maxLatency设为最大值，否则currentTime的变化会影响展示时间
-	 */
-	/**
-	 * 静音播放Preroll广告时，需要显示autoplayPlugin插件的ummute蒙层
-	 */
-	private _handlePrerollMuted;
-}
 export declare class TimeShiftPlugin extends Plugin {
 	static get pluginName(): string;
 	static get defaultConfig(): {
@@ -5941,7 +5932,7 @@ export declare class MirrorPlugin extends Plugin {
 	afterCreate(): void;
 	registerIcons(): {
 		[x: string]: {
-			icon: any;
+			icon: string;
 			class: string;
 		};
 	};