@byteplus/veplayer 2.12.2-rc.0 → 2.13.1-rc.0

package/veplayer.d.ts

@@ -5424,7 +5424,6 @@ declare namespace error {
 declare namespace event {
     const BaseEvents: {
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5469,7 +5468,6 @@ declare namespace event {
     };
     const Events: {
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -6219,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;
@@ -7060,9 +7059,11 @@ interface Rtm {
     checkStatsErrorDelay?: number;
     /** {zh}
      * @brief 是否打开 RTM SEI
+     * @default true
      */
     /** {en}
      * @brief enable RTM SEI data.
+     * @default true
      */
     enableSei?: boolean;
 }
@@ -7307,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
@@ -7317,7 +7344,7 @@ interface RTMNetWorkInfo {
  * @kind property
  * @brief RTM live stream information.
  */
-interface StatsSnapShoot {
+interface StatsSnapShoot extends SEIDelayStats {
     /** {en}
      * @brief Video information.
      */
@@ -7548,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
@@ -7706,6 +7733,7 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     _protocolManager?: ProtocolManager;
+    private _seiDelayStats;
     /** {zh}
      * @hidden
      * @param options
@@ -7736,6 +7764,13 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     get hls(): any;
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @hidden
+     */
+    destroy(): void;
     /** {zh}
      * @brief 调用此方法开启直播日志上报。
      */
@@ -7888,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
@@ -11541,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;
@@ -12392,9 +12432,11 @@ declare namespace live {
         checkStatsErrorDelay?: number;
         /** {zh}
          * @brief 是否打开 RTM SEI
+         * @default true
          */
         /** {en}
          * @brief enable RTM SEI data.
+         * @default true
          */
         enableSei?: boolean;
     }
@@ -12639,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
@@ -12649,7 +12717,7 @@ declare namespace live {
      * @kind property
      * @brief RTM live stream information.
      */
-    interface StatsSnapShoot {
+    interface StatsSnapShoot extends SEIDelayStats {
         /** {en}
          * @brief Video information.
          */
@@ -12880,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
@@ -13038,6 +13106,7 @@ declare namespace live {
          * @hidden
          */
         _protocolManager?: ProtocolManager;
+        private _seiDelayStats;
         /** {zh}
          * @hidden
          * @param options
@@ -13068,6 +13137,13 @@ declare namespace live {
          * @hidden
          */
         get hls(): any;
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @hidden
+         */
+        destroy(): void;
         /** {zh}
          * @brief 调用此方法开启直播日志上报。
          */
@@ -13220,6 +13296,10 @@ declare namespace live {
              */
             source?: string;
         }, needUpdateProtocol?: boolean): Promise<void>;
+        private _resetSEIDelayStats;
+        private _handleSEI;
+        private _getPlayerBufferTime;
+        private _mergeSEIDelayStats;
     }
     /** {zh}
      * @detail api
@@ -13645,13 +13725,6 @@ declare namespace live {
          * The player parses the SEI information.
          */
         SEI = "sei",
-        /** {zh}
-         * SEI 信息与播放进度对齐。SEI 在解析后会被缓存，待播放进度到达该 SEI 对应的时间点时抛出。
-         */
-        /** {en}
-         * The SEI information is aligned with the playback progress. The player caches the parsed SEI and emits it when the playback progress reaches the timestamp of the SEI.
-         */
-        SEI_IN_TIME = "seiInTime",
         /** {zh}
          * 时移状态切换
          */
@@ -14323,67 +14396,6 @@ declare namespace live {
                 uuid: string;
             };
         }) => void;
-        /** {zh}
-         * SEI 信息与播放进度对齐。
-         * @param data SEI 信息，与 SEI 事件的回调数据结构一致
-         */
-        /** {en}
-         * The SEI information is aligned with the playback progress.
-         * @param data The SEI information. The data structure is the same as that of the SEI event.
-         */
-        [LiveEvents.SEI_IN_TIME]: (data: {
-            /** {zh}
-             * 原始 PTS。视频帧在实际推流中的显示时间戳 PTS。
-             */
-            /** {en}
-             * The actual presentation timestamp (PTS) of the video frame.
-             */
-            originPts: number;
-            /** {zh}
-             * 修正后的 PTS。在直播场景中，播放器会根据观众进入直播间时间，从 0 开始重新定义显示时间戳 PTS。
-             */
-            /** {en}
-             * The adjusted presentation timestamp (PTS). The player adjusts the presentation timestamp based on the time the audience enters the live room.
-             */
-            pts: number;
-            /** {zh}
-             * 该 SEI 消息在当前直播视频中的时间点，单位为 s。
-             */
-            /** {en}
-             * The timestamp of the SEI message in the current live stream, in seconds.
-             */
-            time: number;
-            data: {
-                /** {zh}
-                 * SEI 数据。
-                 */
-                /** {en}
-                 * The SEI data.
-                 */
-                payload: Uint8Array;
-                /** {zh}
-                 * SEI 类型。
-                 */
-                /** {en}
-                 * The SEI type.
-                 */
-                type: number;
-                /** {zh}
-                 * SEI 大小。
-                 */
-                /** {en}
-                 * The SEI size.
-                 */
-                size: number;
-                /** {zh}
-                 * SEI UUID，不存在则为空字符串。
-                 */
-                /** {en}
-                 * The SEI UUID or an empty string if the SEI UUID doesn't exist.
-                 */
-                uuid: string;
-            };
-        }) => void;
         /** {zh}
          * @brief 时移状态切换。
          * @param isTimeShift 是否是时移状态。
@@ -14625,7 +14637,6 @@ declare namespace live {
         HLS_PLAYOUT_LIMIT_REACHED: HLS.Events.PLAYOUT_LIMIT_REACHED;
         HLS_EVENT_CUE_ENTER: HLS.Events.EVENT_CUE_ENTER;
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;

package/veplayer.live.d.ts

@@ -5424,7 +5424,6 @@ declare namespace error {
 declare namespace event {
     const BaseEvents: {
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5469,7 +5468,6 @@ declare namespace event {
     };
     const Events: {
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -6219,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;
@@ -7060,9 +7059,11 @@ interface Rtm {
     checkStatsErrorDelay?: number;
     /** {zh}
      * @brief 是否打开 RTM SEI
+     * @default true
      */
     /** {en}
      * @brief enable RTM SEI data.
+     * @default true
      */
     enableSei?: boolean;
 }
@@ -7307,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
@@ -7317,7 +7344,7 @@ interface RTMNetWorkInfo {
  * @kind property
  * @brief RTM live stream information.
  */
-interface StatsSnapShoot {
+interface StatsSnapShoot extends SEIDelayStats {
     /** {en}
      * @brief Video information.
      */
@@ -7548,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
@@ -7706,6 +7733,7 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     _protocolManager?: ProtocolManager;
+    private _seiDelayStats;
     /** {zh}
      * @hidden
      * @param options
@@ -7736,6 +7764,13 @@ declare class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     get hls(): any;
+    /** {zh}
+     * @hidden
+     */
+    /** {en}
+     * @hidden
+     */
+    destroy(): void;
     /** {zh}
      * @brief 调用此方法开启直播日志上报。
      */
@@ -7888,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
@@ -11541,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;
@@ -12392,9 +12432,11 @@ declare namespace live {
         checkStatsErrorDelay?: number;
         /** {zh}
          * @brief 是否打开 RTM SEI
+         * @default true
          */
         /** {en}
          * @brief enable RTM SEI data.
+         * @default true
          */
         enableSei?: boolean;
     }
@@ -12639,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
@@ -12649,7 +12717,7 @@ declare namespace live {
      * @kind property
      * @brief RTM live stream information.
      */
-    interface StatsSnapShoot {
+    interface StatsSnapShoot extends SEIDelayStats {
         /** {en}
          * @brief Video information.
          */
@@ -12880,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
@@ -13038,6 +13106,7 @@ declare namespace live {
          * @hidden
          */
         _protocolManager?: ProtocolManager;
+        private _seiDelayStats;
         /** {zh}
          * @hidden
          * @param options
@@ -13068,6 +13137,13 @@ declare namespace live {
          * @hidden
          */
         get hls(): any;
+        /** {zh}
+         * @hidden
+         */
+        /** {en}
+         * @hidden
+         */
+        destroy(): void;
         /** {zh}
          * @brief 调用此方法开启直播日志上报。
          */
@@ -13220,6 +13296,10 @@ declare namespace live {
              */
             source?: string;
         }, needUpdateProtocol?: boolean): Promise<void>;
+        private _resetSEIDelayStats;
+        private _handleSEI;
+        private _getPlayerBufferTime;
+        private _mergeSEIDelayStats;
     }
     /** {zh}
      * @detail api
@@ -13645,13 +13725,6 @@ declare namespace live {
          * The player parses the SEI information.
          */
         SEI = "sei",
-        /** {zh}
-         * SEI 信息与播放进度对齐。SEI 在解析后会被缓存，待播放进度到达该 SEI 对应的时间点时抛出。
-         */
-        /** {en}
-         * The SEI information is aligned with the playback progress. The player caches the parsed SEI and emits it when the playback progress reaches the timestamp of the SEI.
-         */
-        SEI_IN_TIME = "seiInTime",
         /** {zh}
          * 时移状态切换
          */
@@ -14323,67 +14396,6 @@ declare namespace live {
                 uuid: string;
             };
         }) => void;
-        /** {zh}
-         * SEI 信息与播放进度对齐。
-         * @param data SEI 信息，与 SEI 事件的回调数据结构一致
-         */
-        /** {en}
-         * The SEI information is aligned with the playback progress.
-         * @param data The SEI information. The data structure is the same as that of the SEI event.
-         */
-        [LiveEvents.SEI_IN_TIME]: (data: {
-            /** {zh}
-             * 原始 PTS。视频帧在实际推流中的显示时间戳 PTS。
-             */
-            /** {en}
-             * The actual presentation timestamp (PTS) of the video frame.
-             */
-            originPts: number;
-            /** {zh}
-             * 修正后的 PTS。在直播场景中，播放器会根据观众进入直播间时间，从 0 开始重新定义显示时间戳 PTS。
-             */
-            /** {en}
-             * The adjusted presentation timestamp (PTS). The player adjusts the presentation timestamp based on the time the audience enters the live room.
-             */
-            pts: number;
-            /** {zh}
-             * 该 SEI 消息在当前直播视频中的时间点，单位为 s。
-             */
-            /** {en}
-             * The timestamp of the SEI message in the current live stream, in seconds.
-             */
-            time: number;
-            data: {
-                /** {zh}
-                 * SEI 数据。
-                 */
-                /** {en}
-                 * The SEI data.
-                 */
-                payload: Uint8Array;
-                /** {zh}
-                 * SEI 类型。
-                 */
-                /** {en}
-                 * The SEI type.
-                 */
-                type: number;
-                /** {zh}
-                 * SEI 大小。
-                 */
-                /** {en}
-                 * The SEI size.
-                 */
-                size: number;
-                /** {zh}
-                 * SEI UUID，不存在则为空字符串。
-                 */
-                /** {en}
-                 * The SEI UUID or an empty string if the SEI UUID doesn't exist.
-                 */
-                uuid: string;
-            };
-        }) => void;
         /** {zh}
          * @brief 时移状态切换。
          * @param isTimeShift 是否是时移状态。
@@ -14625,7 +14637,6 @@ declare namespace live {
         HLS_PLAYOUT_LIMIT_REACHED: HLS.Events.PLAYOUT_LIMIT_REACHED;
         HLS_EVENT_CUE_ENTER: HLS.Events.EVENT_CUE_ENTER;
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;

package/veplayer.vod.d.ts

@@ -5080,7 +5080,6 @@ declare namespace error {
 declare namespace event {
     const BaseEvents: {
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;
@@ -5125,7 +5124,6 @@ declare namespace event {
     };
     const Events: {
         SEI: string;
-        SEI_IN_TIME: string;
         PLAYER_CREATE_FINISH: string;
         FALLBACK_ERROR: string;
         FALLBACK: string;