@byteplus/veplayer 1.7.5-rc.4 → 1.7.5

package/index.d.ts

@@ -1097,6 +1097,129 @@ export interface IAutoplayPluginConfig {
 	userActionDom?: Node;
 	enableUserActionAutoplay?: boolean;
 }
+declare class PlayList {
+	private config;
+	private parent;
+	private root;
+	private modal;
+	private _delegates;
+	private attrKeys;
+	constructor(args: any);
+	renderItemList(dataList?: any[]): void;
+	onItemClick(e: any): boolean;
+	getAttrObj(dom: HTMLElement, keys: string[]): {
+		index?: number;
+	} & Record<string, any>;
+	show(): void;
+	hide(): void;
+	modalClick(e: any): void;
+	setStyle(style: any): void;
+	destroy(): void;
+}
+export declare const enum TOGGLE_MODES {
+	CLICK = "click",
+	HOVER = "hover"
+}
+export interface IPlayListItem {
+	url?: string;
+	playAuthToken?: string;
+	vid: string;
+	poster?: string;
+	title?: string;
+}
+declare enum EPlayMode {
+	ORDER = "order",
+	LOOP = "loop"
+}
+export interface IPlayListConfig {
+	position?: string;
+	index?: number;
+	list: IPlayListItem[];
+	mode?: EPlayMode;
+	defaultIndex?: number;
+	isItemClickHide?: boolean;
+	toggleMode?: TOGGLE_MODES;
+	isShowIcon?: boolean;
+}
+export declare class PlayListPlugin extends Plugin {
+	isIcons: boolean;
+	isActive: boolean;
+	curInfo: any;
+	private nextIndex;
+	private prevIndex;
+	curIndex: number;
+	optionsList: OptionList;
+	private activeEvent;
+	private list;
+	private _disable;
+	private halfPass;
+	private mode;
+	private timer;
+	static get pluginName(): string;
+	static get defaultConfig(): IPlayListConfig;
+	beforeCreate(args: any): void;
+	afterCreate(): void;
+	registerLanguageTexts(): {
+		playNext: {
+			jp: string;
+			en: string;
+			zh: string;
+			"zh-hk": string;
+		};
+		playList: {
+			jp: string;
+			en: string;
+			zh: string;
+			"zh-hk": string;
+		};
+	};
+	registerIcons(): {
+		[x: string]: {
+			icon: any;
+			class: string;
+		};
+	};
+	private initIcons;
+	show(): void;
+	hide(): void;
+	private onEnter;
+	private switchActiveState;
+	/**
+	 * @brief 播放上一个
+	 */
+	prev(): void;
+	/**
+	 * @brief 播放下一个
+	 */
+	next(): void;
+	private handleNext;
+	/**
+	 * @breief 更换播放列表
+	 * @param { IPlayListItem[] } list 添加的播放列表
+	 */
+	changeList(list: IPlayListItem[]): void;
+	/**
+	 * @brief 设置播放序号
+	 * @param { number } index 目标序号
+	 */
+	setIndex(index: number): void;
+	private change;
+	_onTimeUpdate: () => void;
+	private confirmOrder;
+	private _nextCompute;
+	private _prevCompute;
+	private _onEnded;
+	private _emitChange;
+	private onLeave;
+	toggle(isActive: boolean): void;
+	private onItemClick;
+	private renderItemList;
+	private _resizeList;
+	destroy(): void;
+	set disable(val: boolean);
+	get disable(): boolean;
+	render(): string;
+}
 export interface IPlayInfoList {
 	BackupPlayUrl: string;
 	BackupUrlExpire: string;
@@ -1362,6 +1485,34 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @memberof IPlayerConfig
 	 */
 	streamType?: "mp4" | "hls" | "dash" | "rtm" | "flv";
+	/**
+	 * 是否总是显示清晰度切换控件，即只有一个清晰度时也显示清晰度切换控件
+	 * @type {boolean}
+	 * @memberof IPlayerConfig
+	 */
+	alwaysShowDefinition?: boolean;
+	/**
+	 * url对应视频的清晰度文案，仅alwaysShowDefinition为true时有效
+	 *
+	 * @type {string}
+	 * @memberof IPlayerConfig
+	 */
+	definitionText?: string;
+	/**
+	 * url对应视频的清晰度文案的多语言key，对应参数 languages 中相对应的文案，仅alwaysShowDefinition为true时有效，优先级高于definitionText
+	 *
+	 * @type {string}
+	 * @memberof IPlayerConfig
+	 */
+	definitionTextKey?: string;
+	/**
+	 * 视频编码方式
+	 * 软解useSoftDecoding设置为true时，提供codec可提升软解初始效率
+	 *
+	 * @type {CodecType}
+	 * @memberof IPlayerConfig
+	 */
+	codec?: CodecType;
 	/**
 	 * 区域，影响服务接口和日志上报
 	 * @volcengine/veplayer默认区域为cn， @byteplus/veplayer默认区域为sg
@@ -1371,6 +1522,12 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @memberof IPlayerConfig
 	 */
 	region?: TRegionType;
+	/**
+	 * 多语言配置key，影响播放器文案的语言种类
+	 * @type {'zh' | 'zh-cn' | 'en' | 'jp' | 'zh-hk'}
+	 * @memberof IPlayerConfig
+	 */
+	lang?: "zh" | "zh-cn" | "en" | "jp" | "zh-hk";
 	/**
 	 * 插件加载公共路径，用于指定插件的加载路径，或者本地文件服务加载插件
 	 *
@@ -1494,14 +1651,6 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @memberof IPlayerConfig
 	 */
 	useSoftDecoding?: boolean;
-	/**
-	 * 视频编码方式
-	 * 软解useSoftDecoding设置为true时，提供codec可提升软解初始效率
-	 *
-	 * @type {('h264' | 'h265')}
-	 * @memberof IPlayerConfig
-	 */
-	codec?: CodecType;
 	/**
 	 * 是否开H265播放降级，即H.265硬解不支持时自动降级为软解
 	 *
@@ -1664,6 +1813,12 @@ export interface IPlayerConfig extends IPlayerOptions {
 	 * @memberof IPlayerConfig
 	 */
 	AutoplayPlugin?: IAutoplayPluginConfig;
+	/**
+	 * 播放列表配置
+	 * @type { IPlayListConfig }
+	 * @memberof IPlayerConfig
+	 */
+	playListPlugin?: IPlayListConfig;
 }
 /**
  * 初始配置
@@ -2057,12 +2212,6 @@ declare class PlayerData {
 	 */
 	get playDomain(): string;
 	setVodTeaId(): void;
-	/**
-	 * @hidden
-	 * @brief 播放列表插件的配置
-	 * @param configs
-	 */
-	setVodPlayListConfig(configs: IPlayerConfig): void;
 }
 declare function isMSESupport(mime?: string): boolean;
 export interface IConfig {
@@ -3250,122 +3399,6 @@ export declare class MemoryPlay extends Plugin {
 	saveTimeByStorage(memoryId: any, time: any): void;
 	getTimeByStorage(memoryId: any): string;
 }
-declare class PlayList {
-	private config;
-	private parent;
-	private root;
-	private modal;
-	private _delegates;
-	private attrKeys;
-	constructor(args: any);
-	renderItemList(dataList?: any[]): void;
-	onItemClick(e: any): boolean;
-	getAttrObj(dom: HTMLElement, keys: string[]): {
-		index?: number;
-	} & Record<string, any>;
-	show(): void;
-	hide(): void;
-	modalClick(e: any): void;
-	setStyle(style: any): void;
-	destroy(): void;
-}
-export declare const enum TOGGLE_MODES {
-	CLICK = "click",
-	HOVER = "hover"
-}
-export interface IPlayListItem {
-	url?: string;
-	playAuthToken?: string;
-	vid: string;
-	poster?: string;
-	title?: string;
-}
-declare enum EPlayMode {
-	ORDER = "order",
-	LOOP = "loop"
-}
-export interface IPlayListConfig {
-	position?: string;
-	index?: number;
-	list: IPlayListItem[];
-	mode?: EPlayMode;
-	defaultIndex?: number;
-	isItemClickHide?: boolean;
-	toggleMode?: TOGGLE_MODES;
-	isShowIcon?: boolean;
-}
-export declare class PlayListPlugin extends Plugin {
-	isIcons: boolean;
-	isActive: boolean;
-	curInfo: any;
-	private nextIndex;
-	private prevIndex;
-	curIndex: number;
-	optionsList: OptionList;
-	private activeEvent;
-	private list;
-	private _disable;
-	private halfPass;
-	private mode;
-	private timer;
-	static get pluginName(): string;
-	static get defaultConfig(): IPlayListConfig;
-	beforeCreate(args: any): void;
-	afterCreate(): void;
-	registerLanguageTexts(): {
-		playNext: {
-			jp: string;
-			en: string;
-			zh: string;
-			"zh-hk": string;
-		};
-		playList: {
-			jp: string;
-			en: string;
-			zh: string;
-			"zh-hk": string;
-		};
-	};
-	registerIcons(): {
-		[x: string]: {
-			icon: any;
-			class: string;
-		};
-	};
-	private initIcons;
-	show(): void;
-	hide(): void;
-	onEnter: (e: any) => void;
-	private switchActiveState;
-	prev(): void;
-	next: () => void;
-	/**
-	 * @breief 更新播放列表
-	 * @param { IPlayListItem[] } list 添加的播放列表
-	 */
-	changeList(list: IPlayListItem[]): void;
-	/**
-	 * @brief 设置播放序号
-	 * @param { number } index 目标序号
-	 */
-	setIndex(index: number): void;
-	change(): void;
-	_onTimeUpdate: () => void;
-	confirmOrder(): void;
-	_nextCompute(): void;
-	_prevCompute(): void;
-	_onEnded: () => void;
-	_emitChange(): void;
-	onLeave: (e: any) => void;
-	toggle(isActive: boolean): void;
-	onItemClick(e: any, data: any): void;
-	renderItemList(curIndex?: number): void;
-	_resizeList(): void;
-	destroy(): void;
-	set disable(val: boolean);
-	get disable(): boolean;
-	render(): string;
-}
 export declare type InfoItem = {
 	key: string;
 	label: string;