@volcengine/veplayer 2.0.0-rc.1 → 2.0.0-rc.2

package/esm/index.d.ts

@@ -1,16 +1,15 @@
-import { default as XGPlayer } from "xgplayer/es/player";
-import { IPlayerOptions as PlayerOptions } from "xgplayer/es/player";
 import Player from "xgplayer";
-import { IXGI18nText, IPluginOptions, Plugin } from "xgplayer";
+import { IXGI18nText, Plugin, IPluginOptions } from "xgplayer";
+import { IPlayerOptions as PlayerOptions } from "xgplayer";
 import { IDefinition as XGDefinition } from "xgplayer";
-import { IError as XGError } from "xgplayer";
 import { default as Player$0 } from "xgplayer";
+import { IError as XGError } from "xgplayer";
+import { IBasePluginOptions as XGPluginOptions } from "xgplayer";
 import { IXGI18n } from "xgplayer/es/lang/i18n";
 import XG_EN from "xgplayer/es/lang/en";
 import XG_ZH_CN from "xgplayer/es/lang/zh-cn";
 import OptionList from "xgplayer/es/plugins/common/optionList";
-import { FlvOption } from "xgplayer-flv/es/flv/options";
-import { HlsOption } from "xgplayer-hls/es/hls/config";
+import { default as XGPlayer } from "xgplayer/es/player";
 declare const EN: {
     DEFINITION_FALLBACK_TOAST: string;
     DEFINITION_SWITCHING: string;
@@ -109,15 +108,61 @@ declare class Definition implements XGDefinition {
     get url(): string;
     next(): DefinitionUrl;
 }
+/**
+ * @list option
+ * @kind property
+ * @id Definition
+ * @name Definition
+ *
+ */
 interface ExposedDefinition {
+    /** {zh}
+     * @brief 播放地址。
+     * @default 无
+     */
     url: string;
+    /** {zh}
+     * @brief 清晰度（唯一值）。
+     * @default 无
+     *
+     */
     definition: string;
+    /** {zh}
+     * @brief 清晰度展示名称。可设置多语言 `{text: {'zh-cn': '高清', 'en': 'HD'}}`。
+     * @default 无
+     */
     text?: Record<Lang, string> | string;
+    /** {zh}
+     * @brief 为当前清晰度地址设置备路拉流地址，支持设置多个备路拉流地址。当前清晰度地址拉流失败时，会在当前清晰度地址和备路直播地址之间循环拉流，直到拉流成功。
+     * @default 无
+     *
+     */
     fallbackUrls?: string[];
 }
+/**
+ * @list option
+ * @brief 线路数据配置。一个线路包含当前线路的 name ，展示名称，及线路下的清晰度列表。
+ * @kind property
+ * @id Source
+ * @name Source
+ */
 interface ExposedSource {
+    /** {zh}
+     * @brief 线路name(唯一值)。
+     * @default 无
+     */
     name?: string;
+    /** {zh}
+     * @brief 线路展示名称。可设置多语言 `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`。
+     * @default 无
+     *
+     */
     text?: Record<Lang, string> | string;
+    /** {zh}
+     * @brief 该线路下清晰度列表。
+     * @default 无
+     *
+     */
     definitions: Array<ExposedDefinition | string>;
 }
 interface CompoundSources {
@@ -139,12 +184,8 @@ declare class Source {
     private static normalizeUrl;
     add(definition: Definition): void;
 }
-declare enum TOP_RIGHT_POSITIONS {
-    ROOT_TOP_RIGHT = "rootTopRight",
-    ROOT_TOP_RIGHT_COLLAPSE = "rootTopRightCollapse"
-}
 interface Config {
-    listType: ListTypeOption;
+    listType: ListType;
     isAutoChange?: boolean;
     onItemClick?: (e: Event, data: CallbackData) => void;
     onOptionClick?: (e: Event, data: CallbackData) => void;
@@ -171,12 +212,12 @@ declare class MobilePlayerPanel {
     private _delegates?;
     private _listType?;
     constructor(args: Options);
-    changeMode(listType: ListTypeOption): void;
+    changeMode(listType: ListType): void;
     // 渲染选择列表
     renderItemList(data?: ListItem[]): HTMLElement;
     // 渲染panel的标题
     renderTitle(): HTMLElement | undefined;
-    updatePanel(listType: ListTypeOption): void;
+    updatePanel(listType: ListType): void;
     // 渲染panel
     renderPanel(): void;
     show(): void;
@@ -197,13 +238,29 @@ declare module MobilePlayerPanelWrapper {
     export { MobilePlayerPanel };
 }
 import MobilePanel = MobilePlayerPanelWrapper.MobilePlayerPanel;
-declare const ListType: {
-    readonly Middle: "middle";
-    readonly Bottom: "bottom";
-    readonly Fullscreen: "fullscreen";
-    readonly Inner: "inner";
-};
-type ListTypeOption = (typeof ListType)[keyof typeof ListType];
+/**
+ * @detail option
+ * @brief **清晰度选择**或**线路选择**时的**选择面板样式**，仅在移动端有效。
+ */
+declare enum ListType {
+    /** {zh}
+     * @brief 全屏布局
+     * @hidden
+     */
+    Middle = "middle",
+    /** {zh}
+     * @brief 底部抽屉
+     */
+    Bottom = "bottom",
+    /** {zh}
+     * @brief 右侧抽屉，常用于全屏时展示
+     */
+    Fullscreen = "fullscreen",
+    /** {zh}
+     * @brief 窗口蒙层展示
+     */
+    Inner = "inner"
+}
 interface ListItem {
     [key: string]: any;
     selected?: boolean;
@@ -234,7 +291,7 @@ type Config$0<T> = {
     // 【xg】是否展示已选择的
     isShowIcon?: boolean;
     // 【xg 扩展】列表渲染样式类型
-    listType?: ListTypeOption;
+    listType?: ListType;
     // 已选择的展示类型（文案 or icon）
     renderType?: RenderType;
     // 列表数据只有一个是否展示
@@ -248,50 +305,743 @@ type Config$0<T> = {
         title?: string | Record<Lang, string>;
     };
 };
-declare enum Codec {
-    H265 = "h265",
-    H264 = "h264"
+// 源自packages/xgplayer/src/plugins/common/optionsIcon.js
+// 自定义了几种选择类型
+declare class OptionsIcon extends Plugin {
+    icons: Record<string, any>;
+    config: Config$0<ListItem>;
+    optionsList?: MobilePanel | OptionList;
+    private _isIcon?;
+    private _isActive?;
+    private _curIndex;
+    private activeEvent?;
+    constructor(args: IPluginOptions);
+    static get pluginName(): string;
+    static get defaultConfig(): Config$0<ListItem>;
+    updateLang(): void;
+    afterCreate(): void;
+    initIcons(): void;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    show(): void;
+    hide(): void;
+    onEnter: (e: Event) => void;
+    onLeave: (e: Event) => void;
+    // 状态切换
+    toggle(isActive: boolean): void;
+    // 列表选择回调
+    onItemClick(e: Event, data: CallbackData): void;
+    // 列表点击回调
+    onOptionClick(e: Event, _data: CallbackData): void;
+    // 已选择 option 的文案
+    changeCurrentText(): void;
+    renderItemList(itemList: ListItem[], curIndex?: number): void;
+    destroy(): void;
+    render(): string;
+    private _getListType;
 }
-declare enum Degradation {
-    SoftFirst = "soft-first",
-    H264First = "h264-first"
+/**
+ * @detail error
+ */
+declare enum Level {
+    /**
+     * @brief 严重
+     *
+     */
+    Fatal = "Fatal",
+    /**
+     * @brief 报错
+     */
+    Error = "Error"
 }
-declare enum DecodeType {
-    Software = "software",
-    Hardware = "hardware"
+declare enum ErrorCode {
+    /**
+     * @brief 视频解析错误
+     * @solution 请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MANIFEST_HLS_ERROR = 1100,
+    /**
+     * @brief 视频解析错误
+     * @solution 请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MANIFEST_DASH_ERROR = 1200,
+    /**
+     * @brief 网络错误
+     * @solution 请检查当前网络环境或播放地址是否合法。
+     */
+    NETWORK = 2100,
+    /**
+     * @brief 网络请求超时
+     * @solution 请检查拉流地址是否合法。
+     */
+    NETWORK_TIMEOUT = 2101,
+    /**
+     * @brief 网络请求 403
+     * @solution 请检查拉流地址鉴权信息。
+     */
+    NETWORK_FORBIDDEN = 2103,
+    /**
+     * @brief 网络请求 404
+     * @solution 请检查拉流地址是否合法。
+     */
+    NETWORK_NOTFOUND = 2104,
+    /**
+     * @brief 网络请求 206
+     * @solution 请检查拉流地址是否合法。
+     */
+    NETWORK_RANGE_NOT_SATISFIABLE = 2116,
+    /**
+     * @brief 视频解析错误
+     * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    DEMUX_FLV_ERROR = 3100,
+    /**
+     * @brief 视频解析错误
+     * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    DEMUX_HLS_ERROR = 3200,
+    /**
+     * @brief 视频解析错误
+     * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
+    DEMUX_MP4_ERROR = 3300,
+    /**
+     * @brief 视频解析错误
+     * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
+    DEMUX_FMP4_ERROR = 3400,
+    /**
+     * @brief 视频解析错误
+     * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
+    DEMUX_SIDX_ERROR = 3410,
+    /**
+     * @brief 视频解析错误
+     * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
+    REMUX_FMP4_ERROR = 4100,
+    /**
+     * @brief 视频解析错误
+     * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     *
+     */
+    REMUX_MP4_ERROR = 4200,
+    /**
+     * @brief 获取数据过程被中止
+     * @solution 请检查浏览器网络请求是否正常，再尝试重新拉流。
+     */
+    MEDIA_ERR_ABORTED = 5101,
+    /**
+     * @brief 网络发生错误，无法成功获取媒体文件
+     * @solution 请检查浏览器网络请求是否正常，再尝试重新拉流。
+     */
+    MEDIA_ERR_NETWORK = 5102,
+    /**
+     * @brief 浏览器在解码媒体资源时发生错误
+     * @solution
+     * 1. 请检查原始视频是否正常；
+     * 2. 重新进行转码和播放；
+     * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_ERR_DECODE = 5103,
+    /**
+     * @brief 因视频格式不支持、服务器或网络的问题造成视频无法加载
+     * @solution
+     * 1. 检查浏览器视频数据请求是否正常；
+     * 2. 检查浏览器和页面环境是否支持要播放的视频格式；
+     * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
+    /**
+     * @brief 当前浏览器不支持视频解码
+     * @solution
+     * 1. 检查浏览器视频数据请求是否正常；
+     * 2. 检查浏览器和页面环境是否支持要播放的视频格式；
+     * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
+    /**
+     * @brief 当前播放地址为空
+     * @solution 请检查必要参数 `url` 或 `playlist` 是否传入。
+     */
+    MEDIA_ERR_URL_EMPTY = 5106,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_MSE_ADD_SB = 5200,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_MSE_APPEND_BUFFER = 5201,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_MSE_OTHER = 5202,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_MSE_FULL = 5203,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_MSE_HIJACK = 5204,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    MEDIA_EME_HIJACK = 5301,
+    /**
+     * @brief DRM 权限校验失败
+     * @hidden
+     */
+    DRM_LICENSE = 7100,
+    /**
+     * @brief DRM 权限校验失败
+     * @hidden
+     */
+    DRM_CUSTOM_LICENSE = 7200,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    OTHER = 8000,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    RUNTIME_NO_CANPLAY_ERROR = 9001,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    RUNTIME_BUFFERBREAK_ERROR = 9002,
+    /**
+     * @brief 播放异常
+     * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+     */
+    RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
+    // veplayer 报错
+    /**
+     * @brief CDN 异步获取失败
+     * @solution 请刷新重试或者检查网络环境。
+     *
+     */
+    MODULE_LOAD_ERROR = 110,
+    /**
+     * @hidden
+     */
+    UNKNOWN = "UNKNOWN"
 }
-type PrepareResult = {
-    options?: Partial<VePlayerBaseOptions>;
-    plugins?: any[];
+declare enum ErrorType {
+    MANIFEST = "manifest",
+    NETWORK = "network",
+    DEMUX = "demux",
+    REMUX = "remux",
+    MEDIA = "media",
+    DRM = "drm",
+    OTHER = "other",
+    RUNTIME = "runtime"
+}
+interface ErrorInfo<T = TextKey> {
+    errorCode?: ErrorCode;
+    message?: string;
+    messageTextKey?: T;
+    level?: Level;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ext?: any;
+    error?: Error;
+}
+/**
+ * @detail error
+ * @name 错误对象
+ * @id 错误对象
+ */
+declare class VeError<T extends string = TextKey> extends Error {
+    /**
+     * @brief 错误码，对应[错误码字典](#错误码)。
+     */
+    readonly errorCode: ErrorCode;
+    /**
+     * @brief 错误等级。
+     */
+    readonly level?: Level;
+    /**
+     * @brief 错误信息。
+     */
+    message: string;
+    /**
+     * @brief 其他错误信息。
+     */
+    readonly ext?: any;
+    /**
+     * @hidden
+     * @param error
+     * @param i18n
+     */
+    constructor(error?: string | ErrorInfo<T>, i18n?: VeI18n<T>);
+}
+/**
+ * @list option
+ * @kind property
+ */
+type ErrorConfig = {
+    /** {zh}
+     * @brief 是否展示报错图片。
+     * @default true
+     */
+    showErrorImg?: boolean;
+    /** {zh}
+     * @brief 是否展示报错提示。
+     * @default true
+     */
+    showErrorTip?: boolean;
+    /** {zh}
+     * @brief 是否展示刷新按钮。
+     * @default true
+     */
+    showRefresh?: boolean;
+    /** {zh}
+     * @brief 自定义报错显示。
+     * @default 无
+     */
+    errorTipsText?: string | Record<Lang, string>;
+    /** {zh}
+     * @brief 更多提示信息。
+     * @default 无
+     */
+    extraTips?: {
+        label: string | Record<Lang, string>;
+        value: string | Record<Lang, string>;
+    }[];
 };
-type PreparePlugins = (url: string) => Promise<PrepareResult> | undefined;
-type Constructor<T> = new (...args: any[]) => T;
+declare class Error extends Plugin {
+    player: Player$0;
+    icons: {
+        error: HTMLElement;
+    };
+    langText: {
+        refresh: string;
+        errorTip: string;
+    };
+    config: ErrorConfig;
+    private _error?;
+    static get pluginName(): string;
+    static get defaultConfig(): {
+        showErrorImg: boolean;
+        showErrorTip: boolean;
+        showRefresh: boolean;
+        errorTipsText: string;
+        extraTips: never[];
+        position: string;
+    };
+    get _errorTip(): string;
+    afterCreate(): void;
+    registerIcons(): {
+        error: {
+            icon: any;
+            class: string;
+        };
+    };
+    updateLang(): void;
+    showError(error: VeError | XGError): void;
+    hideError(): void;
+    destroy(): void;
+    render(): string;
+    private _focus;
+    private _initIcons;
+    private _initEvents;
+    private _renderText;
+    private _renderExtraTips;
+    private _handleRefresh;
+    private _renderRefresh;
+}
+/**
+ * @list option
+ * @kind property
+ */
+interface DefinitionConfig {
+    /** {zh}
+     * @brief 等待超时的时间阈值，单位为 ms。等待超过该值，会抛出 `DEFINITION_FALLBACK` 事件，如果 `needFallback` 为 `true` 则会提示清晰度降级。
+     * @default 5000
+     */
+    longWaitingTime?: number;
+    /** {zh}
+     * @brief 是否开启清晰度降级。
+     * @default false
+     */
+    needFallback?: boolean;
+    /** {zh}
+     * @brief  降级顺序，按照数组顺序依次降级，数组中的元素与 playlist 中的 definition 相对应。
+     * @default "['uhd', 'hd', 'sd', 'ld', 'ao']"
+     */
+    demotePriority?: string[];
+}
 interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
-    url?: string;
+    /** {zh}
+     * @brief 指定播放器容器 ID，VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入，则优先将播放器插入 id 容器中。
+     * @default 'veplayer'
+     */
     id?: string;
+    /** {zh}
+     * @brief 指定播放器容器元素，VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入，则优先将播放器插入 id 容器中。
+     * @default 无
+     */
     el?: HTMLElement;
-    codec?: Codec;
+    /** {zh}
+     * @brief 设置播放器宽度，传入 number 类型参数则播放器内部默认添加单位px，传入 string 类型参数则直接赋值给播放器容器 width 样式属性。
+     * @default '100%'
+     */
+    width?: number | string;
+    /** {zh}
+     * @brief 设置播放器高度，传入 number 类型参数则播放器内部默认添加单位px，传入 string 类型参数则直接赋值给播放器容器 height 样式属性。
+     * @default '100%'
+     */
+    height?: number | string;
+    /** {zh}
+     * @brief 为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址，生成方法请参见[生成直播地址](https://www.volcengine.com/docs/6469/107759)。url 和 playList 需至少传入 1 个。
+     * @default 无
+     */
+    url?: string;
+    /** {zh}
+     * @brief 为播放器配置直播拉流地址列表。url 和 playlist 需至少传入 1 个。
+     * @default 无
+     */
+    playlist?: ExposedSource[];
+    /** {zh}
+     * @brief 当存在多个直播线路时，为播放器设置默认直播线路，不传则默认列表第一个。
+     * @default 无
+     */
+    defaultSource?: string;
+    /** {zh}
+     * @brief 为播放器设置默认直播清晰度，不传则默认列表第一个。
+     * @default 无
+     */
+    defaultDefinition?: string;
+    /** {zh}
+     * @brief 为播放器设置备路拉流地址，支持设置多个备路拉流地址，在 `maxFallbackRound` 大于 `0` 时有效。当您使用配置的直播拉流地址拉流失败时，会在直播地址和备路直播地址之间循环拉流，直到拉流成功。
+     * @default 无
+     */
     fallbackUrls?: string[];
+    /** {zh}
+     * @brief 为播放器设置拉流失败时循环拉流的最大次数。
+     * @default 0
+     */
     maxFallbackRound?: number;
-    degradation?: Degradation | boolean;
+    /** {zh}
+     * @brief 为播放器设置解码方式。
+     * @listtip
+     * 开启软解后，播放器会使用浏览器的软件解码器来解码视频流。软解模式具有较高的兼容性，适用于各种设备和浏览器，但依赖设备 CPU，在高分辨率或高码率视频播放时会出现卡顿或延迟。建议在以下场景开启软解：
+     * 1. 部分安卓浏览器中播放器被劫持，部分功能将不可见，可开启软解；
+     * 2. 移动端浏览器不支持 flv 格式，如果需要播放该格式的视频，可开启软解；
+     * 3. 部分浏览器不支持 H.265 编码格式，如果需要播放该编码格式的视频，请开启软解。
+     * @default 'hardware'
+     */
     decodeType?: DecodeType;
+    /** {zh}
+     * @brief 为播放器设置视频的实际编码格式。如果您在degradation 设置了 `soft-first` 属性（即硬解不支持时降级软解），建议您传入该参数，省去探测实际编码格式的操作。
+     * @default 'h264'
+     */
+    codec?: Codec;
+    /** {zh}
+     * @brief 为播放器设置是否开启 H.265 兼容模式。在 H.265 兼容模式下，播放器会优先使用硬解来解码 H.265 直播流。如果设备或浏览器不支持 H.265 硬解，则自动降级为 H.265 软解。
+     * @default 'soft-first'
+     */
+    degradation?: Degradation | boolean;
+    /** {zh}
+     * @brief 为播放器设置封面图 URL。
+     * @default 无
+     */
     poster?: string;
-    defaultSource?: string;
-    defaultDefinition?: string;
-    preparePlugins?: PreparePlugins;
+    /** {zh}
+     * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
+     * @default -
+     */
+    lang?: Lang;
+    /** {zh}
+     * @brief 为播放器设置自定义的多语言词典，可设置每个语种的词典，格式为 { texts: { [key: string]: Object; } }。<br>
+     * 例如，{ texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }} ，格式请参考[默认词典](https://www.volcengine.com/docs/6469/127529)。
+     * @default 无
+     */
+    i18n?: {
+        texts: Record<Lang, Record<string, string>>;
+    };
+    /** {zh}
+     * @brief 为播放器设置是否自动播放, `muted` 设置为 `true` 为静音自动播放。
+     * @default { muted: true }
+     * @type {{ muted: boolean } | boolean}
+     */
     autoplay?: {
-        muted: boolean;
+        muted?: boolean;
     } | boolean;
-    playlist?: ExposedSource[];
-    listType?: ListTypeOption;
-    flv?: Partial<FlvOption>;
-    hls?: Partial<HlsOption> & {
-        enableMSE?: boolean;
+    /** {zh}
+     * @brief 为播放器设置默认音量，取值范围 [0,1]。
+     * @default 0.6
+     */
+    volume?: number;
+    /** {zh}
+     * @brief 为播放器设置是否显示画中画功能按钮。
+     * - `true`：显示；
+     * - `false`：不显示。
+     * @default false
+     */
+    pip?: boolean;
+    /**{zh}
+     * @brief 为播放器设置是否显示全屏功能按钮，并进行全屏功能设置。
+     * - `true`：显示；
+     * - `false`：不显示。
+     * @default -
+     */
+    fullscreen?: boolean | Fullscreen;
+    /** {zh}
+     * @brief 为播放器设置报错信息，支持配置播放异常时，播放器显示的异常文案、图片，以及是否提供刷新按钮等。
+     * @default -
+     */
+    error?: ErrorConfig;
+    /** {zh}
+     * @brief 为播放器设置清晰度的相关配置。
+     * @default -
+     */
+    definition?: DefinitionConfig;
+    /** {zh}
+     * @brief 为播放器设置是否显示控制栏。
+     * - `true`: 显示；
+     * - `false`: 不显示
+     * @default true
+     */
+    controls?: boolean | {
+        [propName: string]: any;
     };
-    i18n?: {
-        texts: Record<Lang, Record<string, string>>;
+    /** {zh}
+     * @brief 为播放器设置**清晰度选择**或**线路选择**时的**选择面板样式**，仅在移动端有效。
+     * @default 'bottom'
+     */
+    listType?: ListType;
+    /** {zh}
+     * @brief 为播放器设置是否启用内联播放模式。playsinline 属性是 HTML5 视频标签的一个属性，用于指定视频是否应在页面文档内播放。
+     * - `true`：启用，表示视频将在页面文档内播放；
+     * - `false`：停用，默认浏览器播放行为。
+     * 该配置项只在移动端生效，当取值为 true 的时候，会在初始化 video 或 audio 对象的时候，将 playsinline、webkit-playsinline、x5-playsinline 三个属性设置为 true，请参考 [New Policies for iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/) 了解内联模式相关知识。
+     * @listtip
+     * iOS 10 及以上系统 Safari 浏览器支持配置内联播放模式；</br>
+     * iOS 10 以下系统 Safari 浏览器不支持配置内联播放模式 ，默认播放即进入系统全屏。
+     * @default true
+     */
+    playsinline?: boolean;
+    /** {zh}
+     * @brief 为播放器设置 video 标签扩展属性，初始化时会设置在 videoElement 或 audioElement 对象上，请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
+     * @default 无
+     */
+    videoAttributes?: {
+        [propName: string]: any;
     };
+    /** {zh}
+     * @brief 为播放器设置是否启用流式布局，启用流式布局后播放器会根据屏幕的宽度进行调整，保持在不同屏幕尺寸上都有良好的显示效果。
+     * - `true`：启用
+     * - `false`：停用
+     * @listtip
+     * 启用流式布局时：
+     * 如果 `width` 和 `height` 是 `Number` 类型，则按照其数值计算播放器宽高比；
+     * 如果 `width` 和 `height` 不是 `Number` 类型，默认使用 16:9 比例。
+     * @default false
+     */
+    fluid?: boolean;
+    /** {zh}
+     * @brief 为播放器设置尺寸适配方式，在视频资源初始化之后，根据获取到的 videoWidth 和 videoHeight 值对播放器容器宽高比例进行调整，可选项有：
+     * - `fixed`: 保持容器宽/高，不做适配；
+     * - `fixWidth`: 保持容器宽度，适配高度；
+     * - `fixHeight`: 保持容器高度，适配宽度。
+     *
+     * @default 'fixed'
+     */
+    fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
+    /** {zh}
+     * @brief 为播放器设置视频画面填充模式，可选项有：
+     * - `fillwidth`: 填充宽度，高度溢出则裁剪高度；
+     * - `fillHeight`: 填充高度，宽度溢出则裁剪宽度；
+     * - `fill`: 拉伸视频以填充容器；
+     * - `cover`: 保持其宽高比的同时填充元素的整个内容框；
+     * - `auto`: 使用浏览器默认的视频画面填充模式。
+     * @default 'auto'
+     */
+    videoFillMode?: "auto" | "fillHeight" | "fillWidth" | "fill" | "cover";
+    /** {zh}
+     * @brief 是否开启画面和控制栏分离模式。设置为开启时，控制栏将会常驻，与视频画面不重叠。
+     * - `true`：开启
+     * - `false`：关闭
+     * @default false
+     */
+    marginControls?: boolean;
+    /** {zh}
+     *  @brief 启用微信同层播放。
+     * @default 无
+     */
+    "x5-video-player-type"?: string;
+    /** {zh}
+     *  @brief 是否启用微信全屏播放模式。
+     * - `true`：启用
+     * - `false`：停用
+     * @default 无
+     */
+    "x5-video-player-fullscreen"?: boolean;
+    /** {zh}
+     *  @brief 微信横竖屏控制，支持如下取值：
+     * - `landscape`：横屏
+     * - `portrait`：竖屏
+     * - `landscape|portrait`：跟随手机自动旋转
+     * @default 无
+     */
+    "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
+    /** {zh}
+     * @brief 为播放器配置关键点样式。
+     * @default 无
+     * @hidden 直播目前没用到
+     */
+    commonStyle?: CommonStyle;
+    /** {zh}
+     * @brief 自定义插件列表。
+     * @default 无
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    plugins?: any[];
+    /** {zh}
+     * @hidden
+     */
+    preparePlugins?: PreparePlugins;
+}
+/**
+ * @list option
+ * @kind property
+ */
+interface Fullscreen {
+    /** {zh}
+     * @brief 切换全屏时，是否旋转为横屏播放，通常在移动端使用。如果开启横屏播放，切换全屏时，将在竖屏状态下把播放器旋转 90 度，实现横屏效果。该配置优先级高于 useCssFullscreen。
+     * `true`：使用旋转横屏；
+     * `false`：不使用旋转横屏。
+     * @default false
+     */
+    rotateFullscreen?: boolean;
+    /** {zh}
+     * @brief 是否使用页面全屏代替系统全屏功能。
+     * `true`：页面全屏；
+     * `false`：系统全屏。
+     * @default false
+     */
+    useCssFullscreen?: boolean;
+    /**{zh}
+     * 全屏的时候是否显示右上角返回按钮，通常在移动端开启。
+     * `true`：显示；
+     * `false`：不显示。
+     * @default false
+     */
+    needBackIcon?: boolean;
 }
+/**
+ * @list option
+ * @kind property
+ * @hidden
+ */
+interface CommonStyle {
+    /** {zh}
+     * @brief 进度条底色
+     * @default 无
+     */
+    progressColor?: string;
+    /** {zh}
+     * @brief 播放完成部分进度条底色
+     * @default 无
+     */
+    playedColor?: string;
+    /** {zh}
+     * @brief 缓存部分进度条底色
+     * @default 无
+     */
+    cachedColor?: string;
+    /** {zh}
+     * @brief 进度条滑块样式
+     * @default 无
+     */
+    sliderBtnStyle?: {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        [propName: string]: any;
+    };
+    /** {zh}
+     * @brief 音量颜色
+     * @default 无
+     */
+    volumeColor?: string;
+}
+type PrepareResult = {
+    options?: Partial<VePlayerBaseOptions>;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    plugins?: any[];
+};
+type PreparePlugins = (url: string) => Promise<PrepareResult> | undefined;
+/**
+ * @detail option
+ * @brief 视频的实际编码格式。如果您在degradation 设置了 SoftFirst 属性（即硬解不支持降级软解），建议您传入该参数，省去探测实际编码格式的操作。
+ */
+declare enum Codec {
+    /** {zh}
+     * @brief h265 编码格式
+     */
+    H265 = "h265",
+    /** {zh}
+     * @brief h264 编码格式
+     */
+    H264 = "h264"
+}
+/**
+ * @detail option
+ * @brief 是否开启 H.265 兼容模式。在 H.265 兼容模式下，播放器会优先使用硬解来解码 H.265 直播流。如果设备或浏览器不支持 H.265 硬解，则自动降级为 H.265 软解。
+ */
+declare enum Degradation {
+    /** {zh}
+     * @brief 硬解不支持降级到软解
+     */
+    SoftFirst = "soft-first",
+    /** {zh}
+     * @brief 硬解不支持降级到h264
+     * @hidden
+     */
+    H264First = "h264-first"
+}
+/**
+ * @detail option
+ * @brief 解码方式。
+ * @example
+ * ```js
+ * VePlayer.createLivePlayer({
+ *  height: 360,
+ *  url: options.url,
+ * }).then(function (veplayer) {
+ *  veplayer.on(VePlayer.live.Events.CANPLAY, function () {
+ *    console.log('监听到 canplay 事件')
+ *  });
+ * }).catch(error => {
+ *  console.log('创建播放器失败，报错信息:', error);
+ * });;
+ * ```
+ */
+declare enum DecodeType {
+    /** {zh}
+     * @brief 软解
+     */
+    Software = "software",
+    /** {zh}
+     * @brief 硬解
+     */
+    Hardware = "hardware"
+}
+type Constructor<T> = new (...args: any[]) => T;
 declare class VePlayerBase {
     protected readonly _player: XGPlayer;
     private readonly _sourceManager;
@@ -300,82 +1050,311 @@ declare class VePlayerBase {
     private _i18nManager;
     private _events;
     private _errorCallback;
+    /**
+     * @hidden
+     */
     constructor(options?: VePlayerBaseOptions);
+    /**
+     * @brief 获取视频的就绪状态，其状态枚举值、枚举名称和说明如下：
+     * - `0`：HAVE_NOTHING，没有关于媒体资源的可用信息
+     * - `1`：HAVE_METADATA，已检索到足够多的媒体资源来初始化元数据, 快进/快退不会引发异常
+     * - `2`：HAVE_CURRENT_DATA，当前播放位置的数据可用，但不足以播放下一帧
+     * - `3`：HAVE_FUTURE_DATA，当前播放位置以及未来至少一小段时间的数据是可用的（至少有两帧以上的数据）
+     * - `4`：HAVE_ENOUGH_DATA，有足够的数据可用，并且下载速率足够，媒体可以不间断地播放到最后
+     */
     get readyState(): 0 | 2 | 1 | 4 | 3;
+    /**
+     * @brief 获取当前已缓冲的时间范围。
+     */
     get buffered(): TimeRanges;
+    /**
+     * @brief 获取已经播放的音频/视频的时间范围。
+     */
     get played(): TimeRanges;
+    /**
+     * @brief 设置/获取视频当前的播放时间, 单位为 s。
+     */
     get cumulateTime(): number;
+    /**
+     * @brief 获取是否处于焦点状态，处于焦点状态会显示控制栏。
+     */
     get isFocused(): boolean;
+    /**
+     * @brief 获取播放器是否处于全屏状态。
+     */
     get isFullscreen(): boolean;
+    /**
+     * @brief 获取播放器是否处于网页全屏状态。
+     */
     get isCssFullscreen(): boolean;
+    /**
+     * @brief 获取视频的网络状态，其状态枚举值、枚举名称和说明如下：
+     * - `0`：NETWORK_EMPTY，目前还没有数据，readyState 的值是 HAVE_NOTHING
+     * - `1`：NETWORK_IDLE，HTMLMediaElement 处于活动状态并已选择资源，但未使用网络
+     * - `2`：NETWORK_LOADING，浏览器正在下载 HTMLMediaElement 数据
+     * - `3`：NETWORK_NO_SOURCE，未找到 HTMLMediaElement src。
+     */
     get networkState(): 0 | 2 | 1 | 3;
+    /**
+     * @brief 获取当前视频是否处于暂停状态。
+     */
     get paused(): boolean;
+    /**
+     * @brief 获取当前视频是否播放结束。
+     */
     get ended(): boolean;
+    /**
+     * @brief 获取播放器当前所处的状态，其状态枚举值、枚举名称和说明如下：
+     * - `0`：ERROR，播放出现错误
+     * - `1`：INITIAL，初始化
+     * - `2`：READY，配置/事件/插件等均已经初始化/绑定/实例化完成
+     * - `3`：ATTACHING，进入媒体对象挂载阶段
+     * - `4`：ATTACHED，媒体对象已经挂载到了 DOM 中
+     * - `5`：NOTALLOW，播放被阻止
+     * - `6`：RUNNING，已经成功起播进入播放流程
+     * - `7`：ENDED，播放结束
+     * - `8`：DESTROYED，播放器实例处于已被销毁
+     */
     get state(): number;
-    get url(): any;
+    /**
+     * 获取当前播放视频的拉流地址。
+     */
+    get url(): string | undefined;
+    /**
+     * @brief 获取当播放视频的线路名称唯一标识（name）。
+     */
     get source(): string | undefined;
+    /**
+     * @brief 获取当前播放视频的清晰度唯一标识（definition）。
+     */
     get definition(): string;
+    /**
+     * @brief 获取和设置播放器的跨域配置信息，更多信息参考 [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin) 属性介绍。
+     */
     get crossOrigin(): string;
+    /**
+     * @brief 获取和设置播放器的跨域配置信息，更多信息参考 [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin) 属性介绍。
+     */
     set crossOrigin(crossOrigin: string);
+    /**
+     * @brief 获取和设置视频的音量，取值范围为 [0,1]。
+     */
     // eslint-disable-next-line @typescript-eslint/member-ordering
     get volume(): number;
+    /**
+     * @brief 获取和设置视频的音量，取值范围为 [0,1]。
+     */
     set volume(volume: number);
+    /**
+     * @brief 获取和设置视频静音状态。
+     * - `true`：静音
+     * - `false`：非静音
+     */
     // eslint-disable-next-line @typescript-eslint/member-ordering
     get muted(): boolean;
+    /**
+     * @brief 获取和设置视频静音状态。
+     * - `true`：静音
+     * - `false`：非静音
+     */
     set muted(isMuted: boolean);
+    /**
+     * @brief 获取和设置当前语言。
+     */
     // eslint-disable-next-line @typescript-eslint/member-ordering
-    get lang(): Lang;
-    set lang(lang: Lang);
+    get lang(): "zh-cn" | "zh-hk" | string;
+    /**
+     * @brief 获取和设置当前语言。
+     */
+    set lang(lang: "zh-cn" | "zh-hk" | string);
     // eslint-disable-next-line @typescript-eslint/member-ordering
     protected get _src(): string;
+    /**
+     * @hidden
+     */
     static create<T extends VePlayerBase>(options?: VePlayerBaseOptions, Constructor?: Constructor<T>): Promise<T>;
+    /**
+     * @brief 调用此方法切换拉流地址、线路、清晰度。
+     * @param target 目标地址，可以是播放地址，也可以是线路和清晰度
+     * @param options 更多配置信息
+     */
     switch(target: string | {
+        /**
+         * @brief 清晰度的唯一标识。
+         * @default 无
+         */
         definition?: string;
+        /**
+         * @brief 线路的唯一标识。
+         * @default 无
+         */
         source?: string;
     }, options?: {
+        /**
+         * @brief 清晰度 definition 配置无效时，是否降级到播放列表第一个清晰度地址。
+         * @default false
+         *
+         */
         fallbackToFirstDefinition?: boolean;
-    }): Promise<Definition>;
+    }): Promise<ExposedDefinition>;
+    /**
+     * @brief 调用此方法更新拉流地址列表。
+     * @param playlist 要更新的播放列表。
+     * @param target 更新后默认播放的资源。
+     */
     updatePlaylist(playlist: ExposedSource[] | string, target?: string | {
+        /**
+         * @brief 清晰度唯一标识。
+         * @default 无
+         *
+         */
         definition?: string;
+        /**
+         * @brief 线路的唯一标识。
+         * @default 无
+         *
+         */
         source?: string;
     }): Promise<void>;
     // TODO: 等西瓜播放器完善错误码后增加函数重载以提供更好的类型
-    once(event: string, callback: (data?: any) => any, ...args: any[]): void;
-    off(event: string, callback: (data?: any) => any, ...args: any[]): void;
-    emit(event: string, data?: any, ...args: any[]): void;
+    /**
+     * @brief 调用此方法监听指定事件，事件处理函数只执行一次。
+     * @param event 表示事件的名称。
+     * @param callback 表示事件的名称。
+     */
+    once(event: string, callback: (data?: any) => any): void;
+    /**
+     * @brief 调用此方法解绑或移除指定事件的事件监听。
+     * @param event 表示事件的名称。
+     * @param callback 表示事件的名称。
+     */
+    off(event: string, callback: (data?: any) => any): void;
+    /**
+     * @brief 调用此方法触发指定事件。
+     * @param event 表示事件的名称。
+     * @param data 事件信息。
+     */
+    emit(event: string, data?: any): void;
+    /**
+     * @brief 调用此方法解绑或移除指定事件的所有事件监听。
+     */
     offAll(): void;
-    on(event: string, callback: (data?: any) => any, ...args: any[]): void;
+    /**
+     * @brief 调用此方法监听指定事件。
+     * @param event 事件。
+     * @param callback 事件回调。
+     */
+    on(event: string, callback: (data?: any) => any): void;
+    /**
+     * @brief 调用此方法开始播放 。
+     */
     play(): any;
+    /**
+     * @brief 调用此方法暂停播放。
+     */
     pause(): void;
+    /**
+     * @brief 调用此方法打开画中画。
+     */
     requestPIP(): void;
+    /**
+     * @brief 调用此方法关闭画中画。
+     */
     exitPIP(): void;
+    /**
+     * @brief 调用此方法重新拉流。
+     */
     retry(): void;
+    /**
+     * @brief 播放器获取焦点，调用该方法 `veplayer.isFocused` 将会变为 `true`，并触发 `PLAYER_FOCUS` 事件。
+     * @param data 播放器获取焦点配置信息。
+     */
     focus(data?: {
+        /**
+         * @brief 是否需要自动失焦，默认为 true，即经过 delay 时长之后，会自动调用 blur() 进行失焦。
+         * @default true
+         */
         autoHide?: boolean;
+        /**
+         * @brief 自动失焦延迟时长，单位ms，autoHide 为 true 时生效。
+         * @default 3000
+         */
         delay?: number;
     }): void;
+    /**
+     * @brief 播放器失去焦点，调用该方法 `veplayer.isFocused` 将会变为 `false`，并触发 `PLAYER_BLUR` 事件。
+     * @param data 播放器失去焦点配置信息。
+     */
     blur(data?: {
+        /**
+         * @brief 播放器失焦是否忽略暂停状态，默认值是 true，即默认暂停的时候不取消播放器焦点状态。
+         * @default false
+         */
         ignorePaused?: boolean;
     }): void;
+    /**
+     * @brief 调用此方法进入系统全屏状态。如果该方法调用的时候处于网页全屏状态会自动退出网页全屏，下发事件 `Events.FULLSCREEN_CHANGE`。
+     * @param el 全屏作用的 DOM 节点。
+     */
     getFullscreen(el?: HTMLElement): Promise<void>;
+    /**
+     * @brief 调用此方法退出系统全屏状态，调用该方法 `veplayer.isFullscreen` 将会变为 `false`，并触发 `Events.FULLSCREEN_CHANGE` 事件。
+     * @param el 全屏作用的 DOM 节点。
+     */
     exitFullscreen(el?: HTMLElement): Promise<void>;
+    /**
+     * @brief 调用此方法进入网页样式全屏状态，播放器进入网页全屏，利用 CSS 模拟实现全屏效果。如果该接口调用的时候处于全屏状态，会自动退出全屏，下发事件 `Events.CSS_FULLSCREEN_CHANGE`。
+     * @param el 全屏作用的 DOM 节点。
+     */
     getCssFullscreen(el?: HTMLElement): void;
+    /**
+     * @brief 调用此方法退出网页样式全屏状态。 调用该方法 `veplayer.isFullscreen` 将会变为 `false`，并触发 `Events.CSS_FULLSCREEN_CHANGE` 事件。
+     */
     exitCssFullscreen(): void;
+    /**
+     * @brief 调用此方法在当前播放器上注册指定插件。
+     * @param plugin 插件构造函数。
+     * @param config 插件的配置列表。
+     */
     registerPlugin(plugin: 
     // eslint-disable-next-line @typescript-eslint/ban-types
     Function | {
+        /**
+         * @brief 插件构造函数。
+         * @default 无
+         */
         // eslint-disable-next-line @typescript-eslint/ban-types
         plugin: Function;
+        /**
+         * @brief 插件配置参数。
+         * @default 无
+         */
         options: object;
     }, config?: {
         [propName: string]: any;
     }): any;
-    unRegisterPlugin(plugin: any, removedFromConfig?: boolean): void;
-    // 显示插件
+    /**
+     * @brief 调用此方法在当前播放器上销毁/注销指定插件。
+     * @param plugin 插件实例或者插件名称。
+     */
+    unRegisterPlugin(plugin: any): void;
+    /**
+     * @brief 调用此接口显示指定插件图标。
+     * @param pluginNames 插件名称
+     */
     showIcon(pluginNames: string[]): void;
-    // 隐藏插件显示
+    /**
+     * @brief 调用此接口隐藏指定插件图标。
+     * @param pluginNames 插件名称
+     */
     hideIcon(pluginNames: string[]): void;
+    /**
+     * @brief 调用此方法销毁播放器实例。
+     */
     destroy(): void;
+    /**
+     * @hidden
+     */
     prepare(url: string): Promise<any[]>;
     private _handleFallback;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -593,15 +1572,61 @@ declare namespace strategy {
         get url(): string;
         next(): DefinitionUrl;
     }
+    /**
+     * @list option
+     * @kind property
+     * @id Definition
+     * @name Definition
+     *
+     */
     interface ExposedDefinition {
+        /** {zh}
+         * @brief 播放地址。
+         * @default 无
+         */
         url: string;
+        /** {zh}
+         * @brief 清晰度（唯一值）。
+         * @default 无
+         *
+         */
         definition: string;
+        /** {zh}
+         * @brief 清晰度展示名称。可设置多语言 `{text: {'zh-cn': '高清', 'en': 'HD'}}`。
+         * @default 无
+         */
         text?: Record<Lang, string> | string;
+        /** {zh}
+         * @brief 为当前清晰度地址设置备路拉流地址，支持设置多个备路拉流地址。当前清晰度地址拉流失败时，会在当前清晰度地址和备路直播地址之间循环拉流，直到拉流成功。
+         * @default 无
+         *
+         */
         fallbackUrls?: string[];
     }
+    /**
+     * @list option
+     * @brief 线路数据配置。一个线路包含当前线路的 name ，展示名称，及线路下的清晰度列表。
+     * @kind property
+     * @id Source
+     * @name Source
+     */
     interface ExposedSource {
+        /** {zh}
+         * @brief 线路name(唯一值)。
+         * @default 无
+         */
         name?: string;
+        /** {zh}
+         * @brief 线路展示名称。可设置多语言 `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`。
+         * @default 无
+         *
+         */
         text?: Record<Lang, string> | string;
+        /** {zh}
+         * @brief 该线路下清晰度列表。
+         * @default 无
+         *
+         */
         definitions: Array<ExposedDefinition | string>;
     }
     interface CompoundSources {
@@ -623,32 +1648,8 @@ declare namespace strategy {
         private static normalizeUrl;
         add(definition: Definition): void;
     }
-    enum TOP_RIGHT_POSITIONS {
-        ROOT_TOP_RIGHT = "rootTopRight",
-        ROOT_TOP_RIGHT_COLLAPSE = "rootTopRightCollapse"
-    }
-    class TopRightBar extends Plugin {
-        static get pluginName(): string;
-        static get defaultConfig(): {
-            position: string;
-            plugins: never[];
-        };
-        static isTopRightPlugin(plugin: any, options: VePlayerBaseOptions): boolean;
-        registerIcons(): {
-            more: {
-                icon: any;
-                class: string;
-            };
-        };
-        children(): Record<string, {
-            plugin: Partial<Plugin>;
-            options: IPluginOptions["config"];
-        }>;
-        render(): string;
-        private _getPlugins;
-    }
     interface Config {
-        listType: ListTypeOption;
+        listType: ListType;
         isAutoChange?: boolean;
         onItemClick?: (e: Event, data: CallbackData) => void;
         onOptionClick?: (e: Event, data: CallbackData) => void;
@@ -662,7 +1663,7 @@ declare namespace strategy {
     interface Options {
         config: Config;
         root: HTMLElement | null;
-        player: Player;
+        player: Player$0;
     }
     class MobilePlayerPanel {
         private _root?;
@@ -675,12 +1676,12 @@ declare namespace strategy {
         private _delegates?;
         private _listType?;
         constructor(args: Options);
-        changeMode(listType: ListTypeOption): void;
+        changeMode(listType: ListType): void;
         // 渲染选择列表
         renderItemList(data?: ListItem[]): HTMLElement;
         // 渲染panel的标题
         renderTitle(): HTMLElement | undefined;
-        updatePanel(listType: ListTypeOption): void;
+        updatePanel(listType: ListType): void;
         // 渲染panel
         renderPanel(): void;
         show(): void;
@@ -698,13 +1699,29 @@ declare namespace strategy {
         private _handleHide;
     }
     import MobilePanel = MobilePlayerPanelWrapper.MobilePlayerPanel;
-    const ListType: {
-        readonly Middle: "middle";
-        readonly Bottom: "bottom";
-        readonly Fullscreen: "fullscreen";
-        readonly Inner: "inner";
-    };
-    type ListTypeOption = (typeof ListType)[keyof typeof ListType];
+    /**
+     * @detail option
+     * @brief **清晰度选择**或**线路选择**时的**选择面板样式**，仅在移动端有效。
+     */
+    enum ListType {
+        /** {zh}
+         * @brief 全屏布局
+         * @hidden
+         */
+        Middle = "middle",
+        /** {zh}
+         * @brief 底部抽屉
+         */
+        Bottom = "bottom",
+        /** {zh}
+         * @brief 右侧抽屉，常用于全屏时展示
+         */
+        Fullscreen = "fullscreen",
+        /** {zh}
+         * @brief 窗口蒙层展示
+         */
+        Inner = "inner"
+    }
     interface ListItem {
         [key: string]: any;
         selected?: boolean;
@@ -735,7 +1752,7 @@ declare namespace strategy {
         // 【xg】是否展示已选择的
         isShowIcon?: boolean;
         // 【xg 扩展】列表渲染样式类型
-        listType?: ListTypeOption;
+        listType?: ListType;
         // 已选择的展示类型（文案 or icon）
         renderType?: RenderType;
         // 列表数据只有一个是否展示
@@ -784,157 +1801,768 @@ declare namespace strategy {
         render(): string;
         private _getListType;
     }
-    enum Codec {
-        H265 = "h265",
-        H264 = "h264"
+    /**
+     * @detail error
+     */
+    enum Level {
+        /**
+         * @brief 严重
+         *
+         */
+        Fatal = "Fatal",
+        /**
+         * @brief 报错
+         */
+        Error = "Error"
     }
-    enum Degradation {
-        SoftFirst = "soft-first",
-        H264First = "h264-first"
+    enum ErrorCode {
+        /**
+         * @brief 视频解析错误
+         * @solution 请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MANIFEST_HLS_ERROR = 1100,
+        /**
+         * @brief 视频解析错误
+         * @solution 请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MANIFEST_DASH_ERROR = 1200,
+        /**
+         * @brief 网络错误
+         * @solution 请检查当前网络环境或播放地址是否合法。
+         */
+        NETWORK = 2100,
+        /**
+         * @brief 网络请求超时
+         * @solution 请检查拉流地址是否合法。
+         */
+        NETWORK_TIMEOUT = 2101,
+        /**
+         * @brief 网络请求 403
+         * @solution 请检查拉流地址鉴权信息。
+         */
+        NETWORK_FORBIDDEN = 2103,
+        /**
+         * @brief 网络请求 404
+         * @solution 请检查拉流地址是否合法。
+         */
+        NETWORK_NOTFOUND = 2104,
+        /**
+         * @brief 网络请求 206
+         * @solution 请检查拉流地址是否合法。
+         */
+        NETWORK_RANGE_NOT_SATISFIABLE = 2116,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        DEMUX_FLV_ERROR = 3100,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        DEMUX_HLS_ERROR = 3200,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
+        DEMUX_MP4_ERROR = 3300,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
+        DEMUX_FMP4_ERROR = 3400,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
+        DEMUX_SIDX_ERROR = 3410,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
+        REMUX_FMP4_ERROR = 4100,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
+        REMUX_MP4_ERROR = 4200,
+        /**
+         * @brief 获取数据过程被中止
+         * @solution 请检查浏览器网络请求是否正常，再尝试重新拉流。
+         */
+        MEDIA_ERR_ABORTED = 5101,
+        /**
+         * @brief 网络发生错误，无法成功获取媒体文件
+         * @solution 请检查浏览器网络请求是否正常，再尝试重新拉流。
+         */
+        MEDIA_ERR_NETWORK = 5102,
+        /**
+         * @brief 浏览器在解码媒体资源时发生错误
+         * @solution
+         * 1. 请检查原始视频是否正常；
+         * 2. 重新进行转码和播放；
+         * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_ERR_DECODE = 5103,
+        /**
+         * @brief 因视频格式不支持、服务器或网络的问题造成视频无法加载
+         * @solution
+         * 1. 检查浏览器视频数据请求是否正常；
+         * 2. 检查浏览器和页面环境是否支持要播放的视频格式；
+         * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
+        /**
+         * @brief 当前浏览器不支持视频解码
+         * @solution
+         * 1. 检查浏览器视频数据请求是否正常；
+         * 2. 检查浏览器和页面环境是否支持要播放的视频格式；
+         * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
+        /**
+         * @brief 当前播放地址为空
+         * @solution 请检查必要参数 `url` 或 `playlist` 是否传入。
+         */
+        MEDIA_ERR_URL_EMPTY = 5106,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_MSE_ADD_SB = 5200,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_MSE_APPEND_BUFFER = 5201,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_MSE_OTHER = 5202,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_MSE_FULL = 5203,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_MSE_HIJACK = 5204,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        MEDIA_EME_HIJACK = 5301,
+        /**
+         * @brief DRM 权限校验失败
+         * @hidden
+         */
+        DRM_LICENSE = 7100,
+        /**
+         * @brief DRM 权限校验失败
+         * @hidden
+         */
+        DRM_CUSTOM_LICENSE = 7200,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        OTHER = 8000,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        RUNTIME_NO_CANPLAY_ERROR = 9001,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        RUNTIME_BUFFERBREAK_ERROR = 9002,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
+        RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
+        // veplayer 报错
+        /**
+         * @brief CDN 异步获取失败
+         * @solution 请刷新重试或者检查网络环境。
+         *
+         */
+        MODULE_LOAD_ERROR = 110,
+        /**
+         * @hidden
+         */
+        UNKNOWN = "UNKNOWN"
     }
-    enum DecodeType {
-        Software = "software",
-        Hardware = "hardware"
+    enum ErrorType {
+        MANIFEST = "manifest",
+        NETWORK = "network",
+        DEMUX = "demux",
+        REMUX = "remux",
+        MEDIA = "media",
+        DRM = "drm",
+        OTHER = "other",
+        RUNTIME = "runtime"
     }
-    type PrepareResult = {
-        options?: Partial<VePlayerBaseOptions>;
-        plugins?: any[];
-    };
-    type PreparePlugins = (url: string) => Promise<PrepareResult> | undefined;
-    type Constructor<T> = new (...args: any[]) => T;
-    const POSITIONS: {
-        ROOT_TOP_RIGHT: TOP_RIGHT_POSITIONS.ROOT_TOP_RIGHT;
-        ROOT_TOP_RIGHT_COLLAPSE: TOP_RIGHT_POSITIONS.ROOT_TOP_RIGHT_COLLAPSE;
-        ROOT: string;
-        ROOT_LEFT: string;
-        ROOT_RIGHT: string;
-        ROOT_TOP: string;
-        CONTROLS_LEFT: string;
-        CONTROLS_RIGTH: string;
-        CONTROLS_RIGHT: string;
-        CONTROLS_CENTER: string;
-        CONTROLS: string;
+    interface ErrorInfo<T = TextKey> {
+        errorCode?: ErrorCode;
+        message?: string;
+        messageTextKey?: T;
+        level?: Level;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        ext?: any;
+        error?: Error;
+    }
+    // 参考： https://bytedance.feishu.cn/docx/doxcnGPXIOrJk3dGE3E3YghgZke
+    const ERROR_INFO: Partial<Record<ErrorCode, ErrorInfo>>;
+    const ERROR_TYPE_INFO: Record<ErrorType, ErrorInfo>;
+    /**
+     * @detail error
+     * @name 错误对象
+     * @id 错误对象
+     */
+    class VeError<T extends string = TextKey> extends Error {
+        /**
+         * @brief 错误码，对应[错误码字典](#错误码)。
+         */
+        readonly errorCode: ErrorCode;
+        /**
+         * @brief 错误等级。
+         */
+        readonly level?: Level;
+        /**
+         * @brief 错误信息。
+         */
+        message: string;
+        /**
+         * @brief 其他错误信息。
+         */
+        readonly ext?: any;
+        /**
+         * @hidden
+         * @param error
+         * @param i18n
+         */
+        constructor(error?: string | ErrorInfo<T>, i18n?: VeI18n<T>);
+    }
+    function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): VeError<"DEFINITION_FALLBACK_TOAST" | "DEFINITION_SWITCHING" | "ERROR_REFRESH" | "UNMUTE" | "MANIFEST" | "NETWORK" | "NETWORK_TIMEOUT" | "NETWORK_FORBIDDEN" | "NETWORK_NOTFOUND" | "DEMUX" | "REMUX" | "MEDIA" | "MEDIA_ERR_CODEC_NOT_SUPPORTED" | "MEDIA_ERR_URL_EMPTY" | "DRM" | "OTHER" | "RUNTIME" | "MODULE_LOAD_ERROR" | "UNKNOWN" | "ERROR_TYPES" | "HAVE_NOTHING" | "HAVE_METADATA" | "HAVE_CURRENT_DATA" | "HAVE_FUTURE_DATA" | "HAVE_ENOUGH_DATA" | "NETWORK_EMPTY" | "NETWORK_IDLE" | "NETWORK_LOADING" | "NETWORK_NO_SOURCE" | "MEDIA_ERR_ABORTED" | "MEDIA_ERR_NETWORK" | "MEDIA_ERR_DECODE" | "MEDIA_ERR_SRC_NOT_SUPPORTED" | "REPLAY" | "ERROR" | "PLAY_TIPS" | "PAUSE_TIPS" | "PLAYNEXT_TIPS" | "DOWNLOAD_TIPS" | "ROTATE_TIPS" | "RELOAD_TIPS" | "FULLSCREEN_TIPS" | "EXITFULLSCREEN_TIPS" | "CSSFULLSCREEN_TIPS" | "EXITCSSFULLSCREEN_TIPS" | "TEXTTRACK" | "PIP" | "SCREENSHOT" | "LIVE" | "OFF" | "OPEN" | "MINI_DRAG" | "MINISCREEN" | "REFRESH_TIPS" | "REFRESH" | "FORWARD" | "LIVE_TIP">;
+    function transform(xgErr: XGError, i18n?: VeI18n): VeError<"DEFINITION_FALLBACK_TOAST" | "DEFINITION_SWITCHING" | "ERROR_REFRESH" | "UNMUTE" | "MANIFEST" | "NETWORK" | "NETWORK_TIMEOUT" | "NETWORK_FORBIDDEN" | "NETWORK_NOTFOUND" | "DEMUX" | "REMUX" | "MEDIA" | "MEDIA_ERR_CODEC_NOT_SUPPORTED" | "MEDIA_ERR_URL_EMPTY" | "DRM" | "OTHER" | "RUNTIME" | "MODULE_LOAD_ERROR" | "UNKNOWN" | "ERROR_TYPES" | "HAVE_NOTHING" | "HAVE_METADATA" | "HAVE_CURRENT_DATA" | "HAVE_FUTURE_DATA" | "HAVE_ENOUGH_DATA" | "NETWORK_EMPTY" | "NETWORK_IDLE" | "NETWORK_LOADING" | "NETWORK_NO_SOURCE" | "MEDIA_ERR_ABORTED" | "MEDIA_ERR_NETWORK" | "MEDIA_ERR_DECODE" | "MEDIA_ERR_SRC_NOT_SUPPORTED" | "REPLAY" | "ERROR" | "PLAY_TIPS" | "PAUSE_TIPS" | "PLAYNEXT_TIPS" | "DOWNLOAD_TIPS" | "ROTATE_TIPS" | "RELOAD_TIPS" | "FULLSCREEN_TIPS" | "EXITFULLSCREEN_TIPS" | "CSSFULLSCREEN_TIPS" | "EXITCSSFULLSCREEN_TIPS" | "TEXTTRACK" | "PIP" | "SCREENSHOT" | "LIVE" | "OFF" | "OPEN" | "MINI_DRAG" | "MINISCREEN" | "REFRESH_TIPS" | "REFRESH" | "FORWARD" | "LIVE_TIP">;
+    /**
+     * @list option
+     * @kind property
+     */
+    type ErrorConfig = {
+        /** {zh}
+         * @brief 是否展示报错图片。
+         * @default true
+         */
+        showErrorImg?: boolean;
+        /** {zh}
+         * @brief 是否展示报错提示。
+         * @default true
+         */
+        showErrorTip?: boolean;
+        /** {zh}
+         * @brief 是否展示刷新按钮。
+         * @default true
+         */
+        showRefresh?: boolean;
+        /** {zh}
+         * @brief 自定义报错显示。
+         * @default 无
+         */
+        errorTipsText?: string | Record<Lang, string>;
+        /** {zh}
+         * @brief 更多提示信息。
+         * @default 无
+         */
+        extraTips?: {
+            label: string | Record<Lang, string>;
+            value: string | Record<Lang, string>;
+        }[];
     };
+    class Error extends Plugin {
+        player: Player$0;
+        icons: {
+            error: HTMLElement;
+        };
+        langText: {
+            refresh: string;
+            errorTip: string;
+        };
+        config: ErrorConfig;
+        private _error?;
+        static get pluginName(): string;
+        static get defaultConfig(): {
+            showErrorImg: boolean;
+            showErrorTip: boolean;
+            showRefresh: boolean;
+            errorTipsText: string;
+            extraTips: never[];
+            position: string;
+        };
+        get _errorTip(): string;
+        afterCreate(): void;
+        registerIcons(): {
+            error: {
+                icon: any;
+                class: string;
+            };
+        };
+        updateLang(): void;
+        showError(error: VeError | XGError): void;
+        hideError(): void;
+        destroy(): void;
+        render(): string;
+        private _focus;
+        private _initIcons;
+        private _initEvents;
+        private _renderText;
+        private _renderExtraTips;
+        private _handleRefresh;
+        private _renderRefresh;
+    }
+    /**
+     * @list option
+     * @kind property
+     */
+    interface DefinitionConfig {
+        /** {zh}
+         * @brief 等待超时的时间阈值，单位为 ms。等待超过该值，会抛出 `DEFINITION_FALLBACK` 事件，如果 `needFallback` 为 `true` 则会提示清晰度降级。
+         * @default 5000
+         */
+        longWaitingTime?: number;
+        /** {zh}
+         * @brief 是否开启清晰度降级。
+         * @default false
+         */
+        needFallback?: boolean;
+        /** {zh}
+         * @brief  降级顺序，按照数组顺序依次降级，数组中的元素与 playlist 中的 definition 相对应。
+         * @default "['uhd', 'hd', 'sd', 'ld', 'ao']"
+         */
+        demotePriority?: string[];
+    }
+    class DefinitionPlugin extends OptionsIcon {
+        langText: Record<string, string>;
+        private _waitingStartTime;
+        private _timer?;
+        private _toastId?;
+        static get pluginName(): string;
+        static get defaultConfig(): {
+            index: number;
+            list: never[];
+            panel: {
+                title: {
+                    jp: string;
+                    en: string;
+                    "zh-cn": string;
+                    "zh-hk": string;
+                };
+            };
+            className: string;
+            hidePortrait: boolean;
+            isShowIcon: boolean;
+            longWaitingTime: number;
+            needFallback: boolean;
+            demotePriority: string[];
+            isItemClickHide?: boolean | undefined;
+            listType?: ListType | undefined;
+            renderType?: RenderType | undefined;
+            hideOnSingleOption?: boolean | undefined;
+            isAutoChange?: boolean | undefined;
+        };
+        static get textTips(): {
+            jp: string;
+            en: string;
+            "zh-cn": string;
+            "zh-hk": string;
+        };
+        updateLang(): void;
+        beforeCreate(args: XGPluginOptions): void;
+        afterCreate(): void;
+        registerIcons(): {
+            source: {
+                icon: any;
+            };
+        };
+        renderItemList(): void;
+        onItemClick(_: never, data: {
+            to: Definition;
+        }): void;
+        fallback(options?: {
+            toast: boolean;
+        }): Promise<void>;
+        private _waiting;
+        private _clearTimer;
+        private _toast;
+        private _getNextDefinition;
+        private _initTimeUpdateEvent;
+        private _showToast;
+    }
     interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
-        url?: string;
+        /** {zh}
+         * @brief 指定播放器容器 ID，VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入，则优先将播放器插入 id 容器中。
+         * @default 'veplayer'
+         */
         id?: string;
+        /** {zh}
+         * @brief 指定播放器容器元素，VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入，则优先将播放器插入 id 容器中。
+         * @default 无
+         */
         el?: HTMLElement;
-        codec?: Codec;
+        /** {zh}
+         * @brief 设置播放器宽度，传入 number 类型参数则播放器内部默认添加单位px，传入 string 类型参数则直接赋值给播放器容器 width 样式属性。
+         * @default '100%'
+         */
+        width?: number | string;
+        /** {zh}
+         * @brief 设置播放器高度，传入 number 类型参数则播放器内部默认添加单位px，传入 string 类型参数则直接赋值给播放器容器 height 样式属性。
+         * @default '100%'
+         */
+        height?: number | string;
+        /** {zh}
+         * @brief 为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址，生成方法请参见[生成直播地址](https://www.volcengine.com/docs/6469/107759)。url 和 playList 需至少传入 1 个。
+         * @default 无
+         */
+        url?: string;
+        /** {zh}
+         * @brief 为播放器配置直播拉流地址列表。url 和 playlist 需至少传入 1 个。
+         * @default 无
+         */
+        playlist?: ExposedSource[];
+        /** {zh}
+         * @brief 当存在多个直播线路时，为播放器设置默认直播线路，不传则默认列表第一个。
+         * @default 无
+         */
+        defaultSource?: string;
+        /** {zh}
+         * @brief 为播放器设置默认直播清晰度，不传则默认列表第一个。
+         * @default 无
+         */
+        defaultDefinition?: string;
+        /** {zh}
+         * @brief 为播放器设置备路拉流地址，支持设置多个备路拉流地址，在 `maxFallbackRound` 大于 `0` 时有效。当您使用配置的直播拉流地址拉流失败时，会在直播地址和备路直播地址之间循环拉流，直到拉流成功。
+         * @default 无
+         */
         fallbackUrls?: string[];
+        /** {zh}
+         * @brief 为播放器设置拉流失败时循环拉流的最大次数。
+         * @default 0
+         */
         maxFallbackRound?: number;
-        degradation?: Degradation | boolean;
+        /** {zh}
+         * @brief 为播放器设置解码方式。
+         * @listtip
+         * 开启软解后，播放器会使用浏览器的软件解码器来解码视频流。软解模式具有较高的兼容性，适用于各种设备和浏览器，但依赖设备 CPU，在高分辨率或高码率视频播放时会出现卡顿或延迟。建议在以下场景开启软解：
+         * 1. 部分安卓浏览器中播放器被劫持，部分功能将不可见，可开启软解；
+         * 2. 移动端浏览器不支持 flv 格式，如果需要播放该格式的视频，可开启软解；
+         * 3. 部分浏览器不支持 H.265 编码格式，如果需要播放该编码格式的视频，请开启软解。
+         * @default 'hardware'
+         */
         decodeType?: DecodeType;
+        /** {zh}
+         * @brief 为播放器设置视频的实际编码格式。如果您在degradation 设置了 `soft-first` 属性（即硬解不支持时降级软解），建议您传入该参数，省去探测实际编码格式的操作。
+         * @default 'h264'
+         */
+        codec?: Codec;
+        /** {zh}
+         * @brief 为播放器设置是否开启 H.265 兼容模式。在 H.265 兼容模式下，播放器会优先使用硬解来解码 H.265 直播流。如果设备或浏览器不支持 H.265 硬解，则自动降级为 H.265 软解。
+         * @default 'soft-first'
+         */
+        degradation?: Degradation | boolean;
+        /** {zh}
+         * @brief 为播放器设置封面图 URL。
+         * @default 无
+         */
         poster?: string;
-        defaultSource?: string;
-        defaultDefinition?: string;
-        preparePlugins?: PreparePlugins;
+        /** {zh}
+         * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
+         * @default -
+         */
+        lang?: Lang;
+        /** {zh}
+         * @brief 为播放器设置自定义的多语言词典，可设置每个语种的词典，格式为 { texts: { [key: string]: Object; } }。<br>
+         * 例如，{ texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }} ，格式请参考[默认词典](https://www.volcengine.com/docs/6469/127529)。
+         * @default 无
+         */
+        i18n?: {
+            texts: Record<Lang, Record<string, string>>;
+        };
+        /** {zh}
+         * @brief 为播放器设置是否自动播放, `muted` 设置为 `true` 为静音自动播放。
+         * @default { muted: true }
+         * @type {{ muted: boolean } | boolean}
+         */
         autoplay?: {
-            muted: boolean;
+            muted?: boolean;
         } | boolean;
-        playlist?: ExposedSource[];
-        listType?: ListTypeOption;
-        flv?: Partial<FlvOption>;
-        hls?: Partial<HlsOption> & {
-            enableMSE?: boolean;
+        /** {zh}
+         * @brief 为播放器设置默认音量，取值范围 [0,1]。
+         * @default 0.6
+         */
+        volume?: number;
+        /** {zh}
+         * @brief 为播放器设置是否显示画中画功能按钮。
+         * - `true`：显示；
+         * - `false`：不显示。
+         * @default false
+         */
+        pip?: boolean;
+        /**{zh}
+         * @brief 为播放器设置是否显示全屏功能按钮，并进行全屏功能设置。
+         * - `true`：显示；
+         * - `false`：不显示。
+         * @default -
+         */
+        fullscreen?: boolean | Fullscreen;
+        /** {zh}
+         * @brief 为播放器设置报错信息，支持配置播放异常时，播放器显示的异常文案、图片，以及是否提供刷新按钮等。
+         * @default -
+         */
+        error?: ErrorConfig;
+        /** {zh}
+         * @brief 为播放器设置清晰度的相关配置。
+         * @default -
+         */
+        definition?: DefinitionConfig;
+        /** {zh}
+         * @brief 为播放器设置是否显示控制栏。
+         * - `true`: 显示；
+         * - `false`: 不显示
+         * @default true
+         */
+        controls?: boolean | {
+            [propName: string]: any;
         };
-        i18n?: {
-            texts: Record<Lang, Record<string, string>>;
+        /** {zh}
+         * @brief 为播放器设置**清晰度选择**或**线路选择**时的**选择面板样式**，仅在移动端有效。
+         * @default 'bottom'
+         */
+        listType?: ListType;
+        /** {zh}
+         * @brief 为播放器设置是否启用内联播放模式。playsinline 属性是 HTML5 视频标签的一个属性，用于指定视频是否应在页面文档内播放。
+         * - `true`：启用，表示视频将在页面文档内播放；
+         * - `false`：停用，默认浏览器播放行为。
+         * 该配置项只在移动端生效，当取值为 true 的时候，会在初始化 video 或 audio 对象的时候，将 playsinline、webkit-playsinline、x5-playsinline 三个属性设置为 true，请参考 [New Policies for iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/) 了解内联模式相关知识。
+         * @listtip
+         * iOS 10 及以上系统 Safari 浏览器支持配置内联播放模式；</br>
+         * iOS 10 以下系统 Safari 浏览器不支持配置内联播放模式 ，默认播放即进入系统全屏。
+         * @default true
+         */
+        playsinline?: boolean;
+        /** {zh}
+         * @brief 为播放器设置 video 标签扩展属性，初始化时会设置在 videoElement 或 audioElement 对象上，请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
+         * @default 无
+         */
+        videoAttributes?: {
+            [propName: string]: any;
         };
+        /** {zh}
+         * @brief 为播放器设置是否启用流式布局，启用流式布局后播放器会根据屏幕的宽度进行调整，保持在不同屏幕尺寸上都有良好的显示效果。
+         * - `true`：启用
+         * - `false`：停用
+         * @listtip
+         * 启用流式布局时：
+         * 如果 `width` 和 `height` 是 `Number` 类型，则按照其数值计算播放器宽高比；
+         * 如果 `width` 和 `height` 不是 `Number` 类型，默认使用 16:9 比例。
+         * @default false
+         */
+        fluid?: boolean;
+        /** {zh}
+         * @brief 为播放器设置尺寸适配方式，在视频资源初始化之后，根据获取到的 videoWidth 和 videoHeight 值对播放器容器宽高比例进行调整，可选项有：
+         * - `fixed`: 保持容器宽/高，不做适配；
+         * - `fixWidth`: 保持容器宽度，适配高度；
+         * - `fixHeight`: 保持容器高度，适配宽度。
+         *
+         * @default 'fixed'
+         */
+        fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
+        /** {zh}
+         * @brief 为播放器设置视频画面填充模式，可选项有：
+         * - `fillwidth`: 填充宽度，高度溢出则裁剪高度；
+         * - `fillHeight`: 填充高度，宽度溢出则裁剪宽度；
+         * - `fill`: 拉伸视频以填充容器；
+         * - `cover`: 保持其宽高比的同时填充元素的整个内容框；
+         * - `auto`: 使用浏览器默认的视频画面填充模式。
+         * @default 'auto'
+         */
+        videoFillMode?: "auto" | "fillHeight" | "fillWidth" | "fill" | "cover";
+        /** {zh}
+         * @brief 是否开启画面和控制栏分离模式。设置为开启时，控制栏将会常驻，与视频画面不重叠。
+         * - `true`：开启
+         * - `false`：关闭
+         * @default false
+         */
+        marginControls?: boolean;
+        /** {zh}
+         *  @brief 启用微信同层播放。
+         * @default 无
+         */
+        "x5-video-player-type"?: string;
+        /** {zh}
+         *  @brief 是否启用微信全屏播放模式。
+         * - `true`：启用
+         * - `false`：停用
+         * @default 无
+         */
+        "x5-video-player-fullscreen"?: boolean;
+        /** {zh}
+         *  @brief 微信横竖屏控制，支持如下取值：
+         * - `landscape`：横屏
+         * - `portrait`：竖屏
+         * - `landscape|portrait`：跟随手机自动旋转
+         * @default 无
+         */
+        "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
+        /** {zh}
+         * @brief 为播放器配置关键点样式。
+         * @default 无
+         * @hidden 直播目前没用到
+         */
+        commonStyle?: CommonStyle;
+        /** {zh}
+         * @brief 自定义插件列表。
+         * @default 无
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        plugins?: any[];
+        /** {zh}
+         * @hidden
+         */
+        preparePlugins?: PreparePlugins;
     }
-    const transformOption: (options: VePlayerBaseOptions) => Omit<VePlayerBaseOptions, "i18n">;
-    class VePlayerBase {
-        protected readonly _player: XGPlayer;
-        private readonly _sourceManager;
-        private readonly _preparePlugins?;
-        private _previousPrepareResult?;
-        private _i18nManager;
-        private _events;
-        private _errorCallback;
-        constructor(options?: VePlayerBaseOptions);
-        get readyState(): 0 | 2 | 1 | 4 | 3;
-        get buffered(): TimeRanges;
-        get played(): TimeRanges;
-        get cumulateTime(): number;
-        get isFocused(): boolean;
-        get isFullscreen(): boolean;
-        get isCssFullscreen(): boolean;
-        get networkState(): 0 | 2 | 1 | 3;
-        get paused(): boolean;
-        get ended(): boolean;
-        get state(): number;
-        get url(): any;
-        get source(): string | undefined;
-        get definition(): string;
-        get crossOrigin(): string;
-        set crossOrigin(crossOrigin: string);
-        // eslint-disable-next-line @typescript-eslint/member-ordering
-        get volume(): number;
-        set volume(volume: number);
-        // eslint-disable-next-line @typescript-eslint/member-ordering
-        get muted(): boolean;
-        set muted(isMuted: boolean);
-        // eslint-disable-next-line @typescript-eslint/member-ordering
-        get lang(): Lang;
-        set lang(lang: Lang);
-        // eslint-disable-next-line @typescript-eslint/member-ordering
-        protected get _src(): string;
-        static create<T extends VePlayerBase>(options?: VePlayerBaseOptions, Constructor?: Constructor<T>): Promise<T>;
-        switch(target: string | {
-            definition?: string;
-            source?: string;
-        }, options?: {
-            fallbackToFirstDefinition?: boolean;
-        }): Promise<Definition>;
-        updatePlaylist(playlist: ExposedSource[] | string, target?: string | {
-            definition?: string;
-            source?: string;
-        }): Promise<void>;
-        // TODO: 等西瓜播放器完善错误码后增加函数重载以提供更好的类型
-        once(event: string, callback: (data?: any) => any, ...args: any[]): void;
-        off(event: string, callback: (data?: any) => any, ...args: any[]): void;
-        emit(event: string, data?: any, ...args: any[]): void;
-        offAll(): void;
-        on(event: string, callback: (data?: any) => any, ...args: any[]): void;
-        play(): any;
-        pause(): void;
-        requestPIP(): void;
-        exitPIP(): void;
-        retry(): void;
-        focus(data?: {
-            autoHide?: boolean;
-            delay?: number;
-        }): void;
-        blur(data?: {
-            ignorePaused?: boolean;
-        }): void;
-        getFullscreen(el?: HTMLElement): Promise<void>;
-        exitFullscreen(el?: HTMLElement): Promise<void>;
-        getCssFullscreen(el?: HTMLElement): void;
-        exitCssFullscreen(): void;
-        registerPlugin(plugin: 
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        Function | {
-            // eslint-disable-next-line @typescript-eslint/ban-types
-            plugin: Function;
-            options: object;
-        }, config?: {
+    /**
+     * @list option
+     * @kind property
+     */
+    interface Fullscreen {
+        /** {zh}
+         * @brief 切换全屏时，是否旋转为横屏播放，通常在移动端使用。如果开启横屏播放，切换全屏时，将在竖屏状态下把播放器旋转 90 度，实现横屏效果。该配置优先级高于 useCssFullscreen。
+         * `true`：使用旋转横屏；
+         * `false`：不使用旋转横屏。
+         * @default false
+         */
+        rotateFullscreen?: boolean;
+        /** {zh}
+         * @brief 是否使用页面全屏代替系统全屏功能。
+         * `true`：页面全屏；
+         * `false`：系统全屏。
+         * @default false
+         */
+        useCssFullscreen?: boolean;
+        /**{zh}
+         * 全屏的时候是否显示右上角返回按钮，通常在移动端开启。
+         * `true`：显示；
+         * `false`：不显示。
+         * @default false
+         */
+        needBackIcon?: boolean;
+    }
+    /**
+     * @list option
+     * @kind property
+     * @hidden
+     */
+    interface CommonStyle {
+        /** {zh}
+         * @brief 进度条底色
+         * @default 无
+         */
+        progressColor?: string;
+        /** {zh}
+         * @brief 播放完成部分进度条底色
+         * @default 无
+         */
+        playedColor?: string;
+        /** {zh}
+         * @brief 缓存部分进度条底色
+         * @default 无
+         */
+        cachedColor?: string;
+        /** {zh}
+         * @brief 进度条滑块样式
+         * @default 无
+         */
+        sliderBtnStyle?: {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             [propName: string]: any;
-        }): any;
-        unRegisterPlugin(plugin: any, removedFromConfig?: boolean): void;
-        // 显示插件
-        showIcon(pluginNames: string[]): void;
-        // 隐藏插件显示
-        hideIcon(pluginNames: string[]): void;
-        destroy(): void;
-        prepare(url: string): Promise<any[]>;
-        private _handleFallback;
+        };
+        /** {zh}
+         * @brief 音量颜色
+         * @default 无
+         */
+        volumeColor?: string;
+    }
+    type PrepareResult = {
+        options?: Partial<VePlayerBaseOptions>;
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        private _transformEvent;
-        private _switch;
-        private _switchUrl;
-        // 获取需要卸载和需要注册的播放插件
-        private _diffPlugins;
-        private _callBeforePlayerInitForUrl;
+        plugins?: any[];
+    };
+    type PreparePlugins = (url: string) => Promise<PrepareResult> | undefined;
+    /**
+     * @detail option
+     * @brief 视频的实际编码格式。如果您在degradation 设置了 SoftFirst 属性（即硬解不支持降级软解），建议您传入该参数，省去探测实际编码格式的操作。
+     */
+    enum Codec {
+        /** {zh}
+         * @brief h265 编码格式
+         */
+        H265 = "h265",
+        /** {zh}
+         * @brief h264 编码格式
+         */
+        H264 = "h264"
+    }
+    /**
+     * @detail option
+     * @brief 是否开启 H.265 兼容模式。在 H.265 兼容模式下，播放器会优先使用硬解来解码 H.265 直播流。如果设备或浏览器不支持 H.265 硬解，则自动降级为 H.265 软解。
+     */
+    enum Degradation {
+        /** {zh}
+         * @brief 硬解不支持降级到软解
+         */
+        SoftFirst = "soft-first",
+        /** {zh}
+         * @brief 硬解不支持降级到h264
+         * @hidden
+         */
+        H264First = "h264-first"
+    }
+    /**
+     * @detail option
+     * @brief 解码方式。
+     * @example
+     * ```js
+     * VePlayer.createLivePlayer({
+     *  height: 360,
+     *  url: options.url,
+     * }).then(function (veplayer) {
+     *  veplayer.on(VePlayer.live.Events.CANPLAY, function () {
+     *    console.log('监听到 canplay 事件')
+     *  });
+     * }).catch(error => {
+     *  console.log('创建播放器失败，报错信息:', error);
+     * });;
+     * ```
+     */
+    enum DecodeType {
+        /** {zh}
+         * @brief 软解
+         */
+        Software = "software",
+        /** {zh}
+         * @brief 硬解
+         */
+        Hardware = "hardware"
     }
     /// <reference types="./loader" />
     const NAME_MAP: {
@@ -1021,7 +2649,7 @@ declare namespace strategy {
     const createSoftDecodeH265Strategy: StrategyCreator<VePlayerBaseOptions, DynamicModule.PluginXgvideo>;
     function getCodec(options: VePlayerBaseOptions): Promise<"unknown" | Codec>;
     function detectCodec(url: string): Promise<"unknown" | Codec>;
-    function isSoftDecode(options: VePlayerBaseOptions): Promise<boolean>;
+    function isSoftDecode(options: VePlayerBaseOptions, currentCodec?: Codec | "unknown"): Promise<boolean>;
     function combineOptions<T = VePlayerBaseOptions>(strategyList: (Strategy<T> | undefined)[]): Partial<T>;
     const getFlvStrategy: (options: VePlayerBaseOptions) => Promise<{
         options?: undefined;
@@ -1179,45 +2807,205 @@ declare namespace error {
         normalize(text?: string | Record<Lang, string>): string;
         getText(textKey?: T | string): Record<string | T, string>[string | T] | undefined;
     }
+    /**
+     * @detail error
+     */
     enum Level {
+        /**
+         * @brief 严重
+         *
+         */
         Fatal = "Fatal",
+        /**
+         * @brief 报错
+         */
         Error = "Error"
     }
     enum ErrorCode {
+        /**
+         * @brief 视频解析错误
+         * @solution 请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MANIFEST_HLS_ERROR = 1100,
+        /**
+         * @brief 视频解析错误
+         * @solution 请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MANIFEST_DASH_ERROR = 1200,
+        /**
+         * @brief 网络错误
+         * @solution 请检查当前网络环境或播放地址是否合法。
+         */
         NETWORK = 2100,
+        /**
+         * @brief 网络请求超时
+         * @solution 请检查拉流地址是否合法。
+         */
         NETWORK_TIMEOUT = 2101,
+        /**
+         * @brief 网络请求 403
+         * @solution 请检查拉流地址鉴权信息。
+         */
         NETWORK_FORBIDDEN = 2103,
+        /**
+         * @brief 网络请求 404
+         * @solution 请检查拉流地址是否合法。
+         */
         NETWORK_NOTFOUND = 2104,
+        /**
+         * @brief 网络请求 206
+         * @solution 请检查拉流地址是否合法。
+         */
         NETWORK_RANGE_NOT_SATISFIABLE = 2116,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         DEMUX_FLV_ERROR = 3100,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         DEMUX_HLS_ERROR = 3200,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
         DEMUX_MP4_ERROR = 3300,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
         DEMUX_FMP4_ERROR = 3400,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
         DEMUX_SIDX_ERROR = 3410,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
         REMUX_FMP4_ERROR = 4100,
+        /**
+         * @brief 视频解析错误
+         * @solution 请检查拉流地址是否合法或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         *
+         */
         REMUX_MP4_ERROR = 4200,
+        /**
+         * @brief 获取数据过程被中止
+         * @solution 请检查浏览器网络请求是否正常，再尝试重新拉流。
+         */
         MEDIA_ERR_ABORTED = 5101,
+        /**
+         * @brief 网络发生错误，无法成功获取媒体文件
+         * @solution 请检查浏览器网络请求是否正常，再尝试重新拉流。
+         */
         MEDIA_ERR_NETWORK = 5102,
+        /**
+         * @brief 浏览器在解码媒体资源时发生错误
+         * @solution
+         * 1. 请检查原始视频是否正常；
+         * 2. 重新进行转码和播放；
+         * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_ERR_DECODE = 5103,
+        /**
+         * @brief 因视频格式不支持、服务器或网络的问题造成视频无法加载
+         * @solution
+         * 1. 检查浏览器视频数据请求是否正常；
+         * 2. 检查浏览器和页面环境是否支持要播放的视频格式；
+         * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_ERR_SRC_NOT_SUPPORTED = 5104,
+        /**
+         * @brief 当前浏览器不支持视频解码
+         * @solution
+         * 1. 检查浏览器视频数据请求是否正常；
+         * 2. 检查浏览器和页面环境是否支持要播放的视频格式；
+         * 3. 如仍未解决请联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_ERR_CODEC_NOT_SUPPORTED = 5105,
+        /**
+         * @brief 当前播放地址为空
+         * @solution 请检查必要参数 `url` 或 `playlist` 是否传入。
+         */
         MEDIA_ERR_URL_EMPTY = 5106,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_MSE_ADD_SB = 5200,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_MSE_APPEND_BUFFER = 5201,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_MSE_OTHER = 5202,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_MSE_FULL = 5203,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_MSE_HIJACK = 5204,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         MEDIA_EME_HIJACK = 5301,
+        /**
+         * @brief DRM 权限校验失败
+         * @hidden
+         */
         DRM_LICENSE = 7100,
+        /**
+         * @brief DRM 权限校验失败
+         * @hidden
+         */
         DRM_CUSTOM_LICENSE = 7200,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         OTHER = 8000,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         RUNTIME_NO_CANPLAY_ERROR = 9001,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         RUNTIME_BUFFERBREAK_ERROR = 9002,
+        /**
+         * @brief 播放异常
+         * @solution 请检查播放源或联系[技术支持](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000076)。
+         */
         RUNTIME_BWAITING_TIMEOUT_ERROR = 9002,
         // veplayer 报错
-        MODULE_LOAD_ERROR = 100,
+        /**
+         * @brief CDN 异步获取失败
+         * @solution 请刷新重试或者检查网络环境。
+         *
+         */
+        MODULE_LOAD_ERROR = 110,
+        /**
+         * @hidden
+         */
         UNKNOWN = "UNKNOWN"
     }
     enum ErrorType {
@@ -1242,10 +3030,33 @@ declare namespace error {
     // 参考： https://bytedance.feishu.cn/docx/doxcnGPXIOrJk3dGE3E3YghgZke
     const ERROR_INFO: Partial<Record<ErrorCode, ErrorInfo>>;
     const ERROR_TYPE_INFO: Record<ErrorType, ErrorInfo>;
+    /**
+     * @detail error
+     * @name 错误对象
+     * @id 错误对象
+     */
     class VeError<T extends string = TextKey> extends Error {
+        /**
+         * @brief 错误码，对应[错误码字典](#错误码)。
+         */
         readonly errorCode: ErrorCode;
+        /**
+         * @brief 错误等级。
+         */
         readonly level?: Level;
+        /**
+         * @brief 错误信息。
+         */
+        message: string;
+        /**
+         * @brief 其他错误信息。
+         */
         readonly ext?: any;
+        /**
+         * @hidden
+         * @param error
+         * @param i18n
+         */
         constructor(error?: string | ErrorInfo<T>, i18n?: VeI18n<T>);
     }
     function create(errorCode: ErrorCode, info?: ErrorInfo, i18n?: VeI18n): VeError<"DEFINITION_FALLBACK_TOAST" | "DEFINITION_SWITCHING" | "ERROR_REFRESH" | "UNMUTE" | "MANIFEST" | "NETWORK" | "NETWORK_TIMEOUT" | "NETWORK_FORBIDDEN" | "NETWORK_NOTFOUND" | "DEMUX" | "REMUX" | "MEDIA" | "MEDIA_ERR_CODEC_NOT_SUPPORTED" | "MEDIA_ERR_URL_EMPTY" | "DRM" | "OTHER" | "RUNTIME" | "MODULE_LOAD_ERROR" | "UNKNOWN" | "ERROR_TYPES" | "HAVE_NOTHING" | "HAVE_METADATA" | "HAVE_CURRENT_DATA" | "HAVE_FUTURE_DATA" | "HAVE_ENOUGH_DATA" | "NETWORK_EMPTY" | "NETWORK_IDLE" | "NETWORK_LOADING" | "NETWORK_NO_SOURCE" | "MEDIA_ERR_ABORTED" | "MEDIA_ERR_NETWORK" | "MEDIA_ERR_DECODE" | "MEDIA_ERR_SRC_NOT_SUPPORTED" | "REPLAY" | "ERROR" | "PLAY_TIPS" | "PAUSE_TIPS" | "PLAYNEXT_TIPS" | "DOWNLOAD_TIPS" | "ROTATE_TIPS" | "RELOAD_TIPS" | "FULLSCREEN_TIPS" | "EXITFULLSCREEN_TIPS" | "CSSFULLSCREEN_TIPS" | "EXITCSSFULLSCREEN_TIPS" | "TEXTTRACK" | "PIP" | "SCREENSHOT" | "LIVE" | "OFF" | "OPEN" | "MINI_DRAG" | "MINISCREEN" | "REFRESH_TIPS" | "REFRESH" | "FORWARD" | "LIVE_TIP">;
@@ -1351,53 +3162,6 @@ declare namespace event {
         xgCallback: ((...args: any) => void) | undefined;
     };
 }
-type Text = string | Record<Lang, string>;
-type Config$1 = {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    [key: string]: any;
-    showErrorImg: boolean;
-    showErrorTip: boolean;
-    showRefresh: boolean;
-    errorTipsText: Text;
-    extraTips: {
-        label: Text;
-        value: Text;
-    }[];
-};
-declare class Error extends Plugin {
-    player: Player$0;
-    icons: {
-        error: HTMLElement;
-    };
-    langText: {
-        refresh: string;
-        errorTip: string;
-    };
-    config: Config$1;
-    private _error?;
-    static get pluginName(): string;
-    static get defaultConfig(): Config$1;
-    get _errorTip(): string;
-    afterCreate(): void;
-    registerIcons(): {
-        error: {
-            icon: any;
-            class: string;
-        };
-    };
-    updateLang(): void;
-    showError(error: VeError | XGError): void;
-    hideError(): void;
-    destroy(): void;
-    render(): string;
-    private _focus;
-    private _initIcons;
-    private _initEvents;
-    private _renderText;
-    private _renderExtraTips;
-    private _handleRefresh;
-    private _renderRefresh;
-}
 interface VodVePlayerOptions {
     plugins: any[];
 }