@volcengine/veplayer 1.18.0-rc.1 → 1.18.0-rc.3

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.
Files changed (3) hide show
  1. package/index.d.ts +719 -138
  2. package/index.min.js +2 -2
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -941,7 +941,7 @@ export interface ITextItem {
941
941
  * @kind property
942
942
  */
943
943
  export interface IDefinitionDemotePlugin {
944
- /**
944
+ /** {zh}
945
945
  * @brief 是否开启自动降级,取值如下:
946
946
  * - `false`:关闭自动降级。
947
947
  * - `true`:开启自动降级。
@@ -954,7 +954,7 @@ export interface IDefinitionDemotePlugin {
954
954
  * - `true`: automatic downgrade is enabled.
955
955
  */
956
956
  isNeedAutoDemote?: boolean;
957
- /**
957
+ /** {zh}
958
958
  * @brief 清晰度降级顺序。数组中的元素需与 `playList` 中的 `definition` 相对应。
959
959
  * @default []
960
960
  *
@@ -962,49 +962,59 @@ export interface IDefinitionDemotePlugin {
962
962
  * @memberof IDefinitionDemotePlugin
963
963
  */
964
964
  /** {en}
965
+ * @brief The order of definition downgrade. The elements in the array should correspond to the `definition` in the `playList`.
966
+ * @default []
967
+ *
968
+ * @type {string[]}
969
+ * @memberof IDefinitionDemotePlugin
965
970
  */
966
971
  demotePriority: string[];
967
- /**
972
+ /** {zh}
968
973
  * @brief 长时间卡顿的时间阈值,单位为毫秒。卡顿时长超过该值,即视为长时间卡顿。发生长时间卡顿时,SDK 会触发 `LONG_WAITING` 事件。
969
974
  * @default 5000
970
975
  *
971
976
  */
972
977
  /** {en}
978
+ * @brief The threshold for long waiting time, in milliseconds. If the waiting time exceeds this value, it is considered as long waiting. The `LONG_WAITING` event will be triggered when long waiting occurs.
973
979
  * @default 5000
974
980
  *
975
981
  */
976
982
  longWaitingTime?: number;
977
- /**
983
+ /** {zh}
978
984
  * @brief 频繁卡顿的次数阈值。`oftenWaitingTime` 内卡顿次数大于或等于阈值时,SDK 会触发 `OFTEN_WAITING` 事件,提示发生了频繁卡顿。
979
985
  * @default 3
980
986
  *
981
987
  */
982
988
  /** {en}
989
+ * @brief The threshold for frequent stuttering, in milliseconds. If the stuttering count exceeds this value, the `OFTEN_WAITING` event will be triggered, indicating frequent stuttering.
983
990
  * @default 3
984
991
  *
985
992
  */
986
993
  oftenWaitingCount?: number;
987
- /**
994
+ /** {zh}
988
995
  * @brief 频繁卡顿监测的时间范围。`oftenWaitingTime` 内卡顿次数大于或等于 `oftenWaitingCount` 时,SDK 会触发 `OFTEN_WAITING` 事件,提示发生了频繁卡顿。
989
996
  * @default 5000
990
997
  */
991
998
  /** {en}
999
+ * @brief The time range for frequent stuttering monitoring. If the stuttering count exceeds `oftenWaitingCount` within `oftenWaitingTime`, the `OFTEN_WAITING` event will be triggered, indicating frequent stuttering.
992
1000
  * @default 5000
993
1001
  */
994
1002
  oftenWaitingTime?: number;
995
- /**
1003
+ /** {zh}
996
1004
  * @brief 卡顿时是否显示清晰度降级提示 toast。
997
1005
  * @default true
998
1006
  */
999
1007
  /** {en}
1008
+ * @brief Whether to display the definition downgrade toast.
1000
1009
  * @default true
1001
1010
  */
1002
1011
  isNeedShowTips?: boolean;
1003
- /**
1012
+ /** {zh}
1004
1013
  * @brief 清晰度降级提示 toast 的显示时长,单位为毫秒。
1005
1014
  * @default 3000
1006
1015
  */
1007
1016
  /** {en}
1017
+ * @brief The duration of the definition downgrade toast, in milliseconds.
1008
1018
  * @default 3000
1009
1019
  */
1010
1020
  toastShowTime?: number;
@@ -1040,51 +1050,212 @@ export declare class DefinitionDemotePlugin extends Plugin {
1040
1050
  showToast(definition: Stream): void;
1041
1051
  destroy(): void;
1042
1052
  }
1043
- /**
1053
+ /** {zh}
1044
1054
  * 音轨选择选项。
1045
1055
  * 对应 hls.js `AudioSelectionOption` 的所有字段,所有字段均可选。
1046
1056
  * 用于 `switchAudioTrack()` 参数(配合 `id` 使用)以及 `audioPreference` 配置。
1057
+ * @kind property
1058
+ */
1059
+ /** {en}
1060
+ * @brief Audio track selection options.
1061
+ * Corresponding to all fields of hls.js `AudioSelectionOption`, all fields are optional.
1062
+ * Used as parameters for `switchAudioTrack()` (using `id`) and `audioPreference` configuration.
1063
+ * @kind property
1047
1064
  */
1048
1065
  export interface AudioTrackOption {
1066
+ /** {zh}
1067
+ * @brief 音轨主要语言,BCP-47 格式(如 `zh`、`en`)。对应 `#EXT-X-MEDIA` 的 `LANGUAGE`。
1068
+ */
1069
+ /** {en}
1070
+ * @brief Primary track language in BCP-47 format (e.g. `zh`, `en`). Maps to `#EXT-X-MEDIA` `LANGUAGE`.
1071
+ */
1049
1072
  lang?: string;
1073
+ /** {zh}
1074
+ * @brief 关联语言代码。对应 `#EXT-X-MEDIA` 的 `ASSOC-LANGUAGE`。
1075
+ */
1076
+ /** {en}
1077
+ * @brief Associated language code. Maps to `#EXT-X-MEDIA` `ASSOC-LANGUAGE`.
1078
+ */
1050
1079
  assocLang?: string;
1080
+ /** {zh}
1081
+ * @brief 轨道特征描述字符串。对应 `#EXT-X-MEDIA` 的 `CHARACTERISTICS`(如 `public.accessibility.describes-video`)。
1082
+ */
1083
+ /** {en}
1084
+ * @brief Track characteristics string. Maps to `#EXT-X-MEDIA` `CHARACTERISTICS`.
1085
+ */
1051
1086
  characteristics?: string;
1087
+ /** {zh}
1088
+ * @brief 声道数。对应 `#EXT-X-MEDIA` 的 `CHANNELS`(如 `"2"`)。
1089
+ */
1090
+ /** {en}
1091
+ * @brief Number of audio channels. Maps to `#EXT-X-MEDIA` `CHANNELS` (e.g. `"2"`).
1092
+ */
1052
1093
  channels?: string;
1094
+ /** {zh}
1095
+ * @brief 音轨名称,用于展示或精确匹配(如 `Stereo`)。hls.js 路径下与 `lang` 组合可唯一定位轨道。
1096
+ */
1097
+ /** {en}
1098
+ * @brief Track name for display or precise matching (e.g. `Stereo`). With `lang`, uniquely identifies a track on the hls.js path.
1099
+ */
1053
1100
  name?: string;
1101
+ /** {zh}
1102
+ * @brief 音频编解码器标识(如 `mp4a.40.2`)。
1103
+ */
1104
+ /** {en}
1105
+ * @brief Audio codec identifier (e.g. `mp4a.40.2`).
1106
+ */
1054
1107
  audioCodec?: string;
1108
+ /** {zh}
1109
+ * @brief 音频组 ID。对应 `#EXT-X-MEDIA` 的 `GROUP-ID`。
1110
+ */
1111
+ /** {en}
1112
+ * @brief Audio group ID. Maps to `#EXT-X-MEDIA` `GROUP-ID`.
1113
+ */
1055
1114
  groupId?: string;
1115
+ /** {zh}
1116
+ * @brief 是否为 manifest 中的默认音轨。
1117
+ */
1118
+ /** {en}
1119
+ * @brief Whether this is the default track declared in the manifest.
1120
+ */
1056
1121
  default?: boolean;
1122
+ /** {zh}
1123
+ * @hidden
1124
+ */
1125
+ /** {en}
1126
+ * @hidden
1127
+ */
1057
1128
  [key: string]: unknown;
1058
1129
  }
1130
+ /** {zh}
1131
+ * @brief HLS 音轨对象。在 `AudioTrackOption` 基础上包含列表索引与展示名称。
1132
+ */
1133
+ /** {en}
1134
+ * @brief HLS audio track object. Extends `AudioTrackOption` with list index and display name.
1135
+ */
1059
1136
  export interface AudioTrack extends AudioTrackOption {
1137
+ /** {zh}
1138
+ * @brief 轨道在 `audioTracks` 列表中的索引(hls.js 与原生路径均为 number)。
1139
+ */
1140
+ /** {en}
1141
+ * @brief Track index in the `audioTracks` list (number on both hls.js and native paths).
1142
+ */
1060
1143
  id: number;
1144
+ /** {zh}
1145
+ * @brief 展示名称(由 `lang` / `name` 等字段生成或来自 manifest)。
1146
+ */
1147
+ /** {en}
1148
+ * @brief Display name (derived from `lang` / `name` or from the manifest).
1149
+ */
1061
1150
  name: string;
1151
+ /** {zh}
1152
+ * @brief 是否为 manifest 默认音轨。
1153
+ */
1154
+ /** {en}
1155
+ * @brief Whether this is the default track in the manifest.
1156
+ */
1062
1157
  default: boolean;
1063
1158
  }
1064
- /**
1065
- * `getAudioTracks()` / `getCurrentAudioTrack()` 的返回项类型。
1066
- * 是 `switchAudioTrack()` 参数类型的子类型,可直接传入。
1159
+ /** {zh}
1160
+ * @brief `getAudioTracks()` / `getCurrentAudioTrack()` 的返回项类型,可直接传入 `switchAudioTrack()`。
1161
+ */
1162
+ /** {en}
1163
+ * @brief Return type of `getAudioTracks()` / `getCurrentAudioTrack()`; can be passed directly to `switchAudioTrack()`.
1067
1164
  */
1068
1165
  export interface AudioTrackInfo extends AudioTrack {
1069
- /** 是否为当前激活轨道。`getCurrentAudioTrack()` 返回时始终为 `true`。 */
1166
+ /** {zh}
1167
+ * @brief 是否为当前激活轨道。`getCurrentAudioTrack()` 返回时始终为 `true`。
1168
+ */
1169
+ /** {en}
1170
+ * @brief Whether this is the currently active track. Always `true` when returned by `getCurrentAudioTrack()`.
1171
+ */
1070
1172
  selected: boolean;
1071
1173
  }
1174
+ /** {zh}
1175
+ * @brief PC 端音轨切换插件配置。
1176
+ * @list Options
1177
+ * @kind property
1178
+ */
1179
+ /** {en}
1180
+ * @brief PC audio track selector plugin configuration.
1181
+ * @list Options
1182
+ * @kind property
1183
+ */
1072
1184
  export interface IAudioTrackConfig {
1073
- /** 控件在控制栏中的排列顺序,数值越小越靠左。@default 5 */
1185
+ /** {zh}
1186
+ * @brief 控件在控制栏中的排列顺序,数值越小越靠左。
1187
+ * @default 70
1188
+ */
1189
+ /** {en}
1190
+ * @brief Sort weight in the control bar; smaller values appear further left.
1191
+ * @default 70
1192
+ */
1074
1193
  index?: number;
1075
- /** 是否显示图标按钮。@default true */
1194
+ /** {zh}
1195
+ * @brief 是否显示音轨切换图标按钮。
1196
+ * @default true
1197
+ */
1198
+ /** {en}
1199
+ * @brief Whether to show the audio track switcher icon.
1200
+ * @default true
1201
+ */
1076
1202
  isShowIcon?: boolean;
1077
- /** 竖屏时是否隐藏控件。@default false */
1203
+ /** {zh}
1204
+ * @brief 竖屏时是否隐藏音轨控件。
1205
+ * @default false
1206
+ */
1207
+ /** {en}
1208
+ * @brief Whether to hide the audio track control in portrait orientation.
1209
+ * @default false
1210
+ */
1078
1211
  hidePortrait?: boolean;
1079
- /** 音轨列表中是否在语言名称后显示括号内的原始轨道名,如 `日本語 (Stereo AudioTrack1)`。@default true */
1212
+ /** {zh}
1213
+ * @brief 音轨列表中是否在语言名称后显示括号内的原始轨道名,如 `日本語 (Stereo AudioTrack1)`。
1214
+ * @default true
1215
+ */
1216
+ /** {en}
1217
+ * @brief Whether to append the raw track name in parentheses after the language label, e.g. `Japanese (Stereo AudioTrack1)`.
1218
+ * @default true
1219
+ */
1080
1220
  showNameSuffix?: boolean;
1081
1221
  }
1222
+ /** {zh}
1223
+ * @brief 移动端音轨切换插件配置。
1224
+ * @list Options
1225
+ * @kind property
1226
+ */
1227
+ /** {en}
1228
+ * @brief Mobile audio track selector plugin configuration.
1229
+ * @list Options
1230
+ * @kind property
1231
+ */
1082
1232
  export interface IAudioTrackMobileConfig {
1083
- /** 控件在控制栏中的排列顺序,数值越小越靠左。@default 2.6 */
1233
+ /** {zh}
1234
+ * @brief 控件在控制栏中的排列顺序,数值越小越靠左。
1235
+ * @default 2.6
1236
+ */
1237
+ /** {en}
1238
+ * @brief Sort weight in the control bar; smaller values appear further left.
1239
+ * @default 2.6
1240
+ */
1084
1241
  index?: number;
1085
- /** 是否显示图标按钮。@default true */
1242
+ /** {zh}
1243
+ * @brief 是否显示音轨切换图标按钮。
1244
+ * @default true
1245
+ */
1246
+ /** {en}
1247
+ * @brief Whether to show the audio track switcher icon.
1248
+ * @default true
1249
+ */
1086
1250
  isShowIcon?: boolean;
1087
- /** 音轨列表中是否在语言名称后显示括号内的原始轨道名,如 `日本語 (Stereo AudioTrack1)`。@default true */
1251
+ /** {zh}
1252
+ * @brief 音轨列表中是否在语言名称后显示括号内的原始轨道名,如 `日本語 (Stereo AudioTrack1)`。
1253
+ * @default true
1254
+ */
1255
+ /** {en}
1256
+ * @brief Whether to append the raw track name in parentheses after the language label, e.g. `Japanese (Stereo AudioTrack1)`.
1257
+ * @default true
1258
+ */
1088
1259
  showNameSuffix?: boolean;
1089
1260
  }
1090
1261
  /**
@@ -1093,26 +1264,33 @@ export interface IAudioTrackMobileConfig {
1093
1264
  * @kind property
1094
1265
  */
1095
1266
  /** {en}
1267
+ * @brief DASH playback configuration.
1096
1268
  * @list Options
1097
1269
  * @kind property
1098
1270
  */
1099
1271
  export interface IDashPluginConfig {
1100
- /**
1272
+ /** {zh}
1101
1273
  * @brief 视频 ID。
1102
1274
  * @default -
1103
1275
  * @notes 播放加密视频时必选
1104
1276
  */
1105
1277
  /** {en}
1278
+ * @brief Video ID.
1106
1279
  * @default -
1280
+ * @notes When playing encrypted videos, it is required.
1107
1281
  */
1108
1282
  vid?: string;
1109
- /**
1283
+ /** {zh}
1110
1284
  * @hidden
1111
1285
  * @brief 播放类型
1112
1286
  * @default TOP
1113
1287
  */
1288
+ /** {en}
1289
+ * @brief Playback type.
1290
+ * @default TOP
1291
+ */
1114
1292
  playInfoType: "TOP";
1115
- /**
1293
+ /** {zh}
1116
1294
  * @brief 清晰度映射文案。
1117
1295
  * @default -
1118
1296
  * @example
@@ -1127,6 +1305,16 @@ export interface IDashPluginConfig {
1127
1305
  */
1128
1306
  /** {en}
1129
1307
  * @brief Definition label mapping.
1308
+ * @default -
1309
+ * @example
1310
+ * ``` javascript
1311
+ * {
1312
+ * 360p: "SD 360p",
1313
+ * 480p: "HD 480p",
1314
+ * 720p: "FHD 720p",
1315
+ * 1080p: "UHD 1080p"
1316
+ * }
1317
+ * ```
1130
1318
  */
1131
1319
  definitionText: Record<string, string>;
1132
1320
  /**
@@ -1135,91 +1323,142 @@ export interface IDashPluginConfig {
1135
1323
  */
1136
1324
  /** {en}
1137
1325
  * @brief Default definition.
1326
+ * @default The first definition in the list
1138
1327
  */
1139
1328
  defaultDefinition?: string;
1140
- /**
1329
+ /** {zh}
1141
1330
  * @hidden
1142
1331
  * 获取证书地址
1143
1332
  * 默认:`//i.snssdk.com/video/drm/v1/play_licenses`
1144
1333
  * 播放加密视频时必选
1145
1334
  */
1335
+ /** {en}
1336
+ * @brief Get the certificate address.
1337
+ * @default `//i.snssdk.com/video/drm/v1/play_licenses`
1338
+ * @notes When playing encrypted videos, it is required.
1339
+ */
1146
1340
  getLicenseUrl?: string;
1147
- /**
1341
+ /** {zh}
1148
1342
  * @hidden
1149
1343
  * dash播放信息,由`Service.url`服务接口获取
1150
1344
  * 默认:无
1151
1345
  * 必选
1152
1346
  */
1347
+ /** {en}
1348
+ * @hidden
1349
+ * @brief Dash playback information, obtained from the `Service.url` service interface.
1350
+ * @default -
1351
+ * @notes Required.
1352
+ */
1153
1353
  dashOpts?: {
1154
1354
  Data: any;
1155
1355
  };
1156
- /**
1356
+ /** {zh}
1157
1357
  * @brief 兜底的mp4播放列表,由`Service.url`服务接口获取
1158
1358
  * @default -
1159
1359
  * @hidden
1160
1360
  */
1361
+ /** {en}
1362
+ * @brief Fallback mp4 playback list, obtained from the `Service.url` service interface.
1363
+ * @default -
1364
+ * @hidden
1365
+ */
1161
1366
  mp4Opts: {
1162
1367
  mp4List: mp4OptsItem[];
1163
1368
  };
1164
- /**
1165
- * 预加载时间,单位ms
1369
+ /** {zh}
1370
+ * @brief 预加载时间,单位ms
1166
1371
  * @default 50
1167
- * @brief 预加载时间,单位为毫秒。
1168
1372
  */
1169
1373
  /** {en}
1170
1374
  * @brief Preload time in milliseconds.
1375
+ * @default 50
1171
1376
  */
1172
1377
  preloadTime?: number;
1173
- /**
1378
+ /** {zh}
1174
1379
  * @hidden
1175
1380
  * 自适应配置项
1176
1381
  * 默认:undefined
1177
1382
  * 非必选
1178
1383
  */
1384
+ /** {en}
1385
+ * @brief Adaptive configuration item.
1386
+ * @default undefined
1387
+ * @hidden
1388
+ */
1179
1389
  autoBitrateOpts?: any;
1180
- /**
1390
+ /** {zh}
1181
1391
  * @hidden
1182
1392
  * 备用地址降级,默认情况下,当dash播放出问题后,会降级为mp4播放;
1183
1393
  * 设置改参数后,会优先使用备用地址进行dash的降级播放,再次出错时,会降级为mp4播放
1184
1394
  * 默认:false
1185
1395
  * 非必选
1186
1396
  */
1397
+ /** {en}
1398
+ * @brief Fallback address degradation. By default, when dash playback fails, it will be downgraded to mp4 playback.
1399
+ * @default false
1400
+ * @hidden
1401
+ */
1187
1402
  useBackUrl?: boolean;
1188
- /**
1403
+ /** {zh}
1189
1404
  * @hidden
1190
1405
  * 优化首帧
1191
1406
  * 是针对域名,将range参数放在url后面,避免OPTIONS请求,从而优化首帧
1192
1407
  * 默认:无
1193
1408
  * 非必选
1194
1409
  */
1410
+ /** {en}
1411
+ * @brief Optimize the first frame.
1412
+ * @default undefined
1413
+ * @hidden
1414
+ */
1195
1415
  url_range_domains?: string[];
1196
1416
  }
1197
- /**
1417
+ /** {zh}
1198
1418
  * @brief dash播放的mp4兜底播放列表配置
1199
1419
  * @list Options
1420
+ * @kind property
1421
+ * @hidden
1422
+ */
1423
+ /** {en}
1424
+ * @brief Fallback mp4 playback list configuration for dash playback.
1425
+ * @list Options
1426
+ * @kind property
1200
1427
  * @hidden
1201
1428
  */
1202
1429
  export interface mp4OptsItem {
1203
- /**
1430
+ /** {zh}
1204
1431
  * 清晰度
1205
1432
  * 默认: 无
1206
1433
  * 必传
1207
1434
  */
1435
+ /** {en}
1436
+ * @brief Definition for fallback mp4 playback.
1437
+ * @default -
1438
+ * @notes Required.
1439
+ */
1208
1440
  definition: string;
1209
- /**
1210
- * mp4地址
1211
- * 默认:
1212
- * 必传
1441
+ /** {zh}
1442
+ * @briefmp4地址
1443
+ * @default -
1444
+ * @notes Required.
1445
+ */
1446
+ /** {en}
1447
+ * @brief URL for fallback mp4 playback.
1448
+ * @default -
1449
+ * @notes Required.
1213
1450
  */
1214
1451
  url: string;
1215
1452
  }
1216
- /**
1453
+ /** {zh}
1217
1454
  * @brief HLS 加密播放配置。
1218
1455
  * @list Options
1219
1456
  * @kind property
1220
1457
  */
1221
1458
  /** {en}
1222
1459
  * @brief HLS encrypted playback configuration.
1460
+ * @list Options
1461
+ * @kind property
1223
1462
  */
1224
1463
  export interface IEncryptHlsPluginConfig {
1225
1464
  /** {zh}
@@ -1231,49 +1470,77 @@ export interface IEncryptHlsPluginConfig {
1231
1470
  * @default https://vod.byteplusapi.com
1232
1471
  */
1233
1472
  playDomain?: string;
1234
- /**
1473
+ /** {zh}
1235
1474
  * @hidden
1236
1475
  * @brief 请求类型,固定值 'TOP'
1237
1476
  * @default TOP
1238
1477
  */
1478
+ /** {en}
1479
+ * @brief Request type, fixed value 'TOP'
1480
+ * @default TOP
1481
+ * @hidden
1482
+ */
1239
1483
  getKeyType?: string;
1240
- /**
1484
+ /** {zh}
1241
1485
  * @hidden
1242
1486
  * @brief 密钥请求域名
1243
1487
  * @default https://vod.volcengineapi.com
1244
1488
  */
1489
+ /** {en}
1490
+ * @brief Request domain name for key request
1491
+ * @default https://vod.byteplusapi.com
1492
+ */
1245
1493
  keyDomain?: string;
1246
- /**
1494
+ /** {zh}
1247
1495
  * @brief 播放地址获取token,由服务端生成下发,详见{@link https://www.volcengine.com/docs/4/67350#%E4%B8%B4%E6%97%B6%E5%AE%89%E5%85%A8%E5%87%AD%E8%AF%81%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E 播放临时安全凭证(PlayAuthToken)}
1248
1496
  * @default -
1249
1497
  */
1498
+ /** {en}
1499
+ * @brief Playback address acquisition token, generated by the server and distributed by the server, see {@link https://docs.byteplus.com/en/docs/byteplus-vod/reference-getplayinfo PlayAuthToken}
1500
+ * @default -
1501
+ */
1250
1502
  playAuthToken?: string;
1251
- /**
1503
+ /** {zh}
1252
1504
  * @brief 密钥获取token,由服务端生成下发,详见{@link https://www.volcengine.com/docs/4/65659#%E7%AD%BE%E5%8F%91-hls-%E6%A0%87%E5%87%86%E5%8A%A0%E5%AF%86-authtoken%EF%BC%88sha1hlsdrmauthtoken%EF%BC%89 签发 Hls 标准加密AuthToken}
1253
1505
  * @default -
1254
1506
  */
1507
+ /** {en}
1508
+ * @brief Key acquisition token, generated by the server and distributed by the server, see {@link https://docs.byteplus.com/en/docs/byteplus-vod/docs-go-sdk#generating-hls-decryption-token keyToken}
1509
+ */
1255
1510
  keyToken: string;
1256
1511
  }
1257
- /**
1512
+ /** {zh}
1258
1513
  * @brief 质量日志上报配置。
1259
1514
  * @list Options
1260
1515
  * @kind property
1261
1516
  */
1262
1517
  /** {en}
1263
1518
  * @brief Quality log configuration.
1519
+ * @list Options
1520
+ * @kind property
1264
1521
  */
1265
1522
  export interface IVodLogOptsConfig {
1266
- /**
1523
+ /** {zh}
1267
1524
  * @brief 视频点播应用 ID。您可在视频{@link https://console.volcengine.com/vod/region:vod+cn-north-1/sdk/app/ 点播控制台 > 点播SDK > 应用管理}页面获取应用 ID(App ID)。
1268
1525
  * @default -
1269
1526
  */
1527
+ /** {en}
1528
+ * @brief VOD application ID. You can get the application ID (App ID) on the video {@link https://console.byteplus.com/vodpaas/region:vodpaas+ap-singapore-1/sdk/app/?projectName=default VOD Console > VOD SDK > application management} page.
1529
+ * @default -
1530
+ */
1270
1531
  line_app_id: number;
1271
- /**
1532
+ /** {zh}
1272
1533
  * @brief 用于识别单一用户的 ID,可在{@link https://www.volcengine.com/docs/4/75736#qoe-%E6%8C%87%E6%A0%87%E8%AF%B4%E6%98%8E QoE指标}中用于用户维度的筛选,也可以用于{@link https://www.volcengine.com/docs/4/106093 单点追查} 查找单用户的播放日志
1273
1534
  * 用户 ID 对应于单点追查功能的查询条件中的设备 ID 维度。如不设置用户 ID,VePlayer 将根据用户浏览器随机生成一个值,该值会在浏览器端缓存。
1274
1535
  * @notes 强烈建议您使用与业务相关的用户 ID,以便在发生播放错误时通过{@link https://console.volcengine.com/vod/region:vod+cn-north-1/quality_control/SingleTracing/?Tab=play 点播控制台 > 质量平台 > 单点追查}功能排查故障。
1275
1536
  * @default -
1276
1537
  */
1538
+ /** {en}
1539
+ * @brief The ID used to identify a single user. It can be used for user-level filtering in {@link https://docs.byteplus.com/en/docs/byteplus-vod/docs-quality-insight-overview QoE indicators}, and also for {@link https://www.volcengine.com/docs/4/106093 single-point tracing} to find the playback logs of a single user.
1540
+ * The user ID corresponds to the device ID dimension in the query conditions of the single-point tracing function. If no user ID is set, VePlayer will generate a random value according to the user's browser, which will be cached in the browser.
1541
+ * @notes It is strongly recommended to use a user ID related to your business to troubleshoot problems through the {@link https://docs.byteplus.com/en/docs/byteplus-vod/docs-end-point-tracker VOD Console > Quality Platform > Single Tracing} function.
1542
+ * @default -
1543
+ */
1277
1544
  line_user_id: string | number;
1278
1545
  /**
1279
1546
  * @hidden
@@ -1281,154 +1548,273 @@ export interface IVodLogOptsConfig {
1281
1548
  * @default MP4
1282
1549
  */
1283
1550
  vtype?: "MP4" | "HLS" | "DASH" | "FLV";
1284
- /**
1551
+ /** {zh}
1285
1552
  * @brief 业务标签。对应于质量平台上的业务类型维度,其作用是区分业务中的不同场景,以便进行多维度分析。举例来说,假设您的应用中包含短视频和长视频两个场景,则可分别将 `tag` 设为 `short` 和 `long`。这样一来,您就能够在{@link https://www.volcengine.com/docs/4/120175 质量平台}上通过业务标签维度查询或过滤不同场景的数据。
1286
1553
  * @notes 如需自定义配置 tag 值在点播控制台上的展示文案,请联系{@link https://www.volcengine.com/docs/4/108992#%E5%94%AE%E5%90%8E%E6%94%AF%E6%8C%81 技术支持}
1287
1554
  * @default 普通视频
1288
1555
  */
1556
+ /** {en}
1557
+ * @brief Business tag. Corresponds to the business type dimension on the quality platform, which is used to distinguish different scenarios in the business and facilitate multi-dimensional analysis. For example, if your application contains short video and long video scenarios, you can set `tag` to `short` and `long` respectively. This way, you can query or filter data for different scenarios through the business tag dimension on the {@link https://docs.byteplus.com/en/docs/byteplus-vod/docs-end-point-tracker quality platform}.
1558
+ * @notes If you need to customize the display text of `tag` in the VOD Console, please contact {@link https://docs.byteplus.com/en/docs/byteplus-vod/docs-quality-insight-overview technical support}.
1559
+ * @default Normal
1560
+ */
1289
1561
  tag?: string;
1290
- /**
1562
+ /** {zh}
1291
1563
  * @brief 自定义子标签。对应于质量平台上的自定义标签维度,与 `tag` 配合使用,可用于区分同一业务类型下更为细分的音视频类型,比如加密视频、非加密视频、音频等。
1292
1564
  * @default -
1293
1565
  */
1294
1566
  /** {en}
1295
1567
  * @brief Custom sub-tag for quality platform analytics; use with `tag` to distinguish sub-types such as encrypted/non-encrypted video or audio.
1568
+ * @default -
1296
1569
  */
1297
1570
  subtag?: string;
1298
- /**
1571
+ /** {zh}
1299
1572
  * @brief 视频编码类型,取值如下
1300
1573
  * - `h264`:H.264
1301
1574
  * - `h265`:H.265
1302
1575
  * @default unknown
1303
1576
  */
1577
+ /** {en}
1578
+ * @brief Video codec type, values:
1579
+ * - `h264`: H.264
1580
+ * - `h265`: H.265
1581
+ * @default unknown
1582
+ */
1304
1583
  codec_type?: "h264" | "h265";
1305
- /**
1584
+ /** {zh}
1306
1585
  * @brief 是否加密,0:非drm视频,1:drm视频
1307
1586
  * @hidden
1308
1587
  * @default 0
1309
1588
  */
1589
+ /** {en}
1590
+ * @brief Whether the video is encrypted, 0: non-drm video, 1: drm video
1591
+ * @hidden
1592
+ * @default 0
1593
+ */
1310
1594
  drm_type?: 0 | 1;
1311
- /**
1595
+ /** {zh}
1312
1596
  * @hidden
1313
1597
  * @brief 播放内核版本号
1314
1598
  */
1599
+ /** {en}
1600
+ * @brief Player core version number
1601
+ * @hidden
1602
+ * @default -
1603
+ */
1315
1604
  playerCoreVersion?: string;
1316
- /**
1605
+ /** {zh}
1317
1606
  * @hidden
1318
1607
  * @brief 播放器版本号
1319
1608
  */
1609
+ /** {en}
1610
+ * @brief Player version number
1611
+ * @hidden
1612
+ * @default -
1613
+ */
1320
1614
  playerVersion?: string;
1321
- /**
1615
+ /** {zh}
1322
1616
  * @hidden
1323
1617
  * @brief DASH播放的封装类型
1324
1618
  */
1619
+ /** {en}
1620
+ * @brief DASH playback packaging type
1621
+ * @hidden
1622
+ * @default -
1623
+ */
1325
1624
  dynamic_type?: "segment_base" | "segment_template";
1326
- /**
1625
+ /** {zh}
1327
1626
  * @hidden
1328
1627
  * @brief 是否使用bash,0:不使用,1:使用
1329
1628
  * @default 0
1330
1629
  */
1630
+ /** {en}
1631
+ * @brief Whether to use bash, 0: not use, 1: use
1632
+ * @hidden
1633
+ * @default 0
1634
+ */
1331
1635
  enable_bash?: 0 | 1;
1332
- /**
1636
+ /** {zh}
1333
1637
  * @hidden
1334
1638
  * @brief 发送的埋点日志是本地缓存的时候回调
1335
1639
  * @default -
1336
1640
  */
1641
+ /** {en}
1642
+ * @brief Callback when the local cache of the sent log is sent
1643
+ * @hidden
1644
+ * @default -
1645
+ */
1337
1646
  sendLocalCallback?: (event: any, data: any) => void;
1338
- /**
1647
+ /** {zh}
1339
1648
  * @hidden
1340
1649
  * @brief 是否禁用localStorage暂时缓存onPlay逻辑
1341
1650
  * @default false
1342
1651
  */
1652
+ /** {en}
1653
+ * @brief Whether to disable localStorage temporarily cache onPlay logic
1654
+ * @hidden
1655
+ * @default false
1656
+ */
1343
1657
  disableLocalCache?: boolean;
1344
- /**
1658
+ /** {zh}
1345
1659
  * @brief 日志上报渠道,可选值:cn(国内) 、sg(新加坡)
1346
1660
  * @default cn
1661
+ * @hidden
1662
+ */
1663
+ /** {en}
1664
+ * @brief Log reporting channel, optional values: cn(domestic) 、va(overseas) 、sg(Singapore)
1665
+ * @default sg
1666
+ * @hidden
1347
1667
  */
1348
1668
  channel?: "cn" | "va" | "sg";
1349
- /**
1669
+ /** {zh}
1350
1670
  * @brief 日志上报额外配置
1351
1671
  * @note 火山海外区域的用户播放需要配置为`{log_from_region: 'volc-overseas'}`
1672
+ * @hidden
1673
+ */
1674
+ /** {en}
1675
+ * @brief Log reporting additional configuration
1676
+ * @note BytePlus need to configure `{log_from_region: 'byteplus'}`
1677
+ * @hidden
1352
1678
  */
1353
1679
  trackerConfig?: Record<string, string>;
1354
- /**
1680
+ /** {zh}
1355
1681
  * @hidden
1356
1682
  * @brief 是否关闭清晰度切换埋点
1357
1683
  * @default false
1358
1684
  */
1685
+ /** {en}
1686
+ * @brief Whether to close the resolution switching log
1687
+ * @hidden
1688
+ * @default false
1689
+ */
1359
1690
  closeResolutionLog?: boolean;
1360
- /**
1691
+ /** {zh}
1361
1692
  * @hidden
1362
1693
  * @brief 关闭seek相关埋点
1363
1694
  * @default false
1364
1695
  */
1696
+ /** {en}
1697
+ * @brief Whether to close the seek related log
1698
+ * @hidden
1699
+ * @default false
1700
+ */
1365
1701
  closeSeekLog?: boolean;
1366
- /**
1702
+ /** {zh}
1367
1703
  * @hidden
1368
1704
  * @brief 队列超过多少条日志的时候发送
1369
1705
  * @default 5
1370
1706
  */
1707
+ /** {en}
1708
+ * @brief The number of logs when the queue exceeds the threshold
1709
+ * @hidden
1710
+ * @default 5
1711
+ */
1371
1712
  maxQueueCount?: number;
1372
1713
  }
1373
- /**
1714
+ /** {zh}
1374
1715
  * @brief mp4加密日志配置项
1375
1716
  * @list Options
1376
1717
  * @hidden
1377
1718
  */
1378
1719
  export interface IMp4EncryptPlayerConfig {
1379
- /**
1720
+ /** {zh}
1380
1721
  * @hidden
1381
1722
  * @brief 是否加密
1382
1723
  * @default false
1383
1724
  */
1725
+ /** {en}
1726
+ * @brief Whether to encrypt
1727
+ * @hidden
1728
+ * @default false
1729
+ */
1384
1730
  isEncrypt?: boolean;
1385
- /**
1731
+ /** {zh}
1386
1732
  * @hidden
1387
1733
  * @brief 视频vid
1388
1734
  * @default -
1389
1735
  */
1736
+ /** {en}
1737
+ * @brief Video vid
1738
+ * @hidden
1739
+ * @default -
1740
+ */
1390
1741
  vid?: string;
1391
- /**
1742
+ /** {zh}
1392
1743
  * @hidden
1393
1744
  * @brief 视频密钥 id
1394
1745
  * @default -
1395
1746
  */
1747
+ /** {en}
1748
+ * @brief Video kid
1749
+ * @hidden
1750
+ * @default -
1751
+ */
1396
1752
  kid?: string;
1397
- /**
1753
+ /** {zh}
1398
1754
  * @hidden
1399
1755
  * @brief 获取密钥凭证地址
1400
1756
  * @default -
1401
1757
  */
1758
+ /** {en}
1759
+ * @brief Get the certificate address
1760
+ * @hidden
1761
+ * @default -
1762
+ */
1402
1763
  getLicenseUrl?: string;
1403
- /**
1764
+ /** {zh}
1404
1765
  * @hidden
1405
1766
  * @brief 是否使用EME
1406
1767
  * @default false
1407
1768
  */
1769
+ /** {en}
1770
+ * @brief Whether to use EME
1771
+ * @hidden
1772
+ * @default false
1773
+ */
1408
1774
  useEME?: boolean;
1409
- /**
1775
+ /** {zh}
1410
1776
  * @hidden
1411
1777
  * @brief 视频密钥值
1412
1778
  * @default -
1413
1779
  */
1780
+ /** {en}
1781
+ * @brief Video key value
1782
+ * @hidden
1783
+ * @default -
1784
+ */
1414
1785
  keyValue?: string;
1415
- /**
1786
+ /** {zh}
1416
1787
  * @hidden
1417
1788
  * @brief 加密后的视频密钥值
1418
1789
  * @default -
1419
1790
  */
1791
+ /** {en}
1792
+ * @brief Encrypted video key value
1793
+ * @hidden
1794
+ * @default -
1795
+ */
1420
1796
  secretKey?: string;
1421
- /**
1797
+ /** {zh}
1422
1798
  * @hidden
1423
1799
  * @brief 是否携带cookie
1424
1800
  * @default false
1425
1801
  */
1802
+ /** {en}
1803
+ * @brief Whether to carry cookie
1804
+ * @hidden
1805
+ * @default false
1806
+ */
1426
1807
  withCredentials?: boolean;
1427
- /**
1808
+ /** {zh}
1428
1809
  * @hidden
1429
1810
  * @brief drm内容
1430
1811
  * @default -
1431
1812
  */
1813
+ /** {en}
1814
+ * @brief Drm content
1815
+ * @hidden
1816
+ * @default -
1817
+ */
1432
1818
  drm?: {
1433
1819
  clearKeys: {
1434
1820
  [propName: string]: string;
@@ -1451,73 +1837,127 @@ export declare type IDefinition = {
1451
1837
  [propName: string]: any;
1452
1838
  };
1453
1839
  };
1454
- /**
1840
+ /** {zh}
1455
1841
  * @brief 音量配置。
1456
1842
  * @list Options
1457
1843
  * @kind property
1458
1844
  */
1845
+ /** {en}
1846
+ * @brief Volume configuration.
1847
+ * @list Options
1848
+ * @kind property
1849
+ */
1459
1850
  export declare type IVolume = number | {
1460
- /**
1851
+ /** {zh}
1461
1852
  * @brief 插件Dom挂载的位置,默认播放器底部控制栏右侧
1462
1853
  * @default POSITIONS.CONTROLS_RIGHT
1463
1854
  */
1855
+ /** {en}
1856
+ * @brief The position of the plugin dom. The default value is `POSITIONS.CONTROLS_RIGHT`.
1857
+ * @default POSITIONS.CONTROLS_RIGHT
1858
+ */
1464
1859
  position?: POSITIONS;
1465
- /**
1860
+ /** {zh}
1466
1861
  * @brief 插件在挂载的位置的排序权重
1467
1862
  * @default 1
1468
1863
  */
1864
+ /** {en}
1865
+ * @brief The index of the plugin in the position. The default value is `1`.
1866
+ * @default 1
1867
+ */
1469
1868
  index?: number;
1470
- /**
1869
+ /** {zh}
1471
1870
  * @brief 是否禁用插件交互行为,即是否隐藏音量调节按钮
1472
1871
  * @default false
1473
1872
  */
1873
+ /** {en}
1874
+ * @brief Whether to disable the plugin interaction behavior, i.e., whether to hide the volume adjustment button.
1875
+ * @default false
1876
+ */
1474
1877
  disable?: boolean;
1475
- /**
1878
+ /** {zh}
1476
1879
  * @brief 是否在音量调节slider上方显示当前音量数值
1477
1880
  * @default false
1478
1881
  */
1882
+ /** {en}
1883
+ * @brief Whether to show the current volume value on the volume adjustment slider.
1884
+ * @default false
1885
+ */
1479
1886
  showValueLabel?: boolean;
1480
- /**
1887
+ /** {zh}
1481
1888
  * @brief 默认音量大小,取值范围0-1
1482
1889
  * @default 0.6
1483
1890
  */
1891
+ /** {en}
1892
+ * @brief The default volume value. The value range is `[0, 1]`.
1893
+ * @default 0.6
1894
+ */
1484
1895
  default?: number;
1485
- /**
1896
+ /** {zh}
1486
1897
  * @brief 静音恢复的时候最小音量
1487
1898
  * @default 0.2
1488
1899
  */
1900
+ /** {en}
1901
+ * @brief The minimum volume value when unmuting. The value range is `[0, 1]`.
1902
+ * @default 0.2
1903
+ */
1489
1904
  miniVolume?: number;
1490
1905
  };
1491
- /**
1906
+ /** {zh}
1492
1907
  * @brief 进度条标记点配置。
1493
1908
  * @list Options
1494
1909
  * @kind property
1495
1910
  */
1911
+ /** {en}
1912
+ * @brief Progress bar marker point configuration.
1913
+ * @list Options
1914
+ * @kind property
1915
+ */
1496
1916
  export interface IDot {
1497
- /**
1917
+ /** {zh}
1498
1918
  * @brief 进度条标记点
1499
1919
  * @default 1
1500
1920
  */
1921
+ /** {en}
1922
+ * @brief The id of the progress bar marker point.
1923
+ * @default 1
1924
+ */
1501
1925
  id: string | number;
1502
- /**
1926
+ /** {zh}
1503
1927
  * @brief 标记点所在的播放时间
1504
1928
  * @default 0
1505
1929
  */
1930
+ /** {en}
1931
+ * @brief The time of the progress bar marker point.
1932
+ * @default 0
1933
+ */
1506
1934
  time: number;
1507
- /**
1935
+ /** {zh}
1508
1936
  * @brief 进度条自定义文案
1509
1937
  * @default -
1510
1938
  */
1939
+ /** {en}
1940
+ * @brief The text of the progress bar marker point.
1941
+ * @default -
1942
+ */
1511
1943
  text?: string;
1512
- /**
1944
+ /** {zh}
1513
1945
  * @brief 标记点持续的时间,单位秒
1514
1946
  * @default 1
1515
1947
  */
1948
+ /** {en}
1949
+ * @brief The duration of the progress bar marker point.
1950
+ * @default 1
1951
+ */
1516
1952
  duration?: number;
1517
- /**
1953
+ /** {zh}
1518
1954
  * @brief 进度条自定义的CSS Style样式
1519
1955
  * @default -
1520
1956
  */
1957
+ /** {en}
1958
+ * @brief The custom CSS style of the progress bar marker point.
1959
+ * @default -
1960
+ */
1521
1961
  style?: CSSStyleDeclaration;
1522
1962
  }
1523
1963
  /**
@@ -1636,49 +2076,83 @@ export declare type IPlayerOptions = {
1636
2076
  volumeColor?: string;
1637
2077
  };
1638
2078
  };
1639
- /**
2079
+ /** {zh}
1640
2080
  * @brief mobile端交互配置。
1641
2081
  */
2082
+ /** {en}
2083
+ * @brief Mobile interaction configuration.
2084
+ */
1642
2085
  export interface IMobileConfig {
1643
- /**
2086
+ /** {zh}
1644
2087
  * @brief 是否禁用手势,手势包括:
1645
2088
  * - 水平手势滑动快进/快退
1646
2089
  * - 左侧手势滑动调节亮度
1647
2090
  * - 右侧手势滑动调节音量(iOS不可用)
1648
2091
  * @default false
1649
2092
  */
2093
+ /** {en}
2094
+ * @brief Whether to disable gestures. Gesture includes:
2095
+ * - Horizontal gesture to fast forward/rewind
2096
+ * - Left gesture to adjust brightness
2097
+ * - Right gesture to adjust volume (iOS not available)
2098
+ * @default false
2099
+ */
1650
2100
  disableGesture?: boolean;
1651
- /**
2101
+ /** {zh}
1652
2102
  * @brief 是否启用水平手势处理,水平手势快进/快退
1653
2103
  * @default false
1654
2104
  */
2105
+ /** {en}
2106
+ * @brief Whether to enable horizontal gesture processing. Horizontal gesture includes fast forward/rewind.
2107
+ * @default false
2108
+ */
1655
2109
  gestureX?: boolean;
1656
- /**
2110
+ /** {zh}
1657
2111
  * @brief 是否启用垂直手势处理,默认不启用, 垂直手势包括屏幕右侧和屏幕左侧,默认左侧调节亮度,右侧调节音量,左右范围比例通过scopeL和scopeR设置
1658
2112
  * @default false
1659
2113
  */
2114
+ /** {en}
2115
+ * @brief Whether to enable vertical gesture processing. Vertical gesture includes screen right and screen left. Default left to adjust brightness, right to adjust volume. The left and right range ratio is set through scopeL and scopeR.
2116
+ * @default false
2117
+ */
1660
2118
  gestureY?: boolean;
1661
- /**
2119
+ /** {zh}
1662
2120
  * @brief 左侧手势范围比例,取值0-1
1663
2121
  * @default 0.25
1664
2122
  */
2123
+ /** {en}
2124
+ * @brief The left gesture range ratio, the value is 0-1.
2125
+ * @default 0.25
2126
+ */
1665
2127
  scopeL?: number;
1666
- /**
2128
+ /** {zh}
1667
2129
  * @brief 右侧手势范围,取值0-1
1668
2130
  * @default 0.25
1669
2131
  */
2132
+ /** {en}
2133
+ * @brief The right gesture range ratio, the value is 0-1.
2134
+ * @default 0.25
2135
+ */
1670
2136
  scopeR?: number;
1671
- /**
2137
+ /** {zh}
1672
2138
  * @brief 是否启用左侧调暗功能,因为web端无法调用系统的亮度,这个功能实际使用透明蒙层实
1673
2139
  * @default true
1674
2140
  */
2141
+ /** {en}
2142
+ * @brief Whether to enable left dimming function. Because the web端无法调用系统的亮度,这个功能实际使用透明蒙层实现。
2143
+ * @default true
2144
+ */
1675
2145
  darkness?: boolean;
1676
- /**
1677
- * @brief 播放器可调节的最大暗度,即蒙层最大透明度
2146
+ /** {zh}
2147
+ * @brief 播放器可调节的最大暗度,即蒙层最大透明度。
2148
+ * @default 0.6
2149
+ */
2150
+ /** {en}
2151
+ * @brief The maximum darkness of the player, i.e., the maximum transparency of the transparent layer.
1678
2152
  * @default 0.6
1679
2153
  */
1680
2154
  maxDarkness?: number;
1681
- /**
2155
+ /** {zh}
1682
2156
  * @brief 是否启用上下渐变阴影,即在播放器在激活时上下范围内有阴影
1683
2157
  * - normal 上下阴影
1684
2158
  * - none 无阴影
@@ -1686,62 +2160,115 @@ export interface IMobileConfig {
1686
2160
  * - bottom 仅下阴影
1687
2161
  * @default normal
1688
2162
  */
2163
+ /** {en}
2164
+ * @brief Whether to enable vertical gradient shadow, i.e., there is a shadow in the upper and lower range when the player is activated.
2165
+ * - normal: normal shadow
2166
+ * - none: no shadow
2167
+ * - top: only upper shadow
2168
+ * - bottom: only lower shadow
2169
+ * @default normal
2170
+ */
1689
2171
  gradient?: "normal" | "none" | "top" | "bottom";
1690
- /**
2172
+ /** {zh}
1691
2173
  * @brief 是否在touchMove事件触发时(即手势滑动时)同时更新播放器的currentTime, 在手势移动过程中,不会直接调用播放器的快进快退,在toucheEnd的时候再设置
1692
2174
  * @default false
1693
2175
  */
2176
+ /** {en}
2177
+ * @brief Whether to update the player's currentTime when the touchMove event is triggered (i.e., when the gesture is slid). During the gesture movement, the player's fast forward/rewind is not directly called, and the currentTime is set when the toucheEnd event is triggered.
2178
+ * @default false
2179
+ */
1694
2180
  isTouchingSeek?: boolean;
1695
- /**
1696
- * @brief 手势滑动的最小步伐,单位px,即滑动距离超过多少算作滑动,以减少不必要的滑动手势事件触发
2181
+ /** {zh}
2182
+ * @brief 手势滑动的最小步伐,单位px,即滑动距离超过多少算作滑动,以减少不必要的滑动手势事件触发。
2183
+ * @default 5
2184
+ */
2185
+ /** {en}
2186
+ * @brief The minimum step of the gesture movement, the unit is px, i.e., the sliding distance exceeding which is considered as sliding, to reduce unnecessary sliding gesture event triggers.
1697
2187
  * @default 5
1698
2188
  */
1699
2189
  miniMoveStep?: number;
1700
- /**
2190
+ /** {zh}
1701
2191
  * @brief 长按快进倍速
1702
2192
  * @default 2
1703
2193
  */
2194
+ /** {en}
2195
+ * @brief The long press fast forward speed.
2196
+ * @default 2
2197
+ */
1704
2198
  pressRate?: number;
1705
- /**
1706
- * @brief 是否禁用时间预览雪碧图面板
2199
+ /** {zh}
2200
+ * @brief 是否禁用时间预览雪碧图面板。
1707
2201
  * @notice 前提需要配置进度条预览雪碧图 thumbnail
1708
2202
  * @default true
1709
2203
  */
2204
+ /** {en}
2205
+ * @brief Whether to disable the time preview sprite panel.
2206
+ * @notice The prerequisite is to configure the progress bar preview sprite thumbnail.
2207
+ * @default true
2208
+ */
1710
2209
  disableActive?: boolean;
1711
- /**
2210
+ /** {zh}
1712
2211
  * @brief 是否禁用时间进度条,即拖动时不展示mini进度条
1713
2212
  * @default false
1714
2213
  */
2214
+ /** {en}
2215
+ * @brief Whether to disable the time progress bar, i.e., not to show the mini progress bar when dragging.
2216
+ * @default false
2217
+ */
1715
2218
  disableTimeProgress?: boolean;
1716
- /**
2219
+ /** {zh}
1717
2220
  * @brief 手势拖动的时候是否隐藏控制栏
1718
2221
  * @default true
1719
2222
  */
2223
+ /** {en}
2224
+ * @brief Whether to hide the control bar when dragging.
2225
+ * @default true
2226
+ */
1720
2227
  hideControlsActive?: boolean;
1721
- /**
2228
+ /** {zh}
1722
2229
  * @brief 手势结束时隐藏控制栏
1723
2230
  * @default false
1724
2231
  */
2232
+ /** {en}
2233
+ * @brief Whether to hide the control bar when the gesture ends.
2234
+ * @default false
2235
+ */
1725
2236
  hideControlsEnd?: boolean;
1726
- /**
2237
+ /** {zh}
1727
2238
  * @brief 滑动播放器区域快进/快退时,播放器区域对应的时长,即完整滑过播放器所对应的时长,单位ms
1728
2239
  * @default 360000
1729
2240
  */
2241
+ /** {en}
2242
+ * @brief The duration of the player area when fast forward/rewind is performed, i.e., the duration corresponding to the full passage of the player area, the unit is ms.
2243
+ * @default 360000
2244
+ */
1730
2245
  moveDuration?: number;
1731
- /**
2246
+ /** {zh}
1732
2247
  * @brief 是否关闭双击切换暂停/播放的能力,同closeVideoDblclick
1733
2248
  * @default false
1734
2249
  */
2250
+ /** {en}
2251
+ * @brief Whether to disable the double-click to switch pause/play ability, same as closeVideoDblclick.
2252
+ * @default false
2253
+ */
1735
2254
  closedbClick?: boolean;
1736
- /**
2255
+ /** {zh}
1737
2256
  * @brief 禁用长按倍速调整
1738
2257
  * @default true
1739
2258
  */
2259
+ /** {en}
2260
+ * @brief Whether to disable the long press to adjust the speed.
2261
+ * @default true
2262
+ */
1740
2263
  disablePress?: boolean;
1741
- /**
2264
+ /** {zh}
1742
2265
  * @brief 是否禁用快进/快退的时候按钮提示
1743
2266
  * @default false
1744
2267
  */
2268
+ /** {en}
2269
+ * @brief Whether to disable the fast forward/rewind button prompt.
2270
+ * @default false
2271
+ */
1745
2272
  disableSeekIcon?: boolean;
1746
2273
  }
1747
2274
  /**
@@ -1870,14 +2397,14 @@ declare class PlayList {
1870
2397
  * @brief Playlist panel trigger action type.
1871
2398
  */
1872
2399
  export declare const enum TOGGLE_MODES {
1873
- /**
2400
+ /** {zh}
1874
2401
  * @brief 鼠标点击。
1875
2402
  */
1876
2403
  /** {en}
1877
2404
  * @brief Mouse click.
1878
2405
  */
1879
2406
  CLICK = "click",
1880
- /**
2407
+ /** {zh}
1881
2408
  * @brief 鼠标悬浮。
1882
2409
  */
1883
2410
  /** {en}
@@ -1885,20 +2412,26 @@ export declare const enum TOGGLE_MODES {
1885
2412
  */
1886
2413
  HOVER = "hover"
1887
2414
  }
1888
- /**
2415
+ /** {zh}
1889
2416
  * @list Options
1890
2417
  * @brief 播放列表项配置,支持 DirectUrl 和 Vid + playAuthToken 两种播放模式。
1891
2418
  * @notes 列表数据由外部提供,播放器内部不直接获取播放列表数据。
1892
2419
  * @kind property
1893
2420
  */
2421
+ /** {en}
2422
+ * @list Options
2423
+ * @brief Playlist item configuration, supporting DirectUrl and Vid + playAuthToken two playback modes.
2424
+ * @notes The list data is provided by external, and the player does not directly obtain the list data.
2425
+ * @kind property
2426
+ */
1894
2427
  export interface IPlayListItem {
1895
- /**
2428
+ /** {zh}
1896
2429
  * @notes 临时播放 Token 为空时,此参数必传。
1897
2430
  * @default -
1898
2431
  * @listtip `playAuthToken` 为空时,此参数必传。
1899
2432
  * @brief 视频地址。
1900
2433
  */
1901
- /**
2434
+ /** {en}
1902
2435
  * @notes Required when temporary play token is empty.
1903
2436
  * @default -
1904
2437
  * @listtip when `playAuthToken` is empty, this parameter is required.
@@ -1936,7 +2469,7 @@ export interface IPlayListItem {
1936
2469
  * @brief Video cover image URL.
1937
2470
  */
1938
2471
  poster?: string;
1939
- /**
2472
+ /** {zh}
1940
2473
  * @default -
1941
2474
  * @brief 视频标题。
1942
2475
  */
@@ -1945,7 +2478,7 @@ export interface IPlayListItem {
1945
2478
  * @brief Video title.
1946
2479
  */
1947
2480
  title?: string;
1948
- /**
2481
+ /** {zh}
1949
2482
  * @brief 视频时长,单位为秒。
1950
2483
  * @default -
1951
2484
  */
@@ -1981,7 +2514,7 @@ declare enum EPlayMode {
1981
2514
  * @kind property
1982
2515
  */
1983
2516
  export interface IPlayListConfig {
1984
- /**
2517
+ /** {zh}
1985
2518
  * @brief 按钮位置。取值如下:
1986
2519
  *
1987
2520
  * - `controlsLeft`: 播控栏左侧
@@ -2007,7 +2540,7 @@ export interface IPlayListConfig {
2007
2540
  * @default controlsLeft
2008
2541
  */
2009
2542
  position?: string;
2010
- /**
2543
+ /** {zh}
2011
2544
  * @brief 按钮在所在区域的次序。默认值为 `2`,表示在播放按钮后。
2012
2545
  * @default 20
2013
2546
  */
@@ -2016,7 +2549,7 @@ export interface IPlayListConfig {
2016
2549
  * @default 20
2017
2550
  */
2018
2551
  index?: number;
2019
- /**
2552
+ /** {zh}
2020
2553
  * @brief 播放列表数据。
2021
2554
  * @default []
2022
2555
  */
@@ -2025,7 +2558,7 @@ export interface IPlayListConfig {
2025
2558
  * @default []
2026
2559
  */
2027
2560
  list: IPlayListItem[];
2028
- /**
2561
+ /** {zh}
2029
2562
  * @brief 循环模式,取值如下:
2030
2563
  *
2031
2564
  * - `order`: 不循环播放,即列表中最后一个视频播放完成后就停止播放。
@@ -2040,7 +2573,7 @@ export interface IPlayListConfig {
2040
2573
  * @default order
2041
2574
  */
2042
2575
  mode?: EPlayMode;
2043
- /**
2576
+ /** {zh}
2044
2577
  * @brief 默认起始的播放次序。
2045
2578
  * @default order
2046
2579
  */
@@ -2049,7 +2582,7 @@ export interface IPlayListConfig {
2049
2582
  * @default order
2050
2583
  */
2051
2584
  defaultIndex?: number;
2052
- /**
2585
+ /** {zh}
2053
2586
  * @brief 列表点击之后是否隐藏。
2054
2587
  * @default true
2055
2588
  */
@@ -2058,7 +2591,7 @@ export interface IPlayListConfig {
2058
2591
  * @default true
2059
2592
  */
2060
2593
  isItemClickHide?: boolean;
2061
- /**
2594
+ /** {zh}
2062
2595
  * @brief 列表行为触发模式。
2063
2596
  * @default click
2064
2597
  */
@@ -2067,7 +2600,7 @@ export interface IPlayListConfig {
2067
2600
  * @default click
2068
2601
  */
2069
2602
  toggleMode?: TOGGLE_MODES;
2070
- /**
2603
+ /** {zh}
2071
2604
  * @brief 是否显示播放列表按钮。
2072
2605
  * @default true
2073
2606
  */
@@ -2156,16 +2689,18 @@ export declare class PlayListPlugin extends Plugin {
2156
2689
  get disable(): boolean;
2157
2690
  render(): string;
2158
2691
  }
2159
- /**
2692
+ /** {zh}
2160
2693
  * @brief 动态水印配置。
2161
2694
  * @list Options
2162
2695
  * @kind property
2163
2696
  */
2164
2697
  /** {en}
2165
2698
  * @brief watermark config
2699
+ * @list Options
2700
+ * @kind property
2166
2701
  */
2167
2702
  export interface IWatermarkConfig {
2168
- /**
2703
+ /** {zh}
2169
2704
  * @brief 是否开启动态水印,取值如下:<br/>
2170
2705
  * - `true`:开启动态水印
2171
2706
  * - `false`:关闭动态水印
@@ -2175,17 +2710,19 @@ export interface IWatermarkConfig {
2175
2710
  * @brief Is dynamic watermark enabled? The value is as follows:<br/>
2176
2711
  * - `true`: Enable dynamic watermark
2177
2712
  * - `false`: Disable dynamic watermark
2713
+ * @default false
2178
2714
  */
2179
2715
  enable: boolean;
2180
- /**
2716
+ /** {zh}
2181
2717
  * @brief 水印文案。
2182
2718
  * @default -
2183
2719
  */
2184
2720
  /** {en}
2721
+ * @brief Watermark content.
2185
2722
  * @default -
2186
2723
  */
2187
2724
  content: string;
2188
- /**
2725
+ /** {zh}
2189
2726
  * @brief 水印展示形式,取值如下:<br/>
2190
2727
  * - `0`:固定位置
2191
2728
  * - `1`:全屏滚动
@@ -2193,18 +2730,23 @@ export interface IWatermarkConfig {
2193
2730
  * @default 1
2194
2731
  */
2195
2732
  /** {en}
2733
+ * @brief Watermark display type. The value is as follows:<br/>
2734
+ * - `0`: Fixed position
2735
+ * - `1`: Full screen scrolling
2736
+ * - `2`: Random flickering
2196
2737
  * @default 1
2197
2738
  */
2198
2739
  displayType?: 0 | 1 | 2;
2199
- /**
2740
+ /** {zh}
2200
2741
  * @brief 水印字体大小。`number`类型时单位为 px,`string` 类型时需要携带单位。
2201
2742
  * @default 12
2202
2743
  */
2203
2744
  /** {en}
2745
+ * @brief Watermark font size. When the type is `number`, the unit is px. When the type is `string`, the unit needs to be携带.
2204
2746
  * @default 12
2205
2747
  */
2206
2748
  fontSize?: number | string;
2207
- /**
2749
+ /** {zh}
2208
2750
  * @brief 水印字体颜色。
2209
2751
  * @brief 水印字体颜色。
2210
2752
  */
@@ -2213,15 +2755,16 @@ export interface IWatermarkConfig {
2213
2755
  * @brief Watermark font color.
2214
2756
  */
2215
2757
  fontColor?: string;
2216
- /**
2758
+ /** {zh}
2217
2759
  * @brief 水印不透明度。取值范围:\[0~1\]。
2218
2760
  * @default 0.3
2219
2761
  */
2220
2762
  /** {en}
2763
+ * @brief Watermark opacity. The value is in the range of [0~1].
2221
2764
  * @default 0.3
2222
2765
  */
2223
2766
  opacity?: number;
2224
- /**
2767
+ /** {zh}
2225
2768
  * @brief 水印闪烁速度,取值如下:<br/>
2226
2769
  * - `MODERATE`:适中
2227
2770
  * - `FAST`:较快
@@ -2229,33 +2772,57 @@ export interface IWatermarkConfig {
2229
2772
  * @default MODERATE
2230
2773
  */
2231
2774
  /** {en}
2775
+ * @brief Watermark ticker speed. The value is as follows:<br/>
2776
+ * - `MODERATE`: Moderate
2777
+ * - `FAST`: Fast
2778
+ * - `SLOW`: Slow
2232
2779
  * @default MODERATE
2233
2780
  */
2234
2781
  tickerSpeed?: "SLOW" | "MODERATE" | "FAST";
2235
- /**
2782
+ /** {zh}
2236
2783
  * @brief 水印字体类型
2237
2784
  * @default -
2238
2785
  */
2786
+ /** {en}
2787
+ * @brief Watermark font family.
2788
+ * @default -
2789
+ */
2239
2790
  fontFamily?: string;
2240
- /**
2791
+ /** {zh}
2241
2792
  * @brief 水印相对于播放容器顶部的距离,单位为 px
2242
2793
  * @default 0
2243
2794
  */
2795
+ /** {en}
2796
+ * @brief Watermark top distance. The unit is px.
2797
+ * @default 0
2798
+ */
2244
2799
  top?: number;
2245
- /**
2800
+ /** {zh}
2246
2801
  * @brief 水印相对于播放容器左侧的距离,单位为 px。
2247
2802
  * @default 0
2248
2803
  */
2804
+ /** {en}
2805
+ * @brief Watermark left distance. The unit is px.
2806
+ * @default 0
2807
+ */
2249
2808
  left?: number;
2250
- /**
2809
+ /** {zh}
2251
2810
  * @brief 水印相对于播放容器底部的距离,单位为 px。
2252
2811
  * @default -
2253
2812
  */
2813
+ /** {en}
2814
+ * @brief Watermark bottom distance. The unit is px.
2815
+ * @default -
2816
+ */
2254
2817
  bottom?: number;
2255
- /**
2818
+ /** {zh}
2256
2819
  * @brief 水印相对于播放容器右侧的距离,单位为 px。
2257
2820
  * @default -
2258
2821
  */
2822
+ /** {en}
2823
+ * @brief Watermark right distance. The unit is px.
2824
+ * @default -
2825
+ */
2259
2826
  right?: number;
2260
2827
  }
2261
2828
  export declare class DynamicWatermarkPlugin extends Plugin {
@@ -6229,21 +6796,35 @@ export declare type PlayerCore = Player & {
6229
6796
  licenseType: LicenseEdition;
6230
6797
  };
6231
6798
  };
6232
- /**
6799
+ /** {zh}
6233
6800
  * @brief 加密混淆信息
6801
+ * @hidden
6802
+ */
6803
+ /** {en}
6804
+ * @brief Encrypted obfuscation information
6805
+ * @hidden
6234
6806
  */
6235
6807
  export interface EncryptInfo {
6236
- /**
6808
+ /** {zh}
6237
6809
  * @breif 会话ID
6238
6810
  */
6811
+ /** {en}
6812
+ * @brief Session ID
6813
+ */
6239
6814
  sessionId: string;
6240
- /**
6815
+ /** {zh}
6241
6816
  * @brief 混淆后的公钥
6242
6817
  */
6818
+ /** {en}
6819
+ * @brief Encrypted public key
6820
+ */
6243
6821
  drmKeK: string;
6244
- /**
6822
+ /** {zh}
6245
6823
  * @breif 唯一身份信息
6246
6824
  */
6825
+ /** {en}
6826
+ * @brief Unique identity information
6827
+ */
6247
6828
  unionInfo: string;
6248
6829
  }
6249
6830
  declare class VePlayer {