@volcengine/veplayer 1.10.0-rc.0 → 1.10.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
@@ -500,7 +500,7 @@ export interface ISubtitleConfig {
500
500
  export interface ISubtitleStyle {
501
501
  /**
502
502
  * 是否跟随控制栏调整位置
503
- * @default true
503
+ * @default false
504
504
  * @type {boolean | null}
505
505
  * @memberof ISubtitleStyle
506
506
  * @brief 是否跟随控制栏调整位置。
@@ -508,7 +508,7 @@ export interface ISubtitleStyle {
508
508
  /** {en}
509
509
  * @brief 是否跟随控制栏调整位置
510
510
  */
511
- follow: boolean | null;
511
+ follow?: boolean;
512
512
  /**
513
513
  * 字体显示模式,默认是描边
514
514
  * @default 'stroke'
@@ -1371,8 +1371,10 @@ export declare type IPlayerOptions = {
1371
1371
  };
1372
1372
  /**
1373
1373
  * @brief mobile端交互配置。
1374
- * @list Options
1375
- * @kind property
1374
+ * @hidden
1375
+ */
1376
+ /** {en}
1377
+ * @hidden
1376
1378
  */
1377
1379
  export interface IMobileConfig {
1378
1380
  /**
@@ -1481,8 +1483,10 @@ export interface IMobileConfig {
1481
1483
  }
1482
1484
  /**
1483
1485
  * @brief 播放器中间切换暂停/播放的按钮。
1484
- * @list Options
1485
- * @kind property
1486
+ * @hidden
1487
+ */
1488
+ /** {en}
1489
+ * @hidden
1486
1490
  */
1487
1491
  export interface IStartConfig {
1488
1492
  /**
@@ -2053,9 +2057,18 @@ export declare class MemoryPlay extends Plugin {
2053
2057
  getTimeByStorage(memoryId: string): string | 0;
2054
2058
  destroy(): void;
2055
2059
  }
2056
- declare enum EDRMTYPE {
2057
- DRM_ENCRYPT = "drm_encrypt"
2060
+ /** {zh}
2061
+ * @hidden
2062
+ */
2063
+ export declare const enum EDRMTYPE {
2064
+ DRM_ENCRYPT = "drm_encrypt",
2065
+ PRIVATE_ENCRYPT = "private_encrypt",
2066
+ PRIVATE_ENCRYPT_UPGRADE = "private_encrypt_upgrade",
2067
+ STANDARD_ENCRYPT = "standard_encrypt"
2058
2068
  }
2069
+ /** {zh}
2070
+ * @hidden
2071
+ */
2059
2072
  export interface IPlayInfoListItem {
2060
2073
  BackupPlayUrl: string;
2061
2074
  BackupUrlExpire: string;
@@ -2084,6 +2097,10 @@ export interface IPlayInfoListItem {
2084
2097
  Width: number;
2085
2098
  DrmType?: EDRMTYPE;
2086
2099
  }
2100
+ /** {zh}
2101
+ * @hidden
2102
+ * @brief 音频封装格式
2103
+ */
2087
2104
  export interface ISubtitleInfoList {
2088
2105
  CreateTime: string;
2089
2106
  FileId: string;
@@ -2100,7 +2117,10 @@ export interface ISubtitleInfoList {
2100
2117
  Version: string;
2101
2118
  Vid: string;
2102
2119
  }
2103
- export interface IThumbInfoList {
2120
+ /** {zh}
2121
+ * @hidden
2122
+ */
2123
+ export interface IThumbInfoItem {
2104
2124
  CaptureNum: number;
2105
2125
  CellHeight: number;
2106
2126
  CellWidth: number;
@@ -2110,6 +2130,10 @@ export interface IThumbInfoList {
2110
2130
  Interval: number;
2111
2131
  StoreUrls: string[];
2112
2132
  }
2133
+ /** {zh}
2134
+ * @brief 蒙版弹幕信息
2135
+ * @hidden
2136
+ */
2113
2137
  export interface IBarrageMaskInfo {
2114
2138
  Version: string;
2115
2139
  BarrageMaskUrl: string;
@@ -2120,9 +2144,29 @@ export interface IBarrageMaskInfo {
2120
2144
  Bitrate: number;
2121
2145
  HeadLen: number;
2122
2146
  }
2147
+ /** {zh}
2148
+ * @hidden
2149
+ */
2150
+ export interface DashAdaptiveInfo {
2151
+ AdaptiveType: string;
2152
+ BackupPlayUrl: string;
2153
+ MainPlayUrl: string;
2154
+ }
2155
+ /** {zh}
2156
+ * @hidden
2157
+ */
2158
+ export interface ABRInfo {
2159
+ AbrFormat: string;
2160
+ BackupPlayUrl: string;
2161
+ MainPlayUrl: string;
2162
+ }
2163
+ /** {zh}
2164
+ * @hidden
2165
+ */
2123
2166
  export interface IGetPlayInfoRes {
2124
2167
  Vid: string;
2125
- AdaptiveInfo?: any;
2168
+ AdaptiveInfo?: DashAdaptiveInfo;
2169
+ AdaptiveBitrateStreamingInfo?: ABRInfo;
2126
2170
  BarrageMaskInfo?: IBarrageMaskInfo;
2127
2171
  BarrageMaskUrl: string;
2128
2172
  Duration: number;
@@ -2132,11 +2176,21 @@ export interface IGetPlayInfoRes {
2132
2176
  PosterUrl: string;
2133
2177
  Status: number;
2134
2178
  SubtitleInfoList: ISubtitleInfoList[];
2135
- ThumbInfoList: IThumbInfoList[];
2179
+ ThumbInfoList: IThumbInfoItem[];
2136
2180
  TotalCount: number;
2137
2181
  Version: number;
2138
2182
  }
2139
- declare enum CodecType {
2183
+ /**
2184
+ * @author bytedance
2185
+ * @version 1.0
2186
+ * @Description
2187
+ * @date 2024/5/17 15:53
2188
+ */
2189
+ /** {zh}
2190
+ * @list Options
2191
+ * @brief 视频编码格式。
2192
+ */
2193
+ export declare const enum CodecType {
2140
2194
  /** {zh}
2141
2195
  * @brief H.264
2142
2196
  */
@@ -2150,15 +2204,15 @@ declare enum CodecType {
2150
2204
  */
2151
2205
  H266 = "h266",
2152
2206
  /** {zh}
2153
- * @brief 音频AAC,含 heaacv2
2207
+ * @brief 音频 AAC,含 heaacv2
2154
2208
  */
2155
2209
  AAC = "aac",
2156
2210
  /** {zh}
2157
- * @brief 音频MP3
2211
+ * @brief 音频 MP3
2158
2212
  */
2159
2213
  MP3 = "mp3",
2160
2214
  /** {zh}
2161
- * @brief 音频OPUS
2215
+ * @brief 音频 OPUS
2162
2216
  */
2163
2217
  OPUS = "opus",
2164
2218
  /** {zh}
@@ -2398,6 +2452,16 @@ export interface Stream extends Partial<IPlayInfoListItem> {
2398
2452
  * @brief 多语言词典中对应的 key。比如 `lineTextKey: LINE_ONE`。
2399
2453
  */
2400
2454
  lineTextKey?: string;
2455
+ /**
2456
+ * @brief 该码流视频的宽度,单位为像素
2457
+ * @default -
2458
+ */
2459
+ width?: number;
2460
+ /**
2461
+ * @brief 该码流视频的高度,单位为像素
2462
+ * @default -
2463
+ */
2464
+ height?: number;
2401
2465
  /**
2402
2466
  * @brief 码流的平均码率
2403
2467
  * @default -
@@ -2470,7 +2534,7 @@ export interface Current extends Partial<Stream> {
2470
2534
  * @brief 视频为加密视频时的加密类型
2471
2535
  * @default -
2472
2536
  */
2473
- drmType?: string;
2537
+ drmType?: EDRMTYPE;
2474
2538
  /**
2475
2539
  * @brief 地址的过期时间戳,vid模式下不用输入,播放器自动获取。如果是火山引擎的CDN分发地址,在不传入过期时间戳时,则需指定urlType,支持{@link https://www.volcengine.com/docs/4/177191 A-E类型},其他云厂商或者业务服务器存储的地址不支持。
2476
2540
  * @default -
@@ -2500,7 +2564,7 @@ export declare type Url = string | Array<{
2500
2564
  * @brief 播放器实例化配置。
2501
2565
  */
2502
2566
  /** {en}
2503
- * @brief Player Instance Configuration
2567
+ * @brief Player instantiation configuration.
2504
2568
  */
2505
2569
  export interface IPlayerConfig extends IPlayerOptions {
2506
2570
  /** {zh}
@@ -2508,6 +2572,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2508
2572
  * @default false
2509
2573
  * @hidden
2510
2574
  */
2575
+ /** {en}
2576
+ * @hidden
2577
+ */
2511
2578
  isLive?: boolean;
2512
2579
  /** {zh}
2513
2580
  * @brief 播放器容器 ID。播放器将被插入在该容器中。
@@ -2782,8 +2849,7 @@ export interface IPlayerConfig extends IPlayerOptions {
2782
2849
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
2783
2850
  /** {zh}
2784
2851
  * @brief 为播放器配置关键点样式。
2785
- * @default
2786
- * @hidden 直播目前没用到
2852
+ * @default -
2787
2853
  */
2788
2854
  commonStyle?: ICommonStyle;
2789
2855
  /** {zh}
@@ -2801,6 +2867,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2801
2867
  * @type {boolean}
2802
2868
  * @memberof IPlayerConfig
2803
2869
  */
2870
+ /** {en}
2871
+ * @hidden
2872
+ */
2804
2873
  enableContextmenu?: boolean;
2805
2874
  /** {zh}
2806
2875
  * @brief 是否关闭 `video` 标签的事件冒泡。取值如下:
@@ -2818,50 +2887,80 @@ export interface IPlayerConfig extends IPlayerOptions {
2818
2887
  */
2819
2888
  enableMenu?: boolean;
2820
2889
  /**
2821
- * @brief 是否关闭pc端单击播放器区域切换播放/暂停
2890
+ * @brief 是否禁用 PC 端点击播放器区域切换播放和暂停功能。
2822
2891
  * @default false
2823
2892
  */
2893
+ /** {en}
2894
+ * @brief Whether to disable the ability to toggle play and pause by clicking on the player area on PC.
2895
+ */
2824
2896
  closeVideoClick?: boolean;
2825
2897
  /**
2898
+ * @brief <br>- PC 端:是否关闭双击播放器进入全屏的功能。
2899
+ * - 移动端:是否关闭双击切换暂停和播放的功能。
2900
+ * @default PC 端为 true,移动端为 false
2901
+ */
2902
+ /** {en}
2826
2903
  * @brief pc端: 是否关闭双击播放器进入全屏的能力
2827
- * mobile端: 是否关闭双击切换暂停/播放的能力
2904
+ * mobile端: 是否关闭双击切换暂停/播放的能力
2828
2905
  * @default pc端: true, mobile端: false
2829
2906
  */
2830
2907
  closeVideoDblclick?: boolean;
2831
2908
  /**
2832
- * @brief 是否关闭播放器自动失焦(只在pc端生效)
2909
+ * @brief (仅 PC 端生效)是否关闭播放器自动失焦的功能。
2833
2910
  * @default false
2834
2911
  */
2912
+ /** {en}
2913
+ * @brief 是否关闭播放器自动失焦(只在pc端生效)
2914
+ */
2835
2915
  closeDelayBlur?: boolean;
2836
2916
  /**
2837
- * @brief 播放器focus状态自动消失延迟时长,单位为ms
2917
+ * @brief 播放器 focus 状态自动消失延迟时长,单位为毫秒。
2838
2918
  * @default pc端: 2000, mobile端: 3000
2839
2919
  */
2920
+ /** {en}
2921
+ * @brief 播放器focus状态自动消失延迟时长,单位为ms
2922
+ */
2840
2923
  inactive?: number;
2841
2924
  /**
2842
- * @brief 用户鼠标离开播放器区域之后,控制栏隐藏延时时间,如果想要鼠标移出播放器区域就隐藏,则配置为0(只在pc端生效)
2925
+ * @brief (仅 PC 端生效)用户鼠标离开播放器区域后,控制栏隐藏延时时间。若希望鼠标移出播放器区域即隐藏,可设置为 0
2843
2926
  * @default 0
2844
2927
  */
2928
+ /** {en}
2929
+ * @brief 用户鼠标离开播放器区域之后,控制栏隐藏延时时间,如果想要鼠标移出播放器区域就隐藏,则配置为0(只在pc端生效)
2930
+ */
2845
2931
  leavePlayerTime?: number;
2846
2932
  /**
2933
+ * @brief 是否禁用播放时触发播放器焦点状态的功能。
2934
+ * @default PC 端为 true,移动端为 false
2935
+ */
2936
+ /** {en}
2847
2937
  * @brief 是否关闭play时触发player焦点状态
2848
2938
  * @default pc端:true, mobile端:false
2849
2939
  */
2850
2940
  closePlayVideoFocus?: boolean;
2851
2941
  /**
2852
- * @brief 是否关闭pause时触发player焦点状态,会强制呼出控制栏
2942
+ * @brief 是否关闭暂停时触发播放器焦点状态的功能。这样会导致强制呼出控制栏。
2853
2943
  * @default false
2854
2944
  */
2945
+ /** {en}
2946
+ * @brief 是否关闭pause时触发player焦点状态,会强制呼出控制栏
2947
+ */
2855
2948
  closePauseVideoFocus?: boolean;
2856
2949
  /**
2857
- * @brief 是否需要在退出全屏后滚动定位到全屏之前的位置。(一般安卓下退出全屏后页面会滚动)
2950
+ * @brief 是否在退出全屏后将页面滚动定位到全屏之前的位置。通常在安卓设备上退出全屏后页面会发生滚动。
2858
2951
  * @default false
2859
2952
  */
2953
+ /** {en}
2954
+ * @brief 是否需要在退出全屏后滚动定位到全屏之前的位置。(一般安卓下退出全屏后页面会滚动)
2955
+ */
2860
2956
  needFullscreenScroll?: boolean;
2861
2957
  /**
2862
- * @brief 移动端交互插件配置
2958
+ * @brief 移动端交互插件配置。
2863
2959
  * @default -
2864
2960
  */
2961
+ /** {en}
2962
+ * @brief 移动端交互插件配置
2963
+ */
2865
2964
  mobile?: IMobileConfig;
2866
2965
  /**
2867
2966
  * @brief 播放器中间切换暂停/播放的按钮插件配置
@@ -2909,11 +3008,17 @@ export interface IPlayerConfig extends IPlayerOptions {
2909
3008
  * @brief 默认配置
2910
3009
  * @hidden
2911
3010
  */
3011
+ /** {en}
3012
+ * @hidden
3013
+ */
2912
3014
  defaultConfig?: IDefaultConfig;
2913
3015
  /** {zh}
2914
3016
  * @hidden
2915
3017
  * @brief 模拟mobile
2916
3018
  */
3019
+ /** {en}
3020
+ * @hidden
3021
+ */
2917
3022
  isMobile?: boolean;
2918
3023
  /** {zh}
2919
3024
  * @brief UMD 依赖备用地址。用于依赖的 CDN 发生网络错误时的降级备用地址。支持的依赖如下:
@@ -2987,7 +3092,6 @@ export interface IPlayerConfig extends IPlayerOptions {
2987
3092
  */
2988
3093
  urlCheckExpireInterval?: number;
2989
3094
  /** {zh}
2990
- * @hidden
2991
3095
  * @brief 播放源过期的回调函数。可用来更新播放源数据。
2992
3096
  * @default -
2993
3097
  */
@@ -3002,10 +3106,12 @@ export interface IPlayerConfig extends IPlayerOptions {
3002
3106
  * @brief 禁用点播日志配置检测,默认开启,如果未配置line_app_id则会播放报错
3003
3107
  * @default -
3004
3108
  */
3109
+ /** {en}
3110
+ * @hidden
3111
+ */
3005
3112
  disableVodLogOptsCheck?: boolean;
3006
3113
  /** {zh}
3007
- * @hidden
3008
- * @brief 是否打开日志打印
3114
+ * @brief 是否开启日志打印。
3009
3115
  * @default false
3010
3116
  */
3011
3117
  debug?: boolean;
@@ -3020,6 +3126,9 @@ export interface IPlayerConfig extends IPlayerOptions {
3020
3126
  * @default -
3021
3127
  * @hidden
3022
3128
  */
3129
+ /** {en}
3130
+ * @hidden
3131
+ */
3023
3132
  rtm?: IRtmConfig;
3024
3133
  /** {zh}
3025
3134
  * @brief 弹幕及面板配置。支持配置弹幕文字大小、透明度、展示区域等参数。
@@ -3036,6 +3145,9 @@ export interface IPlayerConfig extends IPlayerOptions {
3036
3145
  * @brief DASH 播放配置项
3037
3146
  * @default -
3038
3147
  */
3148
+ /** {en}
3149
+ * @hidden
3150
+ */
3039
3151
  DASHPlugin?: Partial<IDashPluginConfig>;
3040
3152
  /** {zh}
3041
3153
  * @brief HLS 加密播放配置。
@@ -3052,12 +3164,29 @@ export interface IPlayerConfig extends IPlayerOptions {
3052
3164
  * @brief mp4加密播放配置项
3053
3165
  * @default -
3054
3166
  */
3167
+ /** {en}
3168
+ * @hidden
3169
+ */
3055
3170
  Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
3056
3171
  /** {zh}
3057
- * @brief 自适应码率配置。
3172
+ * @brief 多码率自适应播放配置。
3058
3173
  * @default -
3059
3174
  */
3060
3175
  autoBitrateOpts?: IAutoBitrateOpts;
3176
+ /** {zh}
3177
+ * @brief 动态 Buffer 配置。
3178
+ * @default -
3179
+ */
3180
+ adaptRange?: IAdaptRange;
3181
+ /** {zh}
3182
+ * @brief 视频时长。
3183
+ * @default -
3184
+ * @hidden
3185
+ */
3186
+ /** {en}
3187
+ * @hidden
3188
+ */
3189
+ duration?: number;
3061
3190
  /** {zh}
3062
3191
  * @brief 外挂字幕配置。
3063
3192
  * @default -
@@ -3105,6 +3234,9 @@ export declare type SourceConfig = Pick<IPlayerConfig, "url" | "playList" | "get
3105
3234
  /** {zh}
3106
3235
  * @hidden
3107
3236
  */
3237
+ /** {en}
3238
+ * @hidden
3239
+ */
3108
3240
  export interface IDefaultConfig {
3109
3241
  /** {zh}
3110
3242
  * @brief “点播”还是“直播”
@@ -3244,17 +3376,20 @@ export interface IPlayAuthTokenConfig {
3244
3376
  /**
3245
3377
  * @brief 商业DRM 获取license的token
3246
3378
  * @default -
3379
+ * @hidden
3247
3380
  */
3248
3381
  thirdPartyDrmAuthToken?: string;
3249
3382
  /**
3250
3383
  * @brief 商业DRM,获取fairplay证书的地址
3251
3384
  * @default -
3385
+ * @hidden
3252
3386
  */
3253
3387
  serverCertificatePath?: string;
3254
3388
  /**
3255
- * @brief 商业DRM播放时,是否开启防录屏
3256
- * @notice 如果开启后,但当前环境不支持,则报错
3389
+ * @brief 商业DRM播放时,是否开启防录屏检测
3390
+ * @notice 如果开启后检测到当前环境不支持,则报错
3257
3391
  * @default true
3392
+ * @hidden
3258
3393
  */
3259
3394
  unRecord?: boolean;
3260
3395
  /** {zh}
@@ -3576,23 +3711,34 @@ declare enum PreloadScene {
3576
3711
  NORMAL = 0,
3577
3712
  /**
3578
3713
  * Feed流场景(播放器自动执行预加载)
3714
+ * @brief Feed 流场景(播放器自动执行预加载)
3715
+ */
3716
+ /** {en}
3717
+ * @brief Feed流场景(播放器自动执行预加载)
3579
3718
  */
3580
3719
  FEED = 1
3581
3720
  }
3582
3721
  declare enum StrategyNames {
3583
3722
  /**
3584
3723
  * h265
3724
+ * @brief H.265 策略
3585
3725
  */
3586
3726
  H265 = "h265",
3587
3727
  /**
3588
3728
  * 预加载
3729
+ * @brief 预加载策略
3730
+ */
3731
+ PRELOAD = "preload",
3732
+ /**
3733
+ * Range拆分-动态Buffer
3734
+ * @brief 动态 Buffer
3589
3735
  */
3590
- PRELOAD = "preload"
3736
+ ADAPT_RANGE = "adaptRange"
3591
3737
  }
3592
- /**{zh}
3738
+ /** {zh}
3593
3739
  * @hidden
3594
3740
  * h265策略配置
3595
- * @detail detail
3741
+ * @detail Options
3596
3742
  */
3597
3743
  export declare type IH265Config = {
3598
3744
  /**
@@ -3604,9 +3750,9 @@ export declare type IH265Config = {
3604
3750
  */
3605
3751
  disabled?: boolean;
3606
3752
  } & VeStrategyH265Config;
3607
- /**{zh}
3753
+ /** {zh}
3608
3754
  * 预加载初始配置
3609
- * @detail detail
3755
+ * @detail Options
3610
3756
  */
3611
3757
  export declare type IPreloadConfig = {
3612
3758
  /**
@@ -3617,11 +3763,19 @@ export declare type IPreloadConfig = {
3617
3763
  /**
3618
3764
  * 向前预加载视频个数,Feed流场景时生效
3619
3765
  * @default 1
3766
+ * @brief 向前预加载视频个数。Feed 流场景时生效。
3767
+ */
3768
+ /** {en}
3769
+ * @brief 向前预加载视频个数,Feed流场景时生效
3620
3770
  */
3621
3771
  prevCount?: number;
3622
3772
  /**
3623
3773
  * 向后预加载视频个数,Feed流场景生效
3624
3774
  * @default 2
3775
+ * @brief 向后预加载视频个数。Feed 流场景生效
3776
+ */
3777
+ /** {en}
3778
+ * @brief 向后预加载视频个数,Feed流场景生效
3625
3779
  */
3626
3780
  nextCount?: number;
3627
3781
  /**
@@ -3636,6 +3790,10 @@ export declare type IPreloadConfig = {
3636
3790
  preloadMaxCacheCount?: number;
3637
3791
  /**
3638
3792
  * 预加载依赖Module
3793
+ * @brief 预加载依赖 Module
3794
+ */
3795
+ /** {en}
3796
+ * @brief 预加载依赖Module
3639
3797
  */
3640
3798
  Strategy?: any;
3641
3799
  /**
@@ -3643,36 +3801,81 @@ export declare type IPreloadConfig = {
3643
3801
  */
3644
3802
  disabled?: boolean;
3645
3803
  };
3646
- /**{zh}
3647
- * 高级能力(策略)配置
3648
- * @detail detail
3804
+ /** {zh}
3805
+ * @hidden
3806
+ * @detail Options
3807
+ * @brief Range 拆分(动态Buffer)策略初始配置
3808
+ * @notes adaptRange策略配置结构较复杂,暂不开放Range默认配置自定义,使用策略下发
3809
+ */
3810
+ export declare type IAdaptRangeConfig = {
3811
+ /** {zh}
3812
+ * @brief 预加载依赖Module
3813
+ */
3814
+ Strategy?: any;
3815
+ /** {zh}
3816
+ * @brief 是否禁用Range拆分策略
3817
+ */
3818
+ disabled?: boolean;
3819
+ };
3820
+ /** {zh}
3821
+ * @detail Options
3822
+ * @brief 策略配置。
3649
3823
  */
3650
3824
  export declare type StrategyConfigOptions = {
3651
3825
  /**
3652
- * @hidden
3653
3826
  * h265策略配置
3827
+ * @hidden
3828
+ * @brief H.265 策略配置。
3829
+ */
3830
+ /** {en}
3831
+ * @hidden
3832
+ * @brief h265策略配置
3654
3833
  */
3655
3834
  [StrategyNames.H265]?: boolean | IH265Config;
3656
3835
  /**
3657
3836
  * 预加载配置
3837
+ * @brief 预加载配置。
3838
+ */
3839
+ /** {en}
3840
+ * @brief 预加载配置
3658
3841
  */
3659
3842
  [StrategyNames.PRELOAD]?: boolean | IPreloadConfig;
3843
+ /**
3844
+ * Range拆分(动态Buffer)
3845
+ * @brief 动态 Buffer 配置。
3846
+ */
3847
+ /** {en}
3848
+ * @brief Range拆分(动态Buffer)
3849
+ */
3850
+ [StrategyNames.ADAPT_RANGE]?: boolean | IAdaptRangeConfig;
3660
3851
  };
3661
- /**{zh}
3852
+ /** {zh}
3662
3853
  * 播放器预初始化配置
3663
- * @detail detail
3854
+ * @detail Options
3664
3855
  */
3665
3856
  export declare type StrategyInitOptions = {
3666
3857
  /**
3667
3858
  * 应用ID
3859
+ * @brief 应用 ID
3860
+ */
3861
+ /** {en}
3862
+ * @brief 应用ID
3668
3863
  */
3669
3864
  appId: number;
3670
3865
  /**
3671
3866
  * 高级能力(策略)配置
3867
+ * @brief 策略配置
3868
+ */
3869
+ /** {en}
3870
+ * @brief 高级能力(策略)配置
3672
3871
  */
3673
3872
  strategies: StrategyConfigOptions;
3674
3873
  /**
3675
3874
  * 设备ID
3875
+ * @brief 设备 ID
3876
+ */
3877
+ /** {en}
3878
+ * @brief 设备ID
3676
3879
  */
3677
3880
  deviceId?: string;
3678
3881
  /**
@@ -3681,12 +3884,17 @@ export declare type StrategyInitOptions = {
3681
3884
  plugins?: any[];
3682
3885
  /**
3683
3886
  * 策略Module,默认自动加载
3887
+ * @brief 策略 Module,默认自动加载
3888
+ */
3889
+ /** {en}
3890
+ * @brief 策略Module,默认自动加载
3684
3891
  */
3685
3892
  Module?: typeof VeStrategy;
3686
3893
  };
3687
- /**{zh}
3894
+ /** {zh}
3688
3895
  * 预加载实例,通过预加载实例可执行一些高级方法
3689
- * @detail detail
3896
+ * @detail Options
3897
+ * @hidden
3690
3898
  */
3691
3899
  export declare type PreloaderManager = {
3692
3900
  /**
@@ -3720,9 +3928,10 @@ declare enum PreloaderStatus {
3720
3928
  */
3721
3929
  FAILED = 3
3722
3930
  }
3723
- /**{zh}
3931
+ /** {zh}
3724
3932
  * 预加载配置更新
3725
- * @detail detail
3933
+ * @detail Options
3934
+ * @hidden
3726
3935
  */
3727
3936
  export declare type IPreloadUpdateConfig = {
3728
3937
  /**
@@ -3734,17 +3943,25 @@ export declare type IPreloadUpdateConfig = {
3734
3943
  */
3735
3944
  nextCount?: number;
3736
3945
  };
3737
- /**{zh}
3946
+ /** {zh}
3738
3947
  * 预加载视频资源
3739
- * @detail detail
3948
+ * @detail Options
3740
3949
  */
3741
3950
  export declare type IPreloadStream = {
3742
3951
  /**
3743
3952
  * 视频唯一ID
3953
+ * @brief 视频 ID
3954
+ */
3955
+ /** {en}
3956
+ * @brief 视频唯一ID
3744
3957
  */
3745
3958
  vid: string;
3746
3959
  /**
3747
3960
  * 播放地址
3961
+ * @brief 视频播放地址
3962
+ */
3963
+ /** {en}
3964
+ * @brief 播放地址
3748
3965
  */
3749
3966
  url: string;
3750
3967
  /**
@@ -3753,22 +3970,42 @@ export declare type IPreloadStream = {
3753
3970
  definition: string;
3754
3971
  /**
3755
3972
  * 视频streamType,暂只支持 mp4
3973
+ * @brief 视频流类型,当前仅支持 mp4
3974
+ */
3975
+ /** {en}
3976
+ * @brief 视频streamType,暂只支持 mp4
3756
3977
  */
3757
3978
  streamType: string;
3758
3979
  /**
3759
3980
  * 视频codec,暂支持 h264
3981
+ * @brief 视频编码格式,当前仅支持 mp4
3982
+ */
3983
+ /** {en}
3984
+ * @brief 视频codec,暂支持 h264
3760
3985
  */
3761
3986
  codec: string;
3762
3987
  /**
3763
3988
  * 码率, 数据统计需要,可选填
3989
+ * @brief 码率, 数据统计需要,选填
3990
+ */
3991
+ /** {en}
3992
+ * @brief 码率, 数据统计需要,可选填
3764
3993
  */
3765
3994
  bitrate: number;
3766
3995
  /**
3767
3996
  * 视频时长,数据统计需要,可选填
3997
+ * @brief 视频时长,数据统计需要,选填
3998
+ */
3999
+ /** {en}
4000
+ * @brief 视频时长,数据统计需要,可选填
3768
4001
  */
3769
4002
  duration: number;
3770
4003
  /**
3771
4004
  * 视频大小,数据统计需要,可选填
4005
+ * @brief 视频大小,数据统计需要,选填
4006
+ */
4007
+ /** {en}
4008
+ * @brief 视频大小,数据统计需要,可选填
3772
4009
  */
3773
4010
  size: number;
3774
4011
  };
@@ -3801,12 +4038,95 @@ declare class VeStrategyWrapper {
3801
4038
  prepare(): Promise<boolean>;
3802
4039
  getDeviceId(): string;
3803
4040
  isReady(): boolean;
3804
- getStrategyRecommendations(): StrategyRecommendation;
3805
- getStrategyRecommendationsAsync(): Promise<StrategyRecommendation>;
4041
+ getStrategyRecommendations(options?: any, commonOptions?: any): StrategyRecommendation;
4042
+ getStrategyRecommendationsAsync(options?: any, commonOptions?: any): Promise<StrategyRecommendation>;
3806
4043
  isHevcRecommended(): boolean;
3807
4044
  private initPreloaderConfig;
3808
4045
  }
3809
4046
  declare const _default: VeStrategyWrapper;
4047
+ /** {zh}
4048
+ * @hidden
4049
+ */
4050
+ export declare type IRes = IGetPlayInfoRes & {
4051
+ Data: IGetPlayInfoRes & {
4052
+ VideoID?: string;
4053
+ };
4054
+ };
4055
+ /** {zh}
4056
+ * @hidden
4057
+ */
4058
+ export interface IDefItem extends Stream {
4059
+ vid: string;
4060
+ lineId?: number;
4061
+ lineName?: string;
4062
+ url: string;
4063
+ streamType: string;
4064
+ backupUrl: string;
4065
+ backUrlList: string[];
4066
+ fileType?: "video" | "audio" | "evideo" | "eaudio";
4067
+ format: string;
4068
+ bitrate?: number;
4069
+ size?: number;
4070
+ kid?: string;
4071
+ vwidth?: number;
4072
+ vheight?: number;
4073
+ }
4074
+ /** {zh}
4075
+ * @hidden
4076
+ */
4077
+ export interface VideoInfoRes {
4078
+ playList: IDefItem[];
4079
+ type?: string;
4080
+ poster: string;
4081
+ vid: string;
4082
+ duration: number;
4083
+ dashOpts: IRes | {
4084
+ Data: IRes;
4085
+ };
4086
+ thumbs: IThumbInfoItem[];
4087
+ barrageMaskUrl: string;
4088
+ enableAdaptive?: boolean;
4089
+ adaptiveBitrateStreamingInfo?: ABRInfo;
4090
+ }
4091
+ declare function isMSESupport(mime?: string): boolean;
4092
+ /** {zh}
4093
+ * @hidden
4094
+ */
4095
+ export interface IAdaptRangeDefaultOptions {
4096
+ maxTargetCacheDur: number;
4097
+ minTargetCacheDur: number;
4098
+ rangeMaxDuration: number;
4099
+ rangeMinDuration: number;
4100
+ cacheSafeFactor: number;
4101
+ estPTcontrol: boolean;
4102
+ estPlayTime: number;
4103
+ minBandwidth: number;
4104
+ minDangerThreshold: number;
4105
+ rangeControl: boolean;
4106
+ rangeMinSize: number;
4107
+ safeFactor: number;
4108
+ targetCacheControl: boolean;
4109
+ }
4110
+ declare abstract class AbstractBaseAdapter {
4111
+ isLive: boolean;
4112
+ playerData: PlayerData;
4113
+ streamType: string;
4114
+ constructor(options: {
4115
+ configs: IPlayerConfig;
4116
+ playerData: PlayerData;
4117
+ streamType: string;
4118
+ });
4119
+ abstract canOpenAbr(vidPlayInfo?: VideoInfoRes): boolean;
4120
+ abstract applyAbrPluginConfig(_finalOptions: any, _autoBitrateOpts: any): void;
4121
+ abstract prepareAbrModule(_playerData: any, _sdkUmdLoader: any): void;
4122
+ abstract needAbrAutoDefinition(): boolean;
4123
+ abstract setAbrDefaultDefiWithAuto(): boolean;
4124
+ abstract generatePlaylistFromServer(res: VideoInfoRes): Stream[];
4125
+ abstract canAdaptRangeEnable(): boolean;
4126
+ abstract adaptRangeDefaultOptions(): IAdaptRangeDefaultOptions | undefined;
4127
+ abstract applyAdaptRangePluginConfig(_finalOptions: any, _adaptRangeOptions: any): void;
4128
+ abstract applyAdaptRangeStrategy(_finalOptions: any, _adaptRangeOptions: any): void;
4129
+ }
3810
4130
  declare class PlayerData {
3811
4131
  id?: string;
3812
4132
  root?: HTMLElement;
@@ -3850,18 +4170,27 @@ declare class PlayerData {
3850
4170
  urlExpireDiff: number;
3851
4171
  urlCheckExpireInterval: number;
3852
4172
  };
4173
+ private isAutoBitrateEnable;
4174
+ adapter: AbstractBaseAdapter;
3853
4175
  isBusinessDrm: boolean;
3854
4176
  isEncrypt: boolean;
3855
4177
  dashOpts: {
3856
4178
  Data: IGetPlayInfoRes;
3857
4179
  };
3858
- constructor(configs: IPlayerConfig);
4180
+ sdk: VePlayer;
4181
+ constructor(configs: IPlayerConfig, sdk: VePlayer);
3859
4182
  /**
3860
4183
  * 初始化播放数据
3861
4184
  * @param configs { IPlayerConfig } 播放器配置
3862
4185
  */
3863
4186
  initPlayData(configs: IPlayerConfig): void;
3864
4187
  initPlaylistAndGetCurrent(configs: IPlayerConfig): Stream;
4188
+ checkAutoBitratePlayList(): boolean;
4189
+ getABRStreamInfo(streamType: any, originDefaultStream: any): {
4190
+ defaultDefinition: string;
4191
+ defaultStream: any;
4192
+ playList: Stream[];
4193
+ };
3865
4194
  isCurrentH265(): boolean;
3866
4195
  getCurrentByDefaultConfig(): Stream;
3867
4196
  initCurrent(currentStreams: Stream): void;
@@ -3878,12 +4207,13 @@ declare class PlayerData {
3878
4207
  * @description: 获取当前直播url
3879
4208
  */
3880
4209
  getCurrentUrl(): Url;
4210
+ getTargetStreamType(stream?: Stream): string;
3881
4211
  /**
3882
4212
  * @description: 获取当前的streamType
3883
4213
  */
3884
4214
  getCurrentStreamType(): string;
3885
4215
  getStreamType(): string;
3886
- isOpenABR(streamType?: string): boolean;
4216
+ isOpenABR(): boolean;
3887
4217
  showRealDefinition(): boolean;
3888
4218
  isAutoDefinition(def: any): boolean;
3889
4219
  isPlayAutoDefinition(def?: string): boolean;
@@ -3936,8 +4266,8 @@ declare class PlayerData {
3936
4266
  * 更新playList
3937
4267
  */
3938
4268
  updatePlayList(): void;
4269
+ isVidPlay(): boolean;
3939
4270
  }
3940
- declare function isMSESupport(mime?: string): boolean;
3941
4271
  /**
3942
4272
  * @hidden
3943
4273
  * @brief 移动端交互面板配置
@@ -3987,6 +4317,7 @@ declare enum UmdKeys {
3987
4317
  VeStrategy = "vestrategy",
3988
4318
  VeStrategyH265 = "vestrategy_h265",
3989
4319
  VeStrategyPreload = "vestrategy_preload",
4320
+ VeStrategyAdaptRange = "vestrategy_adapt_range",
3990
4321
  DashAbralgo = "DashAbralgo",
3991
4322
  Preloader = "preloader"
3992
4323
  }
@@ -3995,9 +4326,21 @@ declare enum UmdKeys {
3995
4326
  * @breif umdmap 配置
3996
4327
  */
3997
4328
  export declare type UMDMap = Record<UmdKeys, {
4329
+ /**
4330
+ * umd Module 的名称,即在window下暴露的接口名称
4331
+ */
3998
4332
  name: string;
4333
+ /**
4334
+ * 对应umd文件名,只用来标记,实际不使用
4335
+ */
3999
4336
  pluginName?: string;
4337
+ /**
4338
+ * 对应npm包的名称,在打包文件时,会在libd.config.js中onPostBuild的钩子中会用于寻找对应npm包
4339
+ */
4000
4340
  packageName: string;
4341
+ /**
4342
+ * npm包中umd入口文件路径,用于打包上传到cdn目录
4343
+ */
4001
4344
  devPath: string;
4002
4345
  }>;
4003
4346
  declare class umdLoader {
@@ -4058,6 +4401,9 @@ declare class VePlayer {
4058
4401
  * @type {PlayerData}
4059
4402
  * @memberof VePlayer
4060
4403
  */
4404
+ /** {en}
4405
+ * @hidden
4406
+ */
4061
4407
  playerData: PlayerData;
4062
4408
  /** {zh}
4063
4409
  * @brief 播放器内核实例,详情参考{@link https://www.volcengine.com/docs/4/1249083 播放器内核}。
@@ -4071,6 +4417,9 @@ declare class VePlayer {
4071
4417
  * @type {*}
4072
4418
  * @memberof VePlayer
4073
4419
  */
4420
+ /** {en}
4421
+ * @hidden
4422
+ */
4074
4423
  mountingDom: Element;
4075
4424
  /** {zh}
4076
4425
  * @hidden
@@ -4078,6 +4427,9 @@ declare class VePlayer {
4078
4427
  * @type {*}
4079
4428
  * @memberof VePlayer
4080
4429
  */
4430
+ /** {en}
4431
+ * @hidden
4432
+ */
4081
4433
  playerContainer: any;
4082
4434
  /** {zh}
4083
4435
  * @hidden
@@ -4085,6 +4437,9 @@ declare class VePlayer {
4085
4437
  * @type {*}
4086
4438
  * @memberof VePlayer
4087
4439
  */
4440
+ /** {en}
4441
+ * @hidden
4442
+ */
4088
4443
  mobilePanel: any;
4089
4444
  /** {zh}
4090
4445
  *
@@ -4142,6 +4497,7 @@ declare class VePlayer {
4142
4497
  * @memberof VePlayer
4143
4498
  */
4144
4499
  sdkUmdLoader: umdLoader;
4500
+ private adapter;
4145
4501
  /**
4146
4502
  * @hidden
4147
4503
  */
@@ -4160,33 +4516,35 @@ declare class VePlayer {
4160
4516
  * @memberof VePlayer
4161
4517
  */
4162
4518
  static sdkVersion: string;
4163
- /**{zh}
4164
- * @brief 播放器预初始化配置
4519
+ /** {zh}
4520
+ * @brief 播放策略预初始化配置
4165
4521
  * @param options 初始化配置,详情见{@link StrategyInitOptions}
4166
4522
  */
4167
4523
  static prepare(options: StrategyInitOptions): Promise<void>;
4168
- /**{zh}
4524
+ /** {zh}
4169
4525
  * @brief 设置预加载模式
4170
4526
  * @param preloadScene 预加载模式,详情见{@link PreloadScene}
4171
4527
  * @param options 预加载配置更新,详情见{@link IPreloadUpdateConfig}
4172
4528
  */
4173
4529
  static setPreloadScene(preloadScene: PreloadScene, options?: IPreloadUpdateConfig): void;
4174
- /**{zh}
4175
- * @brief 获取预加载实例,可通过预加载实例执行高级方法,需在VePlayer.prepare Promise执行完成之后才能获取到预加载实例
4176
- * @returns 预加载实例,详情见{@link PreloaderManager}
4530
+ /** {zh}
4531
+ * @hidden
4532
+ * @brief 获取预加载实例,可通过预加载实例执行高级方法,需在 `VePlayer.prepare` 的 Promise 执行完成之后才能获取到预加载实例。
4533
+ * @returns 预加载实例,详见 {@link PreloaderManager}
4177
4534
  */
4178
4535
  static get preloader(): PreloaderManager | undefined;
4179
- /**{zh}
4180
- * @brief 获取当前预加载实例状态
4181
- * @returns 预加载实例状态,详情见{@link PreloaderStatus}
4536
+ /** {zh}
4537
+ * @hidden
4538
+ * @brief 获取当前预加载实例状态。
4539
+ * @returns 预加载实例状态,详见 {@link PreloaderStatus}
4182
4540
  */
4183
4541
  static get preloaderStatus(): PreloaderStatus;
4184
- /**{zh}
4542
+ /** {zh}
4185
4543
  * @brief 添加待预加载视频列表
4186
4544
  * @param list 待预加载视频列表,详情见{@link IPreloadStream[]}。
4187
4545
  */
4188
4546
  static addPreloadList(list: IPreloadStream[]): void;
4189
- /**{zh}
4547
+ /** {zh}
4190
4548
  * @brief 设置待预加载视频列表,替换当前已设置的待预加载列表
4191
4549
  * @param list 待预加载视频列表,详情见{@link IPreloadStream[]}
4192
4550
  */
@@ -4295,6 +4653,9 @@ declare class VePlayer {
4295
4653
  *
4296
4654
  * @memberof VePlayer
4297
4655
  */
4656
+ /** {en}
4657
+ * @hidden
4658
+ */
4298
4659
  renderDom(): void;
4299
4660
  /** {zh}
4300
4661
  * @hidden
@@ -4302,6 +4663,9 @@ declare class VePlayer {
4302
4663
  * @return {*}
4303
4664
  * @memberof VePlayer
4304
4665
  */
4666
+ /** {en}
4667
+ * @hidden
4668
+ */
4305
4669
  renderPoster(): void;
4306
4670
  /**
4307
4671
  * @brief 获取西瓜的definition的配置,用于在创建player或者在playNext()时传入definition,
@@ -4315,6 +4679,9 @@ declare class VePlayer {
4315
4679
  * @return {*}
4316
4680
  * @memberof VePlayer
4317
4681
  */
4682
+ /** {en}
4683
+ * @hidden
4684
+ */
4318
4685
  createPlayer(): Promise<PlayerCore>;
4319
4686
  /** {zh}
4320
4687
  * @hidden
@@ -4323,6 +4690,9 @@ declare class VePlayer {
4323
4690
  * @return {void}
4324
4691
  * @memberof VePlayer
4325
4692
  */
4693
+ /** {en}
4694
+ * @hidden
4695
+ */
4326
4696
  setPluginConfig(finalOptions: IPlayerConfig): void;
4327
4697
  /** {zh}
4328
4698
  * @hidden
@@ -4330,6 +4700,9 @@ declare class VePlayer {
4330
4700
  * @param {string} url 地址
4331
4701
  * @memberof VePlayer
4332
4702
  */
4703
+ /** {en}
4704
+ * @hidden
4705
+ */
4333
4706
  detectCodec(url: string): Promise<void>;
4334
4707
  /** {zh}
4335
4708
  * @hidden
@@ -4338,6 +4711,9 @@ declare class VePlayer {
4338
4711
  * @return {*}
4339
4712
  * @memberof VePlayer
4340
4713
  */
4714
+ /** {en}
4715
+ * @hidden
4716
+ */
4341
4717
  setDefaultConfigOptions(options: any): void;
4342
4718
  /** {zh}
4343
4719
  * @brief 获取当前播放视频数据
@@ -4345,6 +4721,9 @@ declare class VePlayer {
4345
4721
  * @return {any}
4346
4722
  * @memberof VePlayer
4347
4723
  */
4724
+ /** {en}
4725
+ * @hidden
4726
+ */
4348
4727
  getCurrentPlayerConfig(): {
4349
4728
  type?: "vod" | "live";
4350
4729
  isLive?: boolean;
@@ -4453,6 +4832,9 @@ declare class VePlayer {
4453
4832
  * @param {*} pluginName
4454
4833
  * @param {*} IsShow
4455
4834
  */
4835
+ /** {en}
4836
+ * @hidden
4837
+ */
4456
4838
  changePluginsIcon(pluginName: any, IsShow: any): void;
4457
4839
  /** {zh}
4458
4840
  * @hidden
@@ -4462,18 +4844,23 @@ declare class VePlayer {
4462
4844
  * @return {*}
4463
4845
  * @memberof VePlayer
4464
4846
  */
4847
+ /** {en}
4848
+ * @hidden
4849
+ */
4465
4850
  getSdkPlugin(name: any): any;
4466
4851
  /** {zh}
4467
4852
  * @brief 播放时更换临时播放 Token,以更换视频源。
4468
4853
  * @memberof VePlayer
4469
4854
  * @param config 临时播放 Token 配置。
4470
4855
  * @param isNewVideo 是否为新视频。为 `false` 时,更换后,会从更换前的时间点继续播放。
4856
+ * @notes 此接口不支持切换火山引擎私有加密 Token。
4471
4857
  */
4472
4858
  switchAuthToken(config: IPlayAuthTokenConfig, isNewVideo?: boolean): Promise<void>;
4473
4859
  /** {zh}
4474
4860
  * @brief 更新临时播放 Token。
4475
4861
  * @memberof VePlayer
4476
- * @notes 播放前临时播放 Token 过期(收到 `play_auth_token_expired` 事件或者 `onTokenExpired` 回调触发)时,调用此方法更新临时播放 Token。
4862
+ * @notes - 播放前临时播放 Token 过期(收到 `play_auth_token_expired` 事件或者 `onTokenExpired` 回调触发)时,调用此方法更新临时播放 Token。
4863
+ * - 此接口不支持切换火山引擎私有加密 Token。
4477
4864
  * @param config 临时播放 Token 配置。
4478
4865
  */
4479
4866
  updateAuthToken(config: IPlayAuthTokenConfig): Promise<void>;
@@ -4503,13 +4890,17 @@ declare class VePlayer {
4503
4890
  * @param config 播放器配置。
4504
4891
  * @param isNewVideo 是否为新视频,默认为 `true`。为 `false` 时表示是同一个视频更换 token。更换后,会从更换前的时间点继续播放。
4505
4892
  */
4893
+ /** {en}
4894
+ * @hidden
4895
+ */
4506
4896
  next(config: IPlayerConfig, isNewVideo?: boolean): Promise<void>;
4507
4897
  /** {zh}
4508
4898
  * @brief 播放下一视频。
4509
4899
  * @return{Promise<any>}
4510
4900
  * @memberof VePlayer
4511
- * @notes 成功更换视频源后,默认是暂停状态,如果设置了自动播放,则会自动播放。
4512
- * @param config 播放器实例化配置。
4901
+ * @notes - 成功更换视频源后,默认是暂停状态。如果设置了自动播放,则会自动播放。
4902
+ * - 此接口不支持切换火山引擎私有加密视频。
4903
+ * @param config 播放器实例化配置。此接口仅支持 `IPlayerConfig` 中的 `url`、`playList`、`poster`、`getVideoByToken` 字段。。
4513
4904
  * @param isNewVideo 是否为新视频。为 `false` 时,更换后,会从更换前的时间点继续播放。
4514
4905
  */
4515
4906
  playNext(config: IPlayerConfig, isNewVideo?: boolean): Promise<any>;
@@ -4527,6 +4918,9 @@ declare class VePlayer {
4527
4918
  * @return {*}
4528
4919
  * @memberof VePlayer
4529
4920
  */
4921
+ /** {en}
4922
+ * @hidden
4923
+ */
4530
4924
  getPlayerInstance(): PlayerCore;
4531
4925
  /** {zh}
4532
4926
  * @hidden
@@ -4534,6 +4928,9 @@ declare class VePlayer {
4534
4928
  * @return {*}
4535
4929
  * @memberof VePlayer
4536
4930
  */
4931
+ /** {en}
4932
+ * @hidden
4933
+ */
4537
4934
  getSoftDecodingOption(isOpenSoftDecoding: boolean, url: string, type: string): Promise<{
4538
4935
  mediaType?: string;
4539
4936
  innerDegrade?: number;
@@ -4546,6 +4943,9 @@ declare class VePlayer {
4546
4943
  * @brief 获取h265软解播放时的播放列表
4547
4944
  * @memberof VePlayer
4548
4945
  */
4946
+ /** {en}
4947
+ * @hidden
4948
+ */
4549
4949
  setH265SoftPlayList(): void;
4550
4950
  /** {zh}
4551
4951
  * @brief 切换清晰度
@@ -4699,11 +5099,6 @@ declare class VePlayer {
4699
5099
  * @param pluginName 插件名。
4700
5100
  */
4701
5101
  getPlugin(pluginName: string): null | BasePlugin;
4702
- /**
4703
- * @brief 当前浏览器环境是否支持商业drm防录屏
4704
- * @return boolean 是否支持商业drm防录屏
4705
- */
4706
- isDrmSupportUnRecord(): Promise<boolean>;
4707
5102
  /** {zh}
4708
5103
  * @memberof VePlayer
4709
5104
  * @brief 销毁当前播放器实例。
@@ -5333,7 +5728,7 @@ export declare const Events: {
5333
5728
  */
5334
5729
  LINE_CHANGE: string;
5335
5730
  /** {zh}
5336
- * @brief `playAuthToken` 获取 URL 失败。
5731
+ * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
5337
5732
  */
5338
5733
  GET_PLAY_URL_ERR: string;
5339
5734
  /** {zh}
@@ -5385,15 +5780,15 @@ export declare const Events: {
5385
5780
  */
5386
5781
  PLAY_LIST_ITEM_CHANGE: string;
5387
5782
  /** {zh}
5388
- * @brief playNext开始
5783
+ * @brief `playNext` 开始。
5389
5784
  */
5390
5785
  PLAY_NEXT_START: string;
5391
5786
  /** {zh}
5392
- * @brief playNext结束。
5787
+ * @brief `playNext` 结束。
5393
5788
  */
5394
5789
  PLAY_NEXT_END: string;
5395
5790
  /** {zh}
5396
- * @brief 自动挡档位改变。
5791
+ * @brief 多码率自适应播放时,自动挡位对应的清晰度改变。
5397
5792
  */
5398
5793
  ABR_AUTO_DESC_CHANGE: string;
5399
5794
  /** {zh}
@@ -5517,9 +5912,11 @@ export declare const Events: {
5517
5912
  */
5518
5913
  SHORTCUT: string;
5519
5914
  /** {zh}
5915
+ * @deprecated
5520
5916
  * @brief SEI 信息解析。
5521
5917
  */
5522
5918
  /** {en}
5919
+ * @deprecated
5523
5920
  * @brief The player parses the SEI information.
5524
5921
  */
5525
5922
  SEI_PARSED: string;
@@ -5561,7 +5958,7 @@ export declare const Events: {
5561
5958
  */
5562
5959
  NOT_SUPPORT_SOFT_DECODER: string;
5563
5960
  /** {zh}
5564
- * @brief `playAuthToken` 过期
5961
+ * @brief `playAuthToken` 过期。
5565
5962
  */
5566
5963
  TOKEN_EXPIRED: string;
5567
5964
  /** {zh}
@@ -5569,31 +5966,31 @@ export declare const Events: {
5569
5966
  */
5570
5967
  UMD_LOAD_FAIL: string;
5571
5968
  /** {zh}
5572
- * @brief 切换下一个视频,playNext方法调用后触发
5969
+ * @brief 切换下一个视频。调用 `playNext` 后触发。
5573
5970
  */
5574
5971
  PLAYNEXT: string;
5575
5972
  /** {zh}
5576
- * @brief 视频地址为空
5973
+ * @brief 视频地址为空。
5577
5974
  */
5578
5975
  URL_NULL: string;
5579
5976
  /** {zh}
5580
- * @brief 鼠标移出
5977
+ * @brief 鼠标移出。
5581
5978
  */
5582
5979
  LEAVE_PLAYER: string;
5583
5980
  /** {zh}
5584
- * @brief 鼠标移出
5981
+ * @brief 鼠标移入。
5585
5982
  */
5586
5983
  ENTER_PLAYER: string;
5587
5984
  /** {zh}
5588
- * @brief 播放器状态重置
5985
+ * @brief 播放器状态重置。
5589
5986
  */
5590
5987
  RESET: string;
5591
5988
  /** {zh}
5592
- * @brief <source> 加载错误,表示<source>不支持或播放失败
5989
+ * @brief `<source>` 加载错误,表示 `<source>` 不支持或播放失败。
5593
5990
  */
5594
5991
  SOURCE_ERROR: string;
5595
5992
  /** {zh}
5596
- * @brief <source> 加载成功
5993
+ * @brief `<source>` 加载成功。
5597
5994
  */
5598
5995
  SOURCE_SUCCESS: string;
5599
5996
  /** {zh}
@@ -5614,11 +6011,11 @@ export declare const Events: {
5614
6011
  DURATION_CHANGE: string;
5615
6012
  /** {zh}
5616
6013
  * @deprecated
5617
- * @brief 媒体被清空(初始化)时触发。
6014
+ * @brief (已废弃)媒体被清空时触发,通常是由于初始化。
5618
6015
  */
5619
6016
  EMPITED: string;
5620
6017
  /** {zh}
5621
- * @brief 媒体被清空(初始化)时触发。
6018
+ * @brief 媒体被清空时触发,通常是由于初始化。
5622
6019
  */
5623
6020
  EMPTIED: string;
5624
6021
  /** {zh}
@@ -5834,9 +6231,11 @@ export declare const Event: {
5834
6231
  */
5835
6232
  SHORTCUT: string;
5836
6233
  /** {zh}
6234
+ * @deprecated
5837
6235
  * @brief SEI 信息解析。
5838
6236
  */
5839
6237
  /** {en}
6238
+ * @deprecated
5840
6239
  * @brief The player parses the SEI information.
5841
6240
  */
5842
6241
  SEI_PARSED: string;
@@ -5878,7 +6277,7 @@ export declare const Event: {
5878
6277
  */
5879
6278
  NOT_SUPPORT_SOFT_DECODER: string;
5880
6279
  /** {zh}
5881
- * @brief `playAuthToken` 过期
6280
+ * @brief `playAuthToken` 过期。
5882
6281
  */
5883
6282
  TOKEN_EXPIRED: string;
5884
6283
  /** {zh}
@@ -5886,31 +6285,31 @@ export declare const Event: {
5886
6285
  */
5887
6286
  UMD_LOAD_FAIL: string;
5888
6287
  /** {zh}
5889
- * @brief 切换下一个视频,playNext方法调用后触发
6288
+ * @brief 切换下一个视频。调用 `playNext` 后触发。
5890
6289
  */
5891
6290
  PLAYNEXT: string;
5892
6291
  /** {zh}
5893
- * @brief 视频地址为空
6292
+ * @brief 视频地址为空。
5894
6293
  */
5895
6294
  URL_NULL: string;
5896
6295
  /** {zh}
5897
- * @brief 鼠标移出
6296
+ * @brief 鼠标移出。
5898
6297
  */
5899
6298
  LEAVE_PLAYER: string;
5900
6299
  /** {zh}
5901
- * @brief 鼠标移出
6300
+ * @brief 鼠标移入。
5902
6301
  */
5903
6302
  ENTER_PLAYER: string;
5904
6303
  /** {zh}
5905
- * @brief 播放器状态重置
6304
+ * @brief 播放器状态重置。
5906
6305
  */
5907
6306
  RESET: string;
5908
6307
  /** {zh}
5909
- * @brief <source> 加载错误,表示<source>不支持或播放失败
6308
+ * @brief `<source>` 加载错误,表示 `<source>` 不支持或播放失败。
5910
6309
  */
5911
6310
  SOURCE_ERROR: string;
5912
6311
  /** {zh}
5913
- * @brief <source> 加载成功
6312
+ * @brief `<source>` 加载成功。
5914
6313
  */
5915
6314
  SOURCE_SUCCESS: string;
5916
6315
  };
@@ -5992,7 +6391,7 @@ export declare const Event: {
5992
6391
  */
5993
6392
  LINE_CHANGE: string;
5994
6393
  /** {zh}
5995
- * @brief `playAuthToken` 获取 URL 失败。
6394
+ * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
5996
6395
  */
5997
6396
  GET_PLAY_URL_ERR: string;
5998
6397
  /** {zh}
@@ -6044,15 +6443,15 @@ export declare const Event: {
6044
6443
  */
6045
6444
  PLAY_LIST_ITEM_CHANGE: string;
6046
6445
  /** {zh}
6047
- * @brief playNext开始
6446
+ * @brief `playNext` 开始。
6048
6447
  */
6049
6448
  PLAY_NEXT_START: string;
6050
6449
  /** {zh}
6051
- * @brief playNext结束。
6450
+ * @brief `playNext` 结束。
6052
6451
  */
6053
6452
  PLAY_NEXT_END: string;
6054
6453
  /** {zh}
6055
- * @brief 自动挡档位改变。
6454
+ * @brief 多码率自适应播放时,自动挡位对应的清晰度改变。
6056
6455
  */
6057
6456
  ABR_AUTO_DESC_CHANGE: string;
6058
6457
  };