截图模板

接口调用说明

• 本文提供的接口调用示例均通过AccessKey初始化客户端实例。

• 接口的参数解释和返回字段的详细说明请访问阿里云OpenAPI门户，在各接口右侧的文档页签查看。

• 本文仅提供部分复杂接口的代码示例，其余接口的SDK代码示例，可以通过阿里云OpenAPI门户获取。访问阿里云OpenAPI门户，在接口的左侧参数配置页签，填写需要的参数信息并发起调用后，在右侧的SDK示例页签，选择SDK版本，选择目标语言，查看并下载示例代码。

• 本文均以V1.0版本的SDK为例进行接口调用，如需获取V2.0版本的SDK示例，请在通过阿里云OpenAPI门户获取SDK示例时，指定到对应的SDK版本。

初始化客户端

使用前请先初始化客户端，请参见初始化。

添加截图模板

调用AddVodTemplate接口，生成添加截图模板的SDK示例。

阿里云OpenAPI门户地址：AddVodTemplate。

调用示例如下：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.auth.AlibabaCloudCredentials;
import com.aliyuncs.auth.EnvironmentVariableCredentialsProvider;
import com.aliyuncs.vod.model.v20170321.AddVodTemplateRequest;
import com.aliyuncs.vod.model.v20170321.AddVodTemplateResponse;

/** 
 * 读取AccessKey信息
 */
public static DefaultAcsClient initVodClient() throws ClientException {
    // 点播服务接入地域
    String regionId = "cn-shanghai";  
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取AccessKey，来实现API访问的身份验证。运行代码示例前，请配置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    DefaultProfile profile = DefaultProfile.getProfile(regionId, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
    DefaultAcsClient client = new DefaultAcsClient(profile);
    return client;
    }

/**
 * 构建截图模板的配置数据，根据具体设置需求修改对应的参数值
 * （以下代码示例为雪碧图完整配置）
 * @return 截图模板配置
 */
public static JSONObject buildSnapshotTemplateConfig() {
    JSONObject templateConfig = new JSONObject();
    JSONObject snapshotConfig = new JSONObject();
    snapshotConfig.put("Count", "50");
    snapshotConfig.put("Interval", "1");
    snapshotConfig.put("SpecifiedOffsetTime", "0");
    snapshotConfig.put("Width", "200");
    snapshotConfig.put("Height", "200");
    snapshotConfig.put("FrameType", "normal");
    //普通截图配置（与雪碧图原始图配置共用该配置信息）
    templateConfig.put("SnapshotConfig", snapshotConfig);

    //雪碧图配置（雪碧图配置必须是建立在普通截图配置之上）
    JSONObject spriteSnapshotConfig = new JSONObject();
    spriteSnapshotConfig.put("CellWidth", "120");
    spriteSnapshotConfig.put("CellHeight", "68");
    spriteSnapshotConfig.put("Columns", "3");
    spriteSnapshotConfig.put("Lines", "10");
    spriteSnapshotConfig.put("Padding", "20");
    spriteSnapshotConfig.put("Margin", "50");
    spriteSnapshotConfig.put("KeepCellPic", "keep");
    spriteSnapshotConfig.put("Color", "tomato");
    snapshotConfig.put("SpriteSnapshotConfig", spriteSnapshotConfig);

    //截图类型（存在雪碧图配置，该类型必须是"SpriteSnapshot"，否则为"NormalSnapshot"）
    templateConfig.put("SnapshotType", "SpriteSnapshot");
    return templateConfig;
}

/**
 * 添加截图模板函数
 */
public static AddVodTemplateResponse addSnapshotVodTemplate(DefaultAcsClient client) throws Exception {
    AddVodTemplateRequest request = new AddVodTemplateRequest();
    //模板名称
    request.setName("截图模板添加测试");
    //模板类型，固定值为Snapshot
    request.setTemplateType("Snapshot");
    //截图模板配置数据生成
    JSONObject templateConfig = buildSnapshotTemplateConfig();
    request.setTemplateConfig(templateConfig.toJSONString());
    return client.getAcsResponse(request);
}

/**
 * 以下为调用示例
 * @param args
 * @throws ClientException
 */
public static void main(String[] args) {
    DefaultAcsClient client = initVodClient();
    AddVodTemplateResponse response = new AddVodTemplateResponse();
    try {
        //添加截图模板
        response = addSnapshotVodTemplate(client);
        //截图模板ID
        System.out.println("SnapshotVodTemplateId = " + response.getVodTemplateId());
    } catch (Exception e) {
        System.out.println("ErrorMessage = " + e.getLocalizedMessage());
    }
    System.out.println("RequestId = " + response.getRequestId());
}

修改截图模板

调用UpdateVodTemplate接口，生成修改截图模板的SDK示例。

阿里云OpenAPI门户地址：UpdateVodTemplate。

调用示例如下：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.auth.AlibabaCloudCredentials;
import com.aliyuncs.auth.EnvironmentVariableCredentialsProvider;
import com.aliyuncs.vod.model.v20170321.UpdateVodTemplateRequest;
import com.aliyuncs.vod.model.v20170321.UpdateVodTemplateResponse;

/** 
 * 读取AccessKey信息
 */
public static DefaultAcsClient initVodClient() throws ClientException {
    // 点播服务接入地域
    String regionId = "cn-shanghai";  
    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // 本示例通过从环境变量中读取AccessKey，来实现API访问的身份验证。运行代码示例前，请配置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    DefaultProfile profile = DefaultProfile.getProfile(regionId, System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
    DefaultAcsClient client = new DefaultAcsClient(profile);
    return client;
    }

/**
 * 构建截图模板的配置数据，根据具体设置需求修改对应的参数值
 * （以下代码为普通截图完整配置）
 * @return 截图模板配置
 */
public static JSONObject buildSnapshotTemplateConfig() {
    JSONObject templateConfig = new JSONObject();
    JSONObject snapshotConfig = new JSONObject();
    snapshotConfig.put("Count", "50");
    snapshotConfig.put("Interval", "1");
    snapshotConfig.put("SpecifiedOffsetTime", "0");
    snapshotConfig.put("Width", "200");
    snapshotConfig.put("Height", "200");
    snapshotConfig.put("FrameType", "normal");
    //普通截图配置（与雪碧图原始图配置共用该配置信息）
    templateConfig.put("SnapshotConfig", snapshotConfig);

    //截图类型（存在雪碧图配置，该类型必须是"SpriteSnapshot"，否则为"NormalSnapshot"）
    templateConfig.put("SnapshotType", "NormalSnapshot");
    return templateConfig;
}

/**
 * 修改截图模板函数
 */
public static UpdateVodTemplateResponse updateSnapshotVodTemplate(DefaultAcsClient client) throws Exception {
    UpdateVodTemplateRequest request = new UpdateVodTemplateRequest();
    //设置要修改的模板ID
    request.setVodTemplateId("53azf9d796fad9d7b862b2e****");
    //模板名称
    request.setName("截图模板修改测试");
    //截图模板配置数据生成
    JSONObject templateConfig = buildSnapshotTemplateConfig();
    request.setTemplateConfig(templateConfig.toJSONString());
    return client.getAcsResponse(request);
}

/**
 * 以下为调用示例
 * @param args
 * @throws ClientException
 */
public static void main(String[] args) {
    DefaultAcsClient client = initVodClient();
    UpdateVodTemplateResponse response = new UpdateVodTemplateResponse();
    try {
        //修改截图模板
        response = updateSnapshotVodTemplate(client);
        //截图模板ID
        System.out.println("SnapshotVodTemplateId = " + response.getVodTemplateId());
    } catch (Exception e) {
        System.out.println("ErrorMessage = " + e.getLocalizedMessage());
    }
    System.out.println("RequestId = " + response.getRequestId());
}

查询截图模板

• 调用GetVodTemplate接口，生成查询单个截图模板信息的SDK示例。

  阿里云OpenAPI门户地址：GetVodTemplate。

• 调用ListVodTemplate接口，生成查询截图模板列表信息的SDK示例。

  阿里云OpenAPI门户地址：ListVodTemplate。

删除截图模板

调用DeleteVodTemplate接口，生成删除截图模板的SDK示例。

阿里云OpenAPI门户地址：DeleteVodTemplate。

相关文档

• 视频截图：介绍视频点播的视频截图功能更完整更详细的信息，包括支持的截图类型、使用说明等。

• 截图任务及模板管理、查询媒体截图数据：提供视频截图相关的SDK完整示例代码。