Class: PlvVideoUpload

PlvVideoUpload(configopt)

new PlvVideoUpload(configopt)

封装一个上传视频文件到polyv云空间的插件
Parameters:
Name Type Attributes Description
config Object <optional>
用户设置
Properties
Name Type Description
events Object 事件回调。包括Error、UploadComplete
Source:
Example
const videoUpload = new PlvVideoUpload({
 events: {
   Error: (err) => { console.log(err); },
   UploadComplete: () => {}
 }
});
// 更新用户数据(由于sign等用户信息有效期为3分钟,需要每隔3分钟更新一次)
videoUpload.updateUserData({
 userid: data.userid,
 ptime: data.ts,
 sign: data.sign,
 hash: data.hash
});
// 开始上传所有文件
videoUpload.startAll();
// 添加文件到上传列表
const uploader = videoUpload.addFile(file, {
 FileStarted: () => {},
 FileStopped: () => {}
}, fileSetting);
// 暂停上传指定文件
videoUpload.stopFile(uploader.id);

Members

files :Array.<FileData>

获取上传文件列表
Type:
Source:

Methods

addFile(file, eventsopt, fileSettingopt) → {UploadManager}

添加文件到文件列表
Parameters:
Name Type Attributes Description
file File 文件对象
events Object <optional>
事件回调。 包括FileStarted、 FileStopped、 FileSucceed、 FileProgress、 FileFailed
fileSetting Object <optional>
针对该文件的设置
Properties
Name Type Default Description
desc String 文件描述
cataid Number 1 分类目录id
tag String 文件标签,不同标签之间使用英文逗号分隔
luping Number 0 开启视频课件优化处理,对于上传录屏类视频清晰度有所优化:0为不开启,1为开启
keepsource Number 0 源文件播放(不对源文件进行编码):0为编码,1为不编码
title String file.name 文件名称
state 自定义信息,会在上传完成的回调中返回
Source:
Returns:
Type
UploadManager

clearAll()

清空文件列表
Source:

removeFile(id)

删除指定文件
Parameters:
Name Type Description
id String 文件id,和对应的UploadManager实例的id一致
Source:

resumeFile(id)

开始/继续上传指定文件
Parameters:
Name Type Description
id String 文件id,和对应的UploadManager实例的id一致
Source:

startAll()

开始上传所有文件
Source:

stopAll()

停止上传所有文件
Source:

stopFile(id)

暂停上传指定文件
Parameters:
Name Type Description
id String 文件id
Source:

updateFileData(uploaderid, fileData)

修改指定文件的文件信息
Parameters:
Name Type Description
uploaderid String UploadManager实例的id
fileData FileData 文件信息
Source:

updateUserData(userData)

更新sign、ptime等授权验证信息,授权验证信息3分钟内有效
Parameters:
Name Type Description
userData UserData
Source:

Events

Error

上传过程出错时触发。
Type:
  • Object
Properties:
Name Type Description
code Number 错误代码(110:文件重复,111:拦截文件类型不在acceptedMimeType中的文件,112:文件已经开始上传或已上传完毕,禁止修改文件信息,102:用户剩余空间不足)
message String 错误信息
data Object
Source:

FileFailed

文件上传失败时触发。
Properties:
Name Type Description
uploaderid String 触发事件的UploadManager的id
fileData FileData 文件信息
errData ErrorData 报错信息
Source:

FileProgress

文件上传过程返回上传进度信息时触发。
Type:
  • Object
Properties:
Name Type Description
uploaderid String 触发事件的UploadManager的id
fileData FileData 文件信息
progress Number 上传进度,范围为0~1
Source:

FileStarted

文件开始上传时触发。
Type:
  • Object
Properties:
Name Type Description
uploaderid String 触发事件的UploadManager的id
fileData FileData 文件信息
Source:

FileStopped

文件暂停上传时触发。
Type:
  • Object
Properties:
Name Type Description
uploaderid String 触发事件的UploadManager的id
fileData FileData 文件信息
Source:

FileSucceed

文件上传成功时触发。
Type:
  • Object
Properties:
Name Type Description
uploaderid String 触发事件的UploadManager的id
fileData FileData 文件信息
Source:

UploadComplete

所有文件上传完成时触发。
Source: