VOD provides an upload SDK for Android for uploading videos on the Android platform. For more information on the upload process, please see Uploading Videos from Client.

Downloading Source Code

1. Click here to download the Android Upload Demo and source code.
2. You can see the Demo directory after decompressing the downloaded zip package. The upload source code is in the Demo/app/src/main/java/com/tencent/ugcupload/demo/videoupload directory.

Integrating Upload Library and Source Code

1. Copy the upload source code directory Demo/app/src/main/java/com/tencent/ugcupload/demo/videoupload to your project directory and rename the package manually.
2. Integrate all the jar packages under the Demo/app/libs/upload directory into your project. You are recommended to retain the upload directory structure for convenient library update in the future.
3. Certain access permissions related to network and storage are required for uploading videos. You can add the following permission declarations in AndroidManifest.xml:

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>``
    <receiver android:name=".videoupload.impl.TVCNetWorkStateReceiver">
        <intent-filter>
            // Action to detect network changes
            <action android:name="android.net.conn.CONNECTIVITY_CHANGE"/>
            <category android:name="android.intent.category.DEFAULT" />
        </intent-filter>
    </receiver>

Simple Video Upload

Initializing an upload object

TXUGCPublish mVideoPublish = new TXUGCPublish(this.getApplicationContext(), "independence_android")

Setting upload object callback

mVideoPublish.setListener(new TXUGCPublishTypeDef.ITXVideoPublishListener() {
    @Override
    public void onPublishProgress(long uploadBytes, long totalBytes) {
        mProgress.setProgress((int) (100*uploadBytes/totalBytes));
    }

    @Override
    public void onPublishComplete(TXUGCPublishTypeDef.TXPublishResult result) {
        mResultMsg.setText(result.retCode + " Msg:" + (result.retCode == 0 ? result.videoURL : result.descMsg));
    }
});

Constructing upload parameter

TXUGCPublishTypeDef.TXPublishParam param = new TXUGCPublishTypeDef.TXPublishParam();

param.signature = "xxx";
param.videoPath = "xxx";

For the rule of signature calculation, please see Signature for Upload from Client.

Calling upload

int publishCode = mVideoPublish.publishVideo(param);

Simple Image Upload

Initializing an upload object

TXUGCPublish mVideoPublish = new TXUGCPublish(this.getApplicationContext(), "independence_android")

Setting upload object callback

mVideoPublish.setListener(new TXUGCPublishTypeDef.ITXMediaPublishListener() {
    @Override
    public void onMediaPublishProgress(long uploadBytes, long totalBytes) {
        mProgress.setProgress((int) (100*uploadBytes/totalBytes));
    }
    @Override
    public void onMediaPublishComplete(TXUGCPublishTypeDef.TXMediaPublishResult mediaResult) {
        mResultMsg.setText(result.retCode + " Msg:" + (result.retCode == 0 ? result.videoURL : result.descMsg));
    }
});

Constructing upload parameter

TXUGCPublishTypeDef.TXMediaPublishParam param = new TXUGCPublishTypeDef.TXMediaPublishParam();

param.signature = "xxx";
param.mediaPath = "xxx";

For the rule of signature calculation, please see Signature for Upload from Client.

Calling upload

int publishCode = mVideoPublish.publishMedia(param);

The upload method automatically selects simple upload or multipart upload based on the file size, eliminating your need to take care of every step in multipart upload.

Advanced Features

Uploading a cover

Include the path to a cover in the upload parameter.

TXUGCPublishTypeDef.TXPublishParam param = new TXUGCPublishTypeDef.TXPublishParam();
param.signature = "xxx";
param.videoPath = "xxx";
param.coverPath = "xxx";

For the rule of signature calculation, please see Signature for Upload from Client.

Canceling and resuming upload

To cancel an upload, call the canclePublish() API of TXUGCPublish.

mVideoPublish.canclePublish();

To resume an upload, call publishVideo of TXUGCPublish again using the same upload parameter, with the paths to the video and cover unchanged.

Resumable upload

During the video upload process, VOD supports resumable upload, that is, when the upload is terminated unexpectedly, you can upload the file again from where it left off, which helps reduce the upload time.

The effective time for resumption is 1 day, i.e., if the upload of a video is interrupted and then resumed within 1 day, it can be directly resumed; otherwise, the full video will be uploaded again by default.

enableResume in the upload parameter is the switch for resumable upload, which is enabled by default.

Pre-upload

In the actual upload process, most of errors are caused by failures or timeout of the network connection. To fix such problems, we have added the optimized pre-upload logic, including resolving HTTPDNS, getting the recommended upload target region, and detecting the optimal upload target region.

You are recommended to call TXUGCPublishOptCenter.getInstance().prepareUpload(signature) when the application is started. The pre-upload module will cache the mapping table of <domain name, IP> and the optimal upload target region locally, and automatically purge and refresh the cache when a network switch is detected.

Be sure to register the network monitoring module in AndroidManifest.xml:

<receiver android:name=".videoupload.impl.TVCNetWorkStateReceiver">
  <intent-filter>
    // Action to detect network changes
    <action android:name="android.net.conn.CONNECTIVITY_CHANGE"/>
    <category android:name="android.intent.category.DEFAULT" />
  </intent-filter>
</receiver>

For the rule of signature calculation, please see Signature for Upload from Client.

Video Upload API Description

Initialize upload object: TXUGCPublish

Set VOD appId: TXUGCPublish.setAppId

Upload video: TXUGCPublish.publishVideo

Upload parameter: TXUGCPublishTypeDef.TXPublishParam

Set upload callback: TXUGCPublish.setListener

Progress callback: TXUGCPublishTypeDef.ITXVideoPublishListener.onPublishProgress

Result callback: TXUGCPublishTypeDef.ITXVideoPublishListener.onPublishComplete

Upload result: TXUGCPublishTypeDef.TXPublishResult

Pre-upload: TXUGCPublishOptCenter.prepareUpload

Image Upload API Description

Initialize upload object: TXUGCPublish

Set VOD appId: TXUGCPublish.setAppId

Upload image: TXUGCPublish.publishMedia

Upload parameter: TXUGCPublishTypeDef.TXMediaPublishParam

Set upload callback: TXUGCPublish.setListener

Progress callback: TXUGCPublishTypeDef.ITXMediaPublishListener.onPublishProgress

Result callback: TXUGCPublishTypeDef.ITXMediaPublishListener.onPublishComplete

Upload result: TXUGCPublishTypeDef.TXMediaPublishResult

Pre-upload: TXUGCPublishOptCenter.prepareUpload

Error Codes

The SDK listens on the video upload status through the TXUGCPublishTypeDef.ITXVideoPublishListene\ITXMediaPublishListener API; therefore, you can check the video upload status with the retCode in TXUGCPublishTypeDef.TXPublishResult\TXMediaPublishResult.