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

package/esm/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/esm/veplayer.development.js

@@ -10905,8 +10905,6 @@ var ZH = {
 const BaseEvents = {
   // sei
   SEI: "sei",
-  // sei，在播放时间对齐到该 sei 的时间戳时抛出
-  SEI_IN_TIME: "seiInTime",
   // 播放器完成创建
   PLAYER_CREATE_FINISH: "playerCreateFinish",
   FALLBACK_ERROR: "fallbackError",
@@ -10967,10 +10965,6 @@ const EVENT_TRANSFORMATION = {
     event: "core_event",
     shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.sei"
   },
-  [BaseEvents.SEI_IN_TIME]: {
-    event: "core_event",
-    shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.seiintime"
-  },
   [BaseEvents.RTM_NETWORK]: {
     event: "core_event",
     shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.rtcnetwork"
@@ -14717,7 +14711,7 @@ class VePlayerBase {
    * @brief Retrieve the player SDK version number.
    */
   get playerVersion() {
-    return "2.12.2-rc.0";
+    return "2.13.1-rc.0";
   }
   /** {zh}
    * @brief 获取当前播放视频的清晰度唯一标识（definition）。
@@ -56512,7 +56506,7 @@ let Logger$1 = class Logger2 extends Plugin {
       device_id: deviceId,
       error_report_stop: true,
       ext: {
-        veplayer_version: "2.12.2-rc.0",
+        veplayer_version: "2.13.1-rc.0",
         flv_version: "3.0.24-rc.6",
         hls_version: "3.0.24-rc.2",
         rts_version: "0.2.1-alpha.64"
@@ -56526,7 +56520,6 @@ function normalizeNumber(value, transform2) {
   return transform2 ? transform2(value) : value.toString();
 }
 function getDefaultRow(data2) {
-  var _a;
   return {
     rows: [
       {
@@ -56567,7 +56560,10 @@ function getDefaultRow(data2) {
       {
         key: "bufferEnd",
         labelTextKey: "BUFFER_END",
-        value: normalizeNumber(Number((_a = data2.bufferEnd) == null ? void 0 : _a.toFixed(2)))
+        value: normalizeNumber(
+          data2.bufferEnd,
+          (value) => Number(value.toFixed(2)).toString()
+        )
       },
       {
         key: "currentTime",
@@ -73909,6 +73905,79 @@ class LiveVeStrategy {
   }
 }
 const liveVeStrategy = new LiveVeStrategy();
+const isNumber = (value) => typeof value === "number" && Number.isFinite(value);
+const getTimestamp = (delaySEI, currentKey, legacyKey) => {
+  const currentValue = delaySEI[currentKey];
+  if (isNumber(currentValue)) {
+    return currentValue;
+  }
+  const legacyValue = delaySEI[legacyKey];
+  return isNumber(legacyValue) ? legacyValue : void 0;
+};
+const utf8ArrayToString = (array) => {
+  let result = "";
+  let index = 0;
+  while (index < array.length) {
+    const first = array[index++];
+    if (first < 128) {
+      result += String.fromCharCode(first);
+    } else if (first < 224) {
+      const second = array[index++];
+      result += String.fromCharCode((first & 31) << 6 | second & 63);
+    } else {
+      const second = array[index++];
+      const third = array[index++];
+      result += String.fromCharCode(
+        (first & 15) << 12 | (second & 63) << 6 | third & 63
+      );
+    }
+  }
+  return result;
+};
+const getSEIDelayStats = (sei, bufferTime = 0, now3 = Date.now()) => {
+  if ((sei == null ? void 0 : sei.code) !== 100 || !sei.content) {
+    return;
+  }
+  try {
+    const rawSEI = utf8ArrayToString(sei.content);
+    const jsonStart = rawSEI.indexOf("{");
+    const jsonEnd = rawSEI.lastIndexOf("}");
+    if (jsonStart < 0 || jsonEnd < jsonStart) {
+      return;
+    }
+    const seiContent = JSON.parse(rawSEI.slice(jsonStart, jsonEnd + 1));
+    const delaySEI = seiContent == null ? void 0 : seiContent.video_e2e_delay;
+    if (!delaySEI || typeof delaySEI !== "object") {
+      return;
+    }
+    const push3 = getTimestamp(delaySEI, "push_edge_ts", "push_node");
+    const source = getTimestamp(delaySEI, "source_ts", "source_node");
+    const cmafSource = getTimestamp(
+      delaySEI,
+      "cmaf_source_ts",
+      "cmaf_source_node"
+    );
+    const hlsSource = getTimestamp(
+      delaySEI,
+      "hls_source_ts",
+      "hls_source_node"
+    );
+    const pull = getTimestamp(delaySEI, "pull_edge_ts", "pull_node");
+    const start = push3 ?? source;
+    const end = pull ?? hlsSource ?? cmafSource;
+    if (!isNumber(start) || !isNumber(end)) {
+      return;
+    }
+    const delayS2S = end - start;
+    const safeBufferTime = isNumber(bufferTime) ? Math.max(0, bufferTime) : 0;
+    return {
+      delay_s2s: delayS2S,
+      delay_s2e: delayS2S + Math.max(0, now3 - end) + safeBufferTime
+    };
+  } catch (e2) {
+    return;
+  }
+};
 VeI18n.extend([
   {
     LANG: "zh-cn",
@@ -73947,6 +74016,22 @@ class VePlayerLive extends VePlayerBase {
      * @hidden
      */
     __publicField(this, "_protocolManager");
+    __publicField(this, "_seiDelayStats", {});
+    __publicField(this, "_resetSEIDelayStats", () => {
+      this._seiDelayStats = {};
+    });
+    __publicField(this, "_handleSEI", (data2) => {
+      const stats = getSEIDelayStats(data2 == null ? void 0 : data2.sei, this._getPlayerBufferTime());
+      if (stats) {
+        this._seiDelayStats = stats;
+      }
+    });
+    this.on(Events.SEI, this._handleSEI);
+    this.on(Events.URL_CHANGE, this._resetSEIDelayStats);
+    this.on(Events.SOURCE_CHANGE, this._resetSEIDelayStats);
+    this.on(Events.DEFINITION_CHANGE, this._resetSEIDelayStats);
+    this.on(Events.REPLAY, this._resetSEIDelayStats);
+    this.on(Events.FALLBACK, this._resetSEIDelayStats);
   }
   /** {zh}
    * @brief 获取已经播放的时长，不包含暂停和等待时间，单位为秒。
@@ -73988,6 +74073,22 @@ class VePlayerLive extends VePlayerBase {
     var _a, _b;
     return (_b = (_a = this._player.plugins) == null ? void 0 : _a.hls) == null ? void 0 : _b.hls;
   }
+  /** {zh}
+   * @hidden
+   */
+  /** {en}
+   * @hidden
+   */
+  destroy() {
+    this.off(Events.SEI, this._handleSEI);
+    this.off(Events.URL_CHANGE, this._resetSEIDelayStats);
+    this.off(Events.SOURCE_CHANGE, this._resetSEIDelayStats);
+    this.off(Events.DEFINITION_CHANGE, this._resetSEIDelayStats);
+    this.off(Events.REPLAY, this._resetSEIDelayStats);
+    this.off(Events.FALLBACK, this._resetSEIDelayStats);
+    this._resetSEIDelayStats();
+    super.destroy();
+  }
   /** {zh}
    * @brief 调用此方法开启直播日志上报。
    */
@@ -74124,7 +74225,8 @@ class VePlayerLive extends VePlayerBase {
    */
   async getRTMStats() {
     var _a, _b, _c;
-    return (_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.rts) == null ? void 0 : _c.getStatsSnapshoot();
+    const stats = await ((_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.rts) == null ? void 0 : _c.getStatsSnapshoot());
+    return this._mergeSEIDelayStats(stats);
   }
   /** {zh}
    * @brief 获取 FLV 拉流的播放信息。
@@ -74135,7 +74237,8 @@ class VePlayerLive extends VePlayerBase {
    */
   getFLVStats() {
     var _a, _b, _c;
-    return (_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.flv) == null ? void 0 : _c.getStats();
+    const stats = (_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.flv) == null ? void 0 : _c.getStats();
+    return this._mergeSEIDelayStats(stats);
   }
   /** {zh}
    * @brief 获取 HLS 拉流的播放信息。
@@ -74147,8 +74250,9 @@ class VePlayerLive extends VePlayerBase {
    * @hidden
    */
   getHLSStats() {
-    var _a, _b, _c;
-    return (_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.hls) == null ? void 0 : _c.getStats();
+    var _a, _b, _c, _d;
+    const stats = ((_d = (_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.hls) == null ? void 0 : _c.getStats) == null ? void 0 : _d.call(_c)) ?? {};
+    return this._mergeSEIDelayStats(stats);
   }
   /** {en}
    * @brief This method is used to update the playlist, supporting updates to source, resolution, and related information.
@@ -74176,6 +74280,40 @@ class VePlayerLive extends VePlayerBase {
     }
     return super.updatePlaylist(playlist, target);
   }
+  _getPlayerBufferTime() {
+    var _a, _b, _c, _d, _e2;
+    try {
+      const rtm = ((_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.rts) ?? ((_d = (_c = this._player) == null ? void 0 : _c.plugins) == null ? void 0 : _d.rtm);
+      if (rtm) {
+        const jitterBufferDelay = rtm.jitterBufferDelay;
+        if (Number.isFinite(jitterBufferDelay) && jitterBufferDelay >= 0) {
+          return jitterBufferDelay;
+        }
+      }
+    } catch (e2) {
+    }
+    const video = (_e2 = this._player) == null ? void 0 : _e2.video;
+    const buffered = video == null ? void 0 : video.buffered;
+    if (!video || !(buffered == null ? void 0 : buffered.length)) {
+      return 0;
+    }
+    try {
+      return Math.trunc(
+        (buffered.end(buffered.length - 1) - video.currentTime) * 1e3
+      );
+    } catch (e2) {
+      return 0;
+    }
+  }
+  _mergeSEIDelayStats(stats) {
+    if (!stats) {
+      return stats;
+    }
+    return {
+      ...stats,
+      ...this._seiDelayStats
+    };
+  }
 }
 async function createLivePlayer(options) {
   var _a, _b, _c, _d, _e2, _f, _g, _h, _i2, _j, _k;
@@ -74208,6 +74346,10 @@ async function createLivePlayer(options) {
     playerOptions,
     recommendation
   );
+  finalOptions.rtm = {
+    enableSei: true,
+    ...finalOptions.rtm
+  };
   await liveLicenseManager.create();
   const licenseFatalError = liveLicenseManager.getLicenseFatalError();
   const protocolManager = await ProtocolManager.create(finalOptions);
@@ -74311,7 +74453,7 @@ async function prepare(options) {
   }
   await ((_a = liveVeStrategy.veStrategyManager) == null ? void 0 : _a.init({
     ...options,
-    playerVersion: "2.12.2-rc.0",
+    playerVersion: "2.13.1-rc.0",
     type: "LIVE"
   }));
   return liveVeStrategy.veStrategyManager;