VOD provides an SDK for uploading videos on Android client. For more information on the upload process, please see Guide - Upload from Client.

Downloading Source Code

1. Click here to download Android upload demo and source code.
2. After decompressing the downloaded zip file, you can see the demo directory and find the upload source code in Demo/app/src/main/java/com/tencent/ugcupload/demo/videoupload.

Integrating Upload Library and Source Code

1. Copy Demo/app/src/main/java/com/tencent/ugcupload/demo/videoupload to your project directory, and modify the package name manually.
2. Refer to Demo/app/build.gradle to add dependencies in your project:

    implementation ('com.tencent.qcloud:cosxml:5.5.3') {
        exclude group:'com.tencent.qcloud', module: 'mtaUtils' // Disable MTA reporting
    }

   Note：

   You can also refer to Manual integration and integrate corresponding dependent libraries.

3. Network and storage access permissions are required for video-uploading. 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>

Uploading Videos

Initializing 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 details on how to calculate signature, please see Signature for Upload from Client.

Calling upload method

int publishCode = mVideoPublish.publishVideo(param);

Uploading Images

Initializing 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 parameters

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

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

For details on how to calculate signature, please see Signature for Upload from Client.

Calling upload method

int publishCode = mVideoPublish.publishMedia(param);

Note：

The upload method automatically selects simple upload or multipart upload based on the file size, saving efforts of users.

Advanced Features

Uploading a cover image

Add path to the cover image as an upload parameter.

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

For details on how to calculate signature, please see Signature for Upload from Client.

Canceling and resuming upload

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

mVideoPublish.canclePublish();

To resume an upload, call publishVideo of TXUGCPublish again using the same upload parameters and same video and cover image paths.

Checkpoint restart

VOD supports checkpoint restart during upload. When the upload terminated unexpectedly, you can resume the upload from the breakpoint, saving time of uploading.

Checkpoint restart is valid within one day. If the upload of a video is interrupted and then resumed within one day, the upload can be resumed; otherwise, the entire video will be uploaded again.

The upload parameter enableResume is the switch for checkpoint restart, enabled by default.

Pre-upload

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

We recommend you call TXUGCPublishOptCenter.getInstance().prepareUpload(signature) when enabling the App. 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.

Note：

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 details on how to calculate signature, please see Signature for Upload from Client.

Video Upload API

Initialize the upload object: TXUGCPublish

Set VOD appId: TXUGCPublish.setAppId

Upload a video: TXUGCPublish.publishVideo

Upload parameter: TXUGCPublishTypeDef.TXPublishParam

Set upload callback: TXUGCPublish.setListener

Progress callback: TXUGCPublishTypeDef.ITXVideoPublishListener.onPublishProgress

Result callback: TXUGCPublishTypeDef.ITXVideoPublishListener.onPublishComplete

| Variable Name | Description | Type ||
| ------ | ---- | ----------------------------------- |
| result | Upload result. | TXUGCPublishTypeDef.TXPublishResult |

Upload result: TXUGCPublishTypeDef.TXPublishResult

Pre-upload: TXUGCPublishOptCenter.prepareUpload

Image Upload API

Initialize upload object: TXUGCPublish

Set VOD appId: TXUGCPublish.setAppId

Upload image: TXUGCPublish.publishMedia

Upload parameter: TXUGCPublishTypeDef.TXPublishParam

| Parameter Name | Description Type | Required |
| ------------ | -------------------------------------------------- | ------- | ---- |
| signature | Signature for Upload from Client. | String | Yes |
| mediaPath | Path to a local image file. | String | Yes |
| enableResume | This parameter specifies whether to enable checkpoint restart. It is enabled by default. | boolean | No |
| enableHttps | This parameter specifies whether to enable HTTPS, which is disabled by default. | boolean | No |
| fileName | Name of a video file uploaded to Tencent Cloud. If this parameter is left empty, the name of the local file will be used by default. | String | No |

Set upload callback: TXUGCPublish.setListener

Progress callback: TXUGCPublishTypeDef.ITXMediaPublishListener.onPublishProgress

Result callback: TXUGCPublishTypeDef.ITXMediaPublishListener.onPublishComplete

Upload result: TXUGCPublishTypeDef.TXPublishResult

Pre-upload: TXUGCPublishOptCenter.prepareUpload

Error Codes

The SDK listens to the video upload status via API TXUGCPublishTypeDef.ITXVideoPublishListene\ITXMediaPublishListener. Therefore, you can check the video upload status using retCode in TXUGCPublishTypeDef.TXPublishResult\TXMediaPublishResult.