@volcengine/veplayer 2.4.0-rc.2 → 2.4.0-rc.4

package/veplayer.d.ts

@@ -1897,6 +1897,11 @@ declare class VePlayerBase {
      * @brief Gets the current playback source ID.
      */
     get source(): string | undefined;
+    /** {zh}
+     * 获取播放器版本号
+     * @returns
+     */
+    get playerVersion(): string;
     /** {zh}
      * @brief 获取当前播放视频的清晰度唯一标识（definition）。
      */
@@ -2019,6 +2024,12 @@ declare class VePlayerBase {
          *
          */
         fallbackToFirstDefinition?: boolean;
+        /** {zh}
+         * @brief 是否无缝切换
+         * - true: 无缝切换
+         * - false: 非无缝切换
+         * @default false
+         */
         seamless?: boolean;
     }): Promise<ExposedDefinition>;
     /** {zh}
@@ -2188,6 +2199,11 @@ declare class VePlayerBase {
          */
         ignorePaused?: boolean;
     }): void;
+    /** {zh}
+     * @brief 判断浏览器是否支持播放格式
+     * @param type 播放格式
+     * @returns
+     */
     canPlayType(type: string): boolean;
     /** {zh}
      * @brief 调用此方法进入系统全屏状态。如果该方法调用的时候处于网页全屏状态会自动退出网页全屏，下发事件 `Events.FULLSCREEN_CHANGE`。
@@ -4895,9 +4911,9 @@ declare namespace event {
         AUTOPLAY_SUCCESS: string;
         ERROR_REFRESH_CLICK: string;
         SOURCE_CHANGE: string;
-        SWITCH_DEFINITION_START: string;
-        SWITCH_DEFINITION_SUCCESS: string;
-        DOWN_DEFINITION: string;
+        ABR_SWITCH_START: string;
+        ABR_SWITCH_SUCCESS: string;
+        ABR_SWITCH_FAILED: string;
     };
     const Events: {
         SEI: string;
@@ -4923,9 +4939,9 @@ declare namespace event {
         AUTOPLAY_SUCCESS: string;
         ERROR_REFRESH_CLICK: string;
         SOURCE_CHANGE: string;
-        SWITCH_DEFINITION_START: string;
-        SWITCH_DEFINITION_SUCCESS: string;
-        DOWN_DEFINITION: string;
+        ABR_SWITCH_START: string;
+        ABR_SWITCH_SUCCESS: string;
+        ABR_SWITCH_FAILED: string;
         REPLAY: string;
         ERROR: string;
         PLAY: string;
@@ -5301,20 +5317,75 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
      */
     drm?: Drm;
 }
+/** {zh}
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface Abr {
+    /** {zh}
+     * @brief 是否开启 abr
+     * - true: 开启
+     * - false: 关闭
+     * @default true
+     */
     enable?: boolean;
+    /** {zh}
+     * @brief 未开启abr的时候，是否开启降码率建议
+     * - true: 开启
+     * - false: 关闭
+     * @default false
+     */
     downTip?: boolean;
+    /** {zh}
+     * @brief 是否开始调试模式
+     * - true: 开启
+     * - false: 关闭
+     */
     debug?: boolean;
-    bitrate: number;
+    /** {zh}
+     * @brief url 参数对应的码率
+     */
+    bitrate?: number;
+    /** {zh}
+     * @brief 多个码率的拉流地址
+     */
     urls?: {
         [bitrate: number]: string;
     };
 }
+/** {zh}
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
 interface HlsAbr {
+    /** {zh}
+     * @brief 是否开启 abr
+     * - true: 开启
+     * - false: 关闭
+     * @default true
+     */
     enable?: boolean;
+    /** {zh}
+     * @brief 未开启abr的时候，是否开启降码率建议
+     * - true: 开启
+     * - false: 关闭
+     * @default false
+     */
     downTip?: boolean;
+    /** {zh}
+     * @brief 是否开始调试模式
+     * - true: 开启
+     * - false: 关闭
+     */
     debug?: boolean;
-    bitrate: number;
 }
 /** {zh}
  * @hidden
@@ -5503,6 +5574,10 @@ interface Rtm {
      * @default false
      */
     enableRTMAutoTranscode?: boolean;
+    /** {zh}
+     * @brief 评估当前网络情况的间隔
+     * @default 1000
+     */
     networkEvaluateInterval?: number;
 }
 /** {zh}
@@ -5555,16 +5630,59 @@ interface Flv {
      */
     enableLowLatency?: boolean;
     /** {zh}
-     * @hidden
+     * @brief 播放器发起 FLV 拉流请求时，开启低延时的详细配置。。
+     * @default -
      */
     /** {en}
-     * @hidden
+     * @brief
+     * @default -
+     */
+    lowLatency?: LowLatency;
+    /** {zh}
+     * @brief 为播放器设置 FLV Abr 配置。
+     * @default -
      */
-    abrPts?: string | number;
     abr?: Abr;
+    /** {zh}
+     * @hidden
+     */
     mseLowLatency?: boolean;
+    /** {zh}
+     * @brief 超过 maxReaderInterval 时间还没有新数据返回视为断流，播放器触发 ended 事件, 单位 s。
+     * @default 5
+     */
     maxReaderInterval?: number;
 }
+/** {zh}
+ * @list option
+ * @kind property
+ */
+/** {en}
+ * @list option
+ * @kind property
+ */
+interface LowLatency {
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @hidden
+     */
+    abrPts?: string | number;
+    /** {zh}
+     * @brief FLV 低延时模式下，是否允许追帧
+     * - true：开启
+     * - false：关闭
+     * @default true
+     */
+    /** {en}
+     * @brief
+     * - true: Enable
+     * - false: Disable
+     * @default true
+     */
+    enableFrameChasing?: boolean;
+}
 /** {zh}
  * @list option
  * @kind property
@@ -5614,9 +5732,95 @@ interface Hls {
      * @default false
      */
     enableMSE?: boolean;
+    /** {zh}
+     * @brief 为播放器设置 HLS Abr 配置。
+     * @default -
+     */
     abr?: HlsAbr;
+    /**
+     * @hidden
+     */
     mseLowLatency?: boolean;
 }
+interface RTMNetWorkInfo {
+    /** {zh}
+     * @brief 当前下载速度
+     */
+    speed?: number;
+    /** {zh}
+     * @brief 当前平均下载速度
+     */
+    avgSpeed?: number;
+    /** {zh}
+     * @brief 当前丢包率
+     */
+    lostRate?: number;
+    /** {zh}
+     * @brief 当前平均丢包率
+     */
+    avgLostRate?: number;
+}
+/** {zh}
+ * @brief RTM 信息
+ */
+interface StatsSnapShoot {
+    video?: {
+        codec: string;
+        payloadType: string;
+        sdpFmtpLine: string;
+        bytesReceived: number;
+        firCount: number;
+        pliCount: number;
+        frameHeight: number;
+        frameWidth: number;
+        framesDecoded: number;
+        framesDropped: number;
+        framesPerSecond: number;
+        framesReceived: number;
+        jitter: number;
+        jitterBufferDelay: number;
+        keyFramesDecoded: number;
+        nackCount: number;
+        packetsLost: number;
+        packetsReceived: number;
+    };
+    audio?: {
+        codec: string;
+        payloadType: string;
+        sdpFmtpLine: string;
+        audioLevel: number;
+        bytesReceived: number;
+        jitter: number;
+        jitterBufferDelay: number;
+        packetsLost: number;
+        packetsReceived: number;
+        totalSamplesDuration: number;
+        totalSamplesReceived: number;
+    };
+}
+/** {zh}
+ * @brief FLV 信息
+ */
+interface FlvStats {
+    audioCodec: string;
+    avgSpeed: number;
+    bitrate: number;
+    bufferEnd: number;
+    channelCount: number;
+    currentTime: number;
+    decodeFps: number;
+    domain: string;
+    downloadSpeed: number;
+    encodeType: string;
+    fps: number;
+    gop: number;
+    height: number;
+    samplerate: number;
+    totalReceivedByte: number;
+    totalReceivedCost: number;
+    videoCodec: string;
+    width: number;
+}
 /** {zh}
  * @detail api
  * @list api
@@ -5637,6 +5841,10 @@ declare class VePlayerLive extends VePlayerBase {
      * @param options
      */
     constructor(options: LiveVePlayerOptions);
+    /** {zh}
+     * @brief 获取已经播放的时间
+     */
+    get playTime(): number;
     /** {zh}
      * @brief 调用此方法开启直播日志上报。
      */
@@ -5667,59 +5875,51 @@ declare class VePlayerLive extends VePlayerBase {
      *
      */
     closeInfoPanel(): void;
+    /** {zh}
+     * @brief 打开 Abr
+     */
     openAbr(): void;
+    /** {zh}
+     * @brief 关闭 Abr
+     */
     closeAbr(): void;
     /** {zh}
      * @brief 调用此方法更新 DRM 鉴权配置。
      * @hidden
      */
     updateDrmConfig(config: FairplayDrmConfig): void;
-    switchAbr({ enable, bitrate }: {
-        enable: boolean;
-        bitrate: number;
-    }): void;
-    switch(target: string | {
-        /** {zh}
-         * @brief 清晰度的唯一标识。
-         * @default 无
-         */
-        /** {en}
-         * @brief The resolution ID.
-         */
-        definition?: string;
+    /** {zh}
+     * @brief 切换 flv Abr
+     * @param options 切换 Abr 的配置。
+     * @returns
+     */
+    switchAbr(options: {
         /** {zh}
-         * @brief 线路的唯一标识。
-         * @default 无
-         */
-        /** {en}
-         * @brief The playback source ID.
+         * @brief 是否开启 Abr
+         * - true: 开启
+         * - false: 关闭
          */
-        source?: string;
-    }, options?: {
+        enable: boolean;
         /** {zh}
-         * @brief 清晰度 definition 配置无效时，是否降级到播放列表第一个清晰度地址。
-         * @default false
-         *
-         */
-        /** {en}
-         * @brief Whether to downgrade to the first resolution in the playlist when the player cannot play with the specified resolution.
-         * @default false
-         *
+         * @brief 切换 Abr 的码率
          */
-        fallbackToFirstDefinition?: boolean;
-        seamless?: boolean;
-        abr?: {
-            bitrate: number; // 默认起播的码率，必传
-            method?: number; // 选择abr算法编号
-            urls: {
-                [bitrate: number]: string;
-            }; // 可用的码率和对应的拉流地址
-        };
-    }): Promise<any>;
-    getPlayTime(): number;
-    getPlayerVersion(): string;
-    getRTMNetWorkInfo(): any;
-    getFLVStats(): any;
+        bitrate: number;
+    }): void;
+    /** {zh}
+     * @brief 获取 RTM 的网络相关信息
+     * @returns
+     */
+    getRTMNetWorkInfo(): RTMNetWorkInfo;
+    /** {zh}
+     * @brief 获取 RTM 播放信息
+     * @returns
+     */
+    getRTMStats(): Promise<StatsSnapShoot>;
+    /** {zh}
+     * @brief 获取 FLV 播放信息
+     * @returns
+     */
+    getFLVStats(): FlvStats;
 }
 /** {zh}
  * @detail api
@@ -6822,7 +7022,19 @@ declare namespace live {
         /** {en}
          * The user clicks the Refresh button.
          */
-        REFRESH_CLICK = "refreshClick"
+        REFRESH_CLICK = "refreshClick",
+        /** {zh}
+         * Abr 切换码率
+         */
+        ABR_SWITCH_START = "abrSwitchStart",
+        /** {zh}
+         * Abr 切换码率成功
+         */
+        ABR_SWITCH_SUCCESS = "abrSwitchedSuccess",
+        /** {zh}
+         * Abr 切换码率失败
+         */
+        ABR_SWITCH_FAILED = "abrSwitchFailed"
     }
     /** {zh}
      * @detail events
@@ -7371,6 +7583,41 @@ declare namespace live {
          * The user clicks the Refresh button.
          */
         [LiveEvents.REFRESH_CLICK]: () => void;
+        /** {zh}
+         * Abr 切换码率
+         */
+        [LiveEvents.ABR_SWITCH_START]: (data: {
+            /** {zh}
+             * 切换的码率
+             */
+            bitrate: number;
+        }) => void;
+        /** {zh}
+         * Abr 切换码率成功
+         */
+        [LiveEvents.ABR_SWITCH_SUCCESS]: (data: {
+            /** {zh}
+             * 切换的码率
+             */
+            bitrate: number;
+            /**
+             * 切换的地址
+             */
+            url: string;
+        }) => void;
+        /** {zh}
+         * Abr 切换码率失败
+         */
+        [LiveEvents.ABR_SWITCH_FAILED]: (data: {
+            /** {zh}
+             * 切换的码率
+             */
+            bitrate: number;
+            /**
+             * 切换的地址
+             */
+            url: string;
+        }) => void;
     }
     const Events: {
         TIME_SHIFT_CHANGE: string;
@@ -7398,9 +7645,9 @@ declare namespace live {
         AUTOPLAY_SUCCESS: string;
         ERROR_REFRESH_CLICK: string;
         SOURCE_CHANGE: string;
-        SWITCH_DEFINITION_START: string;
-        SWITCH_DEFINITION_SUCCESS: string;
-        DOWN_DEFINITION: string;
+        ABR_SWITCH_START: string;
+        ABR_SWITCH_SUCCESS: string;
+        ABR_SWITCH_FAILED: string;
         REPLAY: string;
         ERROR: string;
         PLAY: string;
@@ -8616,6 +8863,11 @@ declare namespace live {
          * @brief Gets the current playback source ID.
          */
         get source(): string | undefined;
+        /** {zh}
+         * 获取播放器版本号
+         * @returns
+         */
+        get playerVersion(): string;
         /** {zh}
          * @brief 获取当前播放视频的清晰度唯一标识（definition）。
          */
@@ -8738,6 +8990,12 @@ declare namespace live {
              *
              */
             fallbackToFirstDefinition?: boolean;
+            /** {zh}
+             * @brief 是否无缝切换
+             * - true: 无缝切换
+             * - false: 非无缝切换
+             * @default false
+             */
             seamless?: boolean;
         }): Promise<ExposedDefinition>;
         /** {zh}
@@ -8907,6 +9165,11 @@ declare namespace live {
              */
             ignorePaused?: boolean;
         }): void;
+        /** {zh}
+         * @brief 判断浏览器是否支持播放格式
+         * @param type 播放格式
+         * @returns
+         */
         canPlayType(type: string): boolean;
         /** {zh}
          * @brief 调用此方法进入系统全屏状态。如果该方法调用的时候处于网页全屏状态会自动退出网页全屏，下发事件 `Events.FULLSCREEN_CHANGE`。
@@ -9864,20 +10127,75 @@ declare namespace live {
          */
         drm?: Drm;
     }
+    /** {zh}
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface Abr {
+        /** {zh}
+         * @brief 是否开启 abr
+         * - true: 开启
+         * - false: 关闭
+         * @default true
+         */
         enable?: boolean;
+        /** {zh}
+         * @brief 未开启abr的时候，是否开启降码率建议
+         * - true: 开启
+         * - false: 关闭
+         * @default false
+         */
         downTip?: boolean;
+        /** {zh}
+         * @brief 是否开始调试模式
+         * - true: 开启
+         * - false: 关闭
+         */
         debug?: boolean;
-        bitrate: number;
+        /** {zh}
+         * @brief url 参数对应的码率
+         */
+        bitrate?: number;
+        /** {zh}
+         * @brief 多个码率的拉流地址
+         */
         urls?: {
             [bitrate: number]: string;
         };
     }
+    /** {zh}
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
     interface HlsAbr {
+        /** {zh}
+         * @brief 是否开启 abr
+         * - true: 开启
+         * - false: 关闭
+         * @default true
+         */
         enable?: boolean;
+        /** {zh}
+         * @brief 未开启abr的时候，是否开启降码率建议
+         * - true: 开启
+         * - false: 关闭
+         * @default false
+         */
         downTip?: boolean;
+        /** {zh}
+         * @brief 是否开始调试模式
+         * - true: 开启
+         * - false: 关闭
+         */
         debug?: boolean;
-        bitrate: number;
     }
     /** {zh}
      * @hidden
@@ -10066,6 +10384,10 @@ declare namespace live {
          * @default false
          */
         enableRTMAutoTranscode?: boolean;
+        /** {zh}
+         * @brief 评估当前网络情况的间隔
+         * @default 1000
+         */
         networkEvaluateInterval?: number;
     }
     /** {zh}
@@ -10118,16 +10440,59 @@ declare namespace live {
          */
         enableLowLatency?: boolean;
         /** {zh}
-         * @hidden
+         * @brief 播放器发起 FLV 拉流请求时，开启低延时的详细配置。。
+         * @default -
          */
         /** {en}
-         * @hidden
+         * @brief
+         * @default -
+         */
+        lowLatency?: LowLatency;
+        /** {zh}
+         * @brief 为播放器设置 FLV Abr 配置。
+         * @default -
          */
-        abrPts?: string | number;
         abr?: Abr;
+        /** {zh}
+         * @hidden
+         */
         mseLowLatency?: boolean;
+        /** {zh}
+         * @brief 超过 maxReaderInterval 时间还没有新数据返回视为断流，播放器触发 ended 事件, 单位 s。
+         * @default 5
+         */
         maxReaderInterval?: number;
     }
+    /** {zh}
+     * @list option
+     * @kind property
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     */
+    interface LowLatency {
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @hidden
+         */
+        abrPts?: string | number;
+        /** {zh}
+         * @brief FLV 低延时模式下，是否允许追帧
+         * - true：开启
+         * - false：关闭
+         * @default true
+         */
+        /** {en}
+         * @brief
+         * - true: Enable
+         * - false: Disable
+         * @default true
+         */
+        enableFrameChasing?: boolean;
+    }
     /** {zh}
      * @list option
      * @kind property
@@ -10177,9 +10542,95 @@ declare namespace live {
          * @default false
          */
         enableMSE?: boolean;
+        /** {zh}
+         * @brief 为播放器设置 HLS Abr 配置。
+         * @default -
+         */
         abr?: HlsAbr;
+        /**
+         * @hidden
+         */
         mseLowLatency?: boolean;
     }
+    interface RTMNetWorkInfo {
+        /** {zh}
+         * @brief 当前下载速度
+         */
+        speed?: number;
+        /** {zh}
+         * @brief 当前平均下载速度
+         */
+        avgSpeed?: number;
+        /** {zh}
+         * @brief 当前丢包率
+         */
+        lostRate?: number;
+        /** {zh}
+         * @brief 当前平均丢包率
+         */
+        avgLostRate?: number;
+    }
+    /** {zh}
+     * @brief RTM 信息
+     */
+    interface StatsSnapShoot {
+        video?: {
+            codec: string;
+            payloadType: string;
+            sdpFmtpLine: string;
+            bytesReceived: number;
+            firCount: number;
+            pliCount: number;
+            frameHeight: number;
+            frameWidth: number;
+            framesDecoded: number;
+            framesDropped: number;
+            framesPerSecond: number;
+            framesReceived: number;
+            jitter: number;
+            jitterBufferDelay: number;
+            keyFramesDecoded: number;
+            nackCount: number;
+            packetsLost: number;
+            packetsReceived: number;
+        };
+        audio?: {
+            codec: string;
+            payloadType: string;
+            sdpFmtpLine: string;
+            audioLevel: number;
+            bytesReceived: number;
+            jitter: number;
+            jitterBufferDelay: number;
+            packetsLost: number;
+            packetsReceived: number;
+            totalSamplesDuration: number;
+            totalSamplesReceived: number;
+        };
+    }
+    /** {zh}
+     * @brief FLV 信息
+     */
+    interface FlvStats {
+        audioCodec: string;
+        avgSpeed: number;
+        bitrate: number;
+        bufferEnd: number;
+        channelCount: number;
+        currentTime: number;
+        decodeFps: number;
+        domain: string;
+        downloadSpeed: number;
+        encodeType: string;
+        fps: number;
+        gop: number;
+        height: number;
+        samplerate: number;
+        totalReceivedByte: number;
+        totalReceivedCost: number;
+        videoCodec: string;
+        width: number;
+    }
     /** {zh}
      * @detail api
      * @list api
@@ -10200,6 +10651,10 @@ declare namespace live {
          * @param options
          */
         constructor(options: LiveVePlayerOptions);
+        /** {zh}
+         * @brief 获取已经播放的时间
+         */
+        get playTime(): number;
         /** {zh}
          * @brief 调用此方法开启直播日志上报。
          */
@@ -10230,59 +10685,51 @@ declare namespace live {
          *
          */
         closeInfoPanel(): void;
+        /** {zh}
+         * @brief 打开 Abr
+         */
         openAbr(): void;
+        /** {zh}
+         * @brief 关闭 Abr
+         */
         closeAbr(): void;
         /** {zh}
          * @brief 调用此方法更新 DRM 鉴权配置。
          * @hidden
          */
         updateDrmConfig(config: FairplayDrmConfig): void;
-        switchAbr({ enable, bitrate }: {
-            enable: boolean;
-            bitrate: number;
-        }): void;
-        switch(target: string | {
-            /** {zh}
-             * @brief 清晰度的唯一标识。
-             * @default 无
-             */
-            /** {en}
-             * @brief The resolution ID.
-             */
-            definition?: string;
+        /** {zh}
+         * @brief 切换 flv Abr
+         * @param options 切换 Abr 的配置。
+         * @returns
+         */
+        switchAbr(options: {
             /** {zh}
-             * @brief 线路的唯一标识。
-             * @default 无
+             * @brief 是否开启 Abr
+             * - true: 开启
+             * - false: 关闭
              */
-            /** {en}
-             * @brief The playback source ID.
-             */
-            source?: string;
-        }, options?: {
+            enable: boolean;
             /** {zh}
-             * @brief 清晰度 definition 配置无效时，是否降级到播放列表第一个清晰度地址。
-             * @default false
-             *
-             */
-            /** {en}
-             * @brief Whether to downgrade to the first resolution in the playlist when the player cannot play with the specified resolution.
-             * @default false
-             *
+             * @brief 切换 Abr 的码率
              */
-            fallbackToFirstDefinition?: boolean;
-            seamless?: boolean;
-            abr?: {
-                bitrate: number; // 默认起播的码率，必传
-                method?: number; // 选择abr算法编号
-                urls: {
-                    [bitrate: number]: string;
-                }; // 可用的码率和对应的拉流地址
-            };
-        }): Promise<any>;
-        getPlayTime(): number;
-        getPlayerVersion(): string;
-        getRTMNetWorkInfo(): any;
-        getFLVStats(): any;
+            bitrate: number;
+        }): void;
+        /** {zh}
+         * @brief 获取 RTM 的网络相关信息
+         * @returns
+         */
+        getRTMNetWorkInfo(): RTMNetWorkInfo;
+        /** {zh}
+         * @brief 获取 RTM 播放信息
+         * @returns
+         */
+        getRTMStats(): Promise<StatsSnapShoot>;
+        /** {zh}
+         * @brief 获取 FLV 播放信息
+         * @returns
+         */
+        getFLVStats(): FlvStats;
     }
     /** {zh}
      * @detail api