快速开始

本文为您介绍如何用 Android 上传 SDK 以简单便捷的方式上传素材。

适用版本

此文档适用于 TTSDK 1.32.2 及以上的版本，其他版本请参考快速开始（历史版本）。

前提条件

您已完成上传 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());

• 参数获取：请参考管理应用，在控制台创建应用后获取。
• 详细的参数说明如下表所示。

创建实例

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

BDMaterialUploader mUploader = new BDMaterialUploader();

设置上传的文件

设置上传的文件，支持 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 不需要接入方设置，其他几个参数说明如下表示。

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

// 例 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，则对应关系如下所示。

设置素材信息

设置素材信息接口的代码示例如下所示。

public void setFileType(String fileType)

public void setTitle(String title)

public void setTags(String tags)

public void setDescription(String description)

public void setCategory(String category)

public void setFormat(String format) 

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

FileType 取值和 Category 对应关系

上传控制

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

mUploader.start();

mUploader.stop();

mUploader.close()

设置回调

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

public void setListener(BDMaterialUploaderListener listener)

public interface BDMaterialUploaderListener {
    // 上传进度和上传状态的回调，详见下表 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}