@volcengine/veplayer 2.5.0-rc.1 → 2.5.1-rc.0

package/esm/veplayer.biz.live.development.js

@@ -8,6 +8,7 @@ const error = window["VePlayer"].error;
 const { VeError } = error;
 var LiveErrorCode = /* @__PURE__ */ ((LiveErrorCode2) => {
   LiveErrorCode2[LiveErrorCode2["INVALID_PARAMETER"] = 210] = "INVALID_PARAMETER";
+  LiveErrorCode2[LiveErrorCode2["INVALID_LOGGER"] = 220] = "INVALID_LOGGER";
   return LiveErrorCode2;
 })(LiveErrorCode || {});
 error.Level;
@@ -23,35 +24,48 @@ const ERRORS = {
   ]: {
     messageTextKey: "INVALID_PARAMETER",
     level: error.Level.Fatal
+  },
+  [
+    220
+    /* INVALID_LOGGER */
+  ]: {
+    messageTextKey: "INVALID_LOGGER",
+    level: error.Level.Error
   }
 };
 function create(errorCode, i18n) {
-  return new VeError(ERRORS[errorCode], i18n);
+  return new VeError(
+    {
+      errorCode,
+      ...ERRORS[errorCode]
+    },
+    i18n
+  );
 }
 const DynamicModule$4 = window["VePlayer"].DynamicModule;
-const load$4 = window["VePlayer"].load;
+const load$5 = window["VePlayer"].load;
 async function isRTMSupported() {
-  const { RtmPlugin } = await load$4(DynamicModule$4.PluginRtm);
+  const { RtmPlugin } = await load$5(DynamicModule$4.PluginRtm);
   return RtmPlugin.isSupported();
 }
 async function isRTMSupportCodec(codec = RTMCodec.H264) {
-  const { RtmPlugin } = await load$4(DynamicModule$4.PluginRtm);
+  const { RtmPlugin } = await load$5(DynamicModule$4.PluginRtm);
   if (codec === RTMCodec.H264)
     return RtmPlugin.isSupportedH264();
   return false;
 }
-const strategy$1 = window["VePlayer"].strategy;
-const util$4 = window["VePlayer"].util;
+const strategy$2 = window["VePlayer"].strategy;
+const util$6 = window["VePlayer"].util;
 const DynamicModule$3 = window["VePlayer"].DynamicModule;
-const load$3 = window["VePlayer"].load;
-const Codec$1 = window["VePlayer"].Codec;
-const Sniffer$3 = window["VePlayer"].Sniffer;
+const load$4 = window["VePlayer"].load;
+const Codec$3 = window["VePlayer"].Codec;
+const Sniffer$5 = window["VePlayer"].Sniffer;
 const rtmStrategy = {
   options: {},
   module: DynamicModule$3.PluginRtm
 };
 const generateFallbackUrl = (url) => {
-  if (Sniffer$3.device === "pc") {
+  if (Sniffer$5.device === "pc") {
     return url.replace(".sdp", ".flv");
   } else {
     return url.replace(".sdp", ".m3u8");
@@ -68,17 +82,17 @@ const getRtmStrategy = async (options, player) => {
     ...ret
   } = options.rtm || {};
   const actualFallbackUrl = !enableFallback ? "" : !fallbackUrl && url ? generateFallbackUrl(url) : fallbackUrl;
-  const backupType = actualFallbackUrl && util$4.getStreamType(actualFallbackUrl);
-  if (backupType === "flv" && util$4.isMseSupported(Codec$1.H264)) {
-    backupStrategy = strategy$1.createFlvMseStrategy(options);
-  } else if (backupType === "hls" && (Sniffer$3.device !== "mobile" || ((_a = options == null ? void 0 : options.hls) == null ? void 0 : _a.enableMSE)) && util$4.isMseSupported(Codec$1.H264)) {
-    backupStrategy = strategy$1.createHlsMseStrategy(options);
+  const backupType = actualFallbackUrl && util$6.getStreamType(actualFallbackUrl);
+  if (backupType === "flv" && util$6.isMseSupported(Codec$3.H264)) {
+    backupStrategy = strategy$2.createFlvMseStrategy(options);
+  } else if (backupType === "hls" && (Sniffer$5.device !== "mobile" || ((_a = options == null ? void 0 : options.hls) == null ? void 0 : _a.enableMSE)) && util$6.isMseSupported(Codec$3.H264)) {
+    backupStrategy = strategy$2.createHlsMseStrategy(options);
   }
   const [rtmCdn, backupCdn] = await Promise.all([
-    load$3(rtmStrategy.module).then((module) => {
+    load$4(rtmStrategy.module).then((module) => {
       return module.RtmPlugin;
     }).catch(() => void 0),
-    backupStrategy && load$3(backupStrategy.module).then((module) => {
+    backupStrategy && load$4(backupStrategy.module).then((module) => {
       if ((backupStrategy == null ? void 0 : backupStrategy.module) === DynamicModule$3.PluginFlv) {
         return module.FlvPlugin;
       } else if ((backupStrategy == null ? void 0 : backupStrategy.module) === DynamicModule$3.PluginHls) {
@@ -117,7 +131,7 @@ const getRtmStrategy = async (options, player) => {
   return {
     options: {
       ...(backupStrategy == null ? void 0 : backupStrategy.options) || {},
-      url: enableRTMAutoTranscode ? util$4.appendSearchParams(url, { enableRTMAutoTranscode: "true" }) : void 0,
+      url: enableRTMAutoTranscode ? util$6.appendSearchParams(url, { enableRTMAutoTranscode: "true" }) : void 0,
       _RTMdegrade: void 0,
       rts: {
         retryCount: 0,
@@ -129,13 +143,13 @@ const getRtmStrategy = async (options, player) => {
     plugins: rtmCdn ? [rtmCdn] : []
   };
 };
-const Sniffer$2 = window["VePlayer"].Sniffer;
+const Sniffer$4 = window["VePlayer"].Sniffer;
 var DrmType = /* @__PURE__ */ ((DrmType2) => {
   DrmType2["Fairplay"] = "fairplay";
   return DrmType2;
 })(DrmType || {});
 function getDrmType(drm) {
-  if ((drm == null ? void 0 : drm.fairplay) && (Sniffer$2.browser === "safari" || Sniffer$2.os.isIos)) {
+  if ((drm == null ? void 0 : drm.fairplay) && (Sniffer$4.browser === "safari" || Sniffer$4.os.isIos)) {
     return "fairplay";
   }
   return;
@@ -153,6 +167,63 @@ function isMseSupportedWithDrm({
   }
   return true;
 }
+const Sniffer$3 = window["VePlayer"].Sniffer;
+const Codec$2 = window["VePlayer"].Codec;
+const util$5 = window["VePlayer"].util;
+const { isMMSSupported: isMMSSupported$1, isMseSupported: isMseSupported$1 } = util$5;
+function enableMMS() {
+  return Sniffer$3.os.isIos;
+}
+function isFLVSupported(codec = Codec$2.H264) {
+  const isMediaSourceSupported = enableMMS() ? isMMSSupported$1 : isMseSupported$1;
+  return isMediaSourceSupported(codec);
+}
+const strategy$1 = window["VePlayer"].strategy;
+const load$3 = window["VePlayer"].load;
+const Sniffer$2 = window["VePlayer"].Sniffer;
+const Codec$1 = window["VePlayer"].Codec;
+const util$4 = window["VePlayer"].util;
+const { appendSearchParams } = util$4;
+const getFlvStrategy = async (options) => {
+  var _a, _b, _c, _d, _e, _f;
+  let mseStrategy;
+  let softStrategy;
+  const enableLowLatency = ((_a = options == null ? void 0 : options.flv) == null ? void 0 : _a.enableLowLatency) && Sniffer$2.device === "pc";
+  const enableFrameChasing = ((_c = (_b = options == null ? void 0 : options.flv) == null ? void 0 : _b.lowLatency) == null ? void 0 : _c.enableFrameChasing) ?? true;
+  const abrPts = ((_e = (_d = options == null ? void 0 : options.flv) == null ? void 0 : _d.lowLatency) == null ? void 0 : _e.abrPts) ?? "-800";
+  const codec = await strategy$1.getCodec(options);
+  const isSoftDecode = await strategy$1.isSoftDecode(options, codec);
+  if (isSoftDecode) {
+    softStrategy = codec === Codec$1.H265 ? strategy$1.createSoftDecodeH265Strategy() : strategy$1.createSoftDecodeH264Strategy();
+    mseStrategy = strategy$1.createFlvMseStrategy(options);
+  }
+  if (codec === "unknown" ? isFLVSupported(Codec$1.H264) : isFLVSupported(codec)) {
+    mseStrategy = enableMMS() ? strategy$1.createFlvMssStrategy(options) : strategy$1.createFlvMseStrategy(options);
+  }
+  if (!mseStrategy && !softStrategy) {
+    return {};
+  }
+  const [mseModule, softModule] = await Promise.all([
+    (mseStrategy == null ? void 0 : mseStrategy.module) && load$3(mseStrategy.module).catch(() => void 0),
+    (softStrategy == null ? void 0 : softStrategy.module) && load$3(softStrategy.module).catch(() => void 0)
+  ]);
+  (softModule == null ? void 0 : softModule.XGVideoPlugin) && ((_f = softStrategy == null ? void 0 : softStrategy.afterLoad) == null ? void 0 : _f.call(softStrategy, softModule == null ? void 0 : softModule.XGVideoPlugin));
+  const combineOptions = strategy$1.combineOptions([mseStrategy, softStrategy]);
+  const plugins = [];
+  if (enableLowLatency) {
+    combineOptions.url = appendSearchParams(options.url, { abr_pts: abrPts });
+  }
+  if (mseModule) {
+    plugins.push(mseModule.FlvPlugin);
+    if (enableLowLatency && enableFrameChasing) {
+      plugins.push(mseModule.Adaptive);
+    }
+  }
+  return {
+    options: combineOptions,
+    plugins
+  };
+};
 const util$3 = window["VePlayer"].util;
 const strategy = window["VePlayer"].strategy;
 const getTypeStrategy = async (options, player) => {
@@ -164,7 +235,7 @@ const getTypeStrategy = async (options, player) => {
     return await getRtmStrategy(options, player);
   }
   if (type === "flv") {
-    return await strategy.getFlvStrategy(options);
+    return await getFlvStrategy(options);
   }
   if (type === "hls") {
     if (!isMseSupportedWithDrm({ drm: options.drm, streamType: type })) {
@@ -2928,7 +2999,7 @@ class Logger extends Plugin$2 {
   }
   static get defaultConfig() {
     return {
-      appId: "",
+      appId: 654925,
       enable: true,
       showUserIdInErrorPanel: true
     };
@@ -2938,10 +3009,6 @@ class Logger extends Plugin$2 {
     if (!this.config.enable) {
       return;
     }
-    if (!this.config.appId) {
-      console.info("not found appId, please generate an appId");
-      return;
-    }
     this._userId = ((_a = this.config) == null ? void 0 : _a.userId) || getUserId2();
     this._deviceId = ((_b = this.config) == null ? void 0 : _b.deviceId) || getDeviceID2();
     this.open();
@@ -2984,16 +3051,17 @@ class Logger extends Plugin$2 {
     this._liveLogger = new LoggerControl({
       Tea: q,
       player: this.player,
-      aid: this.config.appId,
+      aid: this.config.appId || 654925,
       project_key: this.config.appId,
       app_name: this.config.appName || this.config.appId,
       user_id: this._userId,
       device_id: this._deviceId,
+      error_report_stop: true,
       ext: {
         veplayer_version: "2.3.1-rc.1",
-        flv_version: "3.0.19-rc.0",
-        hls_version: "3.0.20-alpha.2",
-        rts_version: "0.2.1-alpha.0"
+        flv_version: "3.0.21-rc.5",
+        hls_version: "3.0.21-rc.5",
+        rts_version: "0.2.1-alpha.14"
       }
     });
   }
@@ -3229,6 +3297,7 @@ const BaseEN = window["VePlayer"].EN;
 const EN$1 = {
   ...BaseEN,
   INVALID_PARAMETER: "The imported parameter is empty, please pass in necessary parameters such as the stream address",
+  INVALID_LOGGER: "Log options not configured correctly. Please refer to this document https://docs.byteplus.com/en/docs/byteplus-media-live/docs-feature-implementation#uploading-logs to configure the logs.",
   // info-panel
   FORMAT: "format",
   FPS: "fps",
@@ -3247,6 +3316,7 @@ const BaseZH_CN = window["VePlayer"].ZH_CN;
 const ZH_CN$1 = {
   ...BaseZH_CN,
   INVALID_PARAMETER: "入参为空，请传入流地址等必要参数",
+  INVALID_LOGGER: "未正确配置质量日志参数, 请参考 https://www.volcengine.com/docs/6469/138655#日志上报 配置",
   // info-panel
   FORMAT: "格式",
   FPS: "帧率",
@@ -3361,7 +3431,9 @@ VeI18n.extend([
   }
 ]);
 const LIVE_DEFAULT_OPTIONS = {
-  autoplay: { muted: true }
+  autoplay: {
+    muted: true
+  }
 };
 const LIVE_DEFAULT_PLUGINS = [...DEFAULT_PLUGINS, Refresh, Logger, InfoPanel];
 var RTMCodec = /* @__PURE__ */ ((RTMCodec2) => {
@@ -3381,7 +3453,10 @@ class VePlayerLive extends VePlayerBase {
     super(options);
   }
   /** {zh}
-   * @brief 获取已经播放的时间
+   * @brief 获取已经播放的时长，不包含暂停和等待时间，单位为秒。
+   */
+  /** {en}
+   * @brief Obtain the duration that has been played, excluding pause and waiting time, with the unit of seconds.
    */
   get playTime() {
     var _a, _b, _c, _d;
@@ -3440,7 +3515,10 @@ class VePlayerLive extends VePlayerBase {
     (_a = this._player.plugins) == null ? void 0 : _a.infopanel.close();
   }
   /** {zh}
-   * @brief 打开 Abr
+   * @brief 打开码率自适应（ABR）切换功能。
+   */
+  /** {en}
+   * @brief Enable the Adaptive Bitrate Streaming (ABR) switching feature.
    */
   openAbr() {
     var _a, _b, _c, _d;
@@ -3454,7 +3532,10 @@ class VePlayerLive extends VePlayerBase {
     }
   }
   /** {zh}
-   * @brief 关闭 Abr
+   * @brief 关闭码率自适应（ABR）切换功能。
+   */
+  /** {en}
+   * @brief Disable the Adaptive Bitrate Streaming (ABR) switching feature.
    */
   closeAbr() {
     var _a, _b, _c, _d;
@@ -3468,18 +3549,25 @@ class VePlayerLive extends VePlayerBase {
     }
   }
   /** {zh}
-   * @brief 调用此方法更新 DRM 鉴权配置。
-   * @hidden
+   * @brief 调用此方法更新 DRM 配置。
+   */
+  /** {en}
+   * @brief Use this method to update DRM configuration.
+   * @param config
    */
   updateDrmConfig(config) {
     var _a, _b, _c;
     (_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.drm) == null ? void 0 : _c.updateDrmConfig(config);
   }
   /** {zh}
-   * @brief 切换 flv Abr
-   * @param options 切换 Abr 的配置。
+   * @brief 修改 ABR 配置，包含修改是否开启 ABR 功能，和修改其他清晰度。
+   * @param options ABR 的配置。
    * @returns
    */
+  /** {en}
+   * @brief Modify ABR configuration, including enabling or disabling the ABR feature and adjusting other resolutions.
+   * @param options Configuration of ABR.
+   */
   switchAbr(options) {
     var _a, _b;
     if (!((_a = this._player.plugins) == null ? void 0 : _a.abr)) {
@@ -3490,7 +3578,9 @@ class VePlayerLive extends VePlayerBase {
       if (!url) {
         return;
       }
-      this.switch(url, { seamless: true });
+      this.switch(url, {
+        seamless: true
+      });
       this._player.plugins.abr.bitrate = options.bitrate;
     }
     if (typeof (options == null ? void 0 : options.enable) !== "undefined") {
@@ -3498,37 +3588,52 @@ class VePlayerLive extends VePlayerBase {
     }
   }
   /** {zh}
-   * @brief 获取 RTM 的网络相关信息
+   * @brief 获取 RTM 拉流的网络评估信息。
    * @returns
    */
+  /** {en}
+   * @brief Obtain the network assessment information of RTM pull streaming.
+   */
   getRTMNetWorkInfo() {
     var _a, _b, _c;
     return (_c = (_b = (_a = this._player) == null ? void 0 : _a.plugins) == null ? void 0 : _b.rts) == null ? void 0 : _c.getNetWorkInfo();
   }
   /** {zh}
-   * @brief 获取 RTM 播放信息
+   * @brief 获取 RTM 拉流的播放信息。
    * @returns
    */
+  /** {en}
+   * @brief Obtain the playback information of RTM pull stream.
+   */
   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();
   }
   /** {zh}
-   * @brief 获取 FLV 播放信息
+   * @brief 获取 FLV 拉流的播放信息。
    * @returns
    */
+  /** {en}
+   * @brief Obtain the playback information of FLV pull streaming.
+   */
   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();
   }
 }
 async function createLivePlayer(options) {
-  var _a, _b;
+  var _a, _b, _c, _d;
   let player = void 0;
+  const i18n = new VeI18n({
+    lang: options == null ? void 0 : options.lang,
+    i18n: options == null ? void 0 : options.i18n
+  });
   if (!options || !options.url && !options.playlist) {
-    throw create(ErrorCode.INVALID_PARAMETER, new VeI18n());
+    throw create(ErrorCode.INVALID_PARAMETER, i18n);
+  }
+  if (!((_a = options.logger) == null ? void 0 : _a.appId) && ((_b = options == null ? void 0 : options.logger) == null ? void 0 : _b.enable) !== false) {
+    console.warn(create(ErrorCode.INVALID_LOGGER, i18n).message);
   }
-  const i18n = new VeI18n({ lang: options == null ? void 0 : options.lang, i18n: options == null ? void 0 : options.i18n });
   const finalOptions = {
     ...options,
     plugins: [...LIVE_DEFAULT_PLUGINS, ...options.plugins ?? []]
@@ -3546,9 +3651,24 @@ async function createLivePlayer(options) {
       },
       async preparePlugins(url) {
         const [typeStrategy, drmStrategy, abrStrategy] = await Promise.all([
-          getTypeStrategy({ ...finalOptions, url }, player),
-          getDrmStrategy({ ...finalOptions, url }, player),
-          getAbrStrategy({ ...finalOptions, url })
+          getTypeStrategy(
+            {
+              ...finalOptions,
+              url
+            },
+            player
+          ),
+          getDrmStrategy(
+            {
+              ...finalOptions,
+              url
+            },
+            player
+          ),
+          getAbrStrategy({
+            ...finalOptions,
+            url
+          })
         ]);
         const { options: options2, plugins } = typeStrategy ?? {};
         const { options: drmOptions, plugins: drmPlugins } = drmStrategy ?? {};
@@ -3566,7 +3686,7 @@ async function createLivePlayer(options) {
     VePlayerLive
   );
   if (player) {
-    const RTMDegrade = (_b = (_a = player == null ? void 0 : player._player) == null ? void 0 : _a.config) == null ? void 0 : _b._RTMdegrade;
+    const RTMDegrade = (_d = (_c = player == null ? void 0 : player._player) == null ? void 0 : _c.config) == null ? void 0 : _d._RTMdegrade;
     if (RTMDegrade) {
       player.emit("degrade", {
         originRtmUrl: RTMDegrade._originRtmUrl,
@@ -3602,6 +3722,7 @@ const ListType = window["VePlayer"].ListType;
 setModuleSystem("esm");
 const isMseSupported = util.isMseSupported;
 const isSoftDecodeSupported = util.isSoftDecodeSupported;
+const isMMSSupported = util.isMMSSupported;
 export {
   Codec,
   DecodeType,
@@ -3615,6 +3736,8 @@ export {
   Sniffer,
   ZH_CN,
   createLivePlayer,
+  isFLVSupported,
+  isMMSSupported,
   isMseSupported,
   isRTMSupportCodec,
   isRTMSupported,