本文介绍如何通过 TOS Java SDK 创建视频转码任务。

注意事项

仅 Java SDK 2.9.15 及以上版本支持创建视频转码任务的功能。

示例代码

根据模板 ID 创建视频转码任务

package org.example.CreateVideoConvertJob;​
​
// 根据模板Id创建视频转码任务​
import com.volcengine.tos.TOSV2;​
import com.volcengine.tos.TOSV2ClientBuilder;​
import com.volcengine.tos.TosClientException;​
import com.volcengine.tos.TosServerException;​
import com.volcengine.tos.comm.common.*;​
import com.volcengine.tos.model.bucket.*;​
import com.volcengine.tos.model.object.*;​
​
public class CreateVideoConvertJobExample {​
    public static void main(String[] args) {​
        String endpoint = System.getenv("TOS_ENDPOINT");​
        String region = System.getenv("TOS_REGION");​
        String accessKey = System.getenv("TOS_ACCESS_KEY");​
        String secretKey = System.getenv("TOS_SECRET_KEY");​
        ​
        // 填写 BucketName​
        String bucketName = System.getenv("TOS_BUCKET");​
        // 模板 ID​
        String templateId = "3633373966613563353858a1015403c6e03f";​
        ​
        // 初始化客户端​
        TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey);​
        ​
        try {​
            // 1. 根据用例类型设置相应的参数（通过模板 ID 触发转码）​
            // 源对象 Key（占位符，请替换为实际视频对象）​
            String sourceObjectKey = "example-input.mp4";​
            ConvertJobInput jobInput = ConvertJobInput.builder()​
                    .object(sourceObjectKey)​
                    .build();​
​
            // 目标输出（将转码后的结果写入同一桶的指定对象）​
            ConvertJobOutput jobOutput = ConvertJobOutput.builder()​
                    .region(region)               // 输出区域：使用当前 region​
                    .bucket(bucketName)           // 输出桶：与输入桶相同，亦可配置为其他桶​
                    .object("example-output.mp4") // 输出对象 Key（占位符）​
                    .build();​
​
            // 使用模板 ID 构造转码配置；Transcode 为空对象即可​
            TranscodeConfig transcodeConfig = TranscodeConfig.builder()​
                    .templateID(templateId)       // 引用已创建的视频转码模板 ID​
                    .transcode(new Transcode())   // 通过模板进行转码，无需额外细项​
                    .build();​
​
            // 2. 调用对应的 API 函数​
            CreateVideoConvertJobInput input = CreateVideoConvertJobInput.builder()​
                    .bucket(bucketName)​
                    .input(jobInput)​
                    .output(jobOutput)​
                    .transcodeConfig(transcodeConfig)​
                    .build();​
            CreateVideoConvertJobOutput output = tos.createVideoConvertJob(input);​
​
            // 3. 处理返回结果​
            System.out.println("创建视频转码任务成功");​
            System.out.println("RequestID: " + output.getRequestInfo().getRequestId());​
            System.out.println("StatusCode: " + output.getRequestInfo().getStatusCode());​
            System.out.println("JobID: " + output.getJobId());​
            ​
            // 4. 添加适当的注释说明：本用例通过模板 ID 创建任务，适合复用统一转码策略​
            ​
        } catch (TosClientException e) {​
            // 操作失败，捕获客户端异常，一般情况是请求参数错误，此时请求并未发送​
            System.out.println("操作失败");​
            System.out.println("Message: " + e.getMessage());​
            if (e.getCause() != null) {​
                e.getCause().printStackTrace();​
            }​
        } catch (TosServerException e) {​
            // 操作失败，捕获服务端异常，可以获取到从服务端返回的详细错误信息​
            System.out.println("操作失败");​
            System.out.println("StatusCode: " + e.getStatusCode());​
            System.out.println("Code: " + e.getCode());​
            System.out.println("Message: " + e.getMessage());​
            System.out.println("RequestID: " + e.getRequestID());​
        } catch (Throwable t) {​
            // 作为兜底捕获其他异常，一般不会执行到这里​
            System.out.println("操作失败");​
            System.out.println("unexpected exception, message: " + t.getMessage());​
        }​
    }​
}​

根据参数配置创建视频转码任务

创建带文字水印的视频转码任务

以下代码展示如何通过 TranscodeConfig.watermark 直接传入文字水印配置。

回调请求说明

当设置 Callback 字段时，任务执行成功后将对 Callback URL 发送回调请求：

对象存储