Web上传SDK使用文档

Polyv JavaScript 上传 SDK 为您提供上传媒体文件到保利威云点播平台的开发工具包。

功能

  • 快捷上传多种格式的媒体文件。
  • 支持上传时的各种设置,如文件标题、描述、标签、上传目录、是否开启课件优化处理等。
  • 默认采用分片并发上传的方式,支持断点续传

使用方法

前提条件

  1. 使用本 SDK 前,要先开通保利威云点播服务。如果您还不了解该服务,请登录产品主页查看,详见:云点播
  2. 获取 secretKey 等相关信息用于用户身份校验,您可以在「云点播管理后台 -> 设置 -> API接口」页面中找到相关信息,点击这里登录后台

浏览器支持

  • IE(>=10)和Edge。
  • 主流版本的 Chrome、Firefox、Safari。
  • 以主流版本 Chrome 为核心的浏览器,如最新版本的 QQ 浏览器、360 浏览器等。

集成 SDK

您可以选择以下任意一种方法调用本 SDK:

方法一:引入在线资源

<!-- 指定版本 -->
<script src="//player.polyv.net/resp/vod-upload-js-sdk/1.2.3.3/vod-upload-js-sdk.min.js"></script>
<!-- 最新版本 -->
<script src="//player.polyv.net/resp/vod-upload-js-sdk/latest/vod-upload-js-sdk.min.js"></script>

方法二:通过 npm 安装

第一步,在项目目录下运行安装命令:

npm install @polyv/vod-upload-js-sdk

第二步, 在页面中引入(需要构建工具支持):

import PlvVideoUpload from '@polyv/vod-upload-js-sdk'

或者

const PlvVideoUpload = require('@polyv/vod-upload-js-sdk');

快速开始

初始化上传实例

首先,创建 PlvVideoUpload 实例。

const videoUpload = new PlvVideoUpload({
  region: 'line1', // (可选)上传线路, 默认line1
  events: {
      Error: (err) => {  // 错误事件回调
          console.log(err);
      },
      UploadComplete: () => {}  // 全部上传任务完成回调
  }
});

调用 updateUserData() 设置账号授权验证信息,并每隔 3 分钟更新一次

// 授权验证信息3分钟内有效,当 sign 过期时需要调用该方法更新
videoUpload.updateUserData({
  userid: <userid> , // Polyv云点播账号的ID
  ptime: <timestamp> , // 时间戳
  sign: <sign> , // 是根据将secretkey和ts按照顺序拼凑起来的字符串进行MD5计算得到的值
  hash: <hash> , // 是根据将ts和writeToken按照顺序拼凑起来的字符串进行MD5计算得到的值
});

其中 ptime、sign 和 hash 都要从服务端获取,服务端的代码示例(PHP)如下:

/* 
 * userid、secretkey、writeToken 都可以在「云点播管理后台 -> 设置 -> API接口」页面中找到。
 */
$userid = "your userid";
$secretkey = "your sercrety";
$writeToken = "your writeToken";

$ptime = time() * 1000;
$sign = md5($secretkey . $ptime);
$hash = md5($ptime . $writeToken);

添加上传文件进入上传列表

fileSetting = { // 文件上传相关信息设置
  title: <title>,  // 标题
  desc: <desc>,  // 描述
  cataid: <cataid>,  // 上传分类目录ID
  tag: <tag>,  // 标签
  luping: 0,  // 是否开启视频课件优化处理,对于上传录屏类视频清晰度有所优化:0为不开启,1为开启
  keepsource: 0,  // 是否源文件播放(不对视频进行编码):0为编码,1为不编码
  state:<customMessage> //用户自定义信息,如果提交了该字段,会在服务端上传完成回调时透传返回。
};

调用 PlvVideoUpload 实例的 addFile(file, events, fileSetting) 方法,添加文件到文件列表,该方法返回一个 UploadManager 对象:

var uploadManager = videoUpload.addFile(
  file, // file 为待上传的文件对象
  { 
    FileStarted: function(uploadInfo) { // 文件开始上传回调
        console.log("文件上传开始: " + uploadInfo.fileData.title);
    },
    FileProgress: function(uploadInfo) { // 文件上传过程返回上传进度信息回调
        console.log("文件上传中: " + (uploadInfo.progress * 100).toFixed(2) + '%');
    },
    FileStopped: function(uploadInfo) { // 文件暂停上传回调
        console.log("文件上传停止: " + uploadInfo.fileData.title);
    },
    FileSucceed: function(uploadInfo) { // 文件上传成功回调
        console.log("文件上传成功: " + uploadInfo.fileData.title);
    },
    FileFailed: function(uploadInfo) { // 文件上传失败回调
        console.log("文件上传失败: " + uploadInfo.fileData.title);
    }
  },
  fileSetting
);

API 文档

源代码中的 docs 文件夹或 点击此处打开

示例代码

源代码中的 demo 文件夹包含两个示例:

  • dev.html & dev.js:以模块化方式引入 SDK 的示例。需要修改 build 文件夹下的 webpack.dev.config.js 文件中的账号信息,然后在本项目根目录下运行 npm run dev ,打开浏览器访问 http://127.0.0.1:14002/index.html 即可。
  • index.html & index.js:以 script 标签引入 SDK 的示例。需要修改 JS 文件中的 getPolyvAuthorization 变量为有效的请求地址,才能正常使用。

错误代码

Error 事件已知错误类型:

code 描述
102 用户剩余空间不足
110 文件重复
111 拦截文件类型不在 acceptedMimeType 中的文件
112 文件已经开始上传或已上传完毕,禁止修改文件信息

FileFailed 事件已知错误类型:

type code 描述
InitUploadError 3001 分类不存在
InitUploadError 405 上传视频初始化失败
InitUploadError 406 视频大小不能为0
InitUploadError 408 账户服务状态异常,请联系客服
MultipartUploadError 断点续传时出错
UpdateTokenError 更新上传token时获取token失败
NoSuchUploadError Multipart Upload ID 不存在

版本更新

v1.2.3

  • 增加region参数

v1.2.2

  • cataid 不存在时返回提示。
  • 规范FileFailed事件返回的数据格式与字段名称。

v1.2.1

  • 问题修复

v1.2.0

  • 支持使用子账号信息上传视频文件

v1.1.3

  • 优化文件上传失败时的回调message

v1.1.2

  • 增加支持文件名后缀大写的文件上传,如 file_example.MP3
  • 修改示例代码

v1.1.1

  • 优化文件上传失败时的重试逻辑
  • 文件上传失败时返回的错误信息中增加 errData 属性

v1.1.0

  • 增加对自定义信息字段的支持

v1.0.0

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...