苏宁视频云-帮助与文档

组件名称

SnVodUploadSdk

当前版本

V3.0.1

下载地址

http://pptvyun.suning.com/lib/videoUpload/vodupload.v3.min.js

目前支持的浏览器

IE11+，Chrome，Firefox

本地上传

                                        
const fileUpload = SnVodUploadSdk({
    uploadDom: document.querySelector('#uploadButton'),
    multiple: true,
    vodDomain:'your vod doamin',
    token: 'yourToken',
    customParams:{
        param:'value'
    },
    onAfterChangeFiles: function(instance, fileObj){
        console.log('您选择了新的文件');
    },
    onProgress: function(localId, fileSize, finished, trunkSize, time){
        console.log('上传进度发生变化');
    },
    onUpdateStatus:function (fileObj, status) {
        console.log('上传文件状态发生变化');
    },
    afterEachFinished: function(fileObj){
        console.log('有文件上传完成');
    },
    onUploadError: function(error){
        console.log('上传发生错误：'+msg);
    },
    checkSizeMessage:function (blobFile, size) {
        console.log(`单个文件大小超出了限制 : ${f.name}`)
    },
    checkTypeMessage:function (blobFile, fileSub) {
        console.log(`文件类型不支持 : ${f.name}`)
    }
});

远程下载

                                        
const fileUpload = SnVodUploadSdk({
    vodDomain:'your vod doamin',
    token: 'yourToken',
    customParams:{
        param:'value'
    },
    isremote: true,
    onAfterChangeFiles(instance, fileObj) {
        const { localId } = fileObj;
        fileUpload.doUpload(localId);
        console.log(fileObj);
    },
    onUpdateStatus(fileObj, status){
        console.log(fileObj, status);
    },
    onUploadError(error){
        console.log(error);
    }
});
fileUpload.addRemoteFie('url', 'name');

配置项

属性名	类型	是否必须	说明	默认值
uploadDom	DOM	本地上传：是远程下载：否	触发选择文件的按钮	无
vodDomain	string	是	点播域的的domain
token	string	是	过gateWay的鉴权token
multiple	boolean	否	是否允许多选文件 true:支持多选文件 false:只能选择单个文件	false
maxFileNumber	number	否	最多可选择的文件个数	10
singleFileMaxLimit	string	否	单个文件的大小限制	100GB
types	array	否	以小写字母列举支持上传文件	['avi', 'asf', 'asx', 'mpeg', 'mpg', 'mp4', 'mov', 'm4v', 'ogm', 'ogv', 'wmv', 'webm', 'flv', 'vob]
customParams	object	否	上传时自定义的参数
validate	function	否	对文件进行验证	(blobFile)=>{}
checkTypeMessage	function	否	验证文件类型，如果不属于给定的类型执行的回调该参数只有本地上传有效	(blobFile,type)=>{}
checkSizeMessage	function	否	验证文件大小，如果超出配置的文件大小执行的回调该参数只有本地上传有效	(blobFile,size)=>{}
onProgress	function	否	文件上传的进度发生改变执行回调可通过（finish/fileSize)获得已完成的比例，通过（datarange/timespan)获得当时的上传速度该参数只有本地上传有效	((localId, fileSize, finished, datarange, timespan) => {}
onUploadError	function	否	文件上传错误执行回调	({code,message})=>{}
afterEachFinished	function	否	在每次文件上传完成以后执行回调该参数只有本地上传有效	(localId,fileObj)=>{}
onAfterChangeFiles	function	否	当文件选择后执行回调	(upload, fileObj)=>{}
onUpdateStatus	function	否	上传状态更改执行回调 status=> 0: 初始化 1: 上传中 2：暂停中 3：完成 4：上传失败远程下载只能收到上传中的通知，无法收到其他状态通知	(fileObj,status)=>{}

实例方法

方法名称	参数	描述
pauseUpload	localId:文件索引	暂停单个上传
pauseUploadAll		暂停所有文件上传
startUpload	localId:文件索引	开始上传单个文件
starUploadAll		开始上传所有文件
deleteFile	localId:文件索引	删除单个文件
deleteFileAll		删除所有文件
setFileParam	localId:文件索引，key：参数名称，value：参数值	为单个文件设置参数
addRemoteFie	url:远程文件地址，name：文件名称	添加远程下载任务只有远程下载可以使用该方法
getFileProgress	localId:文件索引	获取远程下载任务的进度只有远程下载可以使用该方法

fileObj对象描述

属性名	类型	描述
blobFile	Blob	原文件
channelId	string	文件的唯一标识
name	string	文件名,远程下载才有该属性
taskId	string	任务ID
localId	number	文件在上传队列的索引

blobFile对象描述

属性名	类型	描述
fid	number	公有云的文件ID
size	number	文件大小
status	number	文件的上传状态