全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
媒体转码

使用说明

更新时间:2017-06-07 13:26:11

上传SDK提供的功能包括文件列表管理和上传控制。文件列表管理包括文件的增加、删除、取消、恢复、遍历、清空。上传控制包括开始、停止、暂停、恢复。SDK也提供了回调事件,用来监听上传过程中的状态和进度变化。

上传流程

初始化 -> 用户选择文件 -> 添加文件到列表 -> 开始上传 -> 上传完成事件。

  • 初始化

    初始化时,有2种提供授权的方式:AK和安全令牌。考虑到AK在端上保存的安全性,建议AK方式只用于测试,生产环境使用安全令牌方式。详细参考开发人员指南->上传视频文件简介

  • 用户选择文件

    用户选择本地要上传的文件。

  • 添加文件到列表

    把用户需要上传的所有文件通过addFile接口添加到列表中。

  • 开始上传

    调用start接口就会开始真正的上传进程。

  • 上传完成事件

    包含成功和失败两种事件OnUploadSucceed,OnUploadFailed。

概念和说明

  • 分片上传和状态

    SDK内部采用的是分片上传机制,状态只在一次执行内有效,如果由于各种原因导致应用退出(例如:关机、关闭浏览器页面、关闭APP、APP异常退出等),需要重新上传。

  • 授权过期

    安全令牌是有时效性的,当安全令牌过期后,上传过程会中断,并且没法自主恢复。需要从后端重新获取新的安全令牌,并调用resumeUploadWithAuth函数才能恢复上传。

  • 移动端3G/4G<->Wifi切换

    为了避免浪费3G/4G网络下的流量,应用判断切换到3G/4G网络时(需要应用自己实现判断),可以调用pause暂停上传。在切换回Wifi网络时(需要应用自己实现判断),调用resume恢复上传。

  • 现提供了3种终端的SDK:

    • HTML5:可以集成到PC的浏览器中,开发语言JavaScript。

    • iOS:可以集成到iOS系统的APP中,开发语言Object-C。

    • Android:可以集成到Android系统的APP中,开发语言Java。

功能描述

文件列表管理

接口名称 描述
addFile 添加文件到列表中,文件是按照添加的顺序依次上传
deleteFile 从列表中删除文件
cancelFile 取消列表中的单个文件,但是不会从上传列表中删除,效果就是会跳过这个文件的上传(JavaScript版本不支持)
resumeFile 不是恢复上传,只是恢复之前列表中被取消单个文件的状态(JavaScript版本不支持)
listFiles 获取列表
clearFiles 清除列表,即使是上传中的文件,也会停止上传并清除(JavaScript版本不支持)

上传控制

接口名称 描述
start 开始上传
stop 停止上传
pause 暂停上传(JavaScript版本不支持)
resume 恢复上传(JavaScript版本不支持)
resumeUploadWithToken 安全令牌超时后,使用新的安全令牌来恢复上传

回调事件

事件名称 描述
OnUploadStarted 每个文件开始上传时都会触发。
OnUploadSucceed 上传成功。
OnUploadFailed 上传失败。可恢复型的错误会自动断点续传,例如:网络异常、超时等。不可恢复类型的错误会导致失败,例如:上传凭证错误、文件不存在等
OnUploadProgress 上传进度汇报。在分片上传成功时触发
OnUploadTokenExpired 安全令牌超时。需要从服务重新获取新的安全令牌,并调用resumeUploadWithToken函数恢复上传
OnUploadRetry 上传过程中,状态由正常切换为异常时触发。例如:网络异常,超时等(JavaScript版本不支持)
OnUploadRetryResume 上传过程中,状态由异常中恢复时触发。(JavaScript版本不支持)
本文导读目录