本文为您介绍如何使用 Android 上传 SDK 以简单便捷的方式将视频上传至视频点播服务。

适用版本

此文档适用于上传 SDK 1.32.2 及以上的版本，其他版本请参考Android 视频上传 SDK（历史版本）。

前提条件

已完成上传 SDK 的集成准备。

基础功能

日志调试

开发的过程中，建议打开 logcat 日志，便于调试，排查问题。

BDUploadLog.turnOn(LOG_DEBUG, 1);
BDUploadUtil.setEnableNativeLog(true);

初始化 SDK

初始化操作是轻量的，建议放到 Application#onCreate 中执行，保障初始化顺序。

Env.init(new Config.Builder()
        .setApplicationContext(context)
        .setAppID("your app id")
        .setAppName("your app English name")
        // 合法版本号应大于、等于 3 位，如："1.3.2"
        .setAppVersion(BuildConfig.VERSION_NAME)
        .setAppChannel("channel name")
        .build());

详细的参数说明如下表所示。

创建实例

实现创建实例的代码示例如下所示。

BDVideoUploader mUploader = new BDVideoUploader();

设置上传的文件

设置上传的文件，支持 2 种方式，任选其一。

mUploader.setPathName("/data/user/0/xxx/files/test.mp4"); 

mUploader.setMediaDataReader(reader) 

设置鉴权

从接入方自己的 AppServer 获取鉴权参数设置给 SDK。鉴权参数说明详见客户端上传。实现的代码示例如下所示。

mUploader.setTopAccessKey("xxx");
mUploader.setTopSecretKey("xxx");
mUploader.setTopSessionToken("xxx");

设置空间

实现设置空间的代码示例如下所示。空间相关说明请参考空间管理。

mUploader.setSpaceName("xxx");

设置云端存储路径

上传完成后，文件在云端的存储路径形式如下所示。
StoreUri = {{BucketName}}/{{FilePrefix}}{{FileTitle}}{{FileExtension}}
其中 BucketName 不需要接入方设置，其他几个参数说明如下表示。

支持两种方式设置云端存储路径。您可根据自身需求，任选其一。

// 例 1，云端的存储路径：tos-pathxxx/volc/test.mp4
mUploader.setFileName("volc/test.mp4"); 
// 例 2，云端的存储路径：tos-pathxxx/test.mp4
mUploader.setFileName("test.mp4");

// 设置后缀，必须设置，需要以 . 开头，如 .mp4、.mp3 等。
mUploader.setFileExtension(".mp4"); 
// 设置前缀，可选设置，需要以 / 结尾
mUploader.setFilePrefix("volc/"); 
// 例 1，云端的存储路径: tos-pathxxx/volc/b8bb180086f945709dfda76bc9c6133d.mp4
mUploader.setFileExtension(".mp4"); 
mUploader.setFilePrefix("volc/"); 
// 例 2，云端的存储路径: tos-pathxxx/b8bb180086f945709dfda76bc9c6133d.mp4
mUploader.setFileExtension(".mp4");

例如：tos-pathxxx/pathxxx/test.mp4 ，则对应关系如下所示。

设置分类

调用 setClassificationId 方法传入分类 ID，从而对视频进行分类。您可在视频点播控制台指定空间内的分类管理页面创建分类并获取分类 ID，具体请见分类管理。示例代码如下：

public void setClassificationId(long classificationId)

上传控制

上传控制支持的操作开始上传、暂停上传和终止上传。

mUploader.start();

mUploader.stop();

mUploader.close()

设置回调

回调的线程：在 A 线程创建 Uploader 实例，如果 A 线程存在 Looper，则在 A 线程回调；否则在主线程回调。

public void setListener(BDVideoUploaderListener listener)

public interface BDVideoUploaderListener {
    // 上传进度和上传状态的回调，详见下表 onNotify 回调说明
    void onNotify(int what, long parameter, BDVideoInfo info);
    
    // 关键日志回调，接入方可将回调信息上传到您的服务器，可通过日志排查线上问题。
    // 需要通过 mUploader.setEnableLogCallBack(true) 开启才能生效。
    // 不使用空实现即可。
    void onLog(int what, int code, String info);
    
    // 上传出错重试时回调；由接入方检查网络状态，
    // 返回 1 sdk 认为有网，进行重试；
    // 返回 0 sdk 认为无网，不再进行重试
    // 如接入方不想检查网络状态，返回 1 即可，SDK 会在重试次数、超时时间内重试。
    int videoUploadCheckNetState(int errorCode, int tryCount);

    // 暂未使用
    String getStringFromExtern(int key);
}

onNotify 回调说明如下表所示。

BDVideoInfo

{"Bitrate":463419,"Duration":39.726999999999997,"FileType":"video","Format":"MP4","Height":360,"Md5":"53f62abe3c29d0654b3405af7***7060","Size":2301285,"StoreUri":"tos-vod-cn-v-309be6ba73***b04/cd404e7bef654554b638422***7c0c40","Width":640}

进阶功能

设置封面图抽帧时间

调用 setPoster 设置视频自动抽帧时间点，单位为秒。设置成功后，上传 SDK 将根据您设置的固定时间点截取视频帧，作为视频的封面图。示例代码如下：

// 单位为秒，默认值为 0
public void setPoster(float posterTime)

开启断点续传

如想开启断点续传功能，您需要调用 setSDKConfigDir 和 setDiskResumeOption。开启断点续传后，用户在您的应用中上传文件时，如果发生强制退出应用等情况导致上传中断，下次上传同一个文件时，上传 SDK 会自动获取断点，并从断点处继续上传，从而节省上传时间。
示例代码如下：

// 指定断点续传配置文件存放目录，上传 SDK 需要有读写权限，初始化后全局设置 1 次即可。
BDUploadUtil.setSDKConfigDir(dir)

// 开启断点续传，每个 Uploader 实例都需设置。
mUploader.setDiskResumeOption(1);

设置全异步抽取 Meta

如果您的业务场景无需实时抽取 Meta，则可以使用全异步抽取 Meta 的能力，提升上传速度。您需要调用 setGetMetaMode 并将模式设为 GET_META_ASYNC。示例代码如下：

mUploader.setGetMetaMode(GET_META_ASYNC); 

自定义上传配置

上传 SDK 还支持分片上传等功能，您可以设置分片大小、开启并行上传的线程数等能力。实现的代码示例如下所示。

// 分片上传设置分片大小，单位为 byte，默认值为 512 * 1024
public void setSliceSize(int size)

// 开启并行上传的线程数，默认值为 1
public void setSocketNum(int num)  

// 单次 TCP 建连超时，单位为 ms，默认值为 5000
public void setTcpOpenTimeOutMilliSec(int openTimeOutMilliSec) 

// 单个分片传输超时，单位为 s，默认值为 40
public void setRWTimeout(int timeOut) 

// 总建连超时，单位为 s，默认值为 70
public void setMaxFailTime(int maxTime)

// 系统 socket 单次读写超时，单位为 s，默认值为 10
public void setTranTimeOutUnit(int tranTimeOutUnit)

// 复用连接的超时时间，防止老连接质量变差，导致的上传速度变慢，单位为 s，默认值为 6
public void setAliveMaxFailTime(int maxFailTime)

// 分片重试次数，默认值为 2
public void setSliceReTryCount(int retryCount) 

// 文件级别的重试次数，默认值为 3
public void setFileRetryCount(int retryCount)

// 开启 HTTPS，设置 1 为全开启
public void setEnableHttps(int isEnableHttps)

设置回调透传参数

调用 setServerParameter 设置回调透传参数。该参数值会通过 FileUploadComplete 回调中的 CallbackArgs 参数返回给您的服务端。示例代码如下：

// 需要携带的自定义参数，例如："appid=123&did=123456&uid=12345&Region=xxx&StoreRegion=xxx"
public void setServerParameter(String value)

设置工作流 ID

调用 setTemplateId 方法传入工作流 ID，从而触发媒体处理任务。您可在视频点播控制台指定空间内的工作流页面获取工作流 ID，具体详见工作流。示例代码如下：

// 设置工作流 ID
mUploader.setTemplateId(templateId);