更新记录

0.3.4（2024-02-02）

Fixed

  • 【iOS】修复个别下载视频无法播放的问题；

Add

  • 【皮肤】新增支持双击暂停/播放功能；

0.3.3（2024-01-15）

Add

  • 【Android/iOS】升级点播SDK至2.21.0；

0.3.1（2023-08-03）

Fixed

  • 【Android】修复个别视频下载后播放异常的问题；
查看更多

平台兼容性

Android Android CPU类型 iOS
适用版本区间：4.4 - 11.0 armeabi-v7a：支持，arm64-v8a：支持，x86：支持 适用版本区间：11 - 16

原生插件通用使用流程：

  1. 购买插件，选择该插件绑定的项目。
  2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
  3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
  4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
  5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

该插件封装了保利威 Android 与 iOS 原生点播 SDK，集成了保利威常用的基本接口。使用本模块可以轻松把保利威 Android 与 iOS SDK 集成到自己的 app 中，实现保利威视频播放、下载等功能。想要集成本插件，需要在保利威视频云平台注册账号，并开通相关服务。

注意事项

  • 推荐使用从服务端获取加密串，APP 本地解密的方式（开发者设计自己的加解密方式），通过 ConfigModule 的 setToken 方法进行配置。setConfig 安全性不如 setToken 方式，不推荐使用在正式环境。
  • 请务必通过 ConfigModule 的 setViewerId 设置观众ID，观众ID是后台区分用户的唯一标识别，可用于排查问题。
  • Android端自v0.1.0+已经解决云打包与uni-app官方原生插件VideoPlayer（视频播放）、Payment（支付）产生依赖冲突导致云打包失败的问题，Android端集成请务必同时集成Polyv播放器插件。旧版本可以仍旧解决方案请点击文档说明：《Android Uni app 插件冲突解决指南》
  • iOS 端自0.2.2+需要同时集成 Polyv播放器插件。
  • iOS 端自0.1.6+需要同时集成 Polyv UTDID 插件-iOS。如果本插件同时集成了 支付模块的支付宝支付 则不需要集成 [Polyv UTDID 插件-iOS] 插件
  • 此插件不支持Vue3，所以最好使用Vue2的版本进行开发。(可在 manifest.json 的基础配置中进行修改)

快速使用

播放器plv-player

播放器控件为 component，仅允许在 nvue 中声明使用。播放器为纯播放器无状态栏皮肤，开发者可自行添加。亦或者下载示例工程，参考使用Demo中提供的皮肤。

<plv-player
    ref="vod"
    class="vod-player"
    seekType=0
    autoPlay=true
    disableScreenCAP=false
    rememberLastPosition=false
    @onPlayStatus="onPlayStatus"
    @onPlayError="onPlayError"
    @positionChange="positionChange">
</plv-player>

//js方法，播放vid视频
setVid(){
  this.$refs.vod.setVid({
    vid:'c538856dde5bf6a7419dfeece53f83af_c',
    level:0
  },
  (ret) => {
    if (ret.errMsg != null) {
      uni.showToast({
        title: ret.errMsg,
        icon: "none"
      })
    }
  })
},

基本模块

通过 uni.requireNativePlugin("ModuleName") 获取 module ，就可以直接调用相关模块接口。目前有三个模块如下代码所示。其中ConfigModule用于点播的初始化，开发者必须在保利威官网注册以后，在点播后台获取到配置信息初始化，播放器才能正式使用。项目模块介绍和接口说明查看下文各模块接口介绍。

var configModule = uni.requireNativePlugin("PLV-VodUniPlugin-ConfigModule")
    var infoModule = uni.requireNativePlugin("PLV-VodUniPlugin-InfoModule")
    var downloadModule = uni.requireNativePlugin("PLV-VodUniPlugin-DownloadModule")

//...
    configModule.setToken({
            'userid': '',
            'readtoken': '',
            'writetoken': '',
            'secretkey': ''
        },
        (ret) => {
            if (ret.isSuccess == true) {
                uni.showToast({
                    title:'设置token成功',
                    icon: "none"
                })
            } else {
                let errMsg = ret.errMsg;
                uni.showToast({
                    title:'设置token失败：' + errMsg,
                    icon: "none"
                })
            }
        })

配置模块 - ConfigModule

ConfigModule 封装了账号信息、用户信息配置功能。 开发者要播放保利威视频，需先到 保利威官网 注册账号，登录账号后，进入云点播 - 设置 - API接口 获取 userid、 writetoken、 readtoken、 secretkey，并将加密得到加密串放到自己的服务器，再在移动端通过网络获取加密串，app 本地解密，并设置给 setToken 方法。

setConfig【设置账号方式一】

加密串可在保利威官网的云点播 - 设置 - API接口 - 点击查看临时加密串获取，本方法使用固定的加密方式，开发者可在开发时使用，但安全性不如 setToken 方式，不推荐使用在正式环境。

params

config

  • 类型：字符串
  • 描述：（必选项）临时加密串

aeskey

  • 类型：字符串
  • 描述：（可选项，默认值 VXtlHmwfS2oYm0CZ）加密串的加密密钥

iv

  • 类型：字符串
  • 描述：（可选项，默认值 2u9gDPKdX6GyQJKU）加密串的加密向量

callback

isSuccess

  • 类型：布尔类型
  • 描述：是否设置成功

errMsg

  • 类型：字符串
  • 描述：错误信息

setToken【设置账号方式二】

userid、 writetoken、 readtoken、 secretkey可在保利威官网的云点播 - 设置 - API接口获取，推荐用于正式环境。

params

userid

  • 类型：字符串
  • 描述：（必选项）保利威账号下的 userid

readtoken

  • 类型：字符串
  • 描述：（必选项）保利威账号下的 readtoke

writetoken

  • 类型：字符串
  • 描述：（必选项）保利威账号下的 writetoken

secretkey

  • 类型：字符串
  • 描述：（必选项）保利威账号下的 secretkey

callback

isSuccess

  • 类型：布尔类型
  • 描述：是否设置成功

errMsg

  • 类型：字符串
  • 描述：错误信息

setSubAccountConfig【设置账号方式三】

appId、 secretKey、 userId可在保利威官网的云点播 - 设置 - API接口获取，推荐用于正式环境。

params

appId

  • 类型：字符串
  • 描述：（必选项）保利威账号下的子帐号appId

secretKey

  • 类型：字符串
  • 描述：（必选项）保利威账号下的 子帐号加密key

userId

  • 类型：字符串
  • 描述：（必选项）保利威账号下的 总帐号userId

callback

isSuccess

  • 类型：布尔类型
  • 描述：是否设置成功

errMsg

  • 类型：字符串
  • 描述：错误信息

migrateLocalVideoPlaylist

由 2.18.x 及以下版本升级到 2.19.0 及以上版本时，需要注意视频下载的迁移

自 2.19.0 版本开始，本地播放视频鉴权方式进行了调整，为了在覆盖升级时兼容已下载的旧版本视频，需要在视频播放前，手动调用迁移方法

迁移视频前，请认真核对 secretKey，如果使用错误的 secretKey 迁移，迁移后的离线视频将无法播放。

params

secretKey

  • 类型：字符串

  • 描述：（必选项）下载对应离线视频时使用的secretKey

setViewerId

设置观众ID。

params

viewerId

  • 类型：字符串
  • 描述：（必选项）观看日志中的观众ID

setViewerName

设置观众昵称。

params

viewerName

  • 类型：字符串
  • 描述：（必选项）观看日志中的观众昵称

setViewerInfo

设置观众自定义参数。

params

param3

  • 类型：字符串
  • 描述：（可选项）对应观看日志中的 param3

param4

  • 类型：字符串
  • 描述：（可选项）对应观看日志中的 param4

param5

  • 类型：字符串
  • 描述：（可选项）对应观看日志中的 param5

openMediaCodec

设置播放器为硬解解码播放，默认关闭。该解码模式设置后，会缓存该设置，直到清除数据卸载应用或者重新设置并重启应用后生效。【视频播放前设置】（Android v0.0.1+ 可用，iOS v0.0.6+ 可用）

params

mediaCodec

  • 类型：布尔类型
  • 描述：（必选项）默认为false软解。true为硬解。

setRenderView

设置播放器渲染视图类型。仅限Android使用。

params

renderViewType

  • 类型：整型数字
  • 描述：（必选项）渲染视图类型。1为SurfaceView，2为TextureView（默认）

信息模块 - InfoModule

InfoModule 封装了获取保利威视频信息的功能。

getVideoInfo

通过 vid 获取已发布视频的时长、所支持码率。

params

vid

  • 类型：字符串
  • 描述：（必选项）视频的 vid

callback

vid

  • 类型：字符串
  • 描述：视频的 vid

duration

  • 类型：数字类型
  • 描述：视频播放时长，单位秒

levelNum

  • 类型：数字类型
  • 描述：视频支持码率。「1-流畅， 2-高清， 3-超清」，如返回 3，表示支持流畅、高清和超清

errMsg

  • 类型：字符串
  • 描述：错误信息

getFileSize

通过 vid 和指定码率获取已发布视频的文件大小。

params

vid

  • 类型：字符串
  • 描述：（必选项）视频的 vid

level

  • 类型：整型数字
  • 描述：（必选项）视频码率

callback

vid

  • 类型：字符串
  • 描述：视频的 vid

fileSize

  • 类型：数字类型
  • 描述：视频文件大小，单位字节

errMsg

  • 类型：字符串
  • 描述：错误信息

下载模块 - DownloadModule

DownloadModule 封装了保利威的视频下载功能，支持断点下载。最大并发数为3，通过 addDownloader 创建下载器之后，需调用 startDownloader 或 startALLDownloader 开启下载。

自0.1.0开始，下载状态进度回调需要通过setListenDownloadStatus设置，详见下文说明。

setListenDownloadStatus

设置下载器下载状态进度回调监听器。离开页面时应当重新置空。

callback

  {
    vid0: { // 以 vid（字符串） 为键，下载器状态（字典）为值
                  errMsg：// 字符串类型，错误信息
                downloadStatus: // 下载状态，字符串类型；回调事件类型，取值范围如下：
                                // ready-下载器准备就绪
                                // downloading-下载中
                                // stopped-下载被停止
                                // failed-下载失败
                                // finished-下载完成
                downloadPercentage: // 当前下载进度，数字类型，取值范围为0~100浮点数
            }
  }

example

//进入页面后设置下载监听，应当在addDownloader之前设置
downloadModule.setListenDownloadStatus(null, result=>{
    downloadStatus = "\n"+JSON.stringify(result)
})

//离开页面后主动注销监听器
downloadModule.setListenDownloadStatus(null,null)
downloadModule.setListenDownloadStatus(null)

addDownloader

通过 vid 和 指定码率 level 创建一个视频下载器，并添加到下载列表。每个 vid 只能下载一个码率，要想下载新的码率的视频，需删除该 vid 已下载的视频，才能添加下载。（需要执行startDownloader或startAllDownloader才会执行下载任务）

params

downloadArr

  • 类型：字典数组

  • 描述：（必选项）包含多个需要下载视频的 vid、level 健值对

  • 内部字段：

    [
{
    vid: // 视频 vid，字符串类型
    level: // 视频码率，整型数字，取值范围 1-流畅，2-为高清，3-超清，如果设置码率不存在，默认下载最高码率
},
{
    vid:
    level:
},
...
]

callback

  • 类型：JSON对象

  • 描述：下载器状态列表。本回调函数在下载器开始下载后，下载状态发生变化时执行。

  • 版本变更：0.1.0起callback将不再回调downloadStatus、downloadPercentage

  • 内部字段：

    {
vid0: { // 以 vid（字符串） 为键，下载器状态（字典）为值
              errMsg：// 字符串类型，错误信息
            downloadStatus: // 下载状态，字符串类型；回调事件类型，取值范围如下：
                            // ready-下载器准备就绪
                            // downloading-下载中
                            // stopped-下载被停止
                            // failed-下载失败
                            // finished-下载完成
            downloadPercentage: // 当前下载进度，数字类型，取值范围为0~100浮点数
        }
}

setDownloadCallbackInterval

设置下载开启之后，addDownloader 方法 downloadStatus 为 downloading 时的回调时间间隔。

params

seconds

  • 类型：数字类型
  • 描述：（必选项）间隔时间，单位秒，默认值 1，取值范围须为正实数

getDownloadList

返回所有下载器，包括下载中、下载成功、下载失败的下载器。

callback

  • 类型：数组对象

  • 描述：下载器列表。本回调函数在下载器开始下载后，下载状态发生变化时执行

  • 内部字段：

    {
  downloadList：
  [
      {
          vid:  // 视频 vid
          level:    // 视频码率
          duration: //视频时长
          fileSize: //视频文件大小
          title: //视频标题
          progress: //视频已经下载的进度,取值范围为0~100浮点数
      },
      {
          vid:  // 视频 vid
          level:    // 视频码率
        //...
      },
      ...
  ]
}

startDownloader

启动下载器列表中指定下载器的下载。

params

vid

  • 类型：字符串
  • 描述：（必选项）视频的 vid

callback

vid

  • 类型：字符串
  • 描述：视频的 vid

errMsg

  • 类型：字符串
  • 描述：错误信息

stopDownloader

停止下载器列表中指定下载器的下载。

params

vid

  • 类型：字符串
  • 描述：（必选项）视频的 vid

callback

vid

  • 类型：字符串
  • 描述：视频的 vid

errMsg

  • 类型：字符串
  • 描述：错误信息

deleteVideo

删除指定视频的本地缓存，移除指定视频的下载器，若该视频尚未成功下载，停止下载。

params

vid

  • 类型：字符串
  • 描述：（必选项）视频的 vid

callback

vid

  • 类型：字符串
  • 描述：视频的 vid

errMsg

  • 类型：字符串
  • 描述：错误信息

startAllDownloader

启动下载器列表中所有下载器的下载。

stopAllDownloader

停止下载器列表中所有下载器的下载。

deleteAllVideo

删除所有已下载视频的本地缓存，清空下载器队列，停止所有下载。

isVideoExist

判断指定码率的视频是否已成功下载并缓存在本地。

params

vid

  • 类型：字符串
  • 描述：（必选项）视频的 vid

level

  • 类型：整型数字
  • 描述：（必选项）视频码率

syn return

  • 类型：JSON对象

    {
exist:  // 布尔类型，视频是否存在本地，存在为true，反之为false
  errMsg: // 错误描述
}

播放器组件 - PlayerComponent

播放器组件 PlayerComponent 名称为 plv-player，可通过视频 vid 播放保利威视频，也可通过 URL 播放外网视频。

自定义属性

seekType

  • 类型：整型数字，0 或 1
  • 描述：播放定位类型设置，0 默认模式，1 精准模式，默认为 0

autoPlay

  • 类型：布尔类型
  • 描述：是否在设置 vid 后自动开始播放，默认 true

disableScreenCAP

  • 类型：布尔类型
  • 描述：是否开启防录屏功能，true 开启，false 关闭，默认 false

rememberLastPosition

  • 类型：布尔类型
  • 描述：是否开启记忆播放位置，默认 false

自定义事件

onPlayStatus

playbackState

  • 类型：字符串
  • 描述：「start-开始， pause-暂停， stop-停止，complete-完成」

preparedToPlay

  • 类型：布尔类型
  • 描述：准备就绪为 true，未就绪为 false

onPlayError

errCode

  • 类型：数字类型
  • 描述：错误码

errEvent

  • 类型：字符串

  • 描述：错误描述

    errCode - errEvent
0 - config_invalid // 未配置加密串
1 - illegal_vid // 非法播放
2 - status_error // 视频状态码错误（android独有，iOS包含在play_error中）
3 - play_error(#code) // 原生SDK错误码

positionChange

currentPosition

  • 类型：数字类型
  • 描述：当前播放位置，单位秒，播放器就绪状态下每隔一秒回调一次

setCustomVideoToken

设置自定义Token解密视频

播放加密视频时，若设置此Token将优先使用此Token来解密视频

params

token

  • 类型：String
  • 描述：自定义Token字符串

callback

errMsg

  • 类型：字符串
  • 描述：错误信息

setVid

设置播放视频的 vid。

params

vid

  • 类型：字符串
  • 描述：（必选项）视频的 vid

level

  • 类型：整型数字
  • 描述：（可选项）视频码率，「0 - 自动(默认)，1-流畅， 2-高清， 3-超清」

callback

vid

  • 类型：字符串
  • 描述：视频 vid

errMsg

  • 类型：字符串
  • 描述：错误信息

setURL

设置播放视频的 URL。

params

url

  • 类型：字符串
  • 描述：（必选项）视频的 URL

callback

url

  • 类型：字符串
  • 描述：视频的 URL

errMsg

  • 类型：字符串
  • 描述：错误信息

setMediaHardDecode

切换当前视频的解码方式【视频播放中可切换】

params

mediaCodec

  • 类型：Bool
  • 描述：是否是硬解（YES 硬解码，NO软解码）

start

开始播放

pause

暂停播放

stop

停止播放

forward

快进

params

seconds

  • 类型：数字类型
  • 描述：（必选项）快进的时间，单位秒，必须大于 0

rewind

快退

params

seconds

  • 类型：数字类型
  • 描述：（必选项）快退的时间，单位秒，必须大于 0

seekTo

跳转

params

seconds

  • 类型：数字类型
  • 描述：（必选项）跳转到当前音视频播放的时间，单位秒，必须大于等于 0

isPlaying

播放器是否正在播放视频。

callback

isPlaying

  • 类型：布尔类型
  • 描述：视频是否正在播放

getLevelNum

播放器当前播放视频所支持码率。

callback

levelNum

  • 类型：数字类型
  • 描述：视频支持码率，「1-流畅， 2-高清， 3-超清」，如返回 3，表示支持流畅、高清和超清

showMarquee

在播放器组件上显示跑马灯。请不要多次调用，否则可能会显示多条跑马灯信息。

params

marquee

  • 类型：字符串
  • 描述：（可选项）跑马灯文字，默认值 Polyv Uni-App Plugin

duration

  • 类型：数字类型
  • 描述： （可选项）单次跑马灯显示的时长，单位秒，默认值 5

interval

  • 类型：数字类型
  • 描述：（可选项）两次跑马灯播放间隔的时长，单位秒，默认值 0

color

  • 类型：字符串
  • 描述：（可选项）跑马灯颜色 RGB 值，默认值 0xFFE900

font

  • 类型：整型数字
  • 描述：（可选项）跑马灯字体大小，默认值 16，取值范围 5~72

alpha

  • 类型：数字类型
  • 描述：（可选项）跑马灯透明度，0 - 1 的浮点数，默认值 1，取值范围 0~1

setVolume

设置播放器音量。

params

volume

  • 类型：数字类型
  • 描述： （可选项）音量大小，取值范围 0 ~ 1，默认值 0

getVolume

获取播放器音量。

callback

volume

  • 类型：数字类型
  • 描述：当前播放器音量值，取值范围 0~1

setSpeed

设置播放器播放速率。

params

speed

  • 类型：数字类型
  • 描述： （可选项）播放速率，取值范围 0.5 ~ 2.0，默认值 1.0

getSpeed

获取播放器当前播放速率。

callback

speed

  • 类型：数字类型
  • 描述：当前播放器播放速率

getCurrentLevel

获取播放器当前播放视频码率。

callback

currentLevel

  • 类型：数字类型
  • 描述：当前播放视频码率，取值范围 0-自动，1-流畅， 2-高清， 3-超清

changeLevel

切换播放器当前播放视频码率

params

level

  • 类型：整型数字
  • 描述：（可选项）指定码率，取值范围 0-自动，1-流畅， 2-高清， 3-超清

callback

errMsg

  • 类型：字符串
  • 描述：错误信息

getDuration

获取当前播放器播放视频总时长。

callback

duration

  • 类型：数字类型
  • 描述：视频时长，单位秒

getBufferPercentage

获取当前播放器播放视频缓冲百分比。

callback

bufferPercentage

  • 类型：数字类型
  • 描述：视频缓冲百分比，取值范围 0 ~ 100

getCurrentPosition

获取当前播放器播放视频位置。

callback

currentPosition

  • 类型：数字类型
  • 描述：视频当前播放位置，单位秒

getMediaHardDecode

获取当前视频的解码方式

callback

mediaCodec

  • 类型：bool
  • 描述：是否是硬解码(YES 硬解码，NO 软解码)

snapshot

保存播放器播放视频当前画面截图到相册，不受播放器属性 disableScreenCAP 影响。

changeToPortrait

切换屏幕方向到竖屏

changeToLandscape

切换屏幕方向到横屏

disableScreenCAP

控制防录屏开关。仅限Android使用。

params

disableScreenCAP

  • 类型：布尔类型
  • 描述： （必选项）是否开启防录屏功能，true 开启，false 关闭，默认 false

setScalingMode

设置视频拉伸模式

params

scalingMode

  • 类型：数字类型
  • 描述：（可选项）拉伸模式， 取值范围 0-居中，1-适应， 2-填充， 3-拉伸(默认为1-适应)

getScalingMode

获取当前视频拉伸模式

callback

scalingMode

  • 类型：数字类型
  • 描述： 拉伸模式，0-居中，1-适应， 2-填充， 3-拉伸

enableBackgroundPlayback

设置是否开启后台继续播放功能(仅对iOS有效)

params

enable

  • 类型：布尔类型
  • 描述：（可选项）是否开启（iOS默认关闭）

隐私、权限声明

1. 本插件需要申请的系统权限列表：

android："<uses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\" />", "<uses-permission android:name=\"android.permission.INTERNET\" />" iOS: NSPhotoLibraryUsageDescription, NSPhotoLibraryAddUsageDescription

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明：

本插件采集视频标题、视频ID、播放时长等点播视频播放的基础数据，发送服务器地址为：https://prtas.videocc.net/。 采集的数据用于向客户提供观众的播放情况统计。 隐私政策：https://s2.videocc.net/app-simple-pages/privacy-policy/index.html

3. 本插件是否包含广告，如包含需详细说明广告表达方式、展示频率：

无

许可协议

请参考开源项目地址的开源协议
评论列表 撰写评论
加载更多...
插件问答 我要提问

使用中有什么不明白的地方，就向插件作者提问吧~ 我要提问

加载更多...