@volcengine/veplayer 1.17.0-rc.0 → 1.17.0-rc.1

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/index.d.ts CHANGED
@@ -897,6 +897,20 @@ export declare class DefinitionDemotePlugin extends Plugin {
897
897
  showToast(definition: Stream): void;
898
898
  destroy(): void;
899
899
  }
900
+ export interface IAudioTrackConfig {
901
+ /** 控件在控制栏中的排列顺序,数值越小越靠左。@default 5 */
902
+ index?: number;
903
+ /** 是否显示图标按钮。@default true */
904
+ isShowIcon?: boolean;
905
+ /** 竖屏时是否隐藏控件。@default false */
906
+ hidePortrait?: boolean;
907
+ }
908
+ export interface IAudioTrackMobileConfig {
909
+ /** 控件在控制栏中的排列顺序,数值越小越靠左。@default 2.6 */
910
+ index?: number;
911
+ /** 是否显示图标按钮。@default true */
912
+ isShowIcon?: boolean;
913
+ }
900
914
  /**
901
915
  * @brief DASH 播放配置。
902
916
  * @list Options
@@ -2378,24 +2392,36 @@ export interface IMusicListItem {
2378
2392
  * @type {string}
2379
2393
  * @brief 音乐播放地址。
2380
2394
  */
2395
+ /** {en}
2396
+ * @brief Music playback URL.
2397
+ */
2381
2398
  src: string;
2382
2399
  /** {zh}
2383
2400
  * @type {string | number}
2384
2401
  * @memberof IMusicListItem
2385
2402
  * @brief 音乐唯一 ID。
2386
2403
  */
2404
+ /** {en}
2405
+ * @brief Unique music ID.
2406
+ */
2387
2407
  vid: string | number;
2388
2408
  /** {zh}
2389
2409
  * @type {string}
2390
2410
  * @memberof IMusicListItem
2391
2411
  * @brief 音乐封面 URL 地址。
2392
2412
  */
2413
+ /** {en}
2414
+ * @brief Music cover image URL.
2415
+ */
2393
2416
  poster?: string;
2394
2417
  /** {zh}
2395
2418
  * @type {string}
2396
2419
  * @memberof IMusicListItem
2397
2420
  * @brief 音乐标题。
2398
2421
  */
2422
+ /** {en}
2423
+ * @brief Music title.
2424
+ */
2399
2425
  title?: string;
2400
2426
  /** {zh}
2401
2427
  * @hidden
@@ -2419,6 +2445,10 @@ export interface IABCycle {
2419
2445
  * @memberof IABCycle
2420
2446
  * @brief AB 循环段开始时间,单位为秒。
2421
2447
  */
2448
+ /** {en}
2449
+ * @brief AB loop start time in seconds.
2450
+ * @default 0
2451
+ */
2422
2452
  start: number;
2423
2453
  /** {zh}
2424
2454
  * @default 音乐结束时间点
@@ -2427,6 +2457,10 @@ export interface IABCycle {
2427
2457
  * @memberof IABCycle
2428
2458
  * @brief AB 循环段开始时间,单位为秒。
2429
2459
  */
2460
+ /** {en}
2461
+ * @brief AB loop end time in seconds.
2462
+ * @default End of audio
2463
+ */
2430
2464
  end: number;
2431
2465
  /** {zh}
2432
2466
  * @default false
@@ -2434,6 +2468,10 @@ export interface IABCycle {
2434
2468
  * @memberof IABCycle
2435
2469
  * @brief AB 段是否循环播放。
2436
2470
  */
2471
+ /** {en}
2472
+ * @brief Whether to loop the AB segment.
2473
+ * @default false
2474
+ */
2437
2475
  loop?: boolean;
2438
2476
  /**
2439
2477
  * @hidden
@@ -2457,6 +2495,10 @@ export interface IMusicConfig {
2457
2495
  * @memberof IMusicConfig
2458
2496
  * @brief 是否启用离线下载播放。
2459
2497
  */
2498
+ /** {en}
2499
+ * @brief Whether to enable offline downloaded playback.
2500
+ * @default false
2501
+ */
2460
2502
  offline?: boolean;
2461
2503
  /** {zh}
2462
2504
  * @default null
@@ -2465,6 +2507,10 @@ export interface IMusicConfig {
2465
2507
  * @memberof IMusicConfig
2466
2508
  * @brief AB 循环播放配置。
2467
2509
  */
2510
+ /** {en}
2511
+ * @brief AB loop playback configuration.
2512
+ * @default null
2513
+ */
2468
2514
  abCycle?: IABCycle | null;
2469
2515
  /** {zh}
2470
2516
  * @default 15
@@ -2473,6 +2519,10 @@ export interface IMusicConfig {
2473
2519
  * @memberof IMusicConfig
2474
2520
  * @brief 快进快退时间跨度,单位为秒。
2475
2521
  */
2522
+ /** {en}
2523
+ * @brief Fast-forward / rewind step in seconds.
2524
+ * @default 15
2525
+ */
2476
2526
  timeScale?: number;
2477
2527
  /** {zh}
2478
2528
  * @default order
@@ -2481,6 +2531,10 @@ export interface IMusicConfig {
2481
2531
  * @memberof IMusicConfig
2482
2532
  * @brief 循环模式。
2483
2533
  */
2534
+ /** {en}
2535
+ * @brief Playback loop mode: `order`, `sloop` (single loop), `loop` (list loop), `random`.
2536
+ * @default order
2537
+ */
2484
2538
  mode?: PlayModeType;
2485
2539
  /** {zh}
2486
2540
  * @default []
@@ -2489,6 +2543,10 @@ export interface IMusicConfig {
2489
2543
  * @memberof IMusicConfig
2490
2544
  * @brief 播放列表。
2491
2545
  */
2546
+ /** {en}
2547
+ * @brief Music playlist.
2548
+ * @default []
2549
+ */
2492
2550
  list?: Array<IMusicListItem>;
2493
2551
  /** {zh}
2494
2552
  * @hidden
@@ -2518,18 +2576,27 @@ export interface Stream extends Partial<IPlayInfoListItem> {
2518
2576
  * - `"mp4"`
2519
2577
  * - `"hls"`
2520
2578
  */
2579
+ /** {en}
2580
+ * @brief Stream type: `"rtm"`, `"flv"`, `"mp4"`, or `"hls"`.
2581
+ */
2521
2582
  streamType?: string;
2522
2583
  /** {zh}
2523
2584
  * @brief 视频播放地址。
2524
2585
  * @type {Url}
2525
2586
  * @memberof IPlayerConfig
2526
2587
  */
2588
+ /** {en}
2589
+ * @brief Video playback URL.
2590
+ */
2527
2591
  url: Url;
2528
2592
  /** {zh}
2529
2593
  * @type {string}
2530
2594
  * @memberof Stream
2531
2595
  * @brief 清晰度 key
2532
2596
  */
2597
+ /** {en}
2598
+ * @brief Definition key for this stream.
2599
+ */
2533
2600
  definition?: string;
2534
2601
  /** {zh}
2535
2602
  * @type {string}
@@ -2537,6 +2604,10 @@ export interface Stream extends Partial<IPlayInfoListItem> {
2537
2604
  * @brief 映射清晰度 key
2538
2605
  * @default -
2539
2606
  */
2607
+ /** {en}
2608
+ * @brief Mapped definition key.
2609
+ * @default -
2610
+ */
2540
2611
  mapDefinition?: string;
2541
2612
  /** {zh}
2542
2613
  * @type {string}
@@ -2548,10 +2619,17 @@ export interface Stream extends Partial<IPlayInfoListItem> {
2548
2619
  * @brief 编码格式
2549
2620
  * @default unknown
2550
2621
  */
2622
+ /** {en}
2623
+ * @brief Codec type of this stream.
2624
+ * @default unknown
2625
+ */
2551
2626
  codec?: ICodecType;
2552
2627
  /** {zh}
2553
2628
  * @brief 线路唯一 ID
2554
2629
  */
2630
+ /** {en}
2631
+ * @brief Unique line (CDN route) ID.
2632
+ */
2555
2633
  lineId?: number | string;
2556
2634
  /** {zh}
2557
2635
  * @example
@@ -2602,6 +2680,9 @@ export interface Stream extends Partial<IPlayInfoListItem> {
2602
2680
  /** {zh}
2603
2681
  * @brief 私有加密播放的加密密钥,对应{@link https://www.volcengine.com/docs/4/2918 GetPlayInfo} 接口返回的PlayInfoList项中的 PlayAuth
2604
2682
  */
2683
+ /** {en}
2684
+ * @brief Encryption key for private-encrypted playback, corresponding to `PlayAuth` in the GetPlayInfo response.
2685
+ */
2605
2686
  secretKey?: string;
2606
2687
  /**
2607
2688
  * @brief 视频为加密视频时的加密类型
@@ -2697,6 +2778,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2697
2778
  * @default -
2698
2779
  * @listtip `id` 和 `root` 参数需至少传入 1 个。如果都传入,则优先使用 `root` 参数。
2699
2780
  */
2781
+ /** {en}
2782
+ * @brief Player container ID. The player will be inserted into this container. At least one of `id` or `root` must be provided.
2783
+ * @default -
2784
+ */
2700
2785
  id?: string;
2701
2786
  /** {zh}
2702
2787
  * @brief 播放器容器 DOM 元素。VePlayer 将被插入该容器中。
@@ -2704,11 +2789,19 @@ export interface IPlayerConfig extends IPlayerOptions {
2704
2789
  * @default -
2705
2790
  * @listtip `id` 和 `root` 参数需至少传入 1 个。如果都传入,则优先使用 `root` 参数。
2706
2791
  */
2792
+ /** {en}
2793
+ * @brief Player container DOM element. VePlayer will be inserted into this container. At least one of `id` or `root` must be provided; `root` takes precedence when both are provided.
2794
+ * @default -
2795
+ */
2707
2796
  root?: HTMLElement;
2708
2797
  /** {zh}
2709
2798
  * @brief 视频播放地址。
2710
2799
  * @default -
2711
2800
  */
2801
+ /** {en}
2802
+ * @brief Video playback URL.
2803
+ * @default -
2804
+ */
2712
2805
  url?: Url;
2713
2806
  /** {zh}
2714
2807
  * @brief 视频点播服务中的视频 ID。推荐填写,以方便跟踪该视频的播放质量。您将音视频上传至视频点播服务后,可通过以下方式获取 `Vid`:
@@ -2718,21 +2811,35 @@ export interface IPlayerConfig extends IPlayerOptions {
2718
2811
  * - 如果您设置了媒资上传完成的回调事件,会在 [FileUploadComplete](https://www.volcengine.com/docs/4/4655) 中返回 `Vid`。
2719
2812
  * @default -
2720
2813
  */
2814
+ /** {en}
2815
+ * @brief Video ID in the VOD service. Recommended for tracking playback quality.
2816
+ * @default -
2817
+ */
2721
2818
  vid?: string;
2722
2819
  /** {zh}
2723
2820
  * @brief Vid 播放配置项。应用服务端需通过 `vid` 生成临时临时播放 Token,下发给客户端。
2724
2821
  * @type {IPlayAuthTokenConfig}
2725
2822
  * @memberof IPlayerConfig
2726
2823
  */
2824
+ /** {en}
2825
+ * @brief Vid playback configuration. The app server generates a temporary play token from `vid` and passes it to the client.
2826
+ */
2727
2827
  getVideoByToken?: IPlayAuthTokenConfig;
2728
2828
  /** {zh}
2729
2829
  * @brief 视频加密类型
2730
2830
  * @default -
2731
2831
  */
2832
+ /** {en}
2833
+ * @brief Video encryption type.
2834
+ * @default -
2835
+ */
2732
2836
  drmType?: EDRMTYPE;
2733
2837
  /** {zh}
2734
2838
  * @brief 私有加密会话id
2735
2839
  */
2840
+ /** {en}
2841
+ * @brief Private encryption session ID.
2842
+ */
2736
2843
  encryptSessionId?: string;
2737
2844
  /**
2738
2845
  * @brief 视频为加密视频时的密钥KeyId,对应{@link https://www.volcengine.com/docs/4/2918 GetPlayInfo} 接口返回的PlayInfoList项中的 PlayAuthId
@@ -2742,6 +2849,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2742
2849
  /** {zh}
2743
2850
  * @brief 私有加密播放的加密密钥,对应{@link https://www.volcengine.com/docs/4/2918 GetPlayInfo} 接口返回的PlayInfoList项中的 PlayAuth
2744
2851
  */
2852
+ /** {en}
2853
+ * @brief Encryption key for private-encrypted playback, corresponding to `PlayAuth` in the GetPlayInfo response.
2854
+ */
2745
2855
  playAuth?: string;
2746
2856
  /** {zh}
2747
2857
  * @brief 视频格式。取值如下:
@@ -2751,21 +2861,36 @@ export interface IPlayerConfig extends IPlayerOptions {
2751
2861
  * - `flv`
2752
2862
  * @listtip 如果 `url` 参数取值中不包含文件格式后缀,则 `streamType` 必填。
2753
2863
  */
2864
+ /** {en}
2865
+ * @brief Video format. Required when the `url` does not include a file extension.
2866
+ */
2754
2867
  streamType?: "mp4" | "hls" | "dash" | "rtm" | "flv";
2755
2868
  /** {zh}
2756
2869
  * @brief 播放器宽度。可传入数字或者 CSS `width` 属性值。如为数字,单位为 px。
2757
2870
  * @default 100%
2758
2871
  */
2872
+ /** {en}
2873
+ * @brief Player width. Accepts a number (px) or a CSS `width` value.
2874
+ * @default 100%
2875
+ */
2759
2876
  width?: number | string;
2760
2877
  /** {zh}
2761
2878
  * @brief 播放器高度。可传入数字或者 CSS `width` 属性值。如为数字,单位为 px。
2762
2879
  * @default 100%
2763
2880
  */
2881
+ /** {en}
2882
+ * @brief Player height. Accepts a number (px) or a CSS `height` value.
2883
+ * @default 100%
2884
+ */
2764
2885
  height?: number | string;
2765
2886
  /** {zh}
2766
2887
  * @brief 默认起播音量。取值范围为 [0,1]。
2767
2888
  * @default 0.6
2768
2889
  */
2890
+ /** {en}
2891
+ * @brief Initial playback volume. Range: [0, 1].
2892
+ * @default 0.6
2893
+ */
2769
2894
  volume?: number;
2770
2895
  /** {zh}
2771
2896
  * @brief 是否开启自动播放。取值如下:
@@ -2775,10 +2900,17 @@ export interface IPlayerConfig extends IPlayerOptions {
2775
2900
  * @notes 受限制于浏览器策略,自动播放不一定能成功,取决于浏览器环境、用户行为、浏览器配置等,详细参考自动播放 @link https://www.volcengine.com/docs/4/68693#%E8%87%AA%E5%8A%A8%E6%92%AD%E6%94%BE
2776
2901
  * @listtip 受限于浏览器策略,自动播放不一定能成功,取决于浏览器环境、用户行为、浏览器配置等。详情请参考[自动播放](https://www.volcengine.com/docs/4/68693#%E8%87%AA%E5%8A%A8%E6%92%AD%E6%94%BE)。
2777
2902
  */
2903
+ /** {en}
2904
+ * @brief Whether to enable autoplay. Subject to browser autoplay policies.
2905
+ * @default false
2906
+ */
2778
2907
  autoplay?: boolean;
2779
2908
  /** {zh}
2780
2909
  * @brief 视频封面图配置。
2781
2910
  */
2911
+ /** {en}
2912
+ * @brief Video poster image configuration.
2913
+ */
2782
2914
  poster?: string | IPoster;
2783
2915
  /** {zh}
2784
2916
  * @brief 是否开启静音自动播放。取值如下:
@@ -2786,6 +2918,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2786
2918
  * - `false`:关闭静音自动播放。
2787
2919
  * @default false
2788
2920
  */
2921
+ /** {en}
2922
+ * @brief Whether to enable muted autoplay.
2923
+ * @default false
2924
+ */
2789
2925
  autoplayMuted?: boolean;
2790
2926
  /** {zh}
2791
2927
  * @brief 是否开启降级静音自动播放。开启后,有声音自动播放失败时,会降级成静音自动播放。取值如下:
@@ -2793,6 +2929,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2793
2929
  * - `false`:关闭降级静音自动播放
2794
2930
  * @default false
2795
2931
  */
2932
+ /** {en}
2933
+ * @brief Whether to fall back to muted autoplay when autoplay with sound fails.
2934
+ * @default false
2935
+ */
2796
2936
  enableDegradeMuteAutoplay?: boolean;
2797
2937
  /** {zh}
2798
2938
  * @brief 启用微信jsBridge方式的自动播放,默认不开启
@@ -2811,6 +2951,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2811
2951
  * - `false`:不开启
2812
2952
  * @default false
2813
2953
  */
2954
+ /** {en}
2955
+ * @brief Whether to allow the first user interaction (any click) to trigger autoplay.
2956
+ * @default false
2957
+ */
2814
2958
  enableUserActionAutoplay?: boolean;
2815
2959
  /** {zh}
2816
2960
  * @brief 是否开启循环播放。取值如下:
@@ -2818,11 +2962,19 @@ export interface IPlayerConfig extends IPlayerOptions {
2818
2962
  * - `false`:关闭循环播放。
2819
2963
  * @default false
2820
2964
  */
2965
+ /** {en}
2966
+ * @brief Whether to enable loop playback.
2967
+ * @default false
2968
+ */
2821
2969
  loop?: boolean;
2822
2970
  /** {zh}
2823
2971
  * @brief 默认起播倍速。可设为 `0.5`、`0.75`、`1`、`1.5`、`2`。
2824
2972
  * @default 1
2825
2973
  */
2974
+ /** {en}
2975
+ * @brief Default playback rate. Supported values: `0.5`, `0.75`, `1`, `1.5`, `2`.
2976
+ * @default 1
2977
+ */
2826
2978
  defaultPlaybackRate?: number;
2827
2979
  /** {zh}
2828
2980
  * @brief 界面语言。取值如下:
@@ -2832,6 +2984,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2832
2984
  * - `zh-hk`
2833
2985
  * @default zh
2834
2986
  */
2987
+ /** {en}
2988
+ * @brief UI language. Supported values: `zh`, `zh-cn`, `en`, `jp`, `zh-hk`.
2989
+ * @default zh
2990
+ */
2835
2991
  lang?: "zh" | "zh-cn" | "en" | "jp" | "zh-hk";
2836
2992
  /** {zh}
2837
2993
  * @brief 多语言词典。可设置每个语种的词典,例如:
@@ -2842,6 +2998,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2842
2998
  * @see 了解更多,请参见{@link https://www.volcengine.com/docs/6469/127529 默认词典}。
2843
2999
  * @listtip 了解更多,请参见[默认词典](https://www.volcengine.com/docs/6469/127529)。
2844
3000
  */
3001
+ /** {en}
3002
+ * @brief i18n dictionary. Provide per-language key-value maps, e.g. `{ zh: { PIP: '画中画' }, en: { PIP: 'pip' } }`.
3003
+ */
2845
3004
  languages?: {
2846
3005
  [key: string]: Record<string, any>;
2847
3006
  };
@@ -2851,17 +3010,28 @@ export interface IPlayerConfig extends IPlayerOptions {
2851
3010
  * @notes 画中画功能由浏览器提供,如果本身浏览器不支持,即使有该配置也不显示画中画按钮
2852
3011
  * @listtip 画中画功能由浏览器提供。如果浏览器不支持,即使传入此配置也不会显示画中画按钮。
2853
3012
  */
3013
+ /** {en}
3014
+ * @brief Picture-in-picture configuration. Requires browser-level PiP support.
3015
+ * @default PC: {position: 'controlsRight', index: 2.5, showIcon: true}; mobile: false
3016
+ */
2854
3017
  pip?: IPIPConfig | boolean;
2855
3018
  /** {zh}
2856
3019
  * @brief 全屏配置。
2857
3020
  * @default {position: 'controlsRight', index: 0, rotateFullscreen: false, useCssFullscreen: false, target: null, switchCallback: null, disable: false, needBackIcon: false }
2858
3021
  */
3022
+ /** {en}
3023
+ * @brief Fullscreen configuration.
3024
+ */
2859
3025
  fullscreen?: IFullscreenConfig;
2860
3026
  /** {zh}
2861
3027
  * @breif 是否总是显示清晰度切换控件,即只有一个清晰度时也显示清晰度切换控件
2862
3028
  * @default false
2863
3029
  * @brief 是否总是显示清晰度切换控件,即只有单个清晰度时也显示清晰度切换控件。
2864
3030
  */
3031
+ /** {en}
3032
+ * @brief Whether to always show the definition selector, even when only one definition is available.
3033
+ * @default false
3034
+ */
2865
3035
  alwaysShowDefinition?: boolean;
2866
3036
  /** {zh}
2867
3037
  * @breif url对应视频的清晰度文案,仅`alwaysShowDefinition`为`true`时有效
@@ -2869,12 +3039,20 @@ export interface IPlayerConfig extends IPlayerOptions {
2869
3039
  * @listtip 仅 `alwaysShowDefinition` 为 `true` 时有效。
2870
3040
  * @brief `url` 参数对应视频的清晰度文案。
2871
3041
  */
3042
+ /** {en}
3043
+ * @brief Display label for the definition corresponding to `url`. Only effective when `alwaysShowDefinition` is `true`.
3044
+ * @default HD
3045
+ */
2872
3046
  definitionText?: string;
2873
3047
  /** {zh}
2874
3048
  * @brief `url` 参数对应视频的清晰度文案的多语言 key,对应参数 `languages` 中的文案。
2875
3049
  * @default -
2876
3050
  * @listtip 仅 `alwaysShowDefinition` 为 `true` 时有效,优先级高于 `definitionText`。
2877
3051
  */
3052
+ /** {en}
3053
+ * @brief i18n key for the definition label of `url`, mapping to `languages`. Takes priority over `definitionText`.
3054
+ * @default -
3055
+ */
2878
3056
  definitionTextKey?: string;
2879
3057
  /** {zh}
2880
3058
  * @brief 视频编码格式。
@@ -2882,6 +3060,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2882
3060
  * @listtip - 在已知视频编码方式的情况下推荐传入,以便日志分析。
2883
3061
  * - 在 `useSoftDecoding` 参数为 `true`(开启 H.265 兼容降级模式)时,建议传入,可提升软解初始效率。
2884
3062
  */
3063
+ /** {en}
3064
+ * @brief Video codec type. Recommended when the codec is known, to improve log analysis and soft-decode initialization.
3065
+ */
2885
3066
  codec?: ICodecType;
2886
3067
  /** {zh}
2887
3068
  * @brief 点播服务所在区域,影响服务接口的请求域名
@@ -2933,6 +3114,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2933
3114
  * @brief `video` 标签扩展属性。播放器初始化时会设置在 `videoElement` 或 `audioElement` 对象上。请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看支持的属性。
2934
3115
  * @default 无
2935
3116
  */
3117
+ /** {en}
3118
+ * @brief Extra attributes applied to the `videoElement` / `audioElement` on initialization. See [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties).
3119
+ */
2936
3120
  videoAttributes?: Partial<HTMLVideoElement>;
2937
3121
  /** {zh}
2938
3122
  * @brief 是否启用流式布局。启用流式布局后,播放器会根据屏幕宽度进行自适应调整,以确保在不同屏幕尺寸上都能呈现良好的显示效果。取值如下:
@@ -2943,6 +3127,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2943
3127
  * - 如果 `width` 和 `height` 不是 `Number` 类型,默认使用 16:9 比例。
2944
3128
  * @default false
2945
3129
  */
3130
+ /** {en}
3131
+ * @brief Whether to enable fluid layout. When enabled, the player adapts its aspect ratio based on `width` / `height` (defaults to 16:9 when they are non-numeric).
3132
+ * @default false
3133
+ */
2946
3134
  fluid?: boolean;
2947
3135
  /** {zh}
2948
3136
  * @brief 尺寸适配方式。在视频资源初始化之后,根据获取到的 `videoWidth` 和 `videoHeight` 的值对播放器容器宽高比进行调整。取值如下:
@@ -2951,6 +3139,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2951
3139
  * - `fixHeight`: 保持容器高度,仅适配宽度。
2952
3140
  * @default fixed
2953
3141
  */
3142
+ /** {en}
3143
+ * @brief Container size adaptation mode after video metadata is loaded. `fixed`: keep container ratio; `fixWidth`: adapt height; `fixHeight`: adapt width.
3144
+ * @default fixed
3145
+ */
2954
3146
  fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
2955
3147
  /** {zh}
2956
3148
  * @brief 视频画面填充模式,等同于设置{@link https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit CSS object-fit}属性。取值如下:
@@ -2961,6 +3153,10 @@ export interface IPlayerConfig extends IPlayerOptions {
2961
3153
  * - `fillHeight`: 填充高度,宽度溢出则裁剪宽度,当播放器容器宽高比大于视频的宽高比,等同于设置CSS `object-fit: cover`。
2962
3154
  * @default auto
2963
3155
  */
3156
+ /** {en}
3157
+ * @brief Video fill mode, equivalent to CSS `object-fit`. `auto`: browser default (may produce letterboxing); `fill`: stretch; `cover`: crop to fill; `fillWidth` / `fillHeight`: fill one axis and crop the other.
3158
+ * @default auto
3159
+ */
2964
3160
  videoFillMode?: "auto" | "fillHeight" | "fillWidth" | "fill" | "cover";
2965
3161
  /** {zh}
2966
3162
  * @brief 是否开启画面和控制栏分离模式。开启时,控制栏将会常驻,与视频画面不重叠。
@@ -2968,11 +3164,18 @@ export interface IPlayerConfig extends IPlayerOptions {
2968
3164
  * - `false`:关闭
2969
3165
  * @default false
2970
3166
  */
3167
+ /** {en}
3168
+ * @brief Whether to separate the video canvas from the controls bar. When enabled, the controls bar is always visible and does not overlap the video.
3169
+ * @default false
3170
+ */
2971
3171
  marginControls?: boolean;
2972
3172
  /** {zh}
2973
3173
  * @brief 是否启用 X5 内核浏览器的同层播放。
2974
3174
  * @default 无
2975
3175
  */
3176
+ /** {en}
3177
+ * @brief Enable same-layer playback for X5 kernel browsers.
3178
+ */
2976
3179
  "x5-video-player-type"?: string;
2977
3180
  /** {zh}
2978
3181
  * @brief 是否启用 X5 内核浏览器的全屏播放模式。
@@ -2980,6 +3183,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2980
3183
  * - `false`:停用
2981
3184
  * @default 无
2982
3185
  */
3186
+ /** {en}
3187
+ * @brief Whether to enable fullscreen playback mode for X5 kernel browsers.
3188
+ */
2983
3189
  "x5-video-player-fullscreen"?: boolean;
2984
3190
  /** {zh}
2985
3191
  * @brief X5 内核浏览器的横竖屏控制。取值如下:
@@ -2988,11 +3194,19 @@ export interface IPlayerConfig extends IPlayerOptions {
2988
3194
  * - `landscape|portrait`:跟随手机自动旋转
2989
3195
  * @default `landscape|portrait`(移动端)
2990
3196
  */
3197
+ /** {en}
3198
+ * @brief Screen orientation for X5 kernel browsers. `landscape`, `portrait`, or `landscape|portrait` (auto-rotate).
3199
+ * @default `landscape|portrait` (mobile)
3200
+ */
2991
3201
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
2992
3202
  /** {zh}
2993
3203
  * @brief 为播放器配置关键点样式。
2994
3204
  * @default -
2995
3205
  */
3206
+ /** {en}
3207
+ * @brief Key point style configuration for the player.
3208
+ * @default -
3209
+ */
2996
3210
  commonStyle?: ICommonStyle;
2997
3211
  /** {zh}
2998
3212
  * @brief 是否开启音乐播放模式。开启后,您可还通过 `music` 参数对音乐播放器进行配置。取值如下:
@@ -3000,6 +3214,10 @@ export interface IPlayerConfig extends IPlayerOptions {
3000
3214
  * - `false`:停用音乐播放模式
3001
3215
  * @default false
3002
3216
  */
3217
+ /** {en}
3218
+ * @brief Whether to enable music playback mode. Use `music` for further music player configuration.
3219
+ * @default false
3220
+ */
3003
3221
  isMusic?: boolean;
3004
3222
  /** {zh}
3005
3223
  * @hidden
@@ -3020,6 +3238,10 @@ export interface IPlayerConfig extends IPlayerOptions {
3020
3238
  * - `false`:开启。
3021
3239
  * @default false
3022
3240
  */
3241
+ /** {en}
3242
+ * @brief Whether to stop event propagation on the `video` element.
3243
+ * @default false
3244
+ */
3023
3245
  closeVideoStopPropagation?: boolean;
3024
3246
  /** {zh}
3025
3247
  * @brief 是否开启右键菜单。取值如下:
@@ -3027,6 +3249,10 @@ export interface IPlayerConfig extends IPlayerOptions {
3027
3249
  * - `false`:否。
3028
3250
  * @default false
3029
3251
  */
3252
+ /** {en}
3253
+ * @brief Whether to enable the right-click context menu.
3254
+ * @default false
3255
+ */
3030
3256
  enableMenu?: boolean;
3031
3257
  /**
3032
3258
  * @brief 是否禁用 PC 端点击播放器区域切换播放和暂停功能。
@@ -3112,39 +3338,88 @@ export interface IPlayerConfig extends IPlayerOptions {
3112
3338
  /** {zh}
3113
3339
  * @brief 是否开启 HLS 视频的 MSE 模式。仅移动端生效。默认情况下,在移动端使用原生 `video` 播放 HLS 视频。开启后,将采用 MSE 方式播放 HLS 视频,实现更好的兼容性、能控制缓存、节省流量。
3114
3340
  * @notes 仅移动端生效,开启后采用MSE方式播放HLS,默认在移动端使用原生video播放hls
3341
+ * @default false
3342
+ */
3343
+ /** {en}
3344
+ * @brief Whether to use MSE for HLS playback on mobile (default is native `video`). Improves compatibility, cache control, and bandwidth usage.
3345
+ * @default false
3115
3346
  */
3116
3347
  enableHlsMSE?: boolean;
3348
+ /** {zh}
3349
+ * @brief 是否启用 {@link https://hlsjs.video-dev.org/ hls.js} 插件播放HLS视频,默认为true,设置为false后,PC端播放HLS使用自研hls插件播放HLS视频
3350
+ * @default true
3351
+ */
3352
+ /** {en}
3353
+ * @brief Whether to use the hls.js plugin for HLS playback on PC. When `false`, the built-in HLS adapter is used instead.
3354
+ * @default true
3355
+ */
3356
+ enableHlsJs?: boolean;
3117
3357
  /** {zh}
3118
3358
  * @brief 在 PC Safari 上是否 HLS 插件播放视频。取值如下:
3119
3359
  * - `true`:使用 HLS 插件。SDK 会自动加载 HLS 插件。
3120
3360
  * - `false`:不使用 HLS 插件。
3121
3361
  * @default true
3122
3362
  */
3363
+ /** {en}
3364
+ * @brief Whether to use the HLS plugin on PC Safari. When `true`, the SDK loads the HLS plugin automatically.
3365
+ * @default true
3366
+ */
3123
3367
  useHlsPluginForSafari?: boolean;
3124
3368
  /** {zh}
3125
3369
  * @brief 是否开启 MP4 视频的 MSE 模式。开启后,将采用 MSE 方式播放 MP4,实现精确的 Seek 加载、视频的无缝切换、流量节省等功能。
3126
3370
  * @default false
3127
3371
  */
3372
+ /** {en}
3373
+ * @brief Whether to use MSE for MP4 playback, enabling accurate seek, seamless stream switching, and bandwidth savings.
3374
+ * @default false
3375
+ */
3128
3376
  enableMp4MSE?: boolean;
3129
3377
  /** {zh}
3130
3378
  * @brief 播放地址列表。
3131
3379
  * @default -
3132
3380
  */
3381
+ /** {en}
3382
+ * @brief Playlist of video streams with multi-definition and multi-line support.
3383
+ * @default -
3384
+ */
3133
3385
  playList?: Stream[];
3134
3386
  /** {zh}
3135
3387
  * @brief 默认清晰度。仅当 `playList` 有值时生效。
3136
3388
  * @default playList第一项
3137
3389
  */
3390
+ /** {en}
3391
+ * @brief Default definition. Effective only when `playList` is set.
3392
+ * @default First item of playList
3393
+ */
3138
3394
  defaultDefinition?: string;
3395
+ /** {zh}
3396
+ * @brief 起播默认音频轨道的语言代码(BCP-47,如 `"zh-cn"`、`"en"`)。
3397
+ * @notes HLS 流匹配 `audioTrack.lang`;iOS 原生播放匹配 `audioTrack.language`。
3398
+ * 多条轨道语言相同时取第一条。未匹配到时沿用 manifest 默认轨道。
3399
+ * @default -
3400
+ */
3401
+ /** {en}
3402
+ * @brief Default audio track language code (BCP-47, e.g. `"zh-cn"`, `"en"`) at playback start. Falls back to the manifest default when no match is found.
3403
+ * @default -
3404
+ */
3405
+ defaultAudioLang?: string;
3139
3406
  /** {zh}
3140
3407
  * @brief 插件,可自行选择安装的插件,支持{@link https://h5player.bytedance.com/plugins/ 西瓜播放器插件}。
3141
3408
  * @default -
3142
3409
  */
3410
+ /** {en}
3411
+ * @brief Additional plugins to install. Compatible with XGPlayer plugins.
3412
+ * @default -
3413
+ */
3143
3414
  plugins?: any[];
3144
3415
  /** {zh}
3145
3416
  * @brief 用于禁用插件。VePlayer 内置了一些常用的功能插件。如需禁用某一内置插件,可传入插件名称(不区分大小写)。
3146
3417
  * @default []
3147
3418
  */
3419
+ /** {en}
3420
+ * @brief List of built-in plugin names to disable (case-insensitive).
3421
+ * @default []
3422
+ */
3148
3423
  ignores?: string[];
3149
3424
  /** {zh}
3150
3425
  * @brief 默认配置
@@ -3187,6 +3462,10 @@ export interface IPlayerConfig extends IPlayerOptions {
3187
3462
  * @default -
3188
3463
  * @notes 插件可以从{@link https://www.volcengine.com/docs/4/67077 集成SDK} 章节中下载SDK离线包获取
3189
3464
  */
3465
+ /** {en}
3466
+ * @brief Fallback URL map for UMD plugin dependencies when the default CDN is unreachable. Supported keys: `hls`, `flv`, `XGVideo`, `hlsEncrypt`, `dash`, `mp4Encrypt`, `danmujs`, `danmuMask`, `subtitle`.
3467
+ * @default -
3468
+ */
3190
3469
  umdUrlMap?: Record<string, string>;
3191
3470
  /**
3192
3471
  * @brief 唯一 ID,用于[私有加密方案](https://www.volcengine.com/docs/4/106524)。
@@ -3204,6 +3483,10 @@ export interface IPlayerConfig extends IPlayerOptions {
3204
3483
  * @listtip - 移动端浏览器不支持 FLV 格式,如果需要播放该格式的视频,请开启软解。
3205
3484
  * - 软解播放的解码操作依赖设备 CPU,播放高码率、高分辨率的视频时,对 CPU 占用率较高。
3206
3485
  */
3486
+ /** {en}
3487
+ * @brief Whether to enable software decoding. Required for FLV on mobile. High CPU usage on high-bitrate / high-resolution videos.
3488
+ * @default false
3489
+ */
3207
3490
  useSoftDecoding?: boolean;
3208
3491
  /** {zh}
3209
3492
  * @brief 是否开启 H.265 自动降级模式。开启 H.265 兼容模式后,VePlayer 会在不支持 H.265 硬解的浏览器环境下,自动降级为兼容模式。取值如下:
@@ -3212,11 +3495,19 @@ export interface IPlayerConfig extends IPlayerOptions {
3212
3495
  * - `false`:不开启 H.265 自动降级模式。
3213
3496
  * @default false
3214
3497
  */
3498
+ /** {en}
3499
+ * @brief Whether to enable H.265 auto-degrade mode. When enabled, VePlayer falls back to a compatible mode in browsers that do not support H.265 hardware decoding.
3500
+ * @default false
3501
+ */
3215
3502
  enableH265Degrade?: boolean;
3216
3503
  /** {zh}
3217
3504
  * @brief 是否开启视频播放地址过期检测。开启后,播放器会轮询地将播放器所在的客户端时间与过期时间戳进行比较,以判断视频播放地址是否过期。
3218
3505
  * @default false
3219
3506
  */
3507
+ /** {en}
3508
+ * @brief Whether to enable URL expiry polling. The player periodically compares the client time against `urlExpireTimestamp`.
3509
+ * @default false
3510
+ */
3220
3511
  enableUrlExpireCheck?: boolean;
3221
3512
  /**
3222
3513
  * @brief 地址的过期时间戳,单位秒(s),vid模式下不用输入,播放器自动获取。如果是火山引擎的CDN分发地址,在不传入过期时间戳时,则需指定urlType,支持{@link https://www.volcengine.com/docs/4/177191 A-E类型},其他云厂商或者业务服务器存储的地址不支持。
@@ -3237,11 +3528,19 @@ export interface IPlayerConfig extends IPlayerOptions {
3237
3528
  * @brief 播放源过期的回调函数。可用来更新播放源数据。
3238
3529
  * @default -
3239
3530
  */
3531
+ /** {en}
3532
+ * @brief Callback invoked when the playback source expires. Use it to refresh source data.
3533
+ * @default -
3534
+ */
3240
3535
  onMediaExpired?: () => Promise<SourceConfig>;
3241
3536
  /** {zh}
3242
3537
  * @brief 临时播放 Token 过期时的回调函数,可用来更新临时播放 Token。
3243
3538
  * @default -
3244
3539
  */
3540
+ /** {en}
3541
+ * @brief Callback invoked when the temporary play token expires. Use it to refresh the token.
3542
+ * @default -
3543
+ */
3245
3544
  onTokenExpired?: () => Promise<IPlayAuthTokenConfig>;
3246
3545
  /** {zh}
3247
3546
  * @hidden
@@ -3256,78 +3555,192 @@ export interface IPlayerConfig extends IPlayerOptions {
3256
3555
  * @brief 是否开启日志打印。
3257
3556
  * @default false
3258
3557
  */
3558
+ /** {en}
3559
+ * @brief Whether to enable debug log output.
3560
+ * @default false
3561
+ */
3259
3562
  debug?: boolean;
3260
3563
  /** {zh}
3261
3564
  * @brief 播放器报错信息。支持配置播放异常时显示的异常文案、图片以及是否提供刷新按钮等。
3262
3565
  * @default -
3263
3566
  */
3567
+ /** {en}
3568
+ * @brief Error UI configuration. Controls the error message, image, and refresh button displayed on playback failure.
3569
+ * @default -
3570
+ */
3264
3571
  sdkErrorPlugin?: ISdkErrorConfig;
3265
3572
  /** {zh}
3266
- * @brief rtm配置,配置rtm拉流参数
3267
- * @notes 传入rtm流url时才生效
3268
- * @default -
3269
- * @hidden
3573
+ * @brief 非 MSE 播放模式下(含加密 HLS),触发媒体错误后的窗口内最大重试次数。
3574
+ * @default 3
3270
3575
  */
3271
3576
  /** {en}
3272
- * @hidden
3577
+ * @brief Maximum number of retries within the sliding window for media errors in non-MSE mode (including encrypted HLS).
3578
+ * @default 3
3273
3579
  */
3274
- rtm?: IRtmConfig;
3580
+ oriErrRetryCount?: number;
3275
3581
  /** {zh}
3276
- * @brief 弹幕及面板配置。支持配置弹幕文字大小、透明度、展示区域等参数。
3277
- * @default -
3582
+ * @brief 重试滑动窗口时长(ms)。窗口内超过 `oriErrRetryCount` 次重试后停止并进行错误诊断。
3583
+ * @default 10000
3278
3584
  */
3279
- DanmuPlugin?: IDanmuConfig | boolean;
3280
- /** {zh}
3281
- * @brief 清晰度降级配置。
3282
- * @notes 需要先引入DefinitionDemotePlugin插件,plugins: [VePlayer.DefinitionDemotePlugin]
3585
+ /** {en}
3586
+ * @brief Sliding window duration (ms) for retry counting. Retries stop and error analysis begins once `oriErrRetryCount` is reached within the window.
3587
+ * @default 10000
3283
3588
  */
3284
- DefinitionDemotePlugin?: IDefinitionDemotePlugin;
3589
+ oriErrRetryCycle?: number;
3285
3590
  /** {zh}
3286
- * @hidden
3287
- * @brief DASH 播放配置项
3288
- * @default -
3591
+ * @brief 重试指数退避基础延迟(ms)。第 n 次重试延迟为 `oriErrRetryBaseDelay * 2^(n-1)`。
3592
+ * @default 500
3289
3593
  */
3290
3594
  /** {en}
3291
- * @hidden
3595
+ * @brief Base delay (ms) for exponential backoff between retries. The delay for the nth retry is `oriErrRetryBaseDelay * 2^(n-1)`.
3596
+ * @default 500
3292
3597
  */
3293
- DASHPlugin?: Partial<IDashPluginConfig>;
3598
+ oriErrRetryBaseDelay?: number;
3294
3599
  /** {zh}
3295
- * @brief HLS 加密播放配置。
3296
- * @default -
3600
+ * @brief 最大总重试次数(跨窗口累计)。设为 `0` 表示不限制。
3601
+ * @default 0
3297
3602
  */
3298
- EncryptHlsPlugin?: Partial<IEncryptHlsPluginConfig> | boolean;
3299
- /** {zh}
3300
- * @brief 质量日志上报配置。
3301
- * @default -
3603
+ /** {en}
3604
+ * @brief Maximum total retry count accumulated across all windows. Set to `0` to disable the limit.
3605
+ * @default 0
3302
3606
  */
3303
- vodLogOpts?: Partial<IVodLogOptsConfig>;
3607
+ oriErrMaxTotalRetry?: number;
3304
3608
  /** {zh}
3305
- * @brief 日志tea的id,一般不需要配置,播放器会自动设置。
3306
- * @default 火山国内:4951,海外:323254
3609
+ * @brief 是否在重试耗尽后发起错误诊断请求,以细化错误码。
3610
+ * @default true
3307
3611
  */
3308
3612
  /** {en}
3309
- * @brief The id of the log tea. Generally, no configuration is required and the player will automatically set it.。
3310
- * @default 323254
3613
+ * @brief Whether to perform error analysis after retries are exhausted, to refine the error code.
3614
+ * @default true
3311
3615
  */
3312
- logTeaAppId?: number;
3616
+ needSyncAnalyzeError?: boolean;
3313
3617
  /** {zh}
3314
- * @hidden
3315
- * @brief mp4加密播放配置项
3316
- * @default -
3618
+ * @brief 网络诊断请求超时时间(ms)。
3619
+ * @default 3000
3317
3620
  */
3318
3621
  /** {en}
3319
- * @hidden
3622
+ * @brief Timeout (ms) for the network analysis request.
3623
+ * @default 3000
3624
+ */
3625
+ analyzeTimeout?: number;
3626
+ /** {zh}
3627
+ * @brief 需要忽略、不上报的错误码列表。
3628
+ * @default []
3629
+ */
3630
+ /** {en}
3631
+ * @brief List of error codes to suppress and not report.
3632
+ * @default []
3633
+ */
3634
+ ignoreErrorCodes?: Array<string | number>;
3635
+ /** {zh}
3636
+ * @brief PC 端音频轨道切换插件配置。传 `false` 可禁用该插件。
3637
+ * @notes 仅在多音轨视频中生效;单音轨时插件自动隐藏。
3638
+ * @default -
3639
+ */
3640
+ /** {en}
3641
+ * @brief PC audio track selector plugin configuration. Pass `false` to disable. Only effective for multi-track videos.
3642
+ * @default -
3643
+ */
3644
+ AudioTrack?: IAudioTrackConfig | false;
3645
+ /** {zh}
3646
+ * @brief 移动端音频轨道切换插件配置。传 `false` 可禁用该插件。
3647
+ * @notes 仅在多音轨视频中生效;单音轨时插件自动隐藏。
3648
+ * @default -
3649
+ */
3650
+ /** {en}
3651
+ * @brief Mobile audio track selector plugin configuration. Pass `false` to disable. Only effective for multi-track videos.
3652
+ * @default -
3653
+ */
3654
+ AudioTrackMobile?: IAudioTrackMobileConfig | false;
3655
+ /** {zh}
3656
+ * @brief rtm配置,配置rtm拉流参数
3657
+ * @notes 传入rtm流url时才生效
3658
+ * @default -
3659
+ * @hidden
3660
+ */
3661
+ /** {en}
3662
+ * @hidden
3663
+ */
3664
+ rtm?: IRtmConfig;
3665
+ /** {zh}
3666
+ * @brief 弹幕及面板配置。支持配置弹幕文字大小、透明度、展示区域等参数。
3667
+ * @default -
3668
+ */
3669
+ /** {en}
3670
+ * @brief Danmaku (bullet comment) and panel configuration. Supports font size, opacity, display area, etc.
3671
+ * @default -
3672
+ */
3673
+ DanmuPlugin?: IDanmuConfig | boolean;
3674
+ /** {zh}
3675
+ * @brief 清晰度降级配置。
3676
+ * @notes 需要先引入DefinitionDemotePlugin插件,plugins: [VePlayer.DefinitionDemotePlugin]
3677
+ */
3678
+ /** {en}
3679
+ * @brief Definition auto-demote configuration. Requires `DefinitionDemotePlugin` in `plugins`.
3680
+ */
3681
+ DefinitionDemotePlugin?: IDefinitionDemotePlugin;
3682
+ /** {zh}
3683
+ * @hidden
3684
+ * @brief DASH 播放配置项
3685
+ * @default -
3686
+ */
3687
+ /** {en}
3688
+ * @hidden
3689
+ */
3690
+ DASHPlugin?: Partial<IDashPluginConfig>;
3691
+ /** {zh}
3692
+ * @brief HLS 加密播放配置。
3693
+ * @default -
3694
+ */
3695
+ /** {en}
3696
+ * @brief Encrypted HLS playback configuration.
3697
+ * @default -
3698
+ */
3699
+ EncryptHlsPlugin?: Partial<IEncryptHlsPluginConfig> | boolean;
3700
+ /** {zh}
3701
+ * @brief 质量日志上报配置。
3702
+ * @default -
3703
+ */
3704
+ /** {en}
3705
+ * @brief Quality metrics log reporting configuration.
3706
+ * @default -
3707
+ */
3708
+ vodLogOpts?: Partial<IVodLogOptsConfig>;
3709
+ /** {zh}
3710
+ * @brief 日志tea的id,一般不需要配置,播放器会自动设置。
3711
+ * @default 火山国内:4951,海外:323254
3712
+ */
3713
+ /** {en}
3714
+ * @brief The id of the log tea. Generally, no configuration is required and the player will automatically set it.
3715
+ * @default 323254
3716
+ */
3717
+ logTeaAppId?: number;
3718
+ /** {zh}
3719
+ * @hidden
3720
+ * @brief mp4加密播放配置项
3721
+ * @default -
3722
+ */
3723
+ /** {en}
3724
+ * @hidden
3320
3725
  */
3321
3726
  Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
3322
3727
  /** {zh}
3323
3728
  * @brief 多码率自适应播放配置。
3324
3729
  * @default -
3325
3730
  */
3731
+ /** {en}
3732
+ * @brief Adaptive bitrate (ABR) playback configuration.
3733
+ * @default -
3734
+ */
3326
3735
  autoBitrateOpts?: IAutoBitrateOpts;
3327
3736
  /** {zh}
3328
3737
  * @brief 动态 Buffer 配置。
3329
3738
  * @default -
3330
3739
  */
3740
+ /** {en}
3741
+ * @brief Dynamic buffer range configuration.
3742
+ * @default -
3743
+ */
3331
3744
  adaptRange?: IAdaptRange;
3332
3745
  /** {zh}
3333
3746
  * @brief 视频时长。
@@ -3342,45 +3755,73 @@ export interface IPlayerConfig extends IPlayerOptions {
3342
3755
  * @brief 外挂字幕配置。
3343
3756
  * @default -
3344
3757
  */
3758
+ /** {en}
3759
+ * @brief External subtitle configuration.
3760
+ * @default -
3761
+ */
3345
3762
  Subtitle?: ISubtitleConfig;
3346
3763
  /** {zh}
3347
3764
  * @type {IMemoryPlayConfig}
3348
3765
  * @memberof IPlayerConfig
3349
3766
  * @brief 记忆播放配置。
3350
3767
  */
3768
+ /** {en}
3769
+ * @brief Resume playback (memory play) configuration.
3770
+ */
3351
3771
  MemoryPlay?: IMemoryPlayConfig | boolean;
3352
3772
  /** {zh}
3353
3773
  * @type {IMusicConfig}
3354
3774
  * @memberof IPlayerConfig
3355
3775
  * @brief 音乐播放器配置。
3356
3776
  */
3777
+ /** {en}
3778
+ * @brief Music player configuration. Effective when `isMusic` is `true`.
3779
+ */
3357
3780
  music?: IMusicConfig;
3358
3781
  /** {zh}
3359
3782
  * @type {IMusicConfig}
3360
3783
  * @memberof IPlayerConfig
3361
3784
  * @brief 自动播放配置。
3362
3785
  */
3786
+ /** {en}
3787
+ * @brief Autoplay plugin configuration.
3788
+ */
3363
3789
  AutoplayPlugin?: IAutoplayPluginConfig;
3364
3790
  /** {zh}
3365
3791
  * @type { IPlayListConfig }
3366
3792
  * @memberof IPlayerConfig
3367
3793
  * @brief 播放列表配置。
3368
3794
  */
3795
+ /** {en}
3796
+ * @brief Playlist plugin configuration.
3797
+ */
3369
3798
  playListPlugin?: IPlayListConfig;
3370
3799
  /** {zh}
3371
3800
  * @brief 动态水印配置。
3372
3801
  * @default -
3373
3802
  */
3803
+ /** {en}
3804
+ * @brief Dynamic watermark configuration.
3805
+ * @default -
3806
+ */
3374
3807
  dynamicwatermark?: IWatermarkConfig;
3375
3808
  /** {zh}
3376
3809
  * @brief 进度条预览缩略图配置。
3377
3810
  * @default -
3378
3811
  */
3812
+ /** {en}
3813
+ * @brief Progress bar thumbnail preview configuration.
3814
+ * @default -
3815
+ */
3379
3816
  thumbnail?: IThumbnailConfig;
3380
3817
  /** {zh}
3381
3818
  * @brief 进度条标记配置
3382
3819
  * @default -
3383
3820
  */
3821
+ /** {en}
3822
+ * @brief Progress bar dot marker configuration.
3823
+ * @default -
3824
+ */
3384
3825
  progressDot?: IDot[];
3385
3826
  /** {zh}
3386
3827
  * @brief 移动端下倍速、清晰度等选择弹窗的样式
@@ -3464,6 +3905,10 @@ export interface IDefaultConfig {
3464
3905
  * 如果是对象则可以对音量控制插件进行各型特性单独配置
3465
3906
  * @default 0.6
3466
3907
  */
3908
+ /** {en}
3909
+ * @brief Volume configuration. A number sets the default volume [0, 1]; an object allows per-feature configuration.
3910
+ * @default 0.6
3911
+ */
3467
3912
  volume?: IVolume;
3468
3913
  /** {zh}
3469
3914
  * @brief 弹幕插件配置
@@ -3471,6 +3916,9 @@ export interface IDefaultConfig {
3471
3916
  * @type {*}
3472
3917
  * @memberof IDefaultConfig
3473
3918
  */
3919
+ /** {en}
3920
+ * @brief Danmaku plugin configuration.
3921
+ */
3474
3922
  DanmuPlugin?: any;
3475
3923
  /** {zh}
3476
3924
  * @brief 字幕插件配置
@@ -3478,6 +3926,9 @@ export interface IDefaultConfig {
3478
3926
  * @type {*}
3479
3927
  * @memberof IDefaultConfig
3480
3928
  */
3929
+ /** {en}
3930
+ * @brief Live subtitle icon plugin configuration.
3931
+ */
3481
3932
  LiveSubtitlesIconPlugin?: any;
3482
3933
  }
3483
3934
  /** {zh}
@@ -3490,11 +3941,19 @@ export interface IPlayAuthTokenConfig {
3490
3941
  * @brief 应用服务端生成的临时播放凭证。
3491
3942
  * @default -
3492
3943
  */
3944
+ /** {en}
3945
+ * @brief Temporary play token generated by the app server.
3946
+ * @default -
3947
+ */
3493
3948
  playAuthToken: string;
3494
3949
  /** {zh}
3495
3950
  * @brief 默认清晰度。对应 [GetPlayInfo](https://www.volcengine.com/docs/4/2918) 接口返回的 `Definition`。为空时默认为接口返回的最高清晰度。
3496
3951
  * @default -
3497
3952
  */
3953
+ /** {en}
3954
+ * @brief Default definition, corresponding to `Definition` in the GetPlayInfo response. Defaults to the highest available when empty.
3955
+ * @default -
3956
+ */
3498
3957
  defaultDefinition?: string;
3499
3958
  /** {zh}
3500
3959
  * @brief 获取播放地址的请求域名。
@@ -3514,6 +3973,10 @@ export interface IPlayAuthTokenConfig {
3514
3973
  * @default false
3515
3974
  * @listtip 请确保您已在视频点播控制台中生成和设置封面图,详见[封面图和封面候选](https://www.volcengine.com/docs/4/5335)。
3516
3975
  */
3976
+ /** {en}
3977
+ * @brief Whether to use the poster image set in the VOD console.
3978
+ * @default false
3979
+ */
3517
3980
  needPoster?: boolean;
3518
3981
  /** {zh}
3519
3982
  * @brief 是否使用您在视频点播控制台上生成的雪碧图。取值如下:
@@ -3523,6 +3986,10 @@ export interface IPlayAuthTokenConfig {
3523
3986
  * @default false
3524
3987
  * @listtip 请确保您已通过视频点播媒体处理服务生成雪碧图,详见[雪碧图](https://www.volcengine.com/docs/4/1171758)。
3525
3988
  */
3989
+ /** {en}
3990
+ * @brief Whether to use the sprite sheet (thumbnail) generated by the VOD media processing service.
3991
+ * @default false
3992
+ */
3526
3993
  needThumbs?: boolean;
3527
3994
  /** {zh}
3528
3995
  * @brief 是否使用您在视频点播控制台上生成的蒙版弹幕。取值如下:
@@ -3532,17 +3999,29 @@ export interface IPlayAuthTokenConfig {
3532
3999
  * @default false
3533
4000
  * @listtip 请确保您已通过视频点播媒体处理服务生成蒙版弹幕。
3534
4001
  */
4002
+ /** {en}
4003
+ * @brief Whether to use the masked danmaku generated by the VOD media processing service.
4004
+ * @default false
4005
+ */
3535
4006
  needBarrageMask?: boolean;
3536
4007
  /** {zh}
3537
4008
  * @brief 是否需要获取展示多个清晰度。
3538
4009
  * @default true
3539
4010
  */
4011
+ /** {en}
4012
+ * @brief Whether to fetch and display multiple definition options.
4013
+ * @default true
4014
+ */
3540
4015
  needDefinitionList?: boolean;
3541
4016
  /** {zh}
3542
4017
  * @briefhls标准加密播放所需要的keyToken
3543
4018
  * @default -
3544
4019
  * @brief 用于 HLS 标准加密播放的 keyToken。
3545
4020
  */
4021
+ /** {en}
4022
+ * @brief Key token required for HLS standard-encrypted playback.
4023
+ * @default -
4024
+ */
3546
4025
  keyToken?: string;
3547
4026
  /** {zh}
3548
4027
  * @hidden
@@ -3557,6 +4036,10 @@ export interface IPlayAuthTokenConfig {
3557
4036
  * - `unionInfo`: 由 `unionId` 生成的 `unionInfo`,用来加密`PrivateDrmAuthToken`。
3558
4037
  * @default -
3559
4038
  */
4039
+ /** {en}
4040
+ * @brief Async callback to fetch `PrivateDrmAuthToken`. Receives `playAuthIds` (comma-separated key IDs), `vid`, and `unionInfo`.
4041
+ * @default -
4042
+ */
3560
4043
  getDrmAuthToken?: (playAuthIds: string, vid: string, unionInfo: string) => Promise<string>;
3561
4044
  /**
3562
4045
  * @brief 商业DRM 获取license的token
@@ -3583,6 +4066,10 @@ export interface IPlayAuthTokenConfig {
3583
4066
  * 具体可传参数见{@link https://www.volcengine.com/docs/4/65659 签发 PlayAuthToken}
3584
4067
  * @default -
3585
4068
  */
4069
+ /** {en}
4070
+ * @brief Extra pass-through query parameters (e.g. `{ aid: 1234 }`). Parameters from `playAuthToken` take highest priority.
4071
+ * @default -
4072
+ */
3586
4073
  reqParams?: Record<string, number | string | boolean>;
3587
4074
  /** {zh}
3588
4075
  * @brief 定义清晰度的映射。
@@ -3614,24 +4101,46 @@ export interface IPlayAuthTokenConfig {
3614
4101
  * @brief 点播服务发生 502 错误时的重试次数。
3615
4102
  * @default 1
3616
4103
  */
4104
+ /** {en}
4105
+ * @brief Number of retries when the VOD service returns a 502 error.
4106
+ * @default 1
4107
+ */
3617
4108
  retryCount?: number;
3618
4109
  /** {zh}
3619
4110
  * @brief 清晰度自动降级开启时的自动档位,对应{@link https://www.volcengine.com/docs/4/2918 GetPlayInfo}返回的Definition字段
3620
4111
  * @notes 如果指定的清晰度,playAuthToken从服务端返回的清晰度列表中不存在该清晰度,则此参数无效。
3621
4112
  * @default -
3622
4113
  */
4114
+ /** {en}
4115
+ * @brief Auto-demote definition target when definition auto-demote is enabled. Corresponds to `Definition` in GetPlayInfo response.
4116
+ * @default -
4117
+ */
3623
4118
  autoDemoteDefinition?: string;
3624
4119
  /** {zh}
3625
4120
  * @brief 开启清晰度自动降级(`isNeedAutoDemote` 为 `true`)时的自动档位对应的多语言文案 key,取值对应 `languages` 字段中各语种的 `key`。
3626
4121
  * @notes 如果指定的清晰度,playAuthToken从服务端返回的清晰度列表中不存在该清晰度,则此参数无效。
3627
4122
  * @default -
3628
4123
  */
4124
+ /** {en}
4125
+ * @brief i18n key for the auto-demote definition label, mapping into `languages`.
4126
+ * @default -
4127
+ */
3629
4128
  autoDemoteDefinitionTextKey?: string;
3630
4129
  /** {zh}
3631
4130
  * @brief 视频地址请求时携带的额外query参数
3632
4131
  * @notes 一般用于携带HLS标准加密播放携带
3633
4132
  */
4133
+ /** {en}
4134
+ * @brief Extra query parameters appended to video URL requests. Typically used for HLS standard-encrypted playback.
4135
+ */
3634
4136
  urlQueryParams?: Record<string, string>;
4137
+ /** {zh}
4138
+ * @brief HLS 播放时是否使用master m3u8 地址作为播放源
4139
+ */
4140
+ /** {en}
4141
+ * @brief Whether to use the master m3u8 URL as the playback source for HLS.
4142
+ */
4143
+ useMasterM3u8?: boolean;
3635
4144
  }
3636
4145
  /** {zh}
3637
4146
  * @list Options
@@ -3736,6 +4245,10 @@ export interface IPIPConfig extends IPluginConfig {
3736
4245
  * - `false`:不显示画中画按钮。
3737
4246
  * @default false
3738
4247
  */
4248
+ /** {en}
4249
+ * @brief Whether to show the picture-in-picture button.
4250
+ * @default false
4251
+ */
3739
4252
  showIcon?: boolean;
3740
4253
  /** {zh}
3741
4254
  * @brief 是否优先使用[网页画中画](https://developer.mozilla.org/en-US/docs/Web/API/DocumentPictureInPicture)。
@@ -3745,26 +4258,46 @@ export interface IPIPConfig extends IPluginConfig {
3745
4258
  * @default false
3746
4259
  * @listtip 仅浏览器支持 `DocumentPictureInPicture` 时才生效。
3747
4260
  */
4261
+ /** {en}
4262
+ * @brief Whether to prefer `DocumentPictureInPicture` (web PiP) when available.
4263
+ * @default false
4264
+ */
3748
4265
  preferDocument?: boolean;
3749
4266
  /** {zh}
3750
4267
  * @brief 网页画中画模式下窗口的宽度。
3751
4268
  * @default -
3752
4269
  */
4270
+ /** {en}
4271
+ * @brief Width of the document PiP window.
4272
+ * @default -
4273
+ */
3753
4274
  width?: number;
3754
4275
  /** {zh}
3755
4276
  * @brief 网页画中画模式下窗口的高度。
3756
4277
  * @default -
3757
4278
  */
4279
+ /** {en}
4280
+ * @brief Height of the document PiP window.
4281
+ * @default -
4282
+ */
3758
4283
  height?: number;
3759
4284
  /** {zh}
3760
4285
  * @brief 网页画中画模式下窗口的根节点。
3761
4286
  * @default -
3762
4287
  */
4288
+ /** {en}
4289
+ * @brief Root element of the document PiP window.
4290
+ * @default -
4291
+ */
3763
4292
  docPiPNode?: HTMLElement;
3764
4293
  /** {zh}
3765
4294
  * @brief 文档画中画窗口的 css style
3766
4295
  * @default -
3767
4296
  */
4297
+ /** {en}
4298
+ * @brief CSS style for the document PiP window.
4299
+ * @default -
4300
+ */
3768
4301
  docPiPStyle?: ((...arg: any) => string) | string;
3769
4302
  }
3770
4303
  /** {zh}
@@ -3785,6 +4318,10 @@ export interface IFullscreenConfig {
3785
4318
  * - `false`:系统全屏。
3786
4319
  * @default false
3787
4320
  */
4321
+ /** {en}
4322
+ * @brief Whether to use CSS fullscreen instead of native system fullscreen.
4323
+ * @default false
4324
+ */
3788
4325
  useCssFullscreen?: boolean;
3789
4326
  /** {zh}
3790
4327
  * @brief 是否使用旋转横屏。取值如下:
@@ -3797,22 +4334,38 @@ export interface IFullscreenConfig {
3797
4334
  * @listtip - 该参数的优先级高于 `useCssFullscreen` 参数。
3798
4335
  * - 该参数一般用于移动端。
3799
4336
  */
4337
+ /** {en}
4338
+ * @brief Whether to rotate the DOM 90° to achieve landscape fullscreen. Takes priority over `useCssFullscreen`. Mainly for mobile.
4339
+ * @default false
4340
+ */
3800
4341
  rotateFullscreen?: boolean;
3801
4342
  /** {zh}
3802
4343
  * @brief 旋转全屏后,锁定屏幕方向。适应于移动端设备全屏观看横屏视频
3803
4344
  * @default false
3804
4345
  * @notes 仅部分浏览器支持,兼容性见{@link https://caniuse.com/mdn-api_screenorientation_lock ScreenOrientation API: lock}
3805
4346
  */
4347
+ /** {en}
4348
+ * @brief Whether to lock the screen orientation after rotating to fullscreen. Only supported in some browsers.
4349
+ * @default false
4350
+ */
3806
4351
  useScreenOrientation?: boolean;
3807
4352
  /** {zh}
3808
4353
  * @brief 旋转全屏后,锁定屏幕方向类型,默认是横屏,可选值见{@link https://developer.mozilla.org/en-US/docs/Web/API/ScreenOrientation/lock#orientation orientation}
3809
4354
  * @default landscape
3810
4355
  */
4356
+ /** {en}
4357
+ * @brief Orientation type to lock after rotating to fullscreen.
4358
+ * @default landscape
4359
+ */
3811
4360
  lockOrientationType?: string;
3812
4361
  /** {zh}
3813
4362
  * @brief 自定义全屏功能的 `dom`。默认是播放器根节点。该参数必须是 `player.root` 的父辈节点,适用于解决全屏时和 `player.root` 同级的 `dom`需要显示的场景。
3814
4363
  * @default `null`
3815
4364
  */
4365
+ /** {en}
4366
+ * @brief Custom DOM element for fullscreen. Must be an ancestor of `player.root`. Defaults to the player root node.
4367
+ * @default null
4368
+ */
3816
4369
  target?: HTMLElement;
3817
4370
  /** {zh}
3818
4371
  * @brief 是否禁用全屏按钮。
@@ -3820,6 +4373,10 @@ export interface IFullscreenConfig {
3820
4373
  * - `false`:不禁用。
3821
4374
  * @default false
3822
4375
  */
4376
+ /** {en}
4377
+ * @brief Whether to disable the fullscreen button. When `true`, the button is not rendered.
4378
+ * @default false
4379
+ */
3823
4380
  disable?: boolean;
3824
4381
  /** {zh}
3825
4382
  * @brief 全屏的时候是否显示右上角返回按钮。取值如下:
@@ -3830,11 +4387,19 @@ export interface IFullscreenConfig {
3830
4387
  * @notes 该配置一般在移动端开启
3831
4388
  * @listtip 此参数一般用于移动端。
3832
4389
  */
4390
+ /** {en}
4391
+ * @brief Whether to show a back button in the top-right corner during fullscreen. Mainly for mobile.
4392
+ * @default false
4393
+ */
3833
4394
  needBackIcon?: boolean;
3834
4395
  /** {zh}
3835
4396
  * @brief 全屏切换自定义实现。该函数配置相当于完全替代插件内部的切换逻辑。
3836
4397
  * @default `null`
3837
4398
  */
4399
+ /** {en}
4400
+ * @brief Custom fullscreen toggle implementation. Completely replaces the built-in toggle logic.
4401
+ * @default null
4402
+ */
3838
4403
  switchCallback?: (...arg: any) => any;
3839
4404
  }
3840
4405
  /** {zh}
@@ -3847,26 +4412,41 @@ export interface ICommonStyle {
3847
4412
  * @brief 进度条底色。
3848
4413
  * @default 无
3849
4414
  */
4415
+ /** {en}
4416
+ * @brief Progress bar track color.
4417
+ */
3850
4418
  progressColor?: string;
3851
4419
  /** {zh}
3852
4420
  * @brief 播放完成部分进度条底色。
3853
4421
  * @default 无
3854
4422
  */
4423
+ /** {en}
4424
+ * @brief Color of the played portion of the progress bar.
4425
+ */
3855
4426
  playedColor?: string;
3856
4427
  /** {zh}
3857
4428
  * @brief 缓存部分进度条底色。
3858
4429
  * @default 无
3859
4430
  */
4431
+ /** {en}
4432
+ * @brief Color of the buffered portion of the progress bar.
4433
+ */
3860
4434
  cachedColor?: string;
3861
4435
  /** {zh}
3862
4436
  * @brief 进度条滑块样式。
3863
4437
  * @default 无
3864
4438
  */
4439
+ /** {en}
4440
+ * @brief Style of the progress bar thumb/slider.
4441
+ */
3865
4442
  sliderBtnStyle?: CSSStyleDeclaration;
3866
4443
  /** {zh}
3867
4444
  * @brief 音量颜色。
3868
4445
  * @default 无
3869
4446
  */
4447
+ /** {en}
4448
+ * @brief Volume control color.
4449
+ */
3870
4450
  volumeColor?: string;
3871
4451
  }
3872
4452
  /** {zh}
@@ -3879,11 +4459,19 @@ export interface IPoster {
3879
4459
  * @brief 封面图 URL 地址。
3880
4460
  * @default -
3881
4461
  */
4462
+ /** {en}
4463
+ * @brief Poster image URL.
4464
+ * @default -
4465
+ */
3882
4466
  poster: string;
3883
4467
  /** {zh}
3884
4468
  * @brief 是否在播放结束之后显示封面图。
3885
4469
  * @default true
3886
4470
  */
4471
+ /** {en}
4472
+ * @brief Whether to show the poster after playback ends.
4473
+ * @default true
4474
+ */
3887
4475
  isEndedShow?: boolean;
3888
4476
  /** {zh}
3889
4477
  * @brief 是否播放后隐藏封面图。
@@ -3891,11 +4479,19 @@ export interface IPoster {
3891
4479
  * - `false`:在 `play` 事件触发后隐藏封面图。
3892
4480
  * @default false
3893
4481
  */
4482
+ /** {en}
4483
+ * @brief Whether to hide the poster after playback starts. When `true`, the poster re-appears after a URL update.
4484
+ * @default false
4485
+ */
3894
4486
  hideCanplay?: boolean;
3895
4487
  /** {zh}
3896
4488
  * @brief 是否一直显示封面图。
3897
4489
  * @default false
3898
4490
  */
4491
+ /** {en}
4492
+ * @brief Whether to keep the poster always visible.
4493
+ * @default false
4494
+ */
3899
4495
  notHidden?: boolean;
3900
4496
  /** {zh}
3901
4497
  * @brief 封面图填充方式。取值如下:
@@ -3904,6 +4500,9 @@ export interface IPoster {
3904
4500
  * - `cover`:完全覆盖容器,多余部分会被裁剪。
3905
4501
  * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
3906
4502
  */
4503
+ /** {en}
4504
+ * @brief Poster fill mode: `fixWidth`, `fixHeight`, `cover` (crop to fill), or `contain` (stretch to fill).
4505
+ */
3907
4506
  fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
3908
4507
  }
3909
4508
  /** {zh}
@@ -3916,48 +4515,82 @@ export interface IThumbnailConfig {
3916
4515
  * @brief 雪碧图地址数组。
3917
4516
  * @default -
3918
4517
  */
4518
+ /** {en}
4519
+ * @brief Array of sprite sheet URLs.
4520
+ * @default -
4521
+ */
3919
4522
  urls: Array<string>;
3920
4523
  /** {zh}
3921
4524
  * @brief 缩略小图总张数。
3922
4525
  * @default -
3923
4526
  */
4527
+ /** {en}
4528
+ * @brief Total number of thumbnail frames.
4529
+ * @default -
4530
+ */
3924
4531
  pic_num: number;
3925
4532
  /** {zh}
3926
4533
  * @brief 雪碧大图中每列包含的缩略小图数量。
3927
4534
  * @default -
3928
4535
  */
4536
+ /** {en}
4537
+ * @brief Number of thumbnail columns per sprite sheet.
4538
+ * @default -
4539
+ */
3929
4540
  col: number;
3930
4541
  /** {zh}
3931
4542
  * @brief 雪碧大图中每行包含的缩略小图数量。
3932
4543
  * @default -
3933
4544
  */
4545
+ /** {en}
4546
+ * @brief Number of thumbnail rows per sprite sheet.
4547
+ * @default -
4548
+ */
3934
4549
  row: number;
3935
4550
  /** {zh}
3936
4551
  * @brief 缩略小图高度,单位为 px。
3937
4552
  * @default -
3938
4553
  */
4554
+ /** {en}
4555
+ * @brief Thumbnail frame height in px.
4556
+ * @default -
4557
+ */
3939
4558
  height?: number;
3940
4559
  /** {zh}
3941
4560
  * @brief 缩略小图宽度,单位为 px。
3942
4561
  * @default -
3943
4562
  */
4563
+ /** {en}
4564
+ * @brief Thumbnail frame width in px.
4565
+ * @default -
4566
+ */
3944
4567
  width?: number;
3945
4568
  /** {zh}
3946
4569
  * @brief 显示缩放比例
3947
4570
  * @default 1
3948
4571
  * @hidden
3949
4572
  */
4573
+ /** {en}
4574
+ * @hidden
4575
+ */
3950
4576
  scale?: 1;
3951
4577
  /** {zh}
3952
4578
  * @brief 额外添加在dom上的class
3953
4579
  * @default -
3954
4580
  * @hidden
3955
4581
  */
4582
+ /** {en}
4583
+ * @hidden
4584
+ */
3956
4585
  className?: string;
3957
4586
  /** {zh}
3958
4587
  * @brief 是否在竖屏的时候隐藏缩略图。
3959
4588
  * @default false
3960
4589
  */
4590
+ /** {en}
4591
+ * @brief Whether to hide the thumbnail in portrait orientation.
4592
+ * @default false
4593
+ */
3961
4594
  hidePortrait?: false;
3962
4595
  }
3963
4596
  export interface ISourceConfig {
@@ -3973,764 +4606,809 @@ export interface ApiMapConfig {
3973
4606
  playDomain: string;
3974
4607
  backupPlayDomain?: string;
3975
4608
  }
3976
- export type TLogChannel = "cn" | "va" | "sg";
3977
- declare enum PreloadScene {
3978
- /**
3979
- * 普通场景(手动执行预加载)
3980
- */
3981
- NORMAL = 0,
3982
- /**
3983
- * Feed流场景(播放器自动执行预加载)
3984
- * @brief Feed 流场景(播放器自动执行预加载)
3985
- */
3986
- /** {en}
3987
- * @brief Feed流场景(播放器自动执行预加载)
3988
- */
3989
- FEED = 1
4609
+ declare enum UmdKeys {
4610
+ HLS = "hls",
4611
+ HLSJS = "hlsjs",
4612
+ FLV = "flv",
4613
+ XGVideo = "XGVideo",
4614
+ HLSEncrypt = "hlsEncrypt",
4615
+ DASH = "dash",
4616
+ MP4Encrypt = "mp4Encrypt",
4617
+ DanmuJS = "danmujs",
4618
+ DanmuMask = "danmuMask",
4619
+ StreamProbe = "streamprobe",
4620
+ VeStrategy = "vestrategy",
4621
+ VeStrategyH265 = "vestrategy_h265",
4622
+ VeStrategyPreload = "vestrategy_preload",
4623
+ VeStrategyAdaptRange = "vestrategy_adapt_range",
4624
+ DashAbralgo = "DashAbralgo",
4625
+ Preloader = "preloader",
4626
+ HLSjsPro = "hlsjsPro"
3990
4627
  }
3991
- declare enum StrategyNames {
4628
+ /**
4629
+ * @hidden
4630
+ * @breif umdmap 配置
4631
+ */
4632
+ export declare type UMDMap = Record<UmdKeys, {
3992
4633
  /**
3993
- * h265
3994
- * @brief H.265 策略
4634
+ * umd Module 的名称,即在window下暴露的接口名称
3995
4635
  */
3996
- H265 = "h265",
4636
+ name: string;
3997
4637
  /**
3998
- * 预加载
3999
- * @brief 预加载策略
4638
+ * 对应umd文件名,只用来标记,实际不使用
4000
4639
  */
4001
- PRELOAD = "preload",
4640
+ pluginName?: string;
4002
4641
  /**
4003
- * Range拆分-动态Buffer
4004
- * @brief 动态 Buffer
4642
+ * 对应npm包的名称,在打包文件时,会在libd.config.js中onPostBuild的钩子中会用于寻找对应npm包
4005
4643
  */
4006
- ADAPT_RANGE = "adaptRange"
4007
- }
4008
- /** {zh}
4009
- * @hidden
4010
- * h265策略配置
4011
- * @detail Options
4012
- */
4013
- export declare type IH265Config = {
4644
+ packageName: string;
4014
4645
  /**
4015
- * h265策略依赖Module
4646
+ * npm包中umd入口文件路径,用于打包上传到cdn目录
4016
4647
  */
4017
- Strategy?: any;
4648
+ devPath: string;
4649
+ }>;
4650
+ declare class UMDLoader {
4651
+ private static jsLoadMap;
4652
+ private static jsLoadPromiseMap;
4653
+ umdMap: UMDMap;
4654
+ backupUmdUrlMap: Record<string, string>;
4655
+ failCallback: (umdName: string, err: any) => any;
4656
+ region: TRegionType;
4657
+ userRegion: TRegionType;
4658
+ customPluginPublicPath: string;
4659
+ importedPlugins: any[];
4660
+ constructor();
4018
4661
  /**
4019
- * 是否禁用265策略
4662
+ * @return { string } 插件加载的公共路径
4020
4663
  */
4021
- disabled?: boolean;
4022
- } & VeStrategyH265Config;
4023
- /** {zh}
4024
- * 预加载初始配置
4025
- * @detail Options
4026
- */
4027
- export declare type IPreloadConfig = {
4664
+ get pluginPublicPath(): string;
4028
4665
  /**
4029
- * 预加载场景
4030
- * @default 0
4031
- * */
4032
- preloadScene?: PreloadScene;
4666
+ * 更新umd的备用地址
4667
+ * @param {Record<string, string>} map 备用地址map
4668
+ */
4669
+ updateBackupMap(map: Record<string, string>): void;
4033
4670
  /**
4034
- * 向前预加载视频个数,Feed流场景时生效
4035
- * @default 1
4036
- * @brief 向前预加载视频个数。Feed 流场景时生效。
4671
+ * 加载额外的js-sdk
4672
+ * 适用 umd 模块
4673
+ * 只能浏览器环境下使用
4674
+ * @param url 额外加载JS 的 CDN 地址
4675
+ * @param isJs 是否js文件
4037
4676
  */
4038
- /** {en}
4039
- * @brief 向前预加载视频个数,Feed流场景时生效
4677
+ loadExtraCdn(url: string, isJs?: boolean): Promise<void>;
4678
+ /**
4679
+ * @description 加载xgplayer插件
4680
+ * @param pluginName 插件名称
4681
+ * @param successCallback 加载完成后执行的回调
4682
+ * @return Promise<any>
4040
4683
  */
4041
- prevCount?: number;
4684
+ loadPlugins(pluginName: UmdKeys, successCallback?: () => void): Promise<any>;
4042
4685
  /**
4043
- * 向后预加载视频个数,Feed流场景生效
4044
- * @default 2
4045
- * @brief 向后预加载视频个数。Feed 流场景生效
4686
+ * 处理加载成功
4046
4687
  */
4047
- /** {en}
4048
- * @brief 向后预加载视频个数,Feed流场景生效
4688
+ private handleLoadSuccess;
4689
+ /**
4690
+ * 处理加载失败
4049
4691
  */
4050
- nextCount?: number;
4692
+ private handleLoadError;
4051
4693
  /**
4052
- * 单个视频预加载时长
4053
- * @default 5
4694
+ * 处理catch分支的错误处理
4054
4695
  */
4055
- preloadTime?: number;
4696
+ private handleLoadCatch;
4056
4697
  /**
4057
- * 最大视频缓存个数
4058
- * @default 15
4698
+ * 加载备用URL
4059
4699
  */
4060
- preloadMaxCacheCount?: number;
4700
+ private loadBackupUrl;
4061
4701
  /**
4062
- * 预加载依赖Module
4063
- * @brief 预加载依赖 Module
4702
+ * 触发成功回调
4064
4703
  */
4065
- /** {en}
4066
- * @brief 预加载依赖Module
4704
+ private triggerSuccessCallback;
4705
+ }
4706
+ export declare class SdkPlugin {
4707
+ pluginName: string;
4708
+ __args: any;
4709
+ sdk: VePlayer;
4710
+ playerData: PlayerData;
4711
+ player: Player;
4712
+ _emitter: EventEmitter;
4713
+ static defineGetterOrSetter(Obj: any, map: any): void;
4714
+ /**
4715
+ * @type { string }
4067
4716
  */
4068
- Strategy?: any;
4717
+ static get pluginName(): string;
4069
4718
  /**
4070
- * 是否禁用预加载
4719
+ * @constructor
4720
+ * @param { { sdk: object, pluginName: string, [propName: string]: any;} } args
4071
4721
  */
4072
- disabled?: boolean;
4073
- };
4074
- /** {zh}
4075
- * @hidden
4076
- * @detail Options
4077
- * @brief Range 拆分(动态Buffer)策略初始配置
4078
- * @notes adaptRange策略配置结构较复杂,暂不开放Range默认配置自定义,使用策略下发
4079
- */
4080
- export declare type IAdaptRangeConfig = {
4081
- /** {zh}
4082
- * @brief 预加载依赖Module
4722
+ constructor(args: any);
4723
+ /**
4724
+ * @description sdk实例创建,挂载插件实例时首先执行
4083
4725
  */
4084
- Strategy?: any;
4085
- /** {zh}
4086
- * @brief 是否禁用Range拆分策略
4726
+ beforeCreate(): void;
4727
+ /**
4728
+ * @description sdk实例创建,挂载插件实例完后执行
4087
4729
  */
4088
- disabled?: boolean;
4089
- };
4090
- /** {zh}
4091
- * @detail Options
4092
- * @brief 策略配置。
4093
- */
4094
- export declare type StrategyConfigOptions = {
4730
+ afterCreate(): void;
4095
4731
  /**
4096
- * h265策略配置
4097
- * @hidden
4098
- * @brief H.265 策略配置。
4732
+ * @description sdk创建播放器前执行,只有这里能保证异步操作在creatPlayer之前同步完成
4099
4733
  */
4100
- /** {en}
4101
- * @hidden
4102
- * @brief h265策略配置
4734
+ beforePlayerCreate(): void;
4735
+ /**
4736
+ * @description sdk创建播放器完执行
4103
4737
  */
4104
- [StrategyNames.H265]?: boolean | IH265Config;
4738
+ afterPlayerCreate(): void;
4105
4739
  /**
4106
- * 预加载配置
4107
- * @brief 预加载配置。
4740
+ * @description sdk销毁时执行
4108
4741
  */
4109
- /** {en}
4110
- * @brief 预加载配置
4742
+ destroy(): void;
4743
+ /**
4744
+ * @private
4745
+ * @param { any } args
4111
4746
  */
4112
- [StrategyNames.PRELOAD]?: boolean | IPreloadConfig;
4747
+ __init(args: any): void;
4113
4748
  /**
4114
- * Range拆分(动态Buffer)
4115
- * @brief 动态 Buffer 配置。
4749
+ * @description 插件销毁
4750
+ * @private
4116
4751
  */
4117
- /** {en}
4118
- * @brief Range拆分(动态Buffer)
4752
+ __destroy(): void;
4753
+ }
4754
+ declare class AuthToken extends SdkPlugin {
4755
+ static get pluginName(): string;
4756
+ isPlayByToken: boolean;
4757
+ isEncrypt: boolean;
4758
+ tokenInfo: ITokenInfo;
4759
+ keyTokenInfo: ITokenInfo;
4760
+ thirdPartyDrmAuthTokenInfo: ITokenInfo;
4761
+ config: IPlayAuthTokenConfig;
4762
+ privateDrmAuthToken: string;
4763
+ useUnionInfoDRM: boolean;
4764
+ sessionId: string;
4765
+ retryCount: number;
4766
+ playInfo?: VideoInfoRes;
4767
+ constructor(args: any);
4768
+ beforePlayerCreate(): Promise<void>;
4769
+ getVideoInfo(): Promise<{
4770
+ vid: string;
4771
+ playList: Stream[];
4772
+ codec: ICodecType;
4773
+ defaultDefinition: string;
4774
+ }>;
4775
+ getVideos(): Promise<any>;
4776
+ getPrivateDrmInfo(playList: Stream[], vid: string, streamType: string): Promise<void>;
4777
+ getThumbnailConfig(thumbs: IThumbInfoItem[]): void;
4778
+ getBarrageMaskUrl(url: string): void;
4779
+ getDrmConfig(videoInfo: IVideoInfo): void;
4780
+ init(): void;
4781
+ initConfig(getVideoByToken: IPlayAuthTokenConfig): void;
4782
+ /**
4783
+ * @description 更新playAuthToken
4784
+ * @param {IPlayAuthTokenConfig} getVideoByToken token信息
4785
+ * @param {boolean} isNewVideo 是否新视频,即是否为切换视频
4119
4786
  */
4120
- [StrategyNames.ADAPT_RANGE]?: boolean | IAdaptRangeConfig;
4121
- };
4787
+ updateAuthToken(getVideoByToken: IPlayAuthTokenConfig, isNewVideo: boolean): Promise<void>;
4788
+ checkPlayAuthTokenValid(): boolean;
4789
+ checkKeyTokenValid(): boolean;
4790
+ checkDrmAuthTokenValid(): boolean;
4791
+ }
4122
4792
  /** {zh}
4123
- * 播放器预初始化配置
4124
- * @detail Options
4793
+ * @hidden
4125
4794
  */
4126
- export declare type StrategyInitOptions = {
4127
- /** {zh}
4128
- * 应用ID
4129
- * @brief 应用 ID
4130
- */
4131
- /** {en}
4132
- * @brief appid
4133
- */
4134
- appId: number;
4135
- /** {zh}
4136
- * @brief 用户所在区域
4137
- * @default cn
4138
- * @notes 如果是海外用户,播放时请填写'mya'
4139
- */
4140
- /** {en}
4141
- * @brief The region where the user is located,
4142
- * @default sg
4143
- */
4144
- region?: TRegionType;
4145
- /** {zh}
4146
- * 高级能力(策略)配置
4147
- * @brief 策略配置
4148
- */
4149
- /** {en}
4150
- * @brief Advanced Capability (Strategy) Configuration
4151
- */
4152
- strategies: StrategyConfigOptions;
4153
- /** {zh}
4154
- * 设备ID
4155
- * @brief 设备 ID
4156
- */
4157
- /** {en}
4158
- * @brief device id
4159
- */
4160
- deviceId?: string;
4161
- /** {zh}
4162
- * @brief 手动注入依赖插件,默认自动加载
4163
- * @default -
4164
- */
4165
- /** {en}
4166
- * @brief Manually inject dependency plugins, automatically load by default
4167
- * @default -
4168
- */
4169
- plugins?: any[];
4795
+ export interface IAdaptRangeDefaultOptions {
4796
+ maxTargetCacheDur: number;
4797
+ minTargetCacheDur: number;
4798
+ rangeMaxDuration: number;
4799
+ rangeMinDuration: number;
4800
+ cacheSafeFactor: number;
4801
+ estPTcontrol: boolean;
4802
+ estPlayTime: number;
4803
+ minBandwidth: number;
4804
+ minDangerThreshold: number;
4805
+ rangeControl: boolean;
4806
+ rangeMinSize: number;
4807
+ safeFactor: number;
4808
+ targetCacheControl: boolean;
4809
+ }
4810
+ declare abstract class AbstractBaseAdapter {
4811
+ isLive: boolean;
4812
+ playerData: PlayerData;
4813
+ streamType: string;
4814
+ constructor(options: {
4815
+ configs: IPlayerConfig;
4816
+ playerData: PlayerData;
4817
+ streamType: string;
4818
+ });
4170
4819
  /**
4171
- * 策略Module,默认自动加载
4172
- * @brief 策略 Module,默认自动加载
4173
- * @default -
4174
- */
4175
- /** {en}
4176
- * @brief Strategy Module, automatically loaded by default
4177
- * @default -
4820
+ * @description 是否使用原生video的abr能力
4178
4821
  */
4179
- Module?: typeof VeStrategy;
4180
- };
4181
- /** {zh}
4182
- * 预加载实例,通过预加载实例可执行一些高级方法
4183
- * @detail Options
4184
- * @hidden
4185
- */
4186
- export declare type PreloaderManager = {
4822
+ abstract useNativeAbr(): boolean;
4823
+ abstract canOpenAbr(vidPlayInfo?: VideoInfoRes): boolean;
4824
+ abstract applyAbrPluginConfig(_finalOptions: any, _autoBitrateOpts: any): void;
4825
+ abstract prepareAbrModule(_playerData: any, _sdkUmdLoader: any): void;
4826
+ abstract needAbrAutoDefinition(): boolean;
4827
+ abstract setAbrDefaultDefiWithAuto(): boolean;
4828
+ abstract generatePlaylistFromServer(res: VideoInfoRes, ...args: any[]): Stream[];
4829
+ abstract canAdaptRangeEnable(): boolean;
4830
+ abstract adaptRangeDefaultOptions(): IAdaptRangeDefaultOptions | undefined;
4831
+ abstract applyAdaptRangePluginConfig(_finalOptions: any, _adaptRangeOptions: any): void;
4832
+ abstract applyAdaptRangeStrategy(_finalOptions: any, _adaptRangeOptions: any): void;
4833
+ abstract getPlugins(umdLoader: UMDLoader): Promise<XGPlugin[]>;
4834
+ abstract setPluginConfigInVid(videoInfo: IVideoInfo, context: AuthToken): void;
4835
+ }
4836
+ declare class PlayerData {
4837
+ id?: string;
4838
+ root?: HTMLElement;
4839
+ configs: IPlayerConfig;
4840
+ type: string;
4841
+ isLive: boolean;
4842
+ options: any;
4843
+ isMobile: boolean;
4844
+ playList: Stream[];
4845
+ plugins: any[];
4846
+ openSoftDecoding: boolean;
4847
+ defaultConfig: IDefaultConfig | undefined;
4848
+ isHitDefault: boolean;
4849
+ codec?: ICodecType;
4850
+ enableH265Degrade: boolean;
4851
+ languageData: {
4852
+ extraLangList: IXGI18nText[];
4853
+ extendLangList: IXGI18nText[];
4854
+ };
4855
+ current: Current;
4856
+ onMediaExpired: () => Promise<SourceConfig>;
4857
+ onTokenExpired: () => Promise<IPlayAuthTokenConfig>;
4858
+ unionId?: string;
4859
+ unionInfo?: string;
4860
+ isMusic?: boolean;
4861
+ sdkPlugins: any[];
4862
+ useHlsPluginForSafari: boolean;
4863
+ enableHlsJs: boolean;
4864
+ enableMenu: boolean;
4865
+ region: TRegionType;
4866
+ userRegion: TRegionType;
4867
+ playDomainDegrade: boolean;
4868
+ strategiesPlugins: any[];
4869
+ strategiesPluginConfigs: any;
4187
4870
  /**
4188
- * 移除所有已预加载数据
4871
+ * @default playList第一项
4189
4872
  */
4190
- removeAll(): void;
4873
+ defaultDefinition: string;
4874
+ urlCheckData: {
4875
+ enableUrlExpireCheck: boolean;
4876
+ urlExpireTimestamp: number;
4877
+ urlExpireDiff: number;
4878
+ urlCheckExpireInterval: number;
4879
+ };
4880
+ private isAutoBitrateEnable;
4881
+ adapter: AbstractBaseAdapter;
4191
4882
  /**
4192
- * 移除所有预加载任务
4883
+ * @breif 是否vid模式的加密播放
4193
4884
  */
4194
- removeAllPreloadTask(): void;
4885
+ isVidEncrypt: boolean;
4886
+ dashOpts: {
4887
+ Data: IGetPlayInfoRes;
4888
+ };
4195
4889
  /**
4196
- * 清空待预加载列表
4890
+ * @brief 播放器sdk实例
4197
4891
  */
4198
- clearPreloadList(): void;
4199
- };
4200
- declare enum PreloaderStatus {
4892
+ sdk: VePlayer;
4201
4893
  /**
4202
- * 不可用
4894
+ * @brief 当前加密播放类型,为空则表示非加密
4203
4895
  */
4204
- DISABLED = 0,
4896
+ drmType: EDRMTYPE;
4205
4897
  /**
4206
- * 初始状态
4898
+ * @brief 私有加密会话id
4207
4899
  */
4208
- INITIALIZING = 1,
4900
+ encryptSessionId?: string;
4901
+ constructor(configs: IPlayerConfig & {
4902
+ licensSupportModuleList: string[];
4903
+ }, sdk: VePlayer);
4209
4904
  /**
4210
- * 已Ready
4905
+ * 初始化播放数据
4906
+ * @param configs { IPlayerConfig } 播放器配置
4211
4907
  */
4212
- READY = 2,
4908
+ initPlayData(configs: IPlayerConfig): void;
4909
+ initPlaylistAndGetCurrent(configs: IPlayerConfig): Stream;
4910
+ checkAutoBitratePlayList(): boolean;
4911
+ getABRStreamInfo(streamType: any, originDefaultStream: any): {
4912
+ defaultDefinition: string;
4913
+ defaultStream: any;
4914
+ playList: Stream[];
4915
+ };
4916
+ isCurrentH265(): boolean;
4917
+ setDrmType(drmType: EDRMTYPE): void;
4918
+ getCurrentByDefaultConfig(): Stream;
4919
+ initCurrent(currentStreams: Stream): void;
4920
+ initCheckExpireData(): void;
4213
4921
  /**
4214
- * 加载失败
4922
+ * 更新过期检测的数据
4215
4923
  */
4216
- FAILED = 3
4217
- }
4218
- /** {zh}
4219
- * 预加载配置更新
4220
- * @detail Options
4221
- * @hidden
4222
- */
4223
- export declare type IPreloadUpdateConfig = {
4924
+ updateCheckExpireData(): void;
4925
+ initI18nData(languages: any): {
4926
+ extraLangList: any[];
4927
+ extendLangList: any[];
4928
+ };
4224
4929
  /**
4225
- * 向前加载视频个数
4930
+ * @description: 获取当前直播url
4226
4931
  */
4227
- prevCount?: number;
4932
+ getCurrentUrl(): Url;
4933
+ getTargetStreamType(stream?: Stream): string;
4228
4934
  /**
4229
- * 向后加载视频个数
4935
+ * @description: 获取当前的streamType
4230
4936
  */
4231
- nextCount?: number;
4232
- };
4233
- /** {zh}
4234
- * 预加载视频资源
4235
- * @detail Options
4236
- */
4237
- export declare type IPreloadStream = {
4937
+ getCurrentStreamType(): string;
4938
+ getStreamType(): string;
4939
+ isOpenABR(): boolean;
4940
+ showRealDefinition(): boolean;
4941
+ isAutoDefinition(def: any): boolean;
4942
+ isPlayAutoDefinition(def?: string): boolean;
4943
+ isDefinitionMatch(pre: any, next: any): boolean;
4238
4944
  /**
4239
- * 视频唯一ID
4240
- * @brief 视频 ID
4945
+ * @description: 获取满足当前直播条件的流
4241
4946
  */
4242
- /** {en}
4243
- * @brief 视频唯一ID
4947
+ getCurrentStreams(): Stream[];
4948
+ /**
4949
+ * @description: 获取根据线路ID去重的流,用于获取有几个线路
4244
4950
  */
4245
- vid: string;
4951
+ getLineList(): Stream[];
4246
4952
  /**
4247
- * 播放地址
4248
- * @brief 视频播放地址
4953
+ * @description: 根据线路ID获取符合条件的流
4954
+ * @param {number} lineId
4249
4955
  */
4250
- /** {en}
4251
- * @brief 播放地址
4956
+ getLineListByLineId(lineId: number | string): Stream[];
4957
+ /**
4958
+ * @description: 根据线路ID获取清晰度list,用于获取某个线路下有几个清晰度
4959
+ * @param {number} lineId
4252
4960
  */
4253
- url: string;
4961
+ getDefinitionListByLineId(lineId: number | string): Stream[];
4254
4962
  /**
4255
- * 视频清晰度
4963
+ * @description: 根据条件筛选符合条件的流list
4964
+ * @param {Condition} condition
4256
4965
  */
4257
- definition: string;
4966
+ getUrlList(condition: Condition): Stream[];
4258
4967
  /**
4259
- * 视频streamType,暂只支持 mp4
4260
- * @brief 视频流类型,当前仅支持 mp4
4968
+ * @description: 获取当期清晰的上一级清晰度或下一级清晰度
4969
+ * @param {boolean} isDown 是否取下一级清晰度
4970
+ * @param {string[]} demotePriority 清晰度降级顺序
4261
4971
  */
4262
- /** {en}
4263
- * @brief 视频streamType,暂只支持 mp4
4972
+ getNextDefinition(isDown: boolean, demotePriority: string[]): Stream[];
4973
+ /**
4974
+ * 获取api map
4975
+ * @return { ApiMapConfig }
4264
4976
  */
4265
- streamType: string;
4977
+ get apiMap(): ApiMapConfig;
4266
4978
  /**
4267
- * 视频codec,暂支持 h264
4268
- * @brief 视频编码格式,当前仅支持 mp4
4979
+ * 获取播放域名
4269
4980
  */
4270
- /** {en}
4271
- * @brief 视频codec,暂支持 h264
4981
+ get playDomain(): string;
4982
+ setVodTeaId(): void;
4983
+ /**
4984
+ * 更新configs,即更新用户的configs,常用于playNext时
4985
+ * @param newConfigs {IPlayerConfig} 要更新的配置
4272
4986
  */
4273
- codec: string;
4987
+ updateConfigs(newConfigs: IPlayerConfig): void;
4274
4988
  /**
4275
- * 码率, 数据统计需要,可选填
4276
- * @brief 码率, 数据统计需要,选填
4989
+ * 更新playList
4277
4990
  */
4278
- /** {en}
4279
- * @brief 码率, 数据统计需要,可选填
4280
- */
4281
- bitrate: number;
4991
+ updatePlayList(): void;
4992
+ isVidPlay(): boolean;
4993
+ }
4994
+ /**
4995
+ * @hidden
4996
+ * @brief 移动端交互面板配置
4997
+ */
4998
+ export interface IConfig {
4999
+ mode?: number;
5000
+ isAutoChange?: boolean;
5001
+ }
5002
+ declare class MobilePlayerPanel {
5003
+ config: IConfig;
5004
+ parent: HTMLElement;
5005
+ root: any;
5006
+ mode: number;
5007
+ isAutoChange: number;
5008
+ player: any;
5009
+ children: HTMLElement | undefined;
5010
+ container: HTMLElement | undefined;
5011
+ title: HTMLElement | undefined;
5012
+ isShow: boolean;
5013
+ showCancelBtn: boolean;
5014
+ constructor(args: any);
5015
+ initEvents(): void;
5016
+ handleOrientationChange(): void;
5017
+ changeConfig(config: IConfig): void;
5018
+ changeMode(mode: number): void;
5019
+ renderPanel(): void;
5020
+ showPanel(children: HTMLElement, title?: string, isItemList?: boolean): Promise<void>;
5021
+ updatePanel(children: HTMLElement): void;
5022
+ setTitle(title: any): void;
5023
+ renderTitle(title: any): HTMLElement;
5024
+ show(): void;
5025
+ hide(): void;
5026
+ handleHide(e: any): void;
5027
+ bind(event: string, eventHandle: any, isBubble?: boolean): void;
5028
+ destroy(): void;
5029
+ }
5030
+ declare enum StrategyNames {
4282
5031
  /**
4283
- * 视频时长,数据统计需要,可选填
4284
- * @brief 视频时长,数据统计需要,选填
4285
- */
4286
- /** {en}
4287
- * @brief 视频时长,数据统计需要,可选填
5032
+ * h265
5033
+ * @brief H.265 策略
4288
5034
  */
4289
- duration: number;
5035
+ H265 = "h265",
4290
5036
  /**
4291
- * 视频大小,数据统计需要,可选填
4292
- * @brief 视频大小,数据统计需要,选填
5037
+ * 预加载
5038
+ * @brief 预加载策略
4293
5039
  */
4294
- /** {en}
4295
- * @brief 视频大小,数据统计需要,可选填
5040
+ PRELOAD = "preload",
5041
+ /**
5042
+ * Range拆分-动态Buffer
5043
+ * @brief 动态 Buffer
4296
5044
  */
4297
- size: number;
4298
- };
4299
- declare class VeStrategyWrapper {
4300
- private tea;
4301
- private static mapStrategyNameToUmdKey;
4302
- teaId: number;
4303
- teaChannel: TLogChannel;
4304
- preloader: PreloaderManagerOrigin | undefined;
4305
- preloaderStatus: PreloaderStatus;
4306
- private sdkUmdLoader;
4307
- private webId;
4308
- private config;
4309
- private status;
4310
- private initPromise;
4311
- private preloadCacheConfig;
4312
- private preloadCacheScene;
4313
- private preloadCacheList;
4314
- constructor();
4315
- private initUmdLoader;
4316
- private fetchWebId;
4317
- private initTea;
4318
- private fetchVeStrategy;
4319
- private fetchStrategies;
4320
- private initOnce;
4321
- init(config: StrategyInitOptions): Promise<boolean>;
4322
- initPreloadService(options: StrategyInitOptions): Promise<boolean>;
4323
- addPreloadList(list: IPreloadStream[]): void;
4324
- setPreloadList(list: IPreloadStream[]): Promise<void>;
4325
- setPreloadScene(preloadScene: PreloadScene, options?: any): void;
4326
- prepare(): Promise<boolean>;
4327
- getDeviceId(): string;
4328
- isReady(): boolean;
4329
- getStrategyRecommendations(options?: any, commonOptions?: any): StrategyRecommendation;
4330
- getStrategyRecommendationsAsync(options?: any, commonOptions?: any): Promise<StrategyRecommendation>;
4331
- isHevcRecommended(): boolean;
4332
- private initPreloaderConfig;
4333
- }
4334
- declare const _default: VeStrategyWrapper;
4335
- declare enum UmdKeys {
4336
- HLS = "hls",
4337
- FLV = "flv",
4338
- XGVideo = "XGVideo",
4339
- HLSEncrypt = "hlsEncrypt",
4340
- DASH = "dash",
4341
- MP4Encrypt = "mp4Encrypt",
4342
- DanmuJS = "danmujs",
4343
- DanmuMask = "danmuMask",
4344
- StreamProbe = "streamprobe",
4345
- VeStrategy = "vestrategy",
4346
- VeStrategyH265 = "vestrategy_h265",
4347
- VeStrategyPreload = "vestrategy_preload",
4348
- VeStrategyAdaptRange = "vestrategy_adapt_range",
4349
- DashAbralgo = "DashAbralgo",
4350
- Preloader = "preloader"
5045
+ ADAPT_RANGE = "adaptRange"
4351
5046
  }
4352
- /**
5047
+ /** {zh}
5048
+ * 预加载实例,通过预加载实例可执行一些高级方法
5049
+ * @detail Options
4353
5050
  * @hidden
4354
- * @breif umdmap 配置
4355
5051
  */
4356
- export declare type UMDMap = Record<UmdKeys, {
5052
+ export declare type PreloaderManager = {
4357
5053
  /**
4358
- * umd Module 的名称,即在window下暴露的接口名称
5054
+ * 移除所有已预加载数据
4359
5055
  */
4360
- name: string;
5056
+ removeAll(): void;
4361
5057
  /**
4362
- * 对应umd文件名,只用来标记,实际不使用
5058
+ * 移除所有预加载任务
4363
5059
  */
4364
- pluginName?: string;
5060
+ removeAllPreloadTask(): void;
4365
5061
  /**
4366
- * 对应npm包的名称,在打包文件时,会在libd.config.js中onPostBuild的钩子中会用于寻找对应npm包
5062
+ * 清空待预加载列表
4367
5063
  */
4368
- packageName: string;
5064
+ clearPreloadList(): void;
5065
+ };
5066
+ declare enum PreloadScene {
4369
5067
  /**
4370
- * npm包中umd入口文件路径,用于打包上传到cdn目录
5068
+ * 普通场景(手动执行预加载)
4371
5069
  */
4372
- devPath: string;
4373
- }>;
4374
- declare class UMDLoader {
4375
- private static jsLoadMap;
4376
- private static jsLoadPromiseMap;
4377
- umdMap: UMDMap;
4378
- backupUmdUrlMap: Record<string, string>;
4379
- failCallback: (umdName: string, err: any) => any;
4380
- region: TRegionType;
4381
- userRegion: TRegionType;
4382
- customPluginPublicPath: string;
4383
- importedPlugins: any[];
4384
- constructor();
5070
+ NORMAL = 0,
4385
5071
  /**
4386
- * @return { string } 插件加载的公共路径
5072
+ * Feed流场景(播放器自动执行预加载)
5073
+ * @brief Feed 流场景(播放器自动执行预加载)
4387
5074
  */
4388
- get pluginPublicPath(): string;
5075
+ /** {en}
5076
+ * @brief Feed流场景(播放器自动执行预加载)
5077
+ */
5078
+ FEED = 1
5079
+ }
5080
+ declare enum PreloadFormat {
5081
+ MP4 = "mp4",
5082
+ HLS = "hls"
5083
+ }
5084
+ declare enum PreloaderStatus {
4389
5085
  /**
4390
- * 更新umd的备用地址
4391
- * @param {Record<string, string>} map 备用地址map
5086
+ * 不可用
4392
5087
  */
4393
- updateBackupMap(map: Record<string, string>): void;
5088
+ DISABLED = 0,
4394
5089
  /**
4395
- * 加载额外的js-sdk
4396
- * 适用 umd 模块
4397
- * 只能浏览器环境下使用
4398
- * @param url 额外加载JS 的 CDN 地址
4399
- * @param isJs 是否js文件
5090
+ * 初始状态
4400
5091
  */
4401
- loadExtraCdn(url: string, isJs?: boolean): Promise<void>;
5092
+ INITIALIZING = 1,
4402
5093
  /**
4403
- * @description 加载xgplayer插件
4404
- * @param pluginName 插件名称
4405
- * @param successCallback 加载完成后执行的回调
4406
- * @return Promise<any>
5094
+ * 已Ready
4407
5095
  */
4408
- loadPlugins(pluginName: UmdKeys, successCallback?: () => void): Promise<any>;
5096
+ READY = 2,
5097
+ /**
5098
+ * 加载失败
5099
+ */
5100
+ FAILED = 3
4409
5101
  }
4410
- export declare class SdkPlugin {
4411
- pluginName: string;
4412
- __args: any;
4413
- sdk: VePlayer;
4414
- playerData: PlayerData;
4415
- player: Player;
4416
- _emitter: EventEmitter;
4417
- static defineGetterOrSetter(Obj: any, map: any): void;
5102
+ /** {zh}
5103
+ * 预加载配置更新
5104
+ * @detail Options
5105
+ * @hidden
5106
+ */
5107
+ export declare type IPreloadUpdateConfig = {
4418
5108
  /**
4419
- * @type { string }
5109
+ * 向前加载视频个数
4420
5110
  */
4421
- static get pluginName(): string;
5111
+ prevCount?: number;
4422
5112
  /**
4423
- * @constructor
4424
- * @param { { sdk: object, pluginName: string, [propName: string]: any;} } args
5113
+ * 向后加载视频个数
4425
5114
  */
4426
- constructor(args: any);
5115
+ nextCount?: number;
5116
+ };
5117
+ /** {zh}
5118
+ * 预加载视频资源
5119
+ * @detail Options
5120
+ */
5121
+ export declare type IPreloadStream = {
4427
5122
  /**
4428
- * @description sdk实例创建,挂载插件实例时首先执行
5123
+ * 视频唯一ID
5124
+ * @brief 视频 ID
4429
5125
  */
4430
- beforeCreate(): void;
5126
+ /** {en}
5127
+ * @brief 视频唯一ID
5128
+ */
5129
+ vid: string;
4431
5130
  /**
4432
- * @description sdk实例创建,挂载插件实例完后执行
5131
+ * 播放地址
5132
+ * @brief 视频播放地址
4433
5133
  */
4434
- afterCreate(): void;
5134
+ /** {en}
5135
+ * @brief 播放地址
5136
+ */
5137
+ url: string;
4435
5138
  /**
4436
- * @description sdk创建播放器前执行,只有这里能保证异步操作在creatPlayer之前同步完成
5139
+ * 视频清晰度
4437
5140
  */
4438
- beforePlayerCreate(): void;
5141
+ definition: string;
4439
5142
  /**
4440
- * @description sdk创建播放器完执行
5143
+ * 视频streamType,支持 mp4、hls
5144
+ * @brief 视频流类型,支持 mp4、hls
4441
5145
  */
4442
- afterPlayerCreate(): void;
5146
+ /** {en}
5147
+ * @brief video streamType,support mp4、hls
5148
+ */
5149
+ streamType: string;
4443
5150
  /**
4444
- * @description sdk销毁时执行
5151
+ * 视频codec,暂支持 h264
5152
+ * @brief 视频编码格式,当前仅支持 mp4
4445
5153
  */
4446
- destroy(): void;
5154
+ /** {en}
5155
+ * @brief 视频codec,暂支持 h264
5156
+ */
5157
+ codec: string;
4447
5158
  /**
4448
- * @private
4449
- * @param { any } args
5159
+ * 码率, 数据统计需要,可选填
5160
+ * @brief 码率, 数据统计需要,选填
4450
5161
  */
4451
- __init(args: any): void;
5162
+ /** {en}
5163
+ * @brief 码率, 数据统计需要,可选填
5164
+ */
5165
+ bitrate: number;
4452
5166
  /**
4453
- * @description 插件销毁
4454
- * @private
5167
+ * 视频时长,数据统计需要,可选填
5168
+ * @brief 视频时长,数据统计需要,选填
4455
5169
  */
4456
- __destroy(): void;
4457
- }
4458
- declare class AuthToken extends SdkPlugin {
4459
- static get pluginName(): string;
4460
- isPlayByToken: boolean;
4461
- isEncrypt: boolean;
4462
- tokenInfo: ITokenInfo;
4463
- keyTokenInfo: ITokenInfo;
4464
- thirdPartyDrmAuthTokenInfo: ITokenInfo;
4465
- config: IPlayAuthTokenConfig;
4466
- privateDrmAuthToken: string;
4467
- useUnionInfoDRM: boolean;
4468
- sessionId: string;
4469
- retryCount: number;
4470
- playInfo?: VideoInfoRes;
4471
- constructor(args: any);
4472
- beforePlayerCreate(): Promise<void>;
4473
- getVideoInfo(): Promise<{
4474
- vid: string;
4475
- playList: Stream[];
4476
- codec: ICodecType;
4477
- defaultDefinition: string;
4478
- }>;
4479
- getVideos(): Promise<any>;
4480
- getPrivateDrmInfo(playList: Stream[], vid: string, streamType: string): Promise<void>;
4481
- getThumbnailConfig(thumbs: IThumbInfoItem[]): void;
4482
- getBarrageMaskUrl(url: string): void;
4483
- getDrmConfig(videoInfo: IVideoInfo): void;
4484
- init(): void;
4485
- initConfig(getVideoByToken: IPlayAuthTokenConfig): void;
5170
+ /** {en}
5171
+ * @brief 视频时长,数据统计需要,可选填
5172
+ */
5173
+ duration: number;
4486
5174
  /**
4487
- * @description 更新playAuthToken
4488
- * @param {IPlayAuthTokenConfig} getVideoByToken token信息
4489
- * @param {boolean} isNewVideo 是否新视频,即是否为切换视频
5175
+ * 视频大小,数据统计需要,可选填
5176
+ * @brief 视频大小,数据统计需要,选填
4490
5177
  */
4491
- updateAuthToken(getVideoByToken: IPlayAuthTokenConfig, isNewVideo: boolean): Promise<void>;
4492
- checkPlayAuthTokenValid(): boolean;
4493
- checkKeyTokenValid(): boolean;
4494
- checkDrmAuthTokenValid(): boolean;
4495
- }
5178
+ /** {en}
5179
+ * @brief 视频大小,数据统计需要,可选填
5180
+ */
5181
+ size: number;
5182
+ };
5183
+ export type TLogChannel = "cn" | "va" | "sg";
4496
5184
  /** {zh}
4497
5185
  * @hidden
5186
+ * h265策略配置
5187
+ * @detail Options
4498
5188
  */
4499
- export interface IAdaptRangeDefaultOptions {
4500
- maxTargetCacheDur: number;
4501
- minTargetCacheDur: number;
4502
- rangeMaxDuration: number;
4503
- rangeMinDuration: number;
4504
- cacheSafeFactor: number;
4505
- estPTcontrol: boolean;
4506
- estPlayTime: number;
4507
- minBandwidth: number;
4508
- minDangerThreshold: number;
4509
- rangeControl: boolean;
4510
- rangeMinSize: number;
4511
- safeFactor: number;
4512
- targetCacheControl: boolean;
4513
- }
4514
- declare abstract class AbstractBaseAdapter {
4515
- isLive: boolean;
4516
- playerData: PlayerData;
4517
- streamType: string;
4518
- constructor(options: {
4519
- configs: IPlayerConfig;
4520
- playerData: PlayerData;
4521
- streamType: string;
4522
- });
5189
+ export declare type IH265Config = {
4523
5190
  /**
4524
- * @description 是否使用原生video的abr能力
5191
+ * h265策略依赖Module
4525
5192
  */
4526
- abstract useNativeAbr(): boolean;
4527
- abstract canOpenAbr(vidPlayInfo?: VideoInfoRes): boolean;
4528
- abstract applyAbrPluginConfig(_finalOptions: any, _autoBitrateOpts: any): void;
4529
- abstract prepareAbrModule(_playerData: any, _sdkUmdLoader: any): void;
4530
- abstract needAbrAutoDefinition(): boolean;
4531
- abstract setAbrDefaultDefiWithAuto(): boolean;
4532
- abstract generatePlaylistFromServer(res: VideoInfoRes): Stream[];
4533
- abstract canAdaptRangeEnable(): boolean;
4534
- abstract adaptRangeDefaultOptions(): IAdaptRangeDefaultOptions | undefined;
4535
- abstract applyAdaptRangePluginConfig(_finalOptions: any, _adaptRangeOptions: any): void;
4536
- abstract applyAdaptRangeStrategy(_finalOptions: any, _adaptRangeOptions: any): void;
4537
- abstract getPlugins(umdLoader: UMDLoader): Promise<XGPlugin[]>;
4538
- abstract setPluginConfigInVid(videoInfo: IVideoInfo, context: AuthToken): void;
4539
- }
4540
- declare class PlayerData {
4541
- id?: string;
4542
- root?: HTMLElement;
4543
- configs: IPlayerConfig;
4544
- strategyConfig?: StrategyConfigOptions;
4545
- type: string;
4546
- isLive: boolean;
4547
- options: any;
4548
- isMobile: boolean;
4549
- playList: Stream[];
4550
- plugins: any[];
4551
- openSoftDecoding: boolean;
4552
- defaultConfig: IDefaultConfig | undefined;
4553
- isHitDefault: boolean;
4554
- codec?: ICodecType;
4555
- enableH265Degrade: boolean;
4556
- languageData: {
4557
- extraLangList: IXGI18nText[];
4558
- extendLangList: IXGI18nText[];
4559
- };
4560
- current: Current;
4561
- onMediaExpired: () => Promise<SourceConfig>;
4562
- onTokenExpired: () => Promise<IPlayAuthTokenConfig>;
4563
- unionId?: string;
4564
- unionInfo?: string;
4565
- isMusic?: boolean;
4566
- sdkPlugins: any[];
4567
- useHlsPluginForSafari: boolean;
4568
- enableMenu: boolean;
4569
- region: TRegionType;
4570
- userRegion: TRegionType;
4571
- playDomainDegrade: boolean;
4572
- strategiesPlugins: any[];
4573
- strategiesPluginConfigs: any;
5193
+ Strategy?: any;
4574
5194
  /**
4575
- * @default playList第一项
5195
+ * 是否禁用265策略
4576
5196
  */
4577
- defaultDefinition: string;
4578
- urlCheckData: {
4579
- enableUrlExpireCheck: boolean;
4580
- urlExpireTimestamp: number;
4581
- urlExpireDiff: number;
4582
- urlCheckExpireInterval: number;
4583
- };
4584
- private isAutoBitrateEnable;
4585
- adapter: AbstractBaseAdapter;
5197
+ disabled?: boolean;
5198
+ } & VeStrategyH265Config;
5199
+ /** {zh}
5200
+ * 预加载初始配置
5201
+ * @detail Options
5202
+ */
5203
+ export declare type IPreloadConfig = {
5204
+ /** {zh}
5205
+ * 预加载场景
5206
+ * - 0:手动执行
5207
+ * - 1:字段执行
5208
+ * @default 0
5209
+ */
5210
+ /** {en}
5211
+ * preload scene
5212
+ * - 0: manual execution
5213
+ * - 1: field execution
5214
+ * @default 0
5215
+ */
5216
+ preloadScene?: PreloadScene;
5217
+ /** {zh}
5218
+ * @brief 视频格式
5219
+ * - mp4: mp4格式
5220
+ * - hls: hls格式
5221
+ * @default mp4
5222
+ */
5223
+ /** {en}
5224
+ * @brief video format
5225
+ * - mp4: mp4 format
5226
+ * - hls: hls format
5227
+ * @default mp4
5228
+ */
5229
+ format?: PreloadFormat;
5230
+ /** {zh}
5231
+ * 向前预加载视频个数,Feed流场景时生效
5232
+ * @default 1
5233
+ * @brief 向前预加载视频个数。Feed 流场景时生效。
5234
+ */
5235
+ /** {en}
5236
+ * @brief 向前预加载视频个数,Feed流场景时生效
5237
+ */
5238
+ prevCount?: number;
4586
5239
  /**
4587
- * @breif 是否vid模式的加密播放
5240
+ * 向后预加载视频个数,Feed流场景生效
5241
+ * @default 2
5242
+ * @brief 向后预加载视频个数。Feed 流场景生效
5243
+ */
5244
+ /** {en}
5245
+ * @brief 向后预加载视频个数,Feed流场景生效
5246
+ */
5247
+ nextCount?: number;
5248
+ /**
5249
+ * 单个视频预加载时长
5250
+ * @default 5
5251
+ */
5252
+ preloadTime?: number;
5253
+ /**
5254
+ * 最大视频缓存个数
5255
+ * @default 15
5256
+ */
5257
+ preloadMaxCacheCount?: number;
5258
+ /**
5259
+ * 预加载依赖Module
5260
+ * @brief 预加载依赖 Module
5261
+ */
5262
+ /** {en}
5263
+ * @brief 预加载依赖Module
5264
+ */
5265
+ Strategy?: any;
5266
+ /**
5267
+ * 是否禁用预加载
5268
+ */
5269
+ disabled?: boolean;
5270
+ };
5271
+ /** {zh}
5272
+ * @hidden
5273
+ * @detail Options
5274
+ * @brief Range 拆分(动态Buffer)策略初始配置
5275
+ * @notes adaptRange策略配置结构较复杂,暂不开放Range默认配置自定义,使用策略下发
5276
+ */
5277
+ export declare type IAdaptRangeConfig = {
5278
+ /** {zh}
5279
+ * @brief 预加载依赖Module
4588
5280
  */
4589
- isVidEncrypt: boolean;
4590
- dashOpts: {
4591
- Data: IGetPlayInfoRes;
4592
- };
4593
- /**
4594
- * @brief 播放器sdk实例
5281
+ Strategy?: any;
5282
+ /** {zh}
5283
+ * @brief 是否禁用Range拆分策略
4595
5284
  */
4596
- sdk: VePlayer;
5285
+ disabled?: boolean;
5286
+ };
5287
+ /** {zh}
5288
+ * @detail Options
5289
+ * @brief 策略配置。
5290
+ */
5291
+ export declare type StrategyConfigOptions = {
4597
5292
  /**
4598
- * @brief 当前加密播放类型,为空则表示非加密
5293
+ * h265策略配置
5294
+ * @hidden
5295
+ * @brief H.265 策略配置。
4599
5296
  */
4600
- drmType: EDRMTYPE;
4601
- /**
4602
- * @brief 私有加密会话id
5297
+ /** {en}
5298
+ * @hidden
5299
+ * @brief h265策略配置
4603
5300
  */
4604
- encryptSessionId?: string;
4605
- constructor(configs: IPlayerConfig & {
4606
- licensSupportModuleList: string[];
4607
- }, sdk: VePlayer);
5301
+ [StrategyNames.H265]?: boolean | IH265Config;
4608
5302
  /**
4609
- * 初始化播放数据
4610
- * @param configs { IPlayerConfig } 播放器配置
5303
+ * 预加载配置
5304
+ * @brief 预加载配置。
4611
5305
  */
4612
- initPlayData(configs: IPlayerConfig): void;
4613
- initPlaylistAndGetCurrent(configs: IPlayerConfig): Stream;
4614
- checkAutoBitratePlayList(): boolean;
4615
- getABRStreamInfo(streamType: any, originDefaultStream: any): {
4616
- defaultDefinition: string;
4617
- defaultStream: any;
4618
- playList: Stream[];
4619
- };
4620
- isCurrentH265(): boolean;
4621
- setDrmType(drmType: EDRMTYPE): void;
4622
- getCurrentByDefaultConfig(): Stream;
4623
- initCurrent(currentStreams: Stream): void;
4624
- initCheckExpireData(): void;
4625
- /**
4626
- * 更新过期检测的数据
5306
+ /** {en}
5307
+ * @brief 预加载配置
4627
5308
  */
4628
- updateCheckExpireData(): void;
4629
- initI18nData(languages: any): {
4630
- extraLangList: any[];
4631
- extendLangList: any[];
4632
- };
5309
+ [StrategyNames.PRELOAD]?: boolean | IPreloadConfig;
4633
5310
  /**
4634
- * @description: 获取当前直播url
5311
+ * Range拆分(动态Buffer)
5312
+ * @brief 动态 Buffer 配置。
4635
5313
  */
4636
- getCurrentUrl(): Url;
4637
- getTargetStreamType(stream?: Stream): string;
4638
- /**
4639
- * @description: 获取当前的streamType
5314
+ /** {en}
5315
+ * @brief Range拆分(动态Buffer)
4640
5316
  */
4641
- getCurrentStreamType(): string;
4642
- getStreamType(): string;
4643
- isOpenABR(): boolean;
4644
- showRealDefinition(): boolean;
4645
- isAutoDefinition(def: any): boolean;
4646
- isPlayAutoDefinition(def?: string): boolean;
4647
- isDefinitionMatch(pre: any, next: any): boolean;
4648
- /**
4649
- * @description: 获取满足当前直播条件的流
5317
+ [StrategyNames.ADAPT_RANGE]?: boolean | IAdaptRangeConfig;
5318
+ };
5319
+ /** {zh}
5320
+ * 播放器预初始化配置
5321
+ * @detail Options
5322
+ */
5323
+ export declare type StrategyInitOptions = {
5324
+ /** {zh}
5325
+ * 应用ID
5326
+ * @brief 应用 ID
4650
5327
  */
4651
- getCurrentStreams(): Stream[];
4652
- /**
4653
- * @description: 获取根据线路ID去重的流,用于获取有几个线路
5328
+ /** {en}
5329
+ * @brief appid
4654
5330
  */
4655
- getLineList(): Stream[];
4656
- /**
4657
- * @description: 根据线路ID获取符合条件的流
4658
- * @param {number} lineId
5331
+ appId: number;
5332
+ /** {zh}
5333
+ * @brief 用户所在区域
5334
+ * @default cn
5335
+ * @notes 如果是海外用户,播放时请填写'mya'
4659
5336
  */
4660
- getLineListByLineId(lineId: number | string): Stream[];
4661
- /**
4662
- * @description: 根据线路ID获取清晰度list,用于获取某个线路下有几个清晰度
4663
- * @param {number} lineId
5337
+ /** {en}
5338
+ * @brief The region where the user is located,
5339
+ * @default sg
4664
5340
  */
4665
- getDefinitionListByLineId(lineId: number | string): Stream[];
4666
- /**
4667
- * @description: 根据条件筛选符合条件的流list
4668
- * @param {Condition} condition
5341
+ region?: TRegionType;
5342
+ /** {zh}
5343
+ * 高级能力(策略)配置
5344
+ * @brief 策略配置
4669
5345
  */
4670
- getUrlList(condition: Condition): Stream[];
4671
- /**
4672
- * @description: 获取当期清晰的上一级清晰度或下一级清晰度
4673
- * @param {boolean} isDown 是否取下一级清晰度
4674
- * @param {string[]} demotePriority 清晰度降级顺序
5346
+ /** {en}
5347
+ * @brief Advanced Capability (Strategy) Configuration
4675
5348
  */
4676
- getNextDefinition(isDown: boolean, demotePriority: string[]): Stream[];
4677
- /**
4678
- * 获取api map
4679
- * @return { ApiMapConfig }
5349
+ strategies: StrategyConfigOptions;
5350
+ /** {zh}
5351
+ * 设备ID
5352
+ * @brief 设备 ID
4680
5353
  */
4681
- get apiMap(): ApiMapConfig;
4682
- /**
4683
- * 获取播放域名
5354
+ /** {en}
5355
+ * @brief device id
4684
5356
  */
4685
- get playDomain(): string;
4686
- setVodTeaId(): void;
4687
- /**
4688
- * 更新configs,即更新用户的configs,常用于playNext时
4689
- * @param newConfigs {IPlayerConfig} 要更新的配置
5357
+ deviceId?: string;
5358
+ /** {zh}
5359
+ * @brief 手动注入依赖插件,默认自动加载
5360
+ * @default -
4690
5361
  */
4691
- updateConfigs(newConfigs: IPlayerConfig): void;
5362
+ /** {en}
5363
+ * @brief Manually inject dependency plugins, automatically load by default
5364
+ * @default -
5365
+ */
5366
+ plugins?: any[];
4692
5367
  /**
4693
- * 更新playList
5368
+ * 策略Module,默认自动加载
5369
+ * @brief 策略 Module,默认自动加载
5370
+ * @default -
4694
5371
  */
4695
- updatePlayList(): void;
4696
- isVidPlay(): boolean;
4697
- }
4698
- /**
4699
- * @hidden
4700
- * @brief 移动端交互面板配置
4701
- */
4702
- export interface IConfig {
4703
- mode?: number;
4704
- isAutoChange?: boolean;
4705
- }
4706
- declare class MobilePlayerPanel {
4707
- config: IConfig;
4708
- parent: HTMLElement;
4709
- root: any;
4710
- mode: number;
4711
- isAutoChange: number;
4712
- player: any;
4713
- children: HTMLElement | undefined;
4714
- container: HTMLElement | undefined;
4715
- title: HTMLElement | undefined;
4716
- isShow: boolean;
4717
- showCancelBtn: boolean;
4718
- constructor(args: any);
4719
- initEvents(): void;
4720
- handleOrientationChange(): void;
4721
- changeConfig(config: IConfig): void;
4722
- changeMode(mode: number): void;
4723
- renderPanel(): void;
4724
- showPanel(children: HTMLElement, title?: string, isItemList?: boolean): Promise<void>;
4725
- updatePanel(children: HTMLElement): void;
4726
- setTitle(title: any): void;
4727
- renderTitle(title: any): HTMLElement;
4728
- show(): void;
4729
- hide(): void;
4730
- handleHide(e: any): void;
4731
- bind(event: string, eventHandle: any, isBubble?: boolean): void;
4732
- destroy(): void;
5372
+ /** {en}
5373
+ * @brief Strategy Module, automatically loaded by default
5374
+ * @default -
5375
+ */
5376
+ Module?: typeof VeStrategy;
5377
+ };
5378
+ declare class VeStrategyManager {
5379
+ tea: Collector;
5380
+ private static mapStrategyNameToUmdKey;
5381
+ teaId: number;
5382
+ teaChannel: TLogChannel;
5383
+ private sdkUmdLoader;
5384
+ private webId;
5385
+ config: StrategyInitOptions;
5386
+ private status;
5387
+ private initPromise;
5388
+ Module: typeof VeStrategy;
5389
+ private preloadWrapper;
5390
+ private h265Wrapper;
5391
+ get preloader(): PreloaderManagerOrigin | undefined;
5392
+ get preloaderStatus(): PreloaderStatus;
5393
+ constructor();
5394
+ private initUmdLoader;
5395
+ private fetchWebId;
5396
+ private initTea;
5397
+ private fetchVeStrategy;
5398
+ private fetchStrategies;
5399
+ private initOnce;
5400
+ init(config: StrategyInitOptions): Promise<boolean>;
5401
+ addPreloadList(list: IPreloadStream[]): void;
5402
+ setPreloadList(list: IPreloadStream[]): Promise<void>;
5403
+ setPreloadScene(preloadScene: PreloadScene, options?: any): void;
5404
+ prepare(): Promise<boolean>;
5405
+ getDeviceId(): string;
5406
+ isReady(): boolean;
5407
+ getStrategyRecommendations(options?: any, commonOptions?: any): StrategyRecommendation;
5408
+ getStrategyRecommendationsAsync(options?: any, commonOptions?: any): Promise<StrategyRecommendation>;
5409
+ isHevcRecommended(): boolean;
4733
5410
  }
5411
+ declare const _default: VeStrategyManager;
4734
5412
  export interface IlicenseContent {
4735
5413
  content: string;
4736
5414
  sign: string;
@@ -4850,6 +5528,8 @@ declare class VePlayer {
4850
5528
  * @memberof VePlayer
4851
5529
  */
4852
5530
  private _emitter;
5531
+ /** 最近一次用户主动(或 defaultAudioLang)选中的音轨语言代码,用于清晰度切换后恢复音轨 */
5532
+ private _lastSelectedAudioLang;
4853
5533
  /**
4854
5534
  *
4855
5535
  *
@@ -4956,6 +5636,10 @@ declare class VePlayer {
4956
5636
  * @param list 待预加载视频列表,详情见{@link IPreloadStream[]}
4957
5637
  */
4958
5638
  static setPreloadList(list: IPreloadStream[]): Promise<void>;
5639
+ /** {zh}
5640
+ * @brief 是否支持iOS的MMS
5641
+ */
5642
+ static isMMSSupported: typeof isMMSSupported;
4959
5643
  /**
4960
5644
  * @hidden
4961
5645
  * @param codec
@@ -5252,6 +5936,9 @@ declare class VePlayer {
5252
5936
  * @memberof VePlayer
5253
5937
  */
5254
5938
  private _bindSdkEvents;
5939
+ private _bindNativeAudioTrackEvents;
5940
+ private _onNativeAddTrack;
5941
+ private _onNativeTrackChange;
5255
5942
  /** {zh}
5256
5943
  * @hidden
5257
5944
  *
@@ -5265,6 +5952,12 @@ declare class VePlayer {
5265
5952
  * @return {*}
5266
5953
  * @memberof VePlayer
5267
5954
  */
5955
+ /** @hidden 获取 HLS 实例(兼容加密和普通 HLS 插件) */
5956
+ private _getHlsInstance;
5957
+ /** @hidden 在 HLS 音轨列表就绪或清晰度切换后,恢复上次选中的音轨;找不到时 fallback 到 defaultAudioLang */
5958
+ private _applyDefaultAudioLang;
5959
+ /** @hidden 在 native AudioTrackList 就绪后,恢复上次选中的音轨;找不到时 fallback 到 defaultAudioLang */
5960
+ private _applyDefaultAudioLangNative;
5268
5961
  private _offPlayerEvents;
5269
5962
  /** {zh}
5270
5963
  * @hidden 切换插件展示
@@ -5404,6 +6097,50 @@ declare class VePlayer {
5404
6097
  selected: boolean;
5405
6098
  [propName: string]: any;
5406
6099
  }>;
6100
+ /** {zh}
6101
+ * @brief 获取音频轨道列表。HLS 流通过 hls.js 获取,iOS 原生播放通过 HTMLMediaElement.audioTracks 获取。
6102
+ * @notes 每项包含 `id`、`name`、`lang`、`channels`、`default`、`selected` 字段;轨道数量 ≤ 1 时返回空数组。
6103
+ */
6104
+ getAudioTracks(): Array<{
6105
+ id: string | number;
6106
+ name: string;
6107
+ lang?: string;
6108
+ channels?: string;
6109
+ default: boolean;
6110
+ selected: boolean;
6111
+ [key: string]: unknown;
6112
+ }>;
6113
+ /** {zh}
6114
+ * @brief 获取当前激活的音频轨道。
6115
+ * @notes HLS 流通过 hls.js 获取,iOS 原生播放通过 HTMLMediaElement.audioTracks 获取;无激活轨道时返回 null。
6116
+ */
6117
+ getCurrentAudioTrack(): {
6118
+ id: string | number;
6119
+ name: string;
6120
+ lang?: string;
6121
+ channels?: string;
6122
+ default: boolean;
6123
+ selected: boolean;
6124
+ [key: string]: unknown;
6125
+ } | null;
6126
+ /** {zh}
6127
+ * @brief 切换音频轨道。
6128
+ * @param id 目标轨道的 id,可通过 `getAudioTracks()` 获取。
6129
+ * @notes 切换完成后会触发 `Events.AUDIO_TRACK_CHANGE` 事件;
6130
+ * 同时 PC 端和移动端音频轨道插件的选中状态会自动更新。
6131
+ */
6132
+ switchAudioTrack(id: string | number): void;
6133
+ /** {zh}
6134
+ * @brief 当前播放是否命中预加载缓存
6135
+ * @memberof VePlayer
6136
+ * @return {boolean} 是否命中预加载
6137
+ */
6138
+ /** {en}
6139
+ * @brief Whether the current playback hits the preloaded cache
6140
+ * @memberof VePlayer
6141
+ * @return {boolean} Whether the current playback hits the preloaded cache
6142
+ */
6143
+ get hitPreload(): boolean;
5407
6144
  /** {zh}
5408
6145
  * @brief 初始化多语言词典
5409
6146
  *
@@ -5775,15 +6512,17 @@ export declare class Subtitle extends Plugin {
5775
6512
  */
5776
6513
  _initExtSubTitle(defaultIndex: any): void;
5777
6514
  _renderList(defaultIndex: any): void;
5778
- _onOff(): void;
5779
- _onChange(data: any): void;
5780
- _onListReset(data: any): void;
6515
+ _onOff: () => void;
6516
+ _onChange: (data: any) => void;
6517
+ _onListReset: (data: any) => void;
5781
6518
  updateCurItem(cIndex: any, subtitle: any): void;
5782
6519
  initEvents(): void;
5783
- handleButtonChange(e: any): void;
6520
+ handleButtonChange: (e: any) => void;
6521
+ onEnter: (e: any) => void;
6522
+ onLeave: (e: any) => void;
5784
6523
  showList(): void;
5785
6524
  hideList(): void;
5786
- openSubtitle(): void;
6525
+ openSubtitle(): Promise<any>;
5787
6526
  getSubTitleIndex(list: any, subtitle?: {
5788
6527
  id: string;
5789
6528
  language: string;
@@ -5825,9 +6564,9 @@ export declare class Subtitle extends Plugin {
5825
6564
  /**
5826
6565
  *
5827
6566
  * @param {ISubTitleItem} subtitle
5828
- * @returns
6567
+ * @returns {Promise<void>}
5829
6568
  */
5830
- switchSubTitle(subtitle?: ISubTitleItem): any;
6569
+ switchSubTitle(subtitle?: ISubTitleItem): Promise<void>;
5831
6570
  switchOffSubtitle(): void;
5832
6571
  noShowSubtitle(): void;
5833
6572
  renderItemList(): void;
@@ -6191,6 +6930,10 @@ export declare const Events: {
6191
6930
  * @brief 多码率自适应播放时,自动挡位对应的清晰度改变。
6192
6931
  */
6193
6932
  ABR_AUTO_DESC_CHANGE: string;
6933
+ /** {zh}
6934
+ * @brief 播放插件内核的扩展事件
6935
+ */
6936
+ CORE_EVENT: string;
6194
6937
  /** {zh}
6195
6938
  * @brief 播放器实例创建完成时触发。
6196
6939
  */
@@ -6397,6 +7140,14 @@ export declare const Events: {
6397
7140
  * @brief license 提醒
6398
7141
  */
6399
7142
  LICENSE_STATUS_WARNING: string;
7143
+ /** {zh}
7144
+ * @brief HLS 音频轨道列表更新时触发。`data.audioTracks` 为完整轨道数组。
7145
+ */
7146
+ AUDIO_TRACKS_UPDATED: string;
7147
+ /** {zh}
7148
+ * @brief 音频轨道切换完成时触发。`data.id` 为新轨道 id,`data.audioTrack` 为完整轨道对象。
7149
+ */
7150
+ AUDIO_TRACK_CHANGE: string;
6400
7151
  /** {zh}
6401
7152
  * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
6402
7153
  */
@@ -6720,6 +7471,14 @@ export declare const Event: {
6720
7471
  * @brief license 提醒
6721
7472
  */
6722
7473
  LICENSE_STATUS_WARNING: string;
7474
+ /** {zh}
7475
+ * @brief HLS 音频轨道列表更新时触发。`data.audioTracks` 为完整轨道数组。
7476
+ */
7477
+ AUDIO_TRACKS_UPDATED: string;
7478
+ /** {zh}
7479
+ * @brief 音频轨道切换完成时触发。`data.id` 为新轨道 id,`data.audioTrack` 为完整轨道对象。
7480
+ */
7481
+ AUDIO_TRACK_CHANGE: string;
6723
7482
  };
6724
7483
  PluginEvents: {
6725
7484
  /** {zh}
@@ -6862,6 +7621,10 @@ export declare const Event: {
6862
7621
  * @brief 多码率自适应播放时,自动挡位对应的清晰度改变。
6863
7622
  */
6864
7623
  ABR_AUTO_DESC_CHANGE: string;
7624
+ /** {zh}
7625
+ * @brief 播放插件内核的扩展事件
7626
+ */
7627
+ CORE_EVENT: string;
6865
7628
  };
6866
7629
  };
6867
7630
  export * from "xgplayer";