离线转码--veImageX-火山引擎

文档中心

立即注册

导航

离线转码

最近更新时间：2024.02.02 15:34:06首次发布时间：2023.09.01 17:36:39

阅读本文，您可以获取 Java SDK 离线转码的接口调用示例，实现快速开发。

调用说明

本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
接口的参数说明和错误码等信息可通过接口文档查看。

前提条件

调用接口前，请先完成 Java SDK 的安装及初始化操作。

调用示例

本节为您介绍离线转码相关接口的功能和调用示例。

创建任务队列

您可以调用 CreateImageTranscodeQueue 接口在指定服务下创建离线转码任务队列。详细的参数说明可参见 CreateImageTranscodeQueue 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*;
import com.volcengine.service.imagex.v2.ImagexService;

public class CreateImageTranscodeQueueExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        CreateImageTranscodeQueueBody body = new CreateImageTranscodeQueueBody();

        try {
            CreateImageTranscodeQueueRes resp = service.createImageTranscodeQueue(body);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

删除任务队列

您可以调用 DeleteImageTranscodeQueue 接口删除指定的任务队列。详细的参数说明可参见 DeleteImageTranscodeQueue 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class DeleteImageTranscodeQueueExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        DeleteImageTranscodeQueueBody body = new DeleteImageTranscodeQueueBody();

        try {
            DeleteImageTranscodeQueueRes resp = service.deleteImageTranscodeQueue(body);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

更新任务队列

您可以调用 UpdateImageTranscodeQueue 接口更新指定任务队列的离线转码配置，如队列名称、队列描述和回调配置等。详细的参数说明可参见 UpdateImageTranscodeQueue 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class UpdateImageTranscodeQueueExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        UpdateImageTranscodeQueueBody body = new UpdateImageTranscodeQueueBody();

        try {
            UpdateImageTranscodeQueueRes resp = service.updateImageTranscodeQueue(body);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

更新任务队列状态

您可以调用 UpdateImageTranscodeQueueStatus 接口更新指定任务队列的状态，如队列名称、队列描述和回调配置等。详细的参数说明可参见 UpdateImageTranscodeQueueStatus 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class UpdateImageTranscodeQueueStatusExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        UpdateImageTranscodeQueueStatusBody body = new UpdateImageTranscodeQueueStatusBody();

        try {
            UpdateImageTranscodeQueueStatusRes resp = service.updateImageTranscodeQueueStatus(body);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

获取任务队列

您可以调用 GetImageTranscodeQueues 接口获取当前账号下已创建的任务队列详情。详细的参数说明可参见 GetImageTranscodeQueues 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class GetImageTranscodeQueuesExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        GetImageTranscodeQueuesQuery query = new GetImageTranscodeQueuesQuery();

        try {
            GetImageTranscodeQueuesRes resp = service.getImageTranscodeQueues(query);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

提交转码任务

您可以调用 CreateImageTranscodeTask 接口向状态为运行中的任务队列，提交以一条或多条 URL/URI 资源转码执行任务组成的转码任务。详细的参数说明可参见 CreateImageTranscodeTask 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class CreateImageTranscodeTaskExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        CreateImageTranscodeTaskBody body = new CreateImageTranscodeTaskBody();

        try {
            CreateImageTranscodeTaskRes resp = service.createImageTranscodeTask(body);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

获取任务执行详情

您可以调用 GetImageTranscodeDetails 接口获取指定时间段内的指定队列的转码任务详情。详细的参数说明可参见 GetImageTranscodeDetails 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class GetImageTranscodeDetailsExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        GetImageTranscodeDetailsQuery query = new GetImageTranscodeDetailsQuery();

        try {
            GetImageTranscodeDetailsRes resp = service.getImageTranscodeDetails(query);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

手动触发回调

您可以调用 CreateImageTranscodeCallback 接口指定任务条目 ID，手动向该任务队列配置的回调 URL 发送回调信息。详细的参数说明可参见 CreateImageTranscodeCallback 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class CreateImageTranscodeCallbackExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        CreateImageTranscodeCallbackBody body = new CreateImageTranscodeCallbackBody();

        try {
            CreateImageTranscodeCallbackRes resp = service.createImageTranscodeCallback(body);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

删除任务执行详情

您可以调用 DeleteImageTranscodeDetail 接口通过指定任务条目 ID，删除提交任务内对应的该条 URL/URI。详细的参数说明可参见 DeleteImageTranscodeDetail 接口文档。

接口调用示例如下所示。

package com.volcengine.example.imagex.v2.api;


import com.volcengine.model.imagex.v2.*; 
import com.volcengine.service.imagex.v2.ImagexService;

public class DeleteImageTranscodeDetailExample {
    public static void main(String[] args) {
        ImagexService service = ImagexService.getInstance();
        service.setAccessKey("ak");
        service.setSecretKey("sk");

        DeleteImageTranscodeDetailBody body = new DeleteImageTranscodeDetailBody();

        try {
            DeleteImageTranscodeDetailRes resp = service.deleteImageTranscodeDetail(body);
            System.out.println(resp);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}