播放器的构造函数中可传入更多定制化参数(下面代码中的config
变量),您可以根据具体的业务需求来使用这些参数配置播放器:
const config = {
// 提供一个页面的容器,superplayer会将自己append到此容器中
container: '#container',
// 关掉播放器默认tips插件
disableTips: true,
};
new SuperPlayer(config);
下面表格列出了superplayer有哪些常用配置:
属性 | 类型 | 说明 | 示例 |
---|---|---|---|
* container | string|HTMLElement | css选择器或者dom元素,superplayer会将自己append到此容器中 | #container |
type | vod|live | vod为点播模式(默认),live为直播模式 | live |
loop | boolean | 是否循环播放 | false |
plugins | string[] | 指定需要安装的插件,注意会和superplayer内置插件合并而不是覆盖。 | ['watermark'] |
removeComponents | "ctrlbar"|"error-page"|"tips"|"context-menu"|"ui-loading"|"poster"|"ui-watermark"|"info-panel" | 可移除的播放器内置组件 | ["ctrlbar"] |
videoElements | HTMLVideoElement[] | 可以外部指定video标签,这样播放内核会使用外部的video标签来播放 | |
clearVideoAfterStop | boolean | 播放结束时是否清理画面,如果清理,显示为黑屏状态 | |
preloadType | metadata|auto|autoLoad | 预加载策略类型。由此属性控制调用播放器load()接口后加载的数据大小。默认为autoLoad 。具体请参考预加载策略 | metadata |
autoPlayPolicy | autoPlayInMuted|autoPlayRequireByUserGesture | 自动播放策略。更多自动播放的说明参考自动播放问题 | autoPlayInMuted |
enableGetExtInfo | boolean | 是否提前请求视频信息,例如视频文件尺寸等(getextinfo) | 默认true |
useSingleVideoElement | boolean | 是否使用单video标签模式播放,启用的话不会预加载。移动端默认开启(多video在ios 15等设备上无法起播) | 默认false |
disableUserSettingCache | COMMON_DATA_KEY[] | 禁用部分缓存用户参数,默认缓存清晰度/音轨/字幕选择 | ['currentDefn'] |
videoId | string | { cnlid: string, livepid: string } | 默认使用vid信息,传入后自动展示封面图/视频时长等,点击ui也会默认使用该vid请求 | |
videoElementConfig | 查看详细 | video标签的自定义属性 | |
businessConfig | 查看详细 | 业务配置是与业务相关或用户信息相关的信息。例如您在播放腾讯视频的资源时,想定制一些特殊的业务能力,就需要传入businessConfig 中的“平台号”。 | |
getinfoConfig | 查看详细 | 请求视频服务的配置(仅腾讯视频点播播放时有效) | |
getinfoLiveConfig | 查看详细 | 请求视频服务的配置(仅腾讯视频直播播放时有效) | |
offlineConfig | 查看详细 | 离线日志系统的配置信息 | |
ctrlConfig | 查看详细 | 控制栏配置 | |
poster | 查看详细 | 封面图配置 | |
errorPageConfig | 查看详细 | 错误提示界面配置 | |
contextMenuConfig | 查看详细 | 右键菜单配置 | |
... |
说明
所有配置说明中,带*号为必选配置,其他都是非必选。复杂对象需要进入详情查看