@volcengine/veplayer 2.12.0 → 2.12.2-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/veplayer.d.ts CHANGED
@@ -5424,6 +5424,7 @@ declare namespace error {
5424
5424
  declare namespace event {
5425
5425
  const BaseEvents: {
5426
5426
  SEI: string;
5427
+ SEI_IN_TIME: string;
5427
5428
  PLAYER_CREATE_FINISH: string;
5428
5429
  FALLBACK_ERROR: string;
5429
5430
  FALLBACK: string;
@@ -5468,6 +5469,7 @@ declare namespace event {
5468
5469
  };
5469
5470
  const Events: {
5470
5471
  SEI: string;
5472
+ SEI_IN_TIME: string;
5471
5473
  PLAYER_CREATE_FINISH: string;
5472
5474
  FALLBACK_ERROR: string;
5473
5475
  FALLBACK: string;
@@ -5619,15 +5621,56 @@ declare class Sources extends OptionsIcon {
5619
5621
  to: Source;
5620
5622
  }): void;
5621
5623
  }
5624
+ /**
5625
+ * @brief 自动播放配置。
5626
+ * @list Options
5627
+ * @kind property
5628
+ */
5629
+ /** {en}
5630
+ * @brief Autoplay configuration.
5631
+ * @list Options
5632
+ * @kind property
5633
+ */
5622
5634
  interface IAutoplayPluginConfig {
5635
+ /**
5636
+ * @hidden
5637
+ */
5623
5638
  position?: string;
5624
- // 有声音自动播放失败时是否降级成静音自动播放
5639
+ /** {zh}
5640
+ * @brief 有声音自动播放失败时是否降级成静音自动播放。
5641
+ * @default false
5642
+ */
5643
+ /** {en}
5644
+ * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
5645
+ * @default false
5646
+ */
5625
5647
  enableDegradeMuteAutoplay?: boolean;
5626
- // 启用微信jsBridge方式的自动播放
5648
+ /** {zh}
5649
+ * @brief 启用微信jsBridge方式的自动播放。
5650
+ * @default false
5651
+ */
5652
+ /** {en}
5653
+ * @brief Whether to enable wxJsBridge autoplay.
5654
+ * @default false
5655
+ */
5627
5656
  enableWxJsBridgeAutoplay?: boolean;
5628
- // 用户触发自动播放的目标dom
5657
+ /** {zh}
5658
+ * @brief 用户触发自动播放的目标dom。
5659
+ * @default window.document.body
5660
+ */
5661
+ /** {en}
5662
+ * @brief The target dom of user action autoplay.
5663
+ * @default window.document.body
5664
+ */
5629
5665
  userActionDom?: Node;
5630
- // 开启任意点击/触摸的用户行为触发自动播放
5666
+ /** {zh}
5667
+ * @brief 开启任意点击/触摸的用户行为触发自动播放。
5668
+ * @default false
5669
+ */
5670
+ /** {en}
5671
+ * @brief Whether to enable user action autoplay.
5672
+ * @default false
5673
+ */
5631
5674
  enableUserActionAutoplay?: boolean;
5632
5675
  }
5633
5676
  declare class Autoplay extends Plugin {
@@ -10764,15 +10807,56 @@ declare namespace live {
10764
10807
  to: Source;
10765
10808
  }): void;
10766
10809
  }
10810
+ /**
10811
+ * @brief 自动播放配置。
10812
+ * @list Options
10813
+ * @kind property
10814
+ */
10815
+ /** {en}
10816
+ * @brief Autoplay configuration.
10817
+ * @list Options
10818
+ * @kind property
10819
+ */
10767
10820
  interface IAutoplayPluginConfig {
10821
+ /**
10822
+ * @hidden
10823
+ */
10768
10824
  position?: string;
10769
- // 有声音自动播放失败时是否降级成静音自动播放
10825
+ /** {zh}
10826
+ * @brief 有声音自动播放失败时是否降级成静音自动播放。
10827
+ * @default false
10828
+ */
10829
+ /** {en}
10830
+ * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
10831
+ * @default false
10832
+ */
10770
10833
  enableDegradeMuteAutoplay?: boolean;
10771
- // 启用微信jsBridge方式的自动播放
10834
+ /** {zh}
10835
+ * @brief 启用微信jsBridge方式的自动播放。
10836
+ * @default false
10837
+ */
10838
+ /** {en}
10839
+ * @brief Whether to enable wxJsBridge autoplay.
10840
+ * @default false
10841
+ */
10772
10842
  enableWxJsBridgeAutoplay?: boolean;
10773
- // 用户触发自动播放的目标dom
10843
+ /** {zh}
10844
+ * @brief 用户触发自动播放的目标dom。
10845
+ * @default window.document.body
10846
+ */
10847
+ /** {en}
10848
+ * @brief The target dom of user action autoplay.
10849
+ * @default window.document.body
10850
+ */
10774
10851
  userActionDom?: Node;
10775
- // 开启任意点击/触摸的用户行为触发自动播放
10852
+ /** {zh}
10853
+ * @brief 开启任意点击/触摸的用户行为触发自动播放。
10854
+ * @default false
10855
+ */
10856
+ /** {en}
10857
+ * @brief Whether to enable user action autoplay.
10858
+ * @default false
10859
+ */
10776
10860
  enableUserActionAutoplay?: boolean;
10777
10861
  }
10778
10862
  class Autoplay extends Plugin {
@@ -13561,6 +13645,13 @@ declare namespace live {
13561
13645
  * The player parses the SEI information.
13562
13646
  */
13563
13647
  SEI = "sei",
13648
+ /** {zh}
13649
+ * SEI 信息与播放进度对齐。SEI 在解析后会被缓存,待播放进度到达该 SEI 对应的时间点时抛出。
13650
+ */
13651
+ /** {en}
13652
+ * 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.
13653
+ */
13654
+ SEI_IN_TIME = "seiInTime",
13564
13655
  /** {zh}
13565
13656
  * 时移状态切换
13566
13657
  */
@@ -14232,6 +14323,67 @@ declare namespace live {
14232
14323
  uuid: string;
14233
14324
  };
14234
14325
  }) => void;
14326
+ /** {zh}
14327
+ * SEI 信息与播放进度对齐。
14328
+ * @param data SEI 信息,与 SEI 事件的回调数据结构一致
14329
+ */
14330
+ /** {en}
14331
+ * The SEI information is aligned with the playback progress.
14332
+ * @param data The SEI information. The data structure is the same as that of the SEI event.
14333
+ */
14334
+ [LiveEvents.SEI_IN_TIME]: (data: {
14335
+ /** {zh}
14336
+ * 原始 PTS。视频帧在实际推流中的显示时间戳 PTS。
14337
+ */
14338
+ /** {en}
14339
+ * The actual presentation timestamp (PTS) of the video frame.
14340
+ */
14341
+ originPts: number;
14342
+ /** {zh}
14343
+ * 修正后的 PTS。在直播场景中,播放器会根据观众进入直播间时间,从 0 开始重新定义显示时间戳 PTS。
14344
+ */
14345
+ /** {en}
14346
+ * The adjusted presentation timestamp (PTS). The player adjusts the presentation timestamp based on the time the audience enters the live room.
14347
+ */
14348
+ pts: number;
14349
+ /** {zh}
14350
+ * 该 SEI 消息在当前直播视频中的时间点,单位为 s。
14351
+ */
14352
+ /** {en}
14353
+ * The timestamp of the SEI message in the current live stream, in seconds.
14354
+ */
14355
+ time: number;
14356
+ data: {
14357
+ /** {zh}
14358
+ * SEI 数据。
14359
+ */
14360
+ /** {en}
14361
+ * The SEI data.
14362
+ */
14363
+ payload: Uint8Array;
14364
+ /** {zh}
14365
+ * SEI 类型。
14366
+ */
14367
+ /** {en}
14368
+ * The SEI type.
14369
+ */
14370
+ type: number;
14371
+ /** {zh}
14372
+ * SEI 大小。
14373
+ */
14374
+ /** {en}
14375
+ * The SEI size.
14376
+ */
14377
+ size: number;
14378
+ /** {zh}
14379
+ * SEI UUID,不存在则为空字符串。
14380
+ */
14381
+ /** {en}
14382
+ * The SEI UUID or an empty string if the SEI UUID doesn't exist.
14383
+ */
14384
+ uuid: string;
14385
+ };
14386
+ }) => void;
14235
14387
  /** {zh}
14236
14388
  * @brief 时移状态切换。
14237
14389
  * @param isTimeShift 是否是时移状态。
@@ -14473,6 +14625,7 @@ declare namespace live {
14473
14625
  HLS_PLAYOUT_LIMIT_REACHED: HLS.Events.PLAYOUT_LIMIT_REACHED;
14474
14626
  HLS_EVENT_CUE_ENTER: HLS.Events.EVENT_CUE_ENTER;
14475
14627
  SEI: string;
14628
+ SEI_IN_TIME: string;
14476
14629
  PLAYER_CREATE_FINISH: string;
14477
14630
  FALLBACK_ERROR: string;
14478
14631
  FALLBACK: string;
@@ -10905,6 +10905,8 @@ var ZH = {
10905
10905
  const BaseEvents = {
10906
10906
  // sei
10907
10907
  SEI: "sei",
10908
+ // sei,在播放时间对齐到该 sei 的时间戳时抛出
10909
+ SEI_IN_TIME: "seiInTime",
10908
10910
  // 播放器完成创建
10909
10911
  PLAYER_CREATE_FINISH: "playerCreateFinish",
10910
10912
  FALLBACK_ERROR: "fallbackError",
@@ -10965,6 +10967,10 @@ const EVENT_TRANSFORMATION = {
10965
10967
  event: "core_event",
10966
10968
  shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.sei"
10967
10969
  },
10970
+ [BaseEvents.SEI_IN_TIME]: {
10971
+ event: "core_event",
10972
+ shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.seiintime"
10973
+ },
10968
10974
  [BaseEvents.RTM_NETWORK]: {
10969
10975
  event: "core_event",
10970
10976
  shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.rtcnetwork"
@@ -14711,7 +14717,7 @@ class VePlayerBase {
14711
14717
  * @brief Retrieve the player SDK version number.
14712
14718
  */
14713
14719
  get playerVersion() {
14714
- return "2.12.0";
14720
+ return "2.12.2-rc.0";
14715
14721
  }
14716
14722
  /** {zh}
14717
14723
  * @brief 获取当前播放视频的清晰度唯一标识(definition)。
@@ -56506,7 +56512,7 @@ let Logger$1 = class Logger2 extends Plugin {
56506
56512
  device_id: deviceId,
56507
56513
  error_report_stop: true,
56508
56514
  ext: {
56509
- veplayer_version: "2.12.0",
56515
+ veplayer_version: "2.12.2-rc.0",
56510
56516
  flv_version: "3.0.24-rc.6",
56511
56517
  hls_version: "3.0.24-rc.2",
56512
56518
  rts_version: "0.2.1-alpha.64"
@@ -62017,7 +62023,8 @@ class TeaTracker {
62017
62023
  Tea.init({
62018
62024
  ...teaOptions,
62019
62025
  app_id: 468759,
62020
- channel: "cn"
62026
+ channel: "cn",
62027
+ channel_domain: void 0
62021
62028
  });
62022
62029
  Tea.start();
62023
62030
  Tea.config({
@@ -74303,7 +74310,7 @@ async function prepare(options) {
74303
74310
  }
74304
74311
  await ((_a = liveVeStrategy.veStrategyManager) == null ? void 0 : _a.init({
74305
74312
  ...options,
74306
- playerVersion: "2.12.0",
74313
+ playerVersion: "2.12.2-rc.0",
74307
74314
  type: "LIVE"
74308
74315
  }));
74309
74316
  return liveVeStrategy.veStrategyManager;
@@ -5424,6 +5424,7 @@ declare namespace error {
5424
5424
  declare namespace event {
5425
5425
  const BaseEvents: {
5426
5426
  SEI: string;
5427
+ SEI_IN_TIME: string;
5427
5428
  PLAYER_CREATE_FINISH: string;
5428
5429
  FALLBACK_ERROR: string;
5429
5430
  FALLBACK: string;
@@ -5468,6 +5469,7 @@ declare namespace event {
5468
5469
  };
5469
5470
  const Events: {
5470
5471
  SEI: string;
5472
+ SEI_IN_TIME: string;
5471
5473
  PLAYER_CREATE_FINISH: string;
5472
5474
  FALLBACK_ERROR: string;
5473
5475
  FALLBACK: string;
@@ -5619,15 +5621,56 @@ declare class Sources extends OptionsIcon {
5619
5621
  to: Source;
5620
5622
  }): void;
5621
5623
  }
5624
+ /**
5625
+ * @brief 自动播放配置。
5626
+ * @list Options
5627
+ * @kind property
5628
+ */
5629
+ /** {en}
5630
+ * @brief Autoplay configuration.
5631
+ * @list Options
5632
+ * @kind property
5633
+ */
5622
5634
  interface IAutoplayPluginConfig {
5635
+ /**
5636
+ * @hidden
5637
+ */
5623
5638
  position?: string;
5624
- // 有声音自动播放失败时是否降级成静音自动播放
5639
+ /** {zh}
5640
+ * @brief 有声音自动播放失败时是否降级成静音自动播放。
5641
+ * @default false
5642
+ */
5643
+ /** {en}
5644
+ * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
5645
+ * @default false
5646
+ */
5625
5647
  enableDegradeMuteAutoplay?: boolean;
5626
- // 启用微信jsBridge方式的自动播放
5648
+ /** {zh}
5649
+ * @brief 启用微信jsBridge方式的自动播放。
5650
+ * @default false
5651
+ */
5652
+ /** {en}
5653
+ * @brief Whether to enable wxJsBridge autoplay.
5654
+ * @default false
5655
+ */
5627
5656
  enableWxJsBridgeAutoplay?: boolean;
5628
- // 用户触发自动播放的目标dom
5657
+ /** {zh}
5658
+ * @brief 用户触发自动播放的目标dom。
5659
+ * @default window.document.body
5660
+ */
5661
+ /** {en}
5662
+ * @brief The target dom of user action autoplay.
5663
+ * @default window.document.body
5664
+ */
5629
5665
  userActionDom?: Node;
5630
- // 开启任意点击/触摸的用户行为触发自动播放
5666
+ /** {zh}
5667
+ * @brief 开启任意点击/触摸的用户行为触发自动播放。
5668
+ * @default false
5669
+ */
5670
+ /** {en}
5671
+ * @brief Whether to enable user action autoplay.
5672
+ * @default false
5673
+ */
5631
5674
  enableUserActionAutoplay?: boolean;
5632
5675
  }
5633
5676
  declare class Autoplay extends Plugin {
@@ -10764,15 +10807,56 @@ declare namespace live {
10764
10807
  to: Source;
10765
10808
  }): void;
10766
10809
  }
10810
+ /**
10811
+ * @brief 自动播放配置。
10812
+ * @list Options
10813
+ * @kind property
10814
+ */
10815
+ /** {en}
10816
+ * @brief Autoplay configuration.
10817
+ * @list Options
10818
+ * @kind property
10819
+ */
10767
10820
  interface IAutoplayPluginConfig {
10821
+ /**
10822
+ * @hidden
10823
+ */
10768
10824
  position?: string;
10769
- // 有声音自动播放失败时是否降级成静音自动播放
10825
+ /** {zh}
10826
+ * @brief 有声音自动播放失败时是否降级成静音自动播放。
10827
+ * @default false
10828
+ */
10829
+ /** {en}
10830
+ * @brief Whether to downgrade to muted autoplay when sound autoplay fails.
10831
+ * @default false
10832
+ */
10770
10833
  enableDegradeMuteAutoplay?: boolean;
10771
- // 启用微信jsBridge方式的自动播放
10834
+ /** {zh}
10835
+ * @brief 启用微信jsBridge方式的自动播放。
10836
+ * @default false
10837
+ */
10838
+ /** {en}
10839
+ * @brief Whether to enable wxJsBridge autoplay.
10840
+ * @default false
10841
+ */
10772
10842
  enableWxJsBridgeAutoplay?: boolean;
10773
- // 用户触发自动播放的目标dom
10843
+ /** {zh}
10844
+ * @brief 用户触发自动播放的目标dom。
10845
+ * @default window.document.body
10846
+ */
10847
+ /** {en}
10848
+ * @brief The target dom of user action autoplay.
10849
+ * @default window.document.body
10850
+ */
10774
10851
  userActionDom?: Node;
10775
- // 开启任意点击/触摸的用户行为触发自动播放
10852
+ /** {zh}
10853
+ * @brief 开启任意点击/触摸的用户行为触发自动播放。
10854
+ * @default false
10855
+ */
10856
+ /** {en}
10857
+ * @brief Whether to enable user action autoplay.
10858
+ * @default false
10859
+ */
10776
10860
  enableUserActionAutoplay?: boolean;
10777
10861
  }
10778
10862
  class Autoplay extends Plugin {
@@ -13561,6 +13645,13 @@ declare namespace live {
13561
13645
  * The player parses the SEI information.
13562
13646
  */
13563
13647
  SEI = "sei",
13648
+ /** {zh}
13649
+ * SEI 信息与播放进度对齐。SEI 在解析后会被缓存,待播放进度到达该 SEI 对应的时间点时抛出。
13650
+ */
13651
+ /** {en}
13652
+ * 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.
13653
+ */
13654
+ SEI_IN_TIME = "seiInTime",
13564
13655
  /** {zh}
13565
13656
  * 时移状态切换
13566
13657
  */
@@ -14232,6 +14323,67 @@ declare namespace live {
14232
14323
  uuid: string;
14233
14324
  };
14234
14325
  }) => void;
14326
+ /** {zh}
14327
+ * SEI 信息与播放进度对齐。
14328
+ * @param data SEI 信息,与 SEI 事件的回调数据结构一致
14329
+ */
14330
+ /** {en}
14331
+ * The SEI information is aligned with the playback progress.
14332
+ * @param data The SEI information. The data structure is the same as that of the SEI event.
14333
+ */
14334
+ [LiveEvents.SEI_IN_TIME]: (data: {
14335
+ /** {zh}
14336
+ * 原始 PTS。视频帧在实际推流中的显示时间戳 PTS。
14337
+ */
14338
+ /** {en}
14339
+ * The actual presentation timestamp (PTS) of the video frame.
14340
+ */
14341
+ originPts: number;
14342
+ /** {zh}
14343
+ * 修正后的 PTS。在直播场景中,播放器会根据观众进入直播间时间,从 0 开始重新定义显示时间戳 PTS。
14344
+ */
14345
+ /** {en}
14346
+ * The adjusted presentation timestamp (PTS). The player adjusts the presentation timestamp based on the time the audience enters the live room.
14347
+ */
14348
+ pts: number;
14349
+ /** {zh}
14350
+ * 该 SEI 消息在当前直播视频中的时间点,单位为 s。
14351
+ */
14352
+ /** {en}
14353
+ * The timestamp of the SEI message in the current live stream, in seconds.
14354
+ */
14355
+ time: number;
14356
+ data: {
14357
+ /** {zh}
14358
+ * SEI 数据。
14359
+ */
14360
+ /** {en}
14361
+ * The SEI data.
14362
+ */
14363
+ payload: Uint8Array;
14364
+ /** {zh}
14365
+ * SEI 类型。
14366
+ */
14367
+ /** {en}
14368
+ * The SEI type.
14369
+ */
14370
+ type: number;
14371
+ /** {zh}
14372
+ * SEI 大小。
14373
+ */
14374
+ /** {en}
14375
+ * The SEI size.
14376
+ */
14377
+ size: number;
14378
+ /** {zh}
14379
+ * SEI UUID,不存在则为空字符串。
14380
+ */
14381
+ /** {en}
14382
+ * The SEI UUID or an empty string if the SEI UUID doesn't exist.
14383
+ */
14384
+ uuid: string;
14385
+ };
14386
+ }) => void;
14235
14387
  /** {zh}
14236
14388
  * @brief 时移状态切换。
14237
14389
  * @param isTimeShift 是否是时移状态。
@@ -14473,6 +14625,7 @@ declare namespace live {
14473
14625
  HLS_PLAYOUT_LIMIT_REACHED: HLS.Events.PLAYOUT_LIMIT_REACHED;
14474
14626
  HLS_EVENT_CUE_ENTER: HLS.Events.EVENT_CUE_ENTER;
14475
14627
  SEI: string;
14628
+ SEI_IN_TIME: string;
14476
14629
  PLAYER_CREATE_FINISH: string;
14477
14630
  FALLBACK_ERROR: string;
14478
14631
  FALLBACK: string;
@@ -10905,6 +10905,8 @@ var ZH = {
10905
10905
  const BaseEvents = {
10906
10906
  // sei
10907
10907
  SEI: "sei",
10908
+ // sei,在播放时间对齐到该 sei 的时间戳时抛出
10909
+ SEI_IN_TIME: "seiInTime",
10908
10910
  // 播放器完成创建
10909
10911
  PLAYER_CREATE_FINISH: "playerCreateFinish",
10910
10912
  FALLBACK_ERROR: "fallbackError",
@@ -10965,6 +10967,10 @@ const EVENT_TRANSFORMATION = {
10965
10967
  event: "core_event",
10966
10968
  shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.sei"
10967
10969
  },
10970
+ [BaseEvents.SEI_IN_TIME]: {
10971
+ event: "core_event",
10972
+ shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.seiintime"
10973
+ },
10968
10974
  [BaseEvents.RTM_NETWORK]: {
10969
10975
  event: "core_event",
10970
10976
  shouldCallback: (data2) => (data2 == null ? void 0 : data2.eventName) === "core.rtcnetwork"
@@ -14711,7 +14717,7 @@ class VePlayerBase {
14711
14717
  * @brief Retrieve the player SDK version number.
14712
14718
  */
14713
14719
  get playerVersion() {
14714
- return "2.12.0";
14720
+ return "2.12.2-rc.0";
14715
14721
  }
14716
14722
  /** {zh}
14717
14723
  * @brief 获取当前播放视频的清晰度唯一标识(definition)。
@@ -56506,7 +56512,7 @@ let Logger$1 = class Logger2 extends Plugin {
56506
56512
  device_id: deviceId,
56507
56513
  error_report_stop: true,
56508
56514
  ext: {
56509
- veplayer_version: "2.12.0",
56515
+ veplayer_version: "2.12.2-rc.0",
56510
56516
  flv_version: "3.0.24-rc.6",
56511
56517
  hls_version: "3.0.24-rc.2",
56512
56518
  rts_version: "0.2.1-alpha.64"
@@ -62023,7 +62029,8 @@ class TeaTracker {
62023
62029
  Tea.init({
62024
62030
  ...teaOptions,
62025
62031
  app_id: 468759,
62026
- channel: "cn"
62032
+ channel: "cn",
62033
+ channel_domain: void 0
62027
62034
  });
62028
62035
  Tea.start();
62029
62036
  Tea.config({
@@ -74309,7 +74316,7 @@ async function prepare(options) {
74309
74316
  }
74310
74317
  await ((_a = liveVeStrategy.veStrategyManager) == null ? void 0 : _a.init({
74311
74318
  ...options,
74312
- playerVersion: "2.12.0",
74319
+ playerVersion: "2.12.2-rc.0",
74313
74320
  type: "LIVE"
74314
74321
  }));
74315
74322
  return liveVeStrategy.veStrategyManager;