提交模板渲染任务

更新时间 : 2021-11-26 12:09:23

接口地址

https://vecloud.atvideo.cc/render/charge/cpr/request

请求类型

[POST]

其他所需信息

1：注册VE平台账号

2：购买【时长付费-服务器版】套餐或获取测试资格

3：制作AE模板，并通过导出工具导出，且压缩为zip包上传到云存储中可供下载。导出工具使用方式详见文档。

4：配置VE平台云存储设置、秘钥管理两项

请求头信息

1. productId：VE控制台-账号信息中显示的product_id
2. accessKey : VE控制台-秘钥信息中，您配置的access_key
3. token : 生成算法： md5(jsonData + “&&” + product_id + “&&” + access_key + “&&” + md5(access_secret));
4. jsonData : http请求中的body部分

参数

接口返回

• 成功：

  {
    "data" : {
        "orderId" : "2019ax9810jx18hx1pja90"
    },
    "errno" :0 ,
    "errormsg" : success
  }
  

• 失败：

  详见VE平台错误码对照表
  https://www.seeshiontech.com/docs/page_77.html

注意事项

• 模板包更新

  更新AE模板包后，需要修改下载链接和 tplVersion，VE 在渲染时才会重新下载新版模板。

注解1： 替换元素JSON

如果存在此参数，则忽略assetUrls、subTexts、subAssetUrls。建议使用此参数进行替换，后期将不在维护assetUrls、subTexts、subAssetUrls的功能；

• main_file 对应的是主替换元素assetUrls的功能。
• replaces 分别对应subTexts、subAssetUrls的功能。
• replaceableJson的具体字段含义和规范请见 https://www.seeshiontech.com/docs/page_103.html
• 如果你要使用文字动画功能，首先要在setting字段内进行启用，其次在replaceableJson内设置文字动画的内容。请注意，常规模板和动态模板的json内容格式是不同的。详情请参阅https://www.seeshiontech.com/docs/page_178.html

实例

"replaceableJson": [
        {
            "main_file": "https://ve-img-src.atvideo.cc/meipian/img/3.jpeg",
            "replaces": [
                {
                    "d_key_prefix": "dtext",
                    "type": 1,
                    "file": "https://static.atvideo.cc/kebentuya/1.jpeg"
                },
                {
                    "d_key_prefix": "dtext",
                    "type": 2,
                    "text": "字幕四，居中"
                }
            ]
        },
        {
            "main_file": "https://ve-img-src.atvideo.cc/meipian/img/1.jpeg",
            "replaces": [
                {
                    "d_key_prefix": "dtext",
                    "type": 1,
                    "file": "https://static.atvideo.cc/kebentuya/2.jpeg"
                },
                {
                    "d_key_prefix": "dtext",
                    "type": 2,
                    "text": "字幕五"
                }
            ]
        }
    ],

注解2： 主替换素材下载链接

示例：

[
    "https://ve-img-src.atvideo.cc/meipian/img/1.jpeg", 
    "https://ve-img-src.atvideo.cc/meipian/img/2.jpeg", 
    "https://ve-img-src.atvideo.cc/meipian/img/3.jpeg", 
    "https://ve-img-src.atvideo.cc/meipian/img/4.jpeg", 
    "https://ve-img-src.atvideo.cc/meipian/img/5.jpeg"
]

注解3：高级图片素材替换

img_path:        主替换素材下载链接，如果是空，则前缀匹配d_key_prefix
d_key_prefix:    匹配前缀
d_img_paths :    替换元素下载链接数组

示例：

"subAssetUrls": [{
        "img_path": "",
        "d_key_prefix": "title",
        "d_img_paths": ["https://ve-img-src.atvideo.cc/workspace/assets/235_41_text1.png"]
    }, {
        "img_path": "https://ve-img-src.atvideo.cc/meipian/img/2.jpeg",
        "d_key_prefix": "dtext",
        "d_img_paths": ["https://ve-img-src.atvideo.cc/workspace/assets/235_41_text2.png"]
    }]

注解4：视频快照

要求引擎截取一帧视频的画面返还，注意一秒包含多帧。

frame ：帧索引，表示截取视频中的第几帧图像
uploadKey ： 上传保存路径，以 .png 结尾，不能以 / 开头，示例： snapshots/1.png

示例：

 [{
        "frame": 10,
        "uploadKey": "video/snapshot10.png"
    }, {
        "frame": 100,
        "uploadKey": "video/snapshot100.png"
    }]

注解5：高级替换文字 subTexts

img_path ：主替换素材下载链接，如果是空，则前缀匹配 d_key_prefix
d_key_prefix ： 匹配前缀
d_texts ：替换文字

示例：

 [{
        "img_path": "",
        "d_key_prefix": "title",
        "d_texts": ["自定义标题"]
    }, {
        "img_path": "https://ve-img-src.atvideo.cc/meipian/img/1.jpeg",
        "d_key_prefix": "dtext",
        "d_texts": ["描述1"]
    }, {
        "img_path": "https://ve-img-src.atvideo.cc/meipian/img/2.jpeg",
        "d_key_prefix": "dtext",
        "d_texts": ["描述2"]
    }, {
        "img_path": "https://ve-img-src.atvideo.cc/meipian/img/3.jpeg",
        "d_key_prefix": "dtext",
        "d_texts": ["描述3"]
    }]

注解6：开启高级渲染支持参数

• 通过设置该值实现高级渲染选项的开启。
• 比如要在动态模板的渲染任务中支持高级字符动画，则 setting = 动态模板 | 文字动画 = 2 | 512 = 514

注解7 ：高级替换音轨

一个包含替换音频元素的数组JSON 。其中每一个替换元素的字段含义为

"audioTracks": [{
            "filePath": "https://static.atvideo.cc/2019/11/15/17/10/test.mp3",
            "inPoint": 35,
            "duration": 42,
            "startTime": 6,
            "endTime": 15,
            "loop": false,
            "volume": 1
        },
        {
            "filePath": "https://static.atvideo.cc/2019/11/25/10/55/testaacmusic.aac",
            "inPoint": 2.1,
            "duration": 9,
            "startTime": 33,
            "endTime": 38,
            "loop": false,
            "volume": 1
        },
        {
            "filePath": "https://static.atvideo.cc/2019/11/25/11/01/music1.mp4",
            "inPoint": 4.1,
            "duration": 3,
            "startTime": 11,
            "endTime": 12,
            "loop": true,
            "volume": 1
        }
    ],

注解8 : gif输出配置

相关 SDK

• PHP-SDK 下载
• JAVA-SDK 下载

疑难排查

• 接口返回 verify token failed 错误
  1）如是PHP SDK，且版本大于等于7.1的，检查json_encode 函数造成浮点类型数据出现精度问题，可调整 php.ini 中 serialize_precision (序列化精度) 的大小来解决这个问题。

  2）如是使用Python调用接口，请确保json格式化字符串时在:、; 符号后不带有空格