# 短剧播放器接口

本文主要介绍下短剧播放器插件提供的几个接口，在js代码里，插件接口示例通过下面的代码获取

// 名字 playlet-plugin 必须和 app.json 里面引用的插件名一致
const playletPlugin = requirePlugin('playlet-plugin')

# playletPlugin.onPageLoad()

onPageLoad就是播放器页面的 onLoad 事件，接受的参数是函数，直接在 app.js 的 onLaunch 里面调用即可

App({
  onLaunch(options) {
    playletPlugin.onPageLoad(this._onPlayerLoad.bind(this))
  },
  _onPlayerLoad(info) {
    console.log('onPlayerLoad', info.playerId, info)
    // 在这里可以调用
    const pm = playletPlugin.PlayletManager.getPageManager(info.playerId)
    console.log('get playlet manager', pm)
  },
})

# playletPlugin.getPluginVersion()

接口返回当前的插件版本，例如 0.1.4

# playletPlugin.getShareParams()

接口返回 Promise 实例，当从App跳转、分享、公众号、二维码等场景，直接进入到播放器页面的时候，开发者可通过此接口获取跳转到页面链接上的参数。

注意：如果不是直接进入播放器页面的，返回 Promise.reject({err: '首个页面不是播放器页面'})。

playletPlugin.getShareParams().then(res => {
    console.log('getShareParams res', res)
}).catch(err => {
    console.log('getShareParams err', err)
})

# playletPlugin.setLoggerConfig(Object param)

设置播放器插件的日志输出：

# playletPlugin.PlayletManager

PlayletManager 是一个类，可通过 playletPlugin.PlayletManager.getPageManager(playerId) 获取其实例，大部分的接口都在该实例对象上提供，例如 getInfo、showChargeDialog 等。获取 PlayletManager 示例如下：

App({
  onLaunch(options) {
    playletPlugin.onPageLoad(this._onPlayerLoad.bind(this))
  },
  _onPlayerLoad(info) {
    console.log('onPlayerLoad', info.playerId, info)
    // 在这里可以调用
    const pm = playletPlugin.PlayletManager.getPageManager(info.playerId)
    console.log('get playlet manager', pm)
  },
})

在很多接口，都可以获取到 playerId，例如 onPageLoad 事件、充值组件、运营组件等，然后通过 playerId 可以获取到 PlayletManager 实例。

PlayletManager 实例的更多接口介绍如下：

# PlayletManager.setCanPlaySerialList(Object param)

初始化剧集状态，接受的参数字段定义如下：

serialList 和 data 选填一项即可，两者的区别是 serialList 无需加密，而 data 则为加密串，加密方式可参考短剧播放器加密方案章节。选用加密方案的话安全性相对较高，但性能会有所损耗，可根据实际情况选用对应方案。

SerialItem 字段定义如下：

FreeItem 字段定义如下：

// 无需加密方案
pm.setCanPlaySerialList({
  serialList: [{
    start_serial_no: 1,
    end_serial_no: 4,
    status: 1, // 解锁
  }, {
    start_serial_no: 5,
    end_serial_no: 20,
    status: 2, // 未解锁
  }],
})

// 加密方案
const data = await getEncryptData() // getEncryptData 需要开发者自行实现
pm.setCanPlaySerialList({
  data,
})

# PlayletManager.setFreeList(Object param)

在用户观看过程中重新设置免费剧列表，注意：此接口仅改变目录中的剧集显示 ui，并不会做真正的解锁处理。接受的参数字段定义如下：

FreeItem字段定义如下：

# PlayletManager.getInfo()

获取当前剧集信息，返回 Object 字段定义如下：

注意：以上为固定常用字段，页面路径上的其他参数也会在此处返回。

# PlayletManager.onCheckIsCanPlay(Function func)

播放到需要解锁的剧集触发此事件，开发者可在此事件内解锁剧集。

# PlayletManager.isCanPlay(Object param)

设置剧集解锁状态，接受的参数字段定义如下：

类似 setCanPlaySerialList 接口，serialList 和 data 选填一项即可，两者的区别是 serialList 无需加密，而 data 则为加密串，加密方式可参考短剧播放器加密方案章节。选用加密方案的话安全性相对较高，但性能会有所损耗，可根据实际情况选用对应方案。

SerialItem 字段定义如下：

// 无需加密方案
pm.onCheckIsCanPlay(param => {
  pm.isCanPlay({
    serialNo: 15,
    serialList: [{
      start_serial_no: 15,
      end_serial_no: 15,
      status: 1, // 解锁
    }],
  })
})

// 加密方案
pm.onCheckIsCanPlay(async param => {
  const data = await getEncryptData() // getEncryptData 需要开发者自行实现
  pm.isCanPlay({
    serialNo: 15,
    data,
  })
})

// 维持原本的未解锁状态
pm.onCheckIsCanPlay(param => {
  pm.isCanPlay({
    serialNo: 15,
    useLastStatus: true,
  })
})

# PlayletManager.onShowChargeDialog(Function func)

充值弹窗打开事件

# PlayletManager.onHideChargeDialog(Function func)

充值弹窗关闭事件

# PlayletManager.hideChargeDialog()

关闭充值弹窗

# PlayletManager.showChargeDialog()

打开充值弹窗

# PlayletManager.play()

继续播放

# PlayletManager.pause()

暂停播放

# PlayletManager.onDataReport(Function func)

播放器内相关事件的回调函数

# PlayletManager.onBack(Function func)

播放器内左上角返回点击事件

# PlayletManager.changeDrama(Object param)

更换剧目，接受的参数字段定义如下：

# PlayletManager.updateChargeDialogInfo(Object param)

更新充值弹窗，接受的参数字段定义如下：

# PlayletManager.updateChargeDialogHeight(Object param)

更新充值弹窗高度，接受的参数字段定义如下：

# PlayletManager.setVisualEffectOnCapture(Object param)

接口同 wx.setVisualEffectOnCapture

# PlayletManager.setDramaFlag(Object param)

设置分享参数，接受的参数字段定义如下：

# PlayletManager.setExtParam(string extParam)

修改extParam参数

# PlayletManager.onCustomEvent(string name, Function func)

注册自定义事件，用于在充值组件、playletManager、自定义运营位等组件间通信

# PlayletManager.offCustomEvent(string name, Function func)

销毁通过 onCustomEvent 注册的事件

# PlayletManager.emitCustomEvent(string name, Function func)

触发通过 onCustomEvent 注册的事件函数

# PlayletManager.updateOpenArea(Object param)

设置自定义开放区域参数，接受的参数字段定义如下：

LeftSideOption 对象定义如下：

注意：在 LeftSideOption 也可以传一些额外的字段，在 open-area-left-side 组件的 item 属性中可以接收到这些字段

# PlayletManager.setVideoOption(Object param)

设置播放器的播放配置，接受的参数字段定义如下：

# PlayletManager.startBackgroundPreview(Object param)

设置剧集未解锁时的视频预览播放，接受的参数字段定义如下：

# PlayletManager.stopBackgroundPreview()

停止剧集未解锁时的视频预览播放。

# PlayletManager.navigateTo(Object param)

接口含义和参数同 wx.navigateTo。

注意：接口调用成功的前提是用户必须至少点击过页面。

# PlayletManager.navigateBack(Object param)

接口含义和参数同 wx.navigateBack。

注意：接口调用成功的前提是用户必须至少点击过页面。

# PlayletManager.redirectTo(Object param)

接口含义和参数同 wx.redirectTo。

注意：接口调用成功的前提是用户必须至少点击过页面。

# PlayletManager.switchTab(Object param)

接口含义和参数同 wx.switchTab。

注意：接口调用成功的前提是用户必须至少点击过页面。

# PlayletManager.reLaunch(Object param)

接口含义和参数同 wx.reLaunch。

注意：接口调用成功的前提是用户必须至少点击过页面。