创建新模板。

请求参数

公共模板参数

参数 类型 是否必要 示例值 描述
Action String 是 CreateTemplate 操作接口名，系统规定参数。取值：CreateTemplate
Name String 是 录制模板 模板名称。
Description String 否 录制模板 模板描述。
Type String 是 record 模板类型。取值：record(录制),snapshot(截图),transcode(转码),timeshift(时移)
Callback String 否 http://www.example.com 模板执行后的回调。

录制模板

参数 类型 是否必要 示例值 描述
Region String 是 cn-shanghai OSS所属区域，即服务中心。
OssBucket String 是 bucketname OSS的Bucket。
OssEndpoint String 是 oss-cn-shanghai.aliyuncs.com OSS的域名。
Interval Long 是 3600 操作周期，单位秒。
FileFormat String 是 mp4,flv 存储文件格式，多值用逗号分隔。取值：mp4,flv,hls
  • 青岛单元暂不支持flv、mp4录制
Mp4 String 否 osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime} MP4的存储路径。
  • 路径中支持变量匹配，可选{AppName}、{StreamName}、{Sequence}、{EscapedStartTime}、{EscapedEndTime}
  • 必须包含{EscapedStartTime}和{EscapedEndTime}
Flv String 否 osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime} FLV的存储路径。格式参考Mp4说明。
HlsM3u8 String 否 osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime} HLS的存储路径，m3u8文件。格式参考Mp4说明。
HlsTs String 否 osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime} HLS的存储路径，ts文件。
  • 路径中支持变量匹配，可选{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}
  • 必须包含{UnixTimestamp}和{Sequence}变量
Trigger String 否 auto 模板触发类型，默认auto。取值：auto（自动），ondemand（按需）

截图模板

参数 类型 是否必要 示例值 描述
Region String 是 cn-shanghai OSS所属区域，即服务中心。
OssBucket String 是 bucketname OSS的Bucket。
OssEndpoint String 是 oss-cn-shanghai.aliyuncs.com OSS的域名。
Interval Long 是 3600 操作周期，单位秒。
FileFormat String 是 jpg 存储文件格式，多值用逗号分隔。取值：jpg
JpgOverwrite String 否 osspath/snapshot/{AppName}/{StreamName}.jpg JPG的存储路径，用于覆盖截图。
  • 目前仅支持生成jpg图片。
  • 支持变量匹配，包含{AppName}、{StreamName}
JpgSequence String 否 osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg JPG的存储路径，用于序列截图。
  • 目前仅支持生成jpg图片。
  • 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}
  • {UnixTimestamp}、{Sequence}必填一个
JpgOnDemand String 否 osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}-ondemand.jpg JPG的存储路径，用于按需截图。
  • 目前仅支持生成jpg图片。
  • 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}
  • {UnixTimestamp}、{Sequence}必填一个

时移模板

参数 类型 是否必要 示例值 描述

Retention

 Long 是 3 时移保存周期，单位天

转码模板

参数 类型 是否必要 示例值 描述
TransConfigsJSON String 是 转码配置TransConfig类型的数组，JSON格式

TransConfig类型

参数 类型 必要 示例值 描述
Name String 是 sd 转码规则名称,取值：转码规则名称将作为转码流后缀，建议按使用习惯设置为sd，200k等易辨识后缀，只支持数字和字母
VideoCodec String 是 h264 视频编码取值：h264
VideoBitrate Long 是 800 视频比特率，单位kbps
Fps Long 是 25 视频帧率，单位fps
Gop Long 是 50 视频Gop，单位帧
Height Long 是 640 视频高度
Width Long 是 1280 视频宽度

返回参数

参数 类型 示例值 描述
Id String 32388487739092998 模板ID。
RequestId String BEA5625F-8FCF-48F4-851B-CA63946DA664 该条任务请求ID。

示例

请求示例

http://vs.aliyuncs.com?Action=CreateTemplate&Name=录制模板&Type=record&FileFormat=mp4&Interval=3600&<公共请求参数>

返回示例

{
    "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
    "Id": "32388487739092998 "
}