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

使用说明

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

简介

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

上传流程

用户选择文件 -> 添加文件到列表 -> 开始上传 -> 设置上传凭证和地址 -> 上传完成事件。

  • 用户选择文件

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

  • 添加文件到列表

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

  • 开始上传

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

  • 设置上传凭证和地址

    在文件上传开始事件OnUploadStarted,调用setUploadAuthAndAddress函数,设置点播上传服务返回的上传凭证和上传地址。注意上传凭证有时效性,如果一次性返回所有文件的上传凭证,要正确处理失效的场景:上传过程中,如果超出了时效范围,需要刷新上传凭证后才能恢复上传。

  • 上传完成事件

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

备注:视频点播的上传配置仅要求提供上传凭证(uploadAuth)和上传地址(uploadAddress)即可。

概念和说明

  • 上传地址和上传凭证

    • 上传地址

      上传地址是有服务指定的,用户不可修改。

    • 上传凭证

      每个上传凭证都绑定了上传地址,不同上传地址关联的上传凭证不能互换,否则无法正常上传文件。另外,上传凭证是有时效性的。

      具体参数获取方法查看文档 获取上传凭证和地址

  • 分片上传和状态

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

  • 移动端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版本不支持)
resumeUploadWithAuth 上传凭证超时后,使用新的上传凭证来恢复上传
setUploadAuthAndAddress 设置上传地址和上传凭证。每个上传地址和上传凭证是独立的,需要在OnUploadStarted事件中调用,更新当前的上传地址和上传凭证

回调事件

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