@byteplus/veplayer 2.12.1 → 2.13.1-rc.0

package/veplayer.d.ts

@@ -6217,6 +6217,7 @@ interface PrepareOptions {
     logger?: LoggerConfig;
 }
 interface LiveEN {
+    INVALID_PARAMETER: string;
     ERROR_TYPES?: any;
     // eslint-disable-next-line @typescript-eslint/member-ordering
     [key: string]: string | unknown;
@@ -7058,9 +7059,11 @@ interface Rtm {
     checkStatsErrorDelay?: number;
     /** {zh}
      * @brief 是否打开 RTM SEI
+     * @default true
      */
     /** {en}
      * @brief enable RTM SEI data.
+     * @default true
      */
     enableSei?: boolean;
 }
@@ -7305,6 +7308,32 @@ interface RTMNetWorkInfo {
      */
     avgLostRate?: number;
 }
+/** {zh}
+ * @list option
+ * @kind property
+ * @brief 服务端 SEI 延迟统计。
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Server SEI delay statistics.
+ */
+interface SEIDelayStats {
+    /** {zh}
+     * @brief 服务端链路延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+     */
+    /** {en}
+     * @brief Server-side transfer delay in milliseconds. Empty when valid server SEI data is unavailable.
+     */
+    delay_s2s?: number;
+    /** {zh}
+     * @brief 推流端到播放端的延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+     */
+    /** {en}
+     * @brief Stream-to-end playback delay in milliseconds. Empty when valid server SEI data is unavailable.
+     */
+    delay_s2e?: number;
+}
 /** {zh}
  * @list option
  * @kind property
@@ -7315,7 +7344,7 @@ interface RTMNetWorkInfo {
  * @kind property
  * @brief RTM live stream information.
  */
-interface StatsSnapShoot {
+interface StatsSnapShoot extends SEIDelayStats {
     /** {en}
      * @brief Video information.
      */
@@ -7546,7 +7575,7 @@ interface StatsSnapShoot {
  * @kind property
  * @brief Basic information for live stream playback.
  */
-interface Stats$0 {
+interface Stats$0 extends SEIDelayStats {
     /** {zh}
      * @brief 音频格式。
      * @hidden
@@ -7704,6 +7733,7 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     _protocolManager?: ProtocolManager;
+    private _seiDelayStats;
     /** {zh}
      * @hidden
      * @param options
@@ -7734,6 +7764,13 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     get hls(): any;
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @hidden
+     */
+    destroy(): void;
     /** {zh}
      * @brief 调用此方法开启直播日志上报。
      */
@@ -7886,6 +7923,10 @@ declare class VePlayerLive extends VePlayerBase {
          */
         source?: string;
     }, needUpdateProtocol?: boolean): Promise<void>;
+    private _resetSEIDelayStats;
+    private _handleSEI;
+    private _getPlayerBufferTime;
+    private _mergeSEIDelayStats;
 }
 /** {zh}
  * @detail api
@@ -11539,6 +11580,7 @@ declare namespace live {
         logger?: LoggerConfig;
     }
     interface LiveEN {
+        INVALID_PARAMETER: string;
         ERROR_TYPES?: any;
         // eslint-disable-next-line @typescript-eslint/member-ordering
         [key: string]: string | unknown;
@@ -12390,9 +12432,11 @@ declare namespace live {
         checkStatsErrorDelay?: number;
         /** {zh}
          * @brief 是否打开 RTM SEI
+         * @default true
          */
         /** {en}
          * @brief enable RTM SEI data.
+         * @default true
          */
         enableSei?: boolean;
     }
@@ -12637,6 +12681,32 @@ declare namespace live {
          */
         avgLostRate?: number;
     }
+    /** {zh}
+     * @list option
+     * @kind property
+     * @brief 服务端 SEI 延迟统计。
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Server SEI delay statistics.
+     */
+    interface SEIDelayStats {
+        /** {zh}
+         * @brief 服务端链路延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+         */
+        /** {en}
+         * @brief Server-side transfer delay in milliseconds. Empty when valid server SEI data is unavailable.
+         */
+        delay_s2s?: number;
+        /** {zh}
+         * @brief 推流端到播放端的延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+         */
+        /** {en}
+         * @brief Stream-to-end playback delay in milliseconds. Empty when valid server SEI data is unavailable.
+         */
+        delay_s2e?: number;
+    }
     /** {zh}
      * @list option
      * @kind property
@@ -12647,7 +12717,7 @@ declare namespace live {
      * @kind property
      * @brief RTM live stream information.
      */
-    interface StatsSnapShoot {
+    interface StatsSnapShoot extends SEIDelayStats {
         /** {en}
          * @brief Video information.
          */
@@ -12878,7 +12948,7 @@ declare namespace live {
      * @kind property
      * @brief Basic information for live stream playback.
      */
-    interface Stats$0 {
+    interface Stats$0 extends SEIDelayStats {
         /** {zh}
          * @brief 音频格式。
          * @hidden
@@ -13036,6 +13106,7 @@ declare namespace live {
          * @hidden
          */
         _protocolManager?: ProtocolManager;
+        private _seiDelayStats;
         /** {zh}
          * @hidden
          * @param options
@@ -13066,6 +13137,13 @@ declare namespace live {
          * @hidden
          */
         get hls(): any;
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @hidden
+         */
+        destroy(): void;
         /** {zh}
          * @brief 调用此方法开启直播日志上报。
          */
@@ -13218,6 +13296,10 @@ declare namespace live {
              */
             source?: string;
         }, needUpdateProtocol?: boolean): Promise<void>;
+        private _resetSEIDelayStats;
+        private _handleSEI;
+        private _getPlayerBufferTime;
+        private _mergeSEIDelayStats;
     }
     /** {zh}
      * @detail api

package/veplayer.live.d.ts

@@ -6217,6 +6217,7 @@ interface PrepareOptions {
     logger?: LoggerConfig;
 }
 interface LiveEN {
+    INVALID_PARAMETER: string;
     ERROR_TYPES?: any;
     // eslint-disable-next-line @typescript-eslint/member-ordering
     [key: string]: string | unknown;
@@ -7058,9 +7059,11 @@ interface Rtm {
     checkStatsErrorDelay?: number;
     /** {zh}
      * @brief 是否打开 RTM SEI
+     * @default true
      */
     /** {en}
      * @brief enable RTM SEI data.
+     * @default true
      */
     enableSei?: boolean;
 }
@@ -7305,6 +7308,32 @@ interface RTMNetWorkInfo {
      */
     avgLostRate?: number;
 }
+/** {zh}
+ * @list option
+ * @kind property
+ * @brief 服务端 SEI 延迟统计。
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief Server SEI delay statistics.
+ */
+interface SEIDelayStats {
+    /** {zh}
+     * @brief 服务端链路延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+     */
+    /** {en}
+     * @brief Server-side transfer delay in milliseconds. Empty when valid server SEI data is unavailable.
+     */
+    delay_s2s?: number;
+    /** {zh}
+     * @brief 推流端到播放端的延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+     */
+    /** {en}
+     * @brief Stream-to-end playback delay in milliseconds. Empty when valid server SEI data is unavailable.
+     */
+    delay_s2e?: number;
+}
 /** {zh}
  * @list option
  * @kind property
@@ -7315,7 +7344,7 @@ interface RTMNetWorkInfo {
  * @kind property
  * @brief RTM live stream information.
  */
-interface StatsSnapShoot {
+interface StatsSnapShoot extends SEIDelayStats {
     /** {en}
      * @brief Video information.
      */
@@ -7546,7 +7575,7 @@ interface StatsSnapShoot {
  * @kind property
  * @brief Basic information for live stream playback.
  */
-interface Stats$0 {
+interface Stats$0 extends SEIDelayStats {
     /** {zh}
      * @brief 音频格式。
      * @hidden
@@ -7704,6 +7733,7 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     _protocolManager?: ProtocolManager;
+    private _seiDelayStats;
     /** {zh}
      * @hidden
      * @param options
@@ -7734,6 +7764,13 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     get hls(): any;
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @hidden
+     */
+    destroy(): void;
     /** {zh}
      * @brief 调用此方法开启直播日志上报。
      */
@@ -7886,6 +7923,10 @@ declare class VePlayerLive extends VePlayerBase {
          */
         source?: string;
     }, needUpdateProtocol?: boolean): Promise<void>;
+    private _resetSEIDelayStats;
+    private _handleSEI;
+    private _getPlayerBufferTime;
+    private _mergeSEIDelayStats;
 }
 /** {zh}
  * @detail api
@@ -11539,6 +11580,7 @@ declare namespace live {
         logger?: LoggerConfig;
     }
     interface LiveEN {
+        INVALID_PARAMETER: string;
         ERROR_TYPES?: any;
         // eslint-disable-next-line @typescript-eslint/member-ordering
         [key: string]: string | unknown;
@@ -12390,9 +12432,11 @@ declare namespace live {
         checkStatsErrorDelay?: number;
         /** {zh}
          * @brief 是否打开 RTM SEI
+         * @default true
          */
         /** {en}
          * @brief enable RTM SEI data.
+         * @default true
          */
         enableSei?: boolean;
     }
@@ -12637,6 +12681,32 @@ declare namespace live {
          */
         avgLostRate?: number;
     }
+    /** {zh}
+     * @list option
+     * @kind property
+     * @brief 服务端 SEI 延迟统计。
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief Server SEI delay statistics.
+     */
+    interface SEIDelayStats {
+        /** {zh}
+         * @brief 服务端链路延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+         */
+        /** {en}
+         * @brief Server-side transfer delay in milliseconds. Empty when valid server SEI data is unavailable.
+         */
+        delay_s2s?: number;
+        /** {zh}
+         * @brief 推流端到播放端的延迟，单位为毫秒。没有有效的服务端 SEI 数据时为空。
+         */
+        /** {en}
+         * @brief Stream-to-end playback delay in milliseconds. Empty when valid server SEI data is unavailable.
+         */
+        delay_s2e?: number;
+    }
     /** {zh}
      * @list option
      * @kind property
@@ -12647,7 +12717,7 @@ declare namespace live {
      * @kind property
      * @brief RTM live stream information.
      */
-    interface StatsSnapShoot {
+    interface StatsSnapShoot extends SEIDelayStats {
         /** {en}
          * @brief Video information.
          */
@@ -12878,7 +12948,7 @@ declare namespace live {
      * @kind property
      * @brief Basic information for live stream playback.
      */
-    interface Stats$0 {
+    interface Stats$0 extends SEIDelayStats {
         /** {zh}
          * @brief 音频格式。
          * @hidden
@@ -13036,6 +13106,7 @@ declare namespace live {
          * @hidden
          */
         _protocolManager?: ProtocolManager;
+        private _seiDelayStats;
         /** {zh}
          * @hidden
          * @param options
@@ -13066,6 +13137,13 @@ declare namespace live {
          * @hidden
          */
         get hls(): any;
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @hidden
+         */
+        destroy(): void;
         /** {zh}
          * @brief 调用此方法开启直播日志上报。
          */
@@ -13218,6 +13296,10 @@ declare namespace live {
              */
             source?: string;
         }, needUpdateProtocol?: boolean): Promise<void>;
+        private _resetSEIDelayStats;
+        private _handleSEI;
+        private _getPlayerBufferTime;
+        private _mergeSEIDelayStats;
     }
     /** {zh}
      * @detail api