播放器内核

SDK 实例的播放功能是由播放器内核提供，播放器内核提供以下属性、API 等，供您自行开发实现灵活的播放功能。

获取播放器内核和调用 API 的示例代码如下所示。

const playerSdk = new VePlayer({
   id: 'video',
   width: 800,
   height: 500,
   url: 'xx.mp4'
 });

 // 获取属性：当前播放时间
 const curTime = playerSdk.player.currentTime;

 // 获取状态属性：当前视频是否处于暂停状态
 const isPaused = playerSdk.player.paused;

 // 调用 API：播放视频
 playerSdk.player.play().then(() => {
   // 播放成功
 }).catch(() => {
   // 播放失败，一般发生于未经用户交互时的自动播放
 });

属性

播放器内核的属性大部分是只读类型的，某些属性还支持写入。以获取视频时长 duration 为例，该属性是只读类型，不能通过 set 方式设置视频时长。而视频音量 volume 不仅支持播放器内核对象 get 方式获取，还支持 set 方式设置音量。

const playerSdk = new VePlayer({
    id: 'video',
    width: 800,
    height: 500,
    url: 'xx.mp4'
  });

  // 获取视频时长
  const duration = playerSdk.player.duration;

  // 获取视频音量
  const curVolume = playerSdk.player.volume;
  // 设置音量
  playerSdk.player.volume = 0.1;

状态属性

API

play ：播放

调用 play()，实现播放功能的代码示例如下：

@return{ Promise<void> | null }

playerSdk.player.play()// OR
playerSdk.player.play().then(() => {// 播放成功}).catch(() => {// 播放失败，一般发生于未经用户交互时的自动播放})

pause：暂停

调用 pause()，实现暂停功能的代码示例如下：

playerSdk.player.pause()

start：启动

启动播放器，开始加载媒体资源，初始化 video 元素。代码示例如下：

@param{ string } url 视频地址。

playerSdk.player.start(url)

replay：重新播放

播放进度返回至片头，重新播放，一般在播放结束时调用。代码示例如下：

playerSdk.player.replay()

seek

调用 seek()，实现跳转到某个时间点继续播放的功能，代码示例如下：

@param{ number } time，参数是 number 类型，单位是s(秒)。

playerSdk.player.seek(20)

reload：重新加载

调用 reload()，实现重新加载的功能，代码示例如下：

playerSdk.player.reload()

resetState()：重置状态

重置当前实例状态，暂停视频并且将当前实例状态设置为起播之前的状态，累计播放时长的计算结果会清空，播放器容器 DOM 上的类名会重置为起播之前的状态。

reset()：重置

调用 resetState 重置实例状态，并且注销所有已经注册的组件，并且将当前实例的配置恢复为默认值。

setConfig：设置配置项

更新配置信息，如果新的配置列表中包含内置插件的配置项，则会调用内置插件的 setConfig 对其进行更新。代码示例如下：

@param {config)} newConfig

playerSdk.player.setConfig({url: '另一个url',})

destroy：销毁

销毁播放器内核对象，该对象销毁的时候所有内置对象都会销毁，在调用的时候会下发 Events.DESTROY 事件。

playerSdk.player.destroy() // 销毁播放器
playerSdk.player = null // 将实例引用置空

resetState：还原状态

尝试暂停 MediaElement，并还原播放器 UI 状态。

playerSdk.player.resetState()

focus：获取焦点

播放器获取焦点，调用该 API，playerSdk.player.isActive 将会变为 true，会触发 Events.playerSdk.player_FOCUS 事件。

@param{ { autoHide?: boolean, delay?: number } } data

• autoHide 是否需要自动隐藏，默认为true，即经过delay时长之后，会自动调用playerSdk.player.blur()

• delay 自动隐藏延迟时长，单位 ms，当 autoHide: false 的时候，忽略该配置项，默认取 playerSdk.player.config.inactive

blur：失去焦点

播放器失去焦点，调用该 API，playerSdk.player.isActive 将会变为 false，会触发 Events.playerSdk.player_BLUR 事件

@param{ { ignorePaused?: boolean } } data

ignorePaused 是否忽略暂停状态，默认值是 true，默认暂停的时候不取消焦点状态。

canPlayType：检测视频类型

检测当前浏览器是否能播放指定类型的视频，实现的代码示例如下：

• @param{ string } mimeType 需要检测的MimeType
• @return{ boolean } 是否可播放

const mimeType = 'video/mp4; codecs="avc1.64001E, mp4a.40.5"'
playerSdk.player.canPlayType(mimeType);

getBufferedRange：获取缓冲时间范围

返回 currentTime 所处的缓冲时间范围，start 表示缓冲起始时间，end 表示缓存截止时间。

• @param{ TimeRanges? } buffered 如果不传则获取playerSdk.player.buffered
• @return{ [number, number] } [start, end] 返回缓冲开始时间和结束时间

const [start, end] = playerSdk.player.getBufferedRange();

checkBuffer：验证缓冲区间

验证某个时间点是否在当前缓冲区间内。

• @param{number} time 时间点
• @return{ boolean }

const flag = playerSdk.player.checkBuffer(10);

getFullscreen：获取全屏状态

全屏作用的 DOM 节点，如果不传默认是 playerSdk.player.root，必须是 playerSdk.player.root 的父辈节点，如果该接口调用的时候处于网页全屏状态会自动退出网页全屏，下发事件 Events.FULLSCREEN_CHANGE。

@param{ HTMlElement? } el

// 监听全屏变化
playerSdk.player.on(Events.FULLSCREEN_CHANGE, (isFullscreen) => {if (isFullscreen) {// 全屏} else {// 退出全屏}})// 播放器进入全屏状态
playerSdk.player.getFullscreen()

exitFullscreen：退出全屏状态

全屏作用的 DOM 节点，默认不传会获取 getFullscreen 作用的节点，必须是 playerSdk.player.root 的父辈节点，该接口调用会下发事件 Events.FULLSCREEN_CHANGE，isFullscreen 为 false。

@param{ HTMlElement? } el

playerSdk.player.exitFullscreen()

getCssFullscreen：获取网页全屏状态

播放器进入网页全屏，利用CSS模拟实现全屏效果。全屏作用的 DOM 节点，传入参数须是播放器容器playerSdk.player.root 的父辈节点，默认为播放器容器 playerSdk.player.root，如果该接口调用的时候处于全屏状态，会自动退出全屏，下发事件 Events.CSS_FULLSCREEN_CHANGE。

@param{ HTMlElement? } el

// 监听网页全屏变化
playerSdk.player.on(Events.CSS_FULLSCREEN_CHANGE, (isFullscreen) => {if (isFullscreen) {// 网页全屏} else {// 退出网页全屏}})
playerSdk.player.getCssFullscreen()

exitCssFullscreen：退出网页全屏状态

全屏作用的 DOM 节点，默认不传会获取 getCssFullscreen 作用的节点, 必须是 playerSdk.player.root 的父辈节点，该接口调用会下发事件 Events.CSS_FULLSCREEN_CHANGE, isFullscreen 为 false。

@param{ HTMlElement? } el

playerSdk.player.exitCssFullscreen()

addClass：增加类名

给播放器容器 playerSdk.player.root 添加 CSS 类名。

@param{ string } className 类名

playerSdk.player.addClass('className')

removeClass：移除类名

给播放器容器playerSdk.player.root移除 CSS 类名。

@param{ string } className 类名

playerSdk.player.removeClass('className')

hasClass：判定类名

判断播放器容器 playerSdk.player.root 是否存在 CSS 类名。

• @param{ string } className 类名
• @return{ boolean }

const flag = playerSdk.player.hasClass('className')

setAttribute：设置属性

给播放器容器 playerSdk.player.root 设置属性

• @param{ string } key 属性名
• @param{ string } value 值

playerSdk.player.setAttribute('key', 'value')

resize：重置尺寸

调整播放器尺寸，如果初始化的时候有配置 fitVideoSize 或者 videoFillMode，或者视频画面做了旋转，调用该 API 会触发整体的尺寸计算，根据视频画面和当前播放器容器尺寸做计算。

playerSdk.player.resize()

getPlugin：获取实例

从当前播放器获取插件的实例，代码示例如下：

@param{ string } pluginName

const pluginInstance = playerSdk.player.getPlugin('pluginName')

registerPlugin：注册插件

在当前播放器上注册某个插件。

• @param{ {plugin: function, options: object} | function } plugin 插件构造函数。
• @param{ {[propName: string]: any}? } 可选配置，config 插件配置列表。
• @return{ object } pluginInstance 返回插件实例。

const pluginInstance = playerSdk.player.registerPlugin(MyPlugin)

unRegisterPlugin：销毁/注销插件

在当前播放器上销毁或者注销某个插件，代码示例如下：

• @param{ { pluginName: string } | string } Plugin 插件实例或者插件名称。
• @param{ boolean } removedFromConfig 注销实例的同时，是否同时将其从playerSdk.player.config.plugins 中移除，默认 false。

const pluginInstance = playerSdk.player.unRegisterPlugin(pluginName)