@byteplus/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,10 +2057,18 @@ export declare class MemoryPlay extends Plugin {
2053
2057
  getTimeByStorage(memoryId: string): string | 0;
2054
2058
  destroy(): void;
2055
2059
  }
2060
+ /** {zh}
2061
+ * @hidden
2062
+ */
2056
2063
  export declare const enum EDRMTYPE {
2057
2064
  DRM_ENCRYPT = "drm_encrypt",
2058
- PRIVATE_ENCRYPT = "private_encrypt"
2065
+ PRIVATE_ENCRYPT = "private_encrypt",
2066
+ PRIVATE_ENCRYPT_UPGRADE = "private_encrypt_upgrade",
2067
+ STANDARD_ENCRYPT = "standard_encrypt"
2059
2068
  }
2069
+ /** {zh}
2070
+ * @hidden
2071
+ */
2060
2072
  export interface IPlayInfoListItem {
2061
2073
  BackupPlayUrl: string;
2062
2074
  BackupUrlExpire: string;
@@ -2085,6 +2097,10 @@ export interface IPlayInfoListItem {
2085
2097
  Width: number;
2086
2098
  DrmType?: EDRMTYPE;
2087
2099
  }
2100
+ /** {zh}
2101
+ * @hidden
2102
+ * @brief 音频封装格式
2103
+ */
2088
2104
  export interface ISubtitleInfoList {
2089
2105
  CreateTime: string;
2090
2106
  FileId: string;
@@ -2101,7 +2117,10 @@ export interface ISubtitleInfoList {
2101
2117
  Version: string;
2102
2118
  Vid: string;
2103
2119
  }
2104
- export interface IThumbInfoList {
2120
+ /** {zh}
2121
+ * @hidden
2122
+ */
2123
+ export interface IThumbInfoItem {
2105
2124
  CaptureNum: number;
2106
2125
  CellHeight: number;
2107
2126
  CellWidth: number;
@@ -2111,6 +2130,10 @@ export interface IThumbInfoList {
2111
2130
  Interval: number;
2112
2131
  StoreUrls: string[];
2113
2132
  }
2133
+ /** {zh}
2134
+ * @brief 蒙版弹幕信息
2135
+ * @hidden
2136
+ */
2114
2137
  export interface IBarrageMaskInfo {
2115
2138
  Version: string;
2116
2139
  BarrageMaskUrl: string;
@@ -2121,9 +2144,29 @@ export interface IBarrageMaskInfo {
2121
2144
  Bitrate: number;
2122
2145
  HeadLen: number;
2123
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
+ */
2124
2166
  export interface IGetPlayInfoRes {
2125
2167
  Vid: string;
2126
- AdaptiveInfo?: any;
2168
+ AdaptiveInfo?: DashAdaptiveInfo;
2169
+ AdaptiveBitrateStreamingInfo?: ABRInfo;
2127
2170
  BarrageMaskInfo?: IBarrageMaskInfo;
2128
2171
  BarrageMaskUrl: string;
2129
2172
  Duration: number;
@@ -2133,7 +2176,7 @@ export interface IGetPlayInfoRes {
2133
2176
  PosterUrl: string;
2134
2177
  Status: number;
2135
2178
  SubtitleInfoList: ISubtitleInfoList[];
2136
- ThumbInfoList: IThumbInfoList[];
2179
+ ThumbInfoList: IThumbInfoItem[];
2137
2180
  TotalCount: number;
2138
2181
  Version: number;
2139
2182
  }
@@ -2161,15 +2204,15 @@ export declare const enum CodecType {
2161
2204
  */
2162
2205
  H266 = "h266",
2163
2206
  /** {zh}
2164
- * @brief 音频AAC,含 heaacv2
2207
+ * @brief 音频 AAC,含 heaacv2
2165
2208
  */
2166
2209
  AAC = "aac",
2167
2210
  /** {zh}
2168
- * @brief 音频MP3
2211
+ * @brief 音频 MP3
2169
2212
  */
2170
2213
  MP3 = "mp3",
2171
2214
  /** {zh}
2172
- * @brief 音频OPUS
2215
+ * @brief 音频 OPUS
2173
2216
  */
2174
2217
  OPUS = "opus",
2175
2218
  /** {zh}
@@ -2409,6 +2452,16 @@ export interface Stream extends Partial<IPlayInfoListItem> {
2409
2452
  * @brief 多语言词典中对应的 key。比如 `lineTextKey: LINE_ONE`。
2410
2453
  */
2411
2454
  lineTextKey?: string;
2455
+ /**
2456
+ * @brief 该码流视频的宽度,单位为像素
2457
+ * @default -
2458
+ */
2459
+ width?: number;
2460
+ /**
2461
+ * @brief 该码流视频的高度,单位为像素
2462
+ * @default -
2463
+ */
2464
+ height?: number;
2412
2465
  /**
2413
2466
  * @brief 码流的平均码率
2414
2467
  * @default -
@@ -2511,7 +2564,7 @@ export declare type Url = string | Array<{
2511
2564
  * @brief 播放器实例化配置。
2512
2565
  */
2513
2566
  /** {en}
2514
- * @brief Player Instance Configuration
2567
+ * @brief Player instantiation configuration.
2515
2568
  */
2516
2569
  export interface IPlayerConfig extends IPlayerOptions {
2517
2570
  /** {zh}
@@ -2519,6 +2572,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2519
2572
  * @default false
2520
2573
  * @hidden
2521
2574
  */
2575
+ /** {en}
2576
+ * @hidden
2577
+ */
2522
2578
  isLive?: boolean;
2523
2579
  /** {zh}
2524
2580
  * @brief 播放器容器 ID。播放器将被插入在该容器中。
@@ -2793,8 +2849,7 @@ export interface IPlayerConfig extends IPlayerOptions {
2793
2849
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
2794
2850
  /** {zh}
2795
2851
  * @brief 为播放器配置关键点样式。
2796
- * @default
2797
- * @hidden 直播目前没用到
2852
+ * @default -
2798
2853
  */
2799
2854
  commonStyle?: ICommonStyle;
2800
2855
  /** {zh}
@@ -2812,6 +2867,9 @@ export interface IPlayerConfig extends IPlayerOptions {
2812
2867
  * @type {boolean}
2813
2868
  * @memberof IPlayerConfig
2814
2869
  */
2870
+ /** {en}
2871
+ * @hidden
2872
+ */
2815
2873
  enableContextmenu?: boolean;
2816
2874
  /** {zh}
2817
2875
  * @brief 是否关闭 `video` 标签的事件冒泡。取值如下:
@@ -2829,50 +2887,80 @@ export interface IPlayerConfig extends IPlayerOptions {
2829
2887
  */
2830
2888
  enableMenu?: boolean;
2831
2889
  /**
2832
- * @brief 是否关闭pc端单击播放器区域切换播放/暂停
2890
+ * @brief 是否禁用 PC 端点击播放器区域切换播放和暂停功能。
2833
2891
  * @default false
2834
2892
  */
2893
+ /** {en}
2894
+ * @brief Whether to disable the ability to toggle play and pause by clicking on the player area on PC.
2895
+ */
2835
2896
  closeVideoClick?: boolean;
2836
2897
  /**
2898
+ * @brief <br>- PC 端:是否关闭双击播放器进入全屏的功能。
2899
+ * - 移动端:是否关闭双击切换暂停和播放的功能。
2900
+ * @default PC 端为 true,移动端为 false
2901
+ */
2902
+ /** {en}
2837
2903
  * @brief pc端: 是否关闭双击播放器进入全屏的能力
2838
- * mobile端: 是否关闭双击切换暂停/播放的能力
2904
+ * mobile端: 是否关闭双击切换暂停/播放的能力
2839
2905
  * @default pc端: true, mobile端: false
2840
2906
  */
2841
2907
  closeVideoDblclick?: boolean;
2842
2908
  /**
2843
- * @brief 是否关闭播放器自动失焦(只在pc端生效)
2909
+ * @brief (仅 PC 端生效)是否关闭播放器自动失焦的功能。
2844
2910
  * @default false
2845
2911
  */
2912
+ /** {en}
2913
+ * @brief 是否关闭播放器自动失焦(只在pc端生效)
2914
+ */
2846
2915
  closeDelayBlur?: boolean;
2847
2916
  /**
2848
- * @brief 播放器focus状态自动消失延迟时长,单位为ms
2917
+ * @brief 播放器 focus 状态自动消失延迟时长,单位为毫秒。
2849
2918
  * @default pc端: 2000, mobile端: 3000
2850
2919
  */
2920
+ /** {en}
2921
+ * @brief 播放器focus状态自动消失延迟时长,单位为ms
2922
+ */
2851
2923
  inactive?: number;
2852
2924
  /**
2853
- * @brief 用户鼠标离开播放器区域之后,控制栏隐藏延时时间,如果想要鼠标移出播放器区域就隐藏,则配置为0(只在pc端生效)
2925
+ * @brief (仅 PC 端生效)用户鼠标离开播放器区域后,控制栏隐藏延时时间。若希望鼠标移出播放器区域即隐藏,可设置为 0
2854
2926
  * @default 0
2855
2927
  */
2928
+ /** {en}
2929
+ * @brief 用户鼠标离开播放器区域之后,控制栏隐藏延时时间,如果想要鼠标移出播放器区域就隐藏,则配置为0(只在pc端生效)
2930
+ */
2856
2931
  leavePlayerTime?: number;
2857
2932
  /**
2933
+ * @brief 是否禁用播放时触发播放器焦点状态的功能。
2934
+ * @default PC 端为 true,移动端为 false
2935
+ */
2936
+ /** {en}
2858
2937
  * @brief 是否关闭play时触发player焦点状态
2859
2938
  * @default pc端:true, mobile端:false
2860
2939
  */
2861
2940
  closePlayVideoFocus?: boolean;
2862
2941
  /**
2863
- * @brief 是否关闭pause时触发player焦点状态,会强制呼出控制栏
2942
+ * @brief 是否关闭暂停时触发播放器焦点状态的功能。这样会导致强制呼出控制栏。
2864
2943
  * @default false
2865
2944
  */
2945
+ /** {en}
2946
+ * @brief 是否关闭pause时触发player焦点状态,会强制呼出控制栏
2947
+ */
2866
2948
  closePauseVideoFocus?: boolean;
2867
2949
  /**
2868
- * @brief 是否需要在退出全屏后滚动定位到全屏之前的位置。(一般安卓下退出全屏后页面会滚动)
2950
+ * @brief 是否在退出全屏后将页面滚动定位到全屏之前的位置。通常在安卓设备上退出全屏后页面会发生滚动。
2869
2951
  * @default false
2870
2952
  */
2953
+ /** {en}
2954
+ * @brief 是否需要在退出全屏后滚动定位到全屏之前的位置。(一般安卓下退出全屏后页面会滚动)
2955
+ */
2871
2956
  needFullscreenScroll?: boolean;
2872
2957
  /**
2873
- * @brief 移动端交互插件配置
2958
+ * @brief 移动端交互插件配置。
2874
2959
  * @default -
2875
2960
  */
2961
+ /** {en}
2962
+ * @brief 移动端交互插件配置
2963
+ */
2876
2964
  mobile?: IMobileConfig;
2877
2965
  /**
2878
2966
  * @brief 播放器中间切换暂停/播放的按钮插件配置
@@ -2920,11 +3008,17 @@ export interface IPlayerConfig extends IPlayerOptions {
2920
3008
  * @brief 默认配置
2921
3009
  * @hidden
2922
3010
  */
3011
+ /** {en}
3012
+ * @hidden
3013
+ */
2923
3014
  defaultConfig?: IDefaultConfig;
2924
3015
  /** {zh}
2925
3016
  * @hidden
2926
3017
  * @brief 模拟mobile
2927
3018
  */
3019
+ /** {en}
3020
+ * @hidden
3021
+ */
2928
3022
  isMobile?: boolean;
2929
3023
  /** {zh}
2930
3024
  * @brief UMD 依赖备用地址。用于依赖的 CDN 发生网络错误时的降级备用地址。支持的依赖如下:
@@ -2998,7 +3092,6 @@ export interface IPlayerConfig extends IPlayerOptions {
2998
3092
  */
2999
3093
  urlCheckExpireInterval?: number;
3000
3094
  /** {zh}
3001
- * @hidden
3002
3095
  * @brief 播放源过期的回调函数。可用来更新播放源数据。
3003
3096
  * @default -
3004
3097
  */
@@ -3013,10 +3106,12 @@ export interface IPlayerConfig extends IPlayerOptions {
3013
3106
  * @brief 禁用点播日志配置检测,默认开启,如果未配置line_app_id则会播放报错
3014
3107
  * @default -
3015
3108
  */
3109
+ /** {en}
3110
+ * @hidden
3111
+ */
3016
3112
  disableVodLogOptsCheck?: boolean;
3017
3113
  /** {zh}
3018
- * @hidden
3019
- * @brief 是否打开日志打印
3114
+ * @brief 是否开启日志打印。
3020
3115
  * @default false
3021
3116
  */
3022
3117
  debug?: boolean;
@@ -3031,6 +3126,9 @@ export interface IPlayerConfig extends IPlayerOptions {
3031
3126
  * @default -
3032
3127
  * @hidden
3033
3128
  */
3129
+ /** {en}
3130
+ * @hidden
3131
+ */
3034
3132
  rtm?: IRtmConfig;
3035
3133
  /** {zh}
3036
3134
  * @brief 弹幕及面板配置。支持配置弹幕文字大小、透明度、展示区域等参数。
@@ -3047,6 +3145,9 @@ export interface IPlayerConfig extends IPlayerOptions {
3047
3145
  * @brief DASH 播放配置项
3048
3146
  * @default -
3049
3147
  */
3148
+ /** {en}
3149
+ * @hidden
3150
+ */
3050
3151
  DASHPlugin?: Partial<IDashPluginConfig>;
3051
3152
  /** {zh}
3052
3153
  * @brief HLS 加密播放配置。
@@ -3063,12 +3164,29 @@ export interface IPlayerConfig extends IPlayerOptions {
3063
3164
  * @brief mp4加密播放配置项
3064
3165
  * @default -
3065
3166
  */
3167
+ /** {en}
3168
+ * @hidden
3169
+ */
3066
3170
  Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
3067
3171
  /** {zh}
3068
- * @brief 自适应码率配置。
3172
+ * @brief 多码率自适应播放配置。
3069
3173
  * @default -
3070
3174
  */
3071
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;
3072
3190
  /** {zh}
3073
3191
  * @brief 外挂字幕配置。
3074
3192
  * @default -
@@ -3116,6 +3234,9 @@ export declare type SourceConfig = Pick<IPlayerConfig, "url" | "playList" | "get
3116
3234
  /** {zh}
3117
3235
  * @hidden
3118
3236
  */
3237
+ /** {en}
3238
+ * @hidden
3239
+ */
3119
3240
  export interface IDefaultConfig {
3120
3241
  /** {zh}
3121
3242
  * @brief “点播”还是“直播”
@@ -3255,17 +3376,20 @@ export interface IPlayAuthTokenConfig {
3255
3376
  /**
3256
3377
  * @brief 商业DRM 获取license的token
3257
3378
  * @default -
3379
+ * @hidden
3258
3380
  */
3259
3381
  thirdPartyDrmAuthToken?: string;
3260
3382
  /**
3261
3383
  * @brief 商业DRM,获取fairplay证书的地址
3262
3384
  * @default -
3385
+ * @hidden
3263
3386
  */
3264
3387
  serverCertificatePath?: string;
3265
3388
  /**
3266
3389
  * @brief 商业DRM播放时,是否开启防录屏检测
3267
3390
  * @notice 如果开启后检测到当前环境不支持,则报错
3268
3391
  * @default true
3392
+ * @hidden
3269
3393
  */
3270
3394
  unRecord?: boolean;
3271
3395
  /** {zh}
@@ -3587,23 +3711,34 @@ declare enum PreloadScene {
3587
3711
  NORMAL = 0,
3588
3712
  /**
3589
3713
  * Feed流场景(播放器自动执行预加载)
3714
+ * @brief Feed 流场景(播放器自动执行预加载)
3715
+ */
3716
+ /** {en}
3717
+ * @brief Feed流场景(播放器自动执行预加载)
3590
3718
  */
3591
3719
  FEED = 1
3592
3720
  }
3593
3721
  declare enum StrategyNames {
3594
3722
  /**
3595
3723
  * h265
3724
+ * @brief H.265 策略
3596
3725
  */
3597
3726
  H265 = "h265",
3598
3727
  /**
3599
3728
  * 预加载
3729
+ * @brief 预加载策略
3730
+ */
3731
+ PRELOAD = "preload",
3732
+ /**
3733
+ * Range拆分-动态Buffer
3734
+ * @brief 动态 Buffer
3600
3735
  */
3601
- PRELOAD = "preload"
3736
+ ADAPT_RANGE = "adaptRange"
3602
3737
  }
3603
- /**{zh}
3738
+ /** {zh}
3604
3739
  * @hidden
3605
3740
  * h265策略配置
3606
- * @detail detail
3741
+ * @detail Options
3607
3742
  */
3608
3743
  export declare type IH265Config = {
3609
3744
  /**
@@ -3615,9 +3750,9 @@ export declare type IH265Config = {
3615
3750
  */
3616
3751
  disabled?: boolean;
3617
3752
  } & VeStrategyH265Config;
3618
- /**{zh}
3753
+ /** {zh}
3619
3754
  * 预加载初始配置
3620
- * @detail detail
3755
+ * @detail Options
3621
3756
  */
3622
3757
  export declare type IPreloadConfig = {
3623
3758
  /**
@@ -3628,11 +3763,19 @@ export declare type IPreloadConfig = {
3628
3763
  /**
3629
3764
  * 向前预加载视频个数,Feed流场景时生效
3630
3765
  * @default 1
3766
+ * @brief 向前预加载视频个数。Feed 流场景时生效。
3767
+ */
3768
+ /** {en}
3769
+ * @brief 向前预加载视频个数,Feed流场景时生效
3631
3770
  */
3632
3771
  prevCount?: number;
3633
3772
  /**
3634
3773
  * 向后预加载视频个数,Feed流场景生效
3635
3774
  * @default 2
3775
+ * @brief 向后预加载视频个数。Feed 流场景生效
3776
+ */
3777
+ /** {en}
3778
+ * @brief 向后预加载视频个数,Feed流场景生效
3636
3779
  */
3637
3780
  nextCount?: number;
3638
3781
  /**
@@ -3647,6 +3790,10 @@ export declare type IPreloadConfig = {
3647
3790
  preloadMaxCacheCount?: number;
3648
3791
  /**
3649
3792
  * 预加载依赖Module
3793
+ * @brief 预加载依赖 Module
3794
+ */
3795
+ /** {en}
3796
+ * @brief 预加载依赖Module
3650
3797
  */
3651
3798
  Strategy?: any;
3652
3799
  /**
@@ -3654,36 +3801,81 @@ export declare type IPreloadConfig = {
3654
3801
  */
3655
3802
  disabled?: boolean;
3656
3803
  };
3657
- /**{zh}
3658
- * 高级能力(策略)配置
3659
- * @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 策略配置。
3660
3823
  */
3661
3824
  export declare type StrategyConfigOptions = {
3662
3825
  /**
3663
- * @hidden
3664
3826
  * h265策略配置
3827
+ * @hidden
3828
+ * @brief H.265 策略配置。
3829
+ */
3830
+ /** {en}
3831
+ * @hidden
3832
+ * @brief h265策略配置
3665
3833
  */
3666
3834
  [StrategyNames.H265]?: boolean | IH265Config;
3667
3835
  /**
3668
3836
  * 预加载配置
3837
+ * @brief 预加载配置。
3838
+ */
3839
+ /** {en}
3840
+ * @brief 预加载配置
3669
3841
  */
3670
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;
3671
3851
  };
3672
- /**{zh}
3852
+ /** {zh}
3673
3853
  * 播放器预初始化配置
3674
- * @detail detail
3854
+ * @detail Options
3675
3855
  */
3676
3856
  export declare type StrategyInitOptions = {
3677
3857
  /**
3678
3858
  * 应用ID
3859
+ * @brief 应用 ID
3860
+ */
3861
+ /** {en}
3862
+ * @brief 应用ID
3679
3863
  */
3680
3864
  appId: number;
3681
3865
  /**
3682
3866
  * 高级能力(策略)配置
3867
+ * @brief 策略配置
3868
+ */
3869
+ /** {en}
3870
+ * @brief 高级能力(策略)配置
3683
3871
  */
3684
3872
  strategies: StrategyConfigOptions;
3685
3873
  /**
3686
3874
  * 设备ID
3875
+ * @brief 设备 ID
3876
+ */
3877
+ /** {en}
3878
+ * @brief 设备ID
3687
3879
  */
3688
3880
  deviceId?: string;
3689
3881
  /**
@@ -3692,12 +3884,17 @@ export declare type StrategyInitOptions = {
3692
3884
  plugins?: any[];
3693
3885
  /**
3694
3886
  * 策略Module,默认自动加载
3887
+ * @brief 策略 Module,默认自动加载
3888
+ */
3889
+ /** {en}
3890
+ * @brief 策略Module,默认自动加载
3695
3891
  */
3696
3892
  Module?: typeof VeStrategy;
3697
3893
  };
3698
- /**{zh}
3894
+ /** {zh}
3699
3895
  * 预加载实例,通过预加载实例可执行一些高级方法
3700
- * @detail detail
3896
+ * @detail Options
3897
+ * @hidden
3701
3898
  */
3702
3899
  export declare type PreloaderManager = {
3703
3900
  /**
@@ -3731,9 +3928,10 @@ declare enum PreloaderStatus {
3731
3928
  */
3732
3929
  FAILED = 3
3733
3930
  }
3734
- /**{zh}
3931
+ /** {zh}
3735
3932
  * 预加载配置更新
3736
- * @detail detail
3933
+ * @detail Options
3934
+ * @hidden
3737
3935
  */
3738
3936
  export declare type IPreloadUpdateConfig = {
3739
3937
  /**
@@ -3745,17 +3943,25 @@ export declare type IPreloadUpdateConfig = {
3745
3943
  */
3746
3944
  nextCount?: number;
3747
3945
  };
3748
- /**{zh}
3946
+ /** {zh}
3749
3947
  * 预加载视频资源
3750
- * @detail detail
3948
+ * @detail Options
3751
3949
  */
3752
3950
  export declare type IPreloadStream = {
3753
3951
  /**
3754
3952
  * 视频唯一ID
3953
+ * @brief 视频 ID
3954
+ */
3955
+ /** {en}
3956
+ * @brief 视频唯一ID
3755
3957
  */
3756
3958
  vid: string;
3757
3959
  /**
3758
3960
  * 播放地址
3961
+ * @brief 视频播放地址
3962
+ */
3963
+ /** {en}
3964
+ * @brief 播放地址
3759
3965
  */
3760
3966
  url: string;
3761
3967
  /**
@@ -3764,22 +3970,42 @@ export declare type IPreloadStream = {
3764
3970
  definition: string;
3765
3971
  /**
3766
3972
  * 视频streamType,暂只支持 mp4
3973
+ * @brief 视频流类型,当前仅支持 mp4
3974
+ */
3975
+ /** {en}
3976
+ * @brief 视频streamType,暂只支持 mp4
3767
3977
  */
3768
3978
  streamType: string;
3769
3979
  /**
3770
3980
  * 视频codec,暂支持 h264
3981
+ * @brief 视频编码格式,当前仅支持 mp4
3982
+ */
3983
+ /** {en}
3984
+ * @brief 视频codec,暂支持 h264
3771
3985
  */
3772
3986
  codec: string;
3773
3987
  /**
3774
3988
  * 码率, 数据统计需要,可选填
3989
+ * @brief 码率, 数据统计需要,选填
3990
+ */
3991
+ /** {en}
3992
+ * @brief 码率, 数据统计需要,可选填
3775
3993
  */
3776
3994
  bitrate: number;
3777
3995
  /**
3778
3996
  * 视频时长,数据统计需要,可选填
3997
+ * @brief 视频时长,数据统计需要,选填
3998
+ */
3999
+ /** {en}
4000
+ * @brief 视频时长,数据统计需要,可选填
3779
4001
  */
3780
4002
  duration: number;
3781
4003
  /**
3782
4004
  * 视频大小,数据统计需要,可选填
4005
+ * @brief 视频大小,数据统计需要,选填
4006
+ */
4007
+ /** {en}
4008
+ * @brief 视频大小,数据统计需要,可选填
3783
4009
  */
3784
4010
  size: number;
3785
4011
  };
@@ -3812,12 +4038,95 @@ declare class VeStrategyWrapper {
3812
4038
  prepare(): Promise<boolean>;
3813
4039
  getDeviceId(): string;
3814
4040
  isReady(): boolean;
3815
- getStrategyRecommendations(): StrategyRecommendation;
3816
- getStrategyRecommendationsAsync(): Promise<StrategyRecommendation>;
4041
+ getStrategyRecommendations(options?: any, commonOptions?: any): StrategyRecommendation;
4042
+ getStrategyRecommendationsAsync(options?: any, commonOptions?: any): Promise<StrategyRecommendation>;
3817
4043
  isHevcRecommended(): boolean;
3818
4044
  private initPreloaderConfig;
3819
4045
  }
3820
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
+ }
3821
4130
  declare class PlayerData {
3822
4131
  id?: string;
3823
4132
  root?: HTMLElement;
@@ -3861,18 +4170,27 @@ declare class PlayerData {
3861
4170
  urlExpireDiff: number;
3862
4171
  urlCheckExpireInterval: number;
3863
4172
  };
4173
+ private isAutoBitrateEnable;
4174
+ adapter: AbstractBaseAdapter;
3864
4175
  isBusinessDrm: boolean;
3865
4176
  isEncrypt: boolean;
3866
4177
  dashOpts: {
3867
4178
  Data: IGetPlayInfoRes;
3868
4179
  };
3869
- constructor(configs: IPlayerConfig);
4180
+ sdk: VePlayer;
4181
+ constructor(configs: IPlayerConfig, sdk: VePlayer);
3870
4182
  /**
3871
4183
  * 初始化播放数据
3872
4184
  * @param configs { IPlayerConfig } 播放器配置
3873
4185
  */
3874
4186
  initPlayData(configs: IPlayerConfig): void;
3875
4187
  initPlaylistAndGetCurrent(configs: IPlayerConfig): Stream;
4188
+ checkAutoBitratePlayList(): boolean;
4189
+ getABRStreamInfo(streamType: any, originDefaultStream: any): {
4190
+ defaultDefinition: string;
4191
+ defaultStream: any;
4192
+ playList: Stream[];
4193
+ };
3876
4194
  isCurrentH265(): boolean;
3877
4195
  getCurrentByDefaultConfig(): Stream;
3878
4196
  initCurrent(currentStreams: Stream): void;
@@ -3889,12 +4207,13 @@ declare class PlayerData {
3889
4207
  * @description: 获取当前直播url
3890
4208
  */
3891
4209
  getCurrentUrl(): Url;
4210
+ getTargetStreamType(stream?: Stream): string;
3892
4211
  /**
3893
4212
  * @description: 获取当前的streamType
3894
4213
  */
3895
4214
  getCurrentStreamType(): string;
3896
4215
  getStreamType(): string;
3897
- isOpenABR(streamType?: string): boolean;
4216
+ isOpenABR(): boolean;
3898
4217
  showRealDefinition(): boolean;
3899
4218
  isAutoDefinition(def: any): boolean;
3900
4219
  isPlayAutoDefinition(def?: string): boolean;
@@ -3947,8 +4266,8 @@ declare class PlayerData {
3947
4266
  * 更新playList
3948
4267
  */
3949
4268
  updatePlayList(): void;
4269
+ isVidPlay(): boolean;
3950
4270
  }
3951
- declare function isMSESupport(mime?: string): boolean;
3952
4271
  /**
3953
4272
  * @hidden
3954
4273
  * @brief 移动端交互面板配置
@@ -3998,6 +4317,7 @@ declare enum UmdKeys {
3998
4317
  VeStrategy = "vestrategy",
3999
4318
  VeStrategyH265 = "vestrategy_h265",
4000
4319
  VeStrategyPreload = "vestrategy_preload",
4320
+ VeStrategyAdaptRange = "vestrategy_adapt_range",
4001
4321
  DashAbralgo = "DashAbralgo",
4002
4322
  Preloader = "preloader"
4003
4323
  }
@@ -4081,6 +4401,9 @@ declare class VePlayer {
4081
4401
  * @type {PlayerData}
4082
4402
  * @memberof VePlayer
4083
4403
  */
4404
+ /** {en}
4405
+ * @hidden
4406
+ */
4084
4407
  playerData: PlayerData;
4085
4408
  /** {zh}
4086
4409
  * @brief 播放器内核实例,详情参考{@link https://www.volcengine.com/docs/4/1249083 播放器内核}。
@@ -4094,6 +4417,9 @@ declare class VePlayer {
4094
4417
  * @type {*}
4095
4418
  * @memberof VePlayer
4096
4419
  */
4420
+ /** {en}
4421
+ * @hidden
4422
+ */
4097
4423
  mountingDom: Element;
4098
4424
  /** {zh}
4099
4425
  * @hidden
@@ -4101,6 +4427,9 @@ declare class VePlayer {
4101
4427
  * @type {*}
4102
4428
  * @memberof VePlayer
4103
4429
  */
4430
+ /** {en}
4431
+ * @hidden
4432
+ */
4104
4433
  playerContainer: any;
4105
4434
  /** {zh}
4106
4435
  * @hidden
@@ -4108,6 +4437,9 @@ declare class VePlayer {
4108
4437
  * @type {*}
4109
4438
  * @memberof VePlayer
4110
4439
  */
4440
+ /** {en}
4441
+ * @hidden
4442
+ */
4111
4443
  mobilePanel: any;
4112
4444
  /** {zh}
4113
4445
  *
@@ -4165,6 +4497,7 @@ declare class VePlayer {
4165
4497
  * @memberof VePlayer
4166
4498
  */
4167
4499
  sdkUmdLoader: umdLoader;
4500
+ private adapter;
4168
4501
  /**
4169
4502
  * @hidden
4170
4503
  */
@@ -4183,33 +4516,35 @@ declare class VePlayer {
4183
4516
  * @memberof VePlayer
4184
4517
  */
4185
4518
  static sdkVersion: string;
4186
- /**{zh}
4187
- * @brief 播放器预初始化配置
4519
+ /** {zh}
4520
+ * @brief 播放策略预初始化配置
4188
4521
  * @param options 初始化配置,详情见{@link StrategyInitOptions}
4189
4522
  */
4190
4523
  static prepare(options: StrategyInitOptions): Promise<void>;
4191
- /**{zh}
4524
+ /** {zh}
4192
4525
  * @brief 设置预加载模式
4193
4526
  * @param preloadScene 预加载模式,详情见{@link PreloadScene}
4194
4527
  * @param options 预加载配置更新,详情见{@link IPreloadUpdateConfig}
4195
4528
  */
4196
4529
  static setPreloadScene(preloadScene: PreloadScene, options?: IPreloadUpdateConfig): void;
4197
- /**{zh}
4198
- * @brief 获取预加载实例,可通过预加载实例执行高级方法,需在VePlayer.prepare Promise执行完成之后才能获取到预加载实例
4199
- * @returns 预加载实例,详情见{@link PreloaderManager}
4530
+ /** {zh}
4531
+ * @hidden
4532
+ * @brief 获取预加载实例,可通过预加载实例执行高级方法,需在 `VePlayer.prepare` 的 Promise 执行完成之后才能获取到预加载实例。
4533
+ * @returns 预加载实例,详见 {@link PreloaderManager}
4200
4534
  */
4201
4535
  static get preloader(): PreloaderManager | undefined;
4202
- /**{zh}
4203
- * @brief 获取当前预加载实例状态
4204
- * @returns 预加载实例状态,详情见{@link PreloaderStatus}
4536
+ /** {zh}
4537
+ * @hidden
4538
+ * @brief 获取当前预加载实例状态。
4539
+ * @returns 预加载实例状态,详见 {@link PreloaderStatus}
4205
4540
  */
4206
4541
  static get preloaderStatus(): PreloaderStatus;
4207
- /**{zh}
4542
+ /** {zh}
4208
4543
  * @brief 添加待预加载视频列表
4209
4544
  * @param list 待预加载视频列表,详情见{@link IPreloadStream[]}。
4210
4545
  */
4211
4546
  static addPreloadList(list: IPreloadStream[]): void;
4212
- /**{zh}
4547
+ /** {zh}
4213
4548
  * @brief 设置待预加载视频列表,替换当前已设置的待预加载列表
4214
4549
  * @param list 待预加载视频列表,详情见{@link IPreloadStream[]}
4215
4550
  */
@@ -4318,6 +4653,9 @@ declare class VePlayer {
4318
4653
  *
4319
4654
  * @memberof VePlayer
4320
4655
  */
4656
+ /** {en}
4657
+ * @hidden
4658
+ */
4321
4659
  renderDom(): void;
4322
4660
  /** {zh}
4323
4661
  * @hidden
@@ -4325,6 +4663,9 @@ declare class VePlayer {
4325
4663
  * @return {*}
4326
4664
  * @memberof VePlayer
4327
4665
  */
4666
+ /** {en}
4667
+ * @hidden
4668
+ */
4328
4669
  renderPoster(): void;
4329
4670
  /**
4330
4671
  * @brief 获取西瓜的definition的配置,用于在创建player或者在playNext()时传入definition,
@@ -4338,6 +4679,9 @@ declare class VePlayer {
4338
4679
  * @return {*}
4339
4680
  * @memberof VePlayer
4340
4681
  */
4682
+ /** {en}
4683
+ * @hidden
4684
+ */
4341
4685
  createPlayer(): Promise<PlayerCore>;
4342
4686
  /** {zh}
4343
4687
  * @hidden
@@ -4346,6 +4690,9 @@ declare class VePlayer {
4346
4690
  * @return {void}
4347
4691
  * @memberof VePlayer
4348
4692
  */
4693
+ /** {en}
4694
+ * @hidden
4695
+ */
4349
4696
  setPluginConfig(finalOptions: IPlayerConfig): void;
4350
4697
  /** {zh}
4351
4698
  * @hidden
@@ -4353,6 +4700,9 @@ declare class VePlayer {
4353
4700
  * @param {string} url 地址
4354
4701
  * @memberof VePlayer
4355
4702
  */
4703
+ /** {en}
4704
+ * @hidden
4705
+ */
4356
4706
  detectCodec(url: string): Promise<void>;
4357
4707
  /** {zh}
4358
4708
  * @hidden
@@ -4361,6 +4711,9 @@ declare class VePlayer {
4361
4711
  * @return {*}
4362
4712
  * @memberof VePlayer
4363
4713
  */
4714
+ /** {en}
4715
+ * @hidden
4716
+ */
4364
4717
  setDefaultConfigOptions(options: any): void;
4365
4718
  /** {zh}
4366
4719
  * @brief 获取当前播放视频数据
@@ -4368,6 +4721,9 @@ declare class VePlayer {
4368
4721
  * @return {any}
4369
4722
  * @memberof VePlayer
4370
4723
  */
4724
+ /** {en}
4725
+ * @hidden
4726
+ */
4371
4727
  getCurrentPlayerConfig(): {
4372
4728
  type?: "vod" | "live";
4373
4729
  isLive?: boolean;
@@ -4476,6 +4832,9 @@ declare class VePlayer {
4476
4832
  * @param {*} pluginName
4477
4833
  * @param {*} IsShow
4478
4834
  */
4835
+ /** {en}
4836
+ * @hidden
4837
+ */
4479
4838
  changePluginsIcon(pluginName: any, IsShow: any): void;
4480
4839
  /** {zh}
4481
4840
  * @hidden
@@ -4485,18 +4844,23 @@ declare class VePlayer {
4485
4844
  * @return {*}
4486
4845
  * @memberof VePlayer
4487
4846
  */
4847
+ /** {en}
4848
+ * @hidden
4849
+ */
4488
4850
  getSdkPlugin(name: any): any;
4489
4851
  /** {zh}
4490
4852
  * @brief 播放时更换临时播放 Token,以更换视频源。
4491
4853
  * @memberof VePlayer
4492
4854
  * @param config 临时播放 Token 配置。
4493
4855
  * @param isNewVideo 是否为新视频。为 `false` 时,更换后,会从更换前的时间点继续播放。
4856
+ * @notes 此接口不支持切换火山引擎私有加密 Token。
4494
4857
  */
4495
4858
  switchAuthToken(config: IPlayAuthTokenConfig, isNewVideo?: boolean): Promise<void>;
4496
4859
  /** {zh}
4497
4860
  * @brief 更新临时播放 Token。
4498
4861
  * @memberof VePlayer
4499
- * @notes 播放前临时播放 Token 过期(收到 `play_auth_token_expired` 事件或者 `onTokenExpired` 回调触发)时,调用此方法更新临时播放 Token。
4862
+ * @notes - 播放前临时播放 Token 过期(收到 `play_auth_token_expired` 事件或者 `onTokenExpired` 回调触发)时,调用此方法更新临时播放 Token。
4863
+ * - 此接口不支持切换火山引擎私有加密 Token。
4500
4864
  * @param config 临时播放 Token 配置。
4501
4865
  */
4502
4866
  updateAuthToken(config: IPlayAuthTokenConfig): Promise<void>;
@@ -4526,13 +4890,17 @@ declare class VePlayer {
4526
4890
  * @param config 播放器配置。
4527
4891
  * @param isNewVideo 是否为新视频,默认为 `true`。为 `false` 时表示是同一个视频更换 token。更换后,会从更换前的时间点继续播放。
4528
4892
  */
4893
+ /** {en}
4894
+ * @hidden
4895
+ */
4529
4896
  next(config: IPlayerConfig, isNewVideo?: boolean): Promise<void>;
4530
4897
  /** {zh}
4531
4898
  * @brief 播放下一视频。
4532
4899
  * @return{Promise<any>}
4533
4900
  * @memberof VePlayer
4534
- * @notes 成功更换视频源后,默认是暂停状态,如果设置了自动播放,则会自动播放。
4535
- * @param config 播放器实例化配置。
4901
+ * @notes - 成功更换视频源后,默认是暂停状态。如果设置了自动播放,则会自动播放。
4902
+ * - 此接口不支持切换火山引擎私有加密视频。
4903
+ * @param config 播放器实例化配置。此接口仅支持 `IPlayerConfig` 中的 `url`、`playList`、`poster`、`getVideoByToken` 字段。。
4536
4904
  * @param isNewVideo 是否为新视频。为 `false` 时,更换后,会从更换前的时间点继续播放。
4537
4905
  */
4538
4906
  playNext(config: IPlayerConfig, isNewVideo?: boolean): Promise<any>;
@@ -4550,6 +4918,9 @@ declare class VePlayer {
4550
4918
  * @return {*}
4551
4919
  * @memberof VePlayer
4552
4920
  */
4921
+ /** {en}
4922
+ * @hidden
4923
+ */
4553
4924
  getPlayerInstance(): PlayerCore;
4554
4925
  /** {zh}
4555
4926
  * @hidden
@@ -4557,6 +4928,9 @@ declare class VePlayer {
4557
4928
  * @return {*}
4558
4929
  * @memberof VePlayer
4559
4930
  */
4931
+ /** {en}
4932
+ * @hidden
4933
+ */
4560
4934
  getSoftDecodingOption(isOpenSoftDecoding: boolean, url: string, type: string): Promise<{
4561
4935
  mediaType?: string;
4562
4936
  innerDegrade?: number;
@@ -4569,6 +4943,9 @@ declare class VePlayer {
4569
4943
  * @brief 获取h265软解播放时的播放列表
4570
4944
  * @memberof VePlayer
4571
4945
  */
4946
+ /** {en}
4947
+ * @hidden
4948
+ */
4572
4949
  setH265SoftPlayList(): void;
4573
4950
  /** {zh}
4574
4951
  * @brief 切换清晰度
@@ -5351,7 +5728,7 @@ export declare const Events: {
5351
5728
  */
5352
5729
  LINE_CHANGE: string;
5353
5730
  /** {zh}
5354
- * @brief `playAuthToken` 获取 URL 失败。
5731
+ * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
5355
5732
  */
5356
5733
  GET_PLAY_URL_ERR: string;
5357
5734
  /** {zh}
@@ -5403,15 +5780,15 @@ export declare const Events: {
5403
5780
  */
5404
5781
  PLAY_LIST_ITEM_CHANGE: string;
5405
5782
  /** {zh}
5406
- * @brief playNext开始
5783
+ * @brief `playNext` 开始。
5407
5784
  */
5408
5785
  PLAY_NEXT_START: string;
5409
5786
  /** {zh}
5410
- * @brief playNext结束。
5787
+ * @brief `playNext` 结束。
5411
5788
  */
5412
5789
  PLAY_NEXT_END: string;
5413
5790
  /** {zh}
5414
- * @brief 自动挡档位改变。
5791
+ * @brief 多码率自适应播放时,自动挡位对应的清晰度改变。
5415
5792
  */
5416
5793
  ABR_AUTO_DESC_CHANGE: string;
5417
5794
  /** {zh}
@@ -5581,7 +5958,7 @@ export declare const Events: {
5581
5958
  */
5582
5959
  NOT_SUPPORT_SOFT_DECODER: string;
5583
5960
  /** {zh}
5584
- * @brief `playAuthToken` 过期
5961
+ * @brief `playAuthToken` 过期。
5585
5962
  */
5586
5963
  TOKEN_EXPIRED: string;
5587
5964
  /** {zh}
@@ -5589,31 +5966,31 @@ export declare const Events: {
5589
5966
  */
5590
5967
  UMD_LOAD_FAIL: string;
5591
5968
  /** {zh}
5592
- * @brief 切换下一个视频,playNext方法调用后触发
5969
+ * @brief 切换下一个视频。调用 `playNext` 后触发。
5593
5970
  */
5594
5971
  PLAYNEXT: string;
5595
5972
  /** {zh}
5596
- * @brief 视频地址为空
5973
+ * @brief 视频地址为空。
5597
5974
  */
5598
5975
  URL_NULL: string;
5599
5976
  /** {zh}
5600
- * @brief 鼠标移出
5977
+ * @brief 鼠标移出。
5601
5978
  */
5602
5979
  LEAVE_PLAYER: string;
5603
5980
  /** {zh}
5604
- * @brief 鼠标移出
5981
+ * @brief 鼠标移入。
5605
5982
  */
5606
5983
  ENTER_PLAYER: string;
5607
5984
  /** {zh}
5608
- * @brief 播放器状态重置
5985
+ * @brief 播放器状态重置。
5609
5986
  */
5610
5987
  RESET: string;
5611
5988
  /** {zh}
5612
- * @brief <source> 加载错误,表示<source>不支持或播放失败
5989
+ * @brief `<source>` 加载错误,表示 `<source>` 不支持或播放失败。
5613
5990
  */
5614
5991
  SOURCE_ERROR: string;
5615
5992
  /** {zh}
5616
- * @brief <source> 加载成功
5993
+ * @brief `<source>` 加载成功。
5617
5994
  */
5618
5995
  SOURCE_SUCCESS: string;
5619
5996
  /** {zh}
@@ -5634,11 +6011,11 @@ export declare const Events: {
5634
6011
  DURATION_CHANGE: string;
5635
6012
  /** {zh}
5636
6013
  * @deprecated
5637
- * @brief 媒体被清空(初始化)时触发。
6014
+ * @brief (已废弃)媒体被清空时触发,通常是由于初始化。
5638
6015
  */
5639
6016
  EMPITED: string;
5640
6017
  /** {zh}
5641
- * @brief 媒体被清空(初始化)时触发。
6018
+ * @brief 媒体被清空时触发,通常是由于初始化。
5642
6019
  */
5643
6020
  EMPTIED: string;
5644
6021
  /** {zh}
@@ -5900,7 +6277,7 @@ export declare const Event: {
5900
6277
  */
5901
6278
  NOT_SUPPORT_SOFT_DECODER: string;
5902
6279
  /** {zh}
5903
- * @brief `playAuthToken` 过期
6280
+ * @brief `playAuthToken` 过期。
5904
6281
  */
5905
6282
  TOKEN_EXPIRED: string;
5906
6283
  /** {zh}
@@ -5908,31 +6285,31 @@ export declare const Event: {
5908
6285
  */
5909
6286
  UMD_LOAD_FAIL: string;
5910
6287
  /** {zh}
5911
- * @brief 切换下一个视频,playNext方法调用后触发
6288
+ * @brief 切换下一个视频。调用 `playNext` 后触发。
5912
6289
  */
5913
6290
  PLAYNEXT: string;
5914
6291
  /** {zh}
5915
- * @brief 视频地址为空
6292
+ * @brief 视频地址为空。
5916
6293
  */
5917
6294
  URL_NULL: string;
5918
6295
  /** {zh}
5919
- * @brief 鼠标移出
6296
+ * @brief 鼠标移出。
5920
6297
  */
5921
6298
  LEAVE_PLAYER: string;
5922
6299
  /** {zh}
5923
- * @brief 鼠标移出
6300
+ * @brief 鼠标移入。
5924
6301
  */
5925
6302
  ENTER_PLAYER: string;
5926
6303
  /** {zh}
5927
- * @brief 播放器状态重置
6304
+ * @brief 播放器状态重置。
5928
6305
  */
5929
6306
  RESET: string;
5930
6307
  /** {zh}
5931
- * @brief <source> 加载错误,表示<source>不支持或播放失败
6308
+ * @brief `<source>` 加载错误,表示 `<source>` 不支持或播放失败。
5932
6309
  */
5933
6310
  SOURCE_ERROR: string;
5934
6311
  /** {zh}
5935
- * @brief <source> 加载成功
6312
+ * @brief `<source>` 加载成功。
5936
6313
  */
5937
6314
  SOURCE_SUCCESS: string;
5938
6315
  };
@@ -6014,7 +6391,7 @@ export declare const Event: {
6014
6391
  */
6015
6392
  LINE_CHANGE: string;
6016
6393
  /** {zh}
6017
- * @brief `playAuthToken` 获取 URL 失败。
6394
+ * @brief 播放器通过 `playAuthToken` 获取 URL 失败。
6018
6395
  */
6019
6396
  GET_PLAY_URL_ERR: string;
6020
6397
  /** {zh}
@@ -6066,15 +6443,15 @@ export declare const Event: {
6066
6443
  */
6067
6444
  PLAY_LIST_ITEM_CHANGE: string;
6068
6445
  /** {zh}
6069
- * @brief playNext开始
6446
+ * @brief `playNext` 开始。
6070
6447
  */
6071
6448
  PLAY_NEXT_START: string;
6072
6449
  /** {zh}
6073
- * @brief playNext结束。
6450
+ * @brief `playNext` 结束。
6074
6451
  */
6075
6452
  PLAY_NEXT_END: string;
6076
6453
  /** {zh}
6077
- * @brief 自动挡档位改变。
6454
+ * @brief 多码率自适应播放时,自动挡位对应的清晰度改变。
6078
6455
  */
6079
6456
  ABR_AUTO_DESC_CHANGE: string;
6080
6457
  };