new PlvVideoUpload(configopt)
封装一个上传视频文件到polyv云空间的插件
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
config |
Object |
<optional> |
用户设置
Properties
|
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:
- Array.<FileData>
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
|
Returns:
- Type
- UploadManager
clearAll()
清空文件列表
removeFile(id)
删除指定文件
Parameters:
Name | Type | Description |
---|---|---|
id |
String | 文件id,和对应的UploadManager实例的id一致 |
resumeFile(id)
开始/继续上传指定文件
Parameters:
Name | Type | Description |
---|---|---|
id |
String | 文件id,和对应的UploadManager实例的id一致 |
startAll()
开始上传所有文件
stopAll()
停止上传所有文件
stopFile(id)
暂停上传指定文件
Parameters:
Name | Type | Description |
---|---|---|
id |
String | 文件id |
updateFileData(uploaderid, fileData)
修改指定文件的文件信息
Parameters:
Name | Type | Description |
---|---|---|
uploaderid |
String | UploadManager实例的id |
fileData |
FileData | 文件信息 |
updateUserData(userData)
更新sign、ptime等授权验证信息,授权验证信息3分钟内有效
Parameters:
Name | Type | Description |
---|---|---|
userData |
UserData |
Events
Error
上传过程出错时触发。
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
code |
Number | 错误代码(110:文件重复,111:拦截文件类型不在acceptedMimeType中的文件,112:文件已经开始上传或已上传完毕,禁止修改文件信息,102:用户剩余空间不足) |
message |
String | 错误信息 |
data |
Object |
FileFailed
文件上传失败时触发。
Properties:
Name | Type | Description |
---|---|---|
uploaderid |
String | 触发事件的UploadManager的id |
fileData |
FileData | 文件信息 |
errData |
ErrorData | 报错信息 |
FileProgress
文件上传过程返回上传进度信息时触发。
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
uploaderid |
String | 触发事件的UploadManager的id |
fileData |
FileData | 文件信息 |
progress |
Number | 上传进度,范围为0~1 |
FileStarted
文件开始上传时触发。
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
uploaderid |
String | 触发事件的UploadManager的id |
fileData |
FileData | 文件信息 |
FileStopped
文件暂停上传时触发。
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
uploaderid |
String | 触发事件的UploadManager的id |
fileData |
FileData | 文件信息 |
FileSucceed
文件上传成功时触发。
Type:
- Object
Properties:
Name | Type | Description |
---|---|---|
uploaderid |
String | 触发事件的UploadManager的id |
fileData |
FileData | 文件信息 |
UploadComplete
所有文件上传完成时触发。