功能描述

此接口用于创建音视频转码模版。

注意事项

单条规则 body 最大不超过 20KB，最多允许配置 300 条自定义模板。

使用子账号操作时，请先在访问控制 > 权限策略中创建或编辑自定义策略，为当前桶添加 tos:PutDataProcessTemplate 权限，再将该策略绑定至需要使用本功能的子账号。

PUT /?process_template&tag=Transcode HTTP/1.1​
Host: {BucketName}.tos-cn-beijing.volces.com​
Date: Fri, 30 Jul 2021 08:05:36 +0000​
Content-Type: application/json​
Content-Length: <length>​
Authorization: authorization string​
​
{​
  "Tag": "Transcode", // 固定标识​
  "Name": "my-template",​
  "TranscodeConfig": {​
    "TimeInterval": {​
      "Start": 0,​
      "Duration": 10000,​
    },​
    "Container": {​
      "Format": "mp4"​
    },​
    "Video": {​
      "Codec": "h264",​
      "Width": 480,​
      "Height": 480,​
      "Crf": 1,​
      "PixFmt": "yuv420p"​
      "BitRate": 3000000,​
      "MaxBitRate": 5000000,​
      "BufferSize": 10000000,​
      "Fps": 24,​
      "Remove": false​
    },​
    "Audio": {​
      "Codec": "aac",​
      "BitRate": 128000,​
      "SampleFormat": "fltp",​
      "Channels": 2,​
      "Remove": false​
    },​
    "Options": {​
      "AIGCMetadata": {​
        "Label": "1",​
        "ContentProducer": "test_producer",​
        "ProduceID": "12345",​
        "ContentPropagator": "test_propagator",​
        "PropagateID": "12345",​
        "ReservedCode1": "ewogICAgIm****UiLAp9",​
        "ReservedCode2": "ewogICAg*****UyIiwKfQ"​
      }​
    }​
  }​
}​

请求参数和消息头

参数名称	参数类型	是否必填	示例值	说明
process_template	String	是	-	视频转码模板标识。
Tag	String	是	Transcode	任务类型，音视频转码场景下取值仅为 Transcode。

请求元素

参数名称	参数类型	是否必填	示例值	说明
Name	String	是	name	自定义模板名称：仅支持 a-z、A-Z、0-9、_、-和 .，长度不超过 64，开头和结尾字符必须是 a-z、A-Z、0-9。多条规则不能重复。
TranscodeConfig	Container	是	-	音视频转码模板详情信息。
TimeInterval	Container	否	-	指定转码时长。父节点：TranscodeConfig
Start	Integer	否	0	开始时间，单位毫秒，默认值 0。父节点：TimeInterval
Duration	Integer	否	10000	持续时间，单位毫秒，默认值 0 表示视频时长。父节点：TimeInterval
Container	Container	是	-	指定转码容器格式。父节点：TranscodeConfig
Format	String	是	mp4	视频文件封装格式，取值列表如下： mp4 ts hls flv mp3 aac flac m4a oga wav ac3 opus pcm 父节点：Container
ClipConfig	Container	否	-	分片配置，指定 hls 转码分片时长。父节点：Container
Duration	Integer	否	5000	hls 转码的分片时长，单位毫秒，默认值为 5000，合法取值范围为 (0, 3600000)。父节点：ClipConfig
Video	Container	是	-	视频编码参数。父节点：TranscodeConfig
Codec	String	否	H.264	视频编解码格式，取值如下： h264 h265 父节点：Video 。
Width	Integer	否	4096	视频宽度，默认值为 0，单位 px，必须为偶数，取值范围为 [128, 4096]。父节点：Video 说明只设置 Width ，未设置Height，将按照视频原始比例计算视频文件的高度。 Width 和Height都不设置时，将按照视频原始比例计算视频文件的宽度与高度
Height	Integer	否	1024	视频高度，默认值为 0，单位 px，必须为偶数，取值范围为 [128, 4096]。父节点：Video 说明只设置 Height ，未设置Width，将按照视频原始比例计算视频文件的宽度。 Width 和Height都不设置时，将按照视频原始比例计算视频文件的宽度与高度
Crf	Integer	否	25	视频文件的码率控制因子，值范围 (0, 51]。默认 0 表示不设置。如果设置了 Crf，则 Bitrate 的设置失效。当 Bitrate 为空时，按照编码器默认值。父节点：Video
PixFmt	String	否	yuv420p	视频像素格式。取值如下： yuv420p yuv420p10le 父节点：Video
BitRate	Integer	否	0	视频输出文件的码率，单位 bps，值范围 [10000, 50000000]，默认 0 表示不设置。父节点：Video
MaxBitRate	Integer	否	5000000	视频输出最大码率，单位 bps，值范围 [10000, 50000000]。设置该参数时必须同时设置 BitRate，且 MaxBitRate 必须大于等于 BitRate。父节点：Video
BufferSize	Integer	否	10000000	视频码率控制缓冲区大小，单位 bps，值范围 [1000000, 128000000]。设置该参数时必须同时设置 MaxBitRate。父节点：Video
Fps	Integer	否	0	视频帧率，单位 fps，值范围 (0, 60]，默认 0 表示不设置。父节点：Video
Remove	Bool	否	false	是否删除源视频流，默认值为 falase，取值如下： true ：删除源音频流。 false：默认值，保留源音频流并转码。父节点：Video
Audio	Container	否	-	指定音频流参数。父节点：TranscodeConfig。
Codec	String	否	aac	音频流编码格式，取值列表如下： mp3 aac flac Vorbis ac3 opus pcm_s16le 父节点：Audio 说明不同容器格式支持的音频编码格式有所不同，详情请参见不同容器的音频编码格式支持情况。
BitRate	Integer	否	128000	音频码率，单位为比特/秒（bps），取值范围：[8000, 1000000]。为 0 时使用原音频码率，部分容器不支持指定码率。父节点：Audio 说明不同格式支持的声道数有所不同，详情请参见不同音频容器参数支持情况。
SampleFormat	String	否	fltp	音频采样格式，不同容器取值范围不同。取值： fltp s16 s16p s32 s32p 父节点：Audio
SampleRate	Integer	否	48000	音频采样率，不同容器取值范围不同。父节点：Audio 说明不同格式支持的采样率有所不同，详情请参见不同音频容器采样率支持情况。
Channels	Integer	否	2	音频声道数，默认与指定的源音频一致，取值范围：1 ~ 8，不同容器取值范围不同。父节点：Audio 说明不同格式支持的声道数有所不同，详情请参见不同音频容器参数支持情况。
Remove	Bool	否	false	是否删除源音频流，默认值为 falase，取值如下： true ：删除源音频流。 false：默认值，保留源音频流并转码。父节点：Audio
Options	Container	否	-	指定转码可选参数。父节点：TranscodeConfig
AIGCMetadata	Container	否	-	视频 AIGC 元信息。父节点：Options
Label	String	是	1	生成合成标签要素，该标签用于标识目标视频属于、可能、疑似为人工智能生成合成的属性信息。父节点：AIGCMetadata
ContentProducer	String	是	tes_producer	生成合成服务提供者要素，内容为视频生成合成服务提供者的名称或编码。长度不超过 2048 个字符，仅支持 ASCII 可见字符（0x21–0x7E）。父节点：AIGCMetadata
ProduceID	String	是	123456	内容制作编号要素，内容为视频生成合成服务提供者对该内容的唯一编号。父节点：AIGCMetadata
ContentPropagator	String	否	test_propagator	内容传播服务提供者要素，内容为视频传播服务提供者的名称或编码。长度不超过 2048 个字符，仅支持 ASCII 可见字符（0x21–0x7E）。父节点：AIGCMetadata
PropagateID	String	否	123456	内容传播编号要素，内容为视频传播服务提供者对该视频的唯一编号。父节点：AIGCMetadata
ReservedCode1	String	否	ewogICAgIm****UiLAp9	预留字段 1，内容为用户自主开展安全防护，保护内容、标识完整性的信息。需经过 base64 编码后传入。父节点：AIGCMetadata
ReservedCode2	String	否	ewogICAg*****UyIiwKfQ	预留字段 2，内容为用户自主开展安全防护，保护内容、标识完整性的信息。需经过 base64 编码后传入。父节点：AIGCMetadata
Delogos	Array	否	-	去 Logo 配置，用于模糊处理视频中的指定矩形区域，最多配置 10 个，省略或传入空数组表示不启用。通过该接口创建的模板不保存此字段，且不能与 Video.Remove=true 或纯音频输出组合使用。父节点：TranscodeConfig
Pos	String	是	TopRight	矩形定位基准，取值如下： TopLeft：左上。 TopRight：右上。 BottomLeft：左下。 BottomRight：右下。父节点：Delogos
LocMode	String	是	Absolute	偏移模式，坐标和尺寸以处理后的实际画面为准，百分比以整数表示（如 10 表示 10%）。取值如下： Absolute ：像素，取值范围为 [0,4096] px。 Relative ：百分比，取值范围为 [0,100]。父节点：Delogos
SizeMode	String	是	Fixed	尺寸模式，可与偏移模式独立组合。取值如下： Fixed ：像素，取值范围为 [2,4096] px。 Proportion ：百分比，取值范围为 [0,100]。当偏移模式为 Relative、尺寸模式为 Proportion 时，Dx + Width 与 Dy + Height 均不得超过 100，且实际宽高至少为 2 像素。父节点：Delogos
Dx	Integer	否，默认 0	20	水平偏移量，以实际处理画面宽度为基准，向画面内部偏移。取值如下： Absolute：像素，取值范围为 [0,4096] px。 Relative：百分比，取值范围为 [0,100]。父节点：Delogos
Dy	Integer	否，默认 0	20	垂直偏移量，以实际处理画面高度为基准，向画面内部偏移。取值范围如下： Absolute：像素，取值范围为 [0,4096] px。 Relative：百分比，取值范围为 [0,100]。父节点：Delogos
Width	Integer	是	160	区域宽度，表示画面宽度百分比。取值如下： Fixed：像素，取值范围为 [2,4096] px。 Proportion：百分比，取值范围为 [0,100]。父节点：Delogos
Height	Integer	是	60	区域高度，表示画面高度百分比。取值如下： Fixed：像素，取值范围为 [2,4096] px。 Proportion：百分比，取值范围为 [0,100]。父节点：Delogos 。
StartTime	Integer	否，默认 0	0	模糊处理的开始时间，单位为毫秒，取值须 ≥ 0，以本次转码输出时间线起点为基准。父节点：Delogos 。
EndTime	Integer	否，默认 0	5000	模糊处理的结束时间，单位为毫秒，取值须 ≥ 0，为 0 时表示持续到输出视频结束，非 0 时须 ≥ StartTime。父节点：Delogos 。

响应消息头

该请求返回的公共响应消息头，请参见公共参数。

响应元素

参数名称	参数类型	示例值	说明
template_id	String	393161343761366633396119012e********	创建音频转码模板的唯一 ID。

请求示例

响应示例

对象存储