UIPLShortVideo

立即使用

auth loadRes open

概述

UIPLShortVideo 封装了七牛的短视频 SDK，同时集成了抖音的美颜等功能。

使用本模块需要先跟抖音和七牛注册账号并开通相关权限，获取相关参数和文件。

本模块是一套完整的短视频录制器，自带UI，只需一个接口即可开发出完整的短视频录制功能。简单快捷。

注意：iOS端授权文件和包名（bundle ID）是绑定的，否则运行闪退。

Android需要如下配置

  • 下载自定义模块qiniuShortvideoRes
  • 解压后将 qiniushortvideores-release.aar->assets->resource下相应的bundle目录替换为自己的重新打包，自定义模块编译即可

Android调用流程如下

  • 调用auth进行授权，返回authorized表示授权成功，unAuthorized授权失败联系七牛商务
  • 授权成功，调用loadRes加载/检测是否加载美颜，特效资源
  • 资源加载成功后open即可

auth

授权 （暂仅支持Android）

auth(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
     eventType:'authorized'    // 取值范围如下：
                    //authorized 授权成功 
                           //unAuthorized 未授权成功
}

示例代码

var PLShortVideo = api.require('UIPLShortVideo');
PLShortVideo.auth(function(ret){
    alert(JSON.stringify(ret));
});

loadRes

加载资源（第一次使用的时候会加载资源，耗时较长） （暂仅支持Android）

loadRes(callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
     eventType:'resStartLoad'    // 取值范围如下：
                   //resStartLoad 开始加载美颜，贴纸等资源文件
                   //resReady 资源已经加载完毕 
}

示例代码

var PLShortVideo = api.require('UIPLShortVideo');
PLShortVideo.loadRes(function(ret){
    alert(JSON.stringify(ret));
});

open

打开视频录像机

open({params},callback(ret))

params

modelFileDirPath：

  • 类型：字符串
  • 描述：算法模型文件所在目录路径，要求本地路径。如：widget://res/ModelResource.bundle

licenseFilePath：

  • 类型：字符串
  • 描述：授权文件路径，要求本地路径。如：widget://res/LicenseBag.bundle/qiniu_20200214_20210213_com.qbox.PLShortVideoKit.ByteDance.Demo_qiniu_v3.4.2.licbag

maxDuration：

  • 类型：数字类型
  • 描述：（可选项）视频录制的最大时长，单位为秒
  • 默认：10

minDuration：

  • 类型：数字类型
  • 描述：（可选项）视频录制的最短时间，单位为秒；
  • 默认：2

beautifyModeOn：

  • 类型：布尔类型
  • 描述：（可选项）是否开启美颜
  • 默认：true

bgmPath:

  • 类型：字符串
  • 描述：背景音乐路径，要求本地路径（fs://、widget://）

token:

  • 类型：字符串
  • 描述：七牛云存储上传token

domain：

  • 类型：字符串
  • 描述：七牛云存储上传域名

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
     eventType:'uploaded'      //字符串类型；交互事件类型；取值范围
                               //cancel：取消
                               //uploaded：已上传
     localPath:'',             //字符串类型；视频本地路径
     url:'',                   //字符串类型；视频服务器端路径
}

示例代码

var UIPLShortVideo = api.require('UIPLShortVideo');
UIPLShortVideo.open({
    modelFileDirPath:"widget://res/ModelResource.bundle",
licenseFilePath:"widget://res/LicenseBag.bundle/qiniu_20200214_20210213_com.qbox.PLShortVideoKit.ByteDance.Demo_qiniu_v3.4.2.licbag",
    bgmPath:'widget://res/ml.mp3',
    beautifyModeOn:true,
    minDuration:10,
    maxDuration:60
},function(ret){
    api.alert({msg:JSON.stringify(ret)});
});

可用性

iOS 系统，Android 系统

可提供的 1.0.0 及更高版本