创建自定义模板,包含容器信息,视频跟音频流等设置,如果相应部分不做设置,则使用模板转出来的码流中也不会包含相应的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String AddTemplate

系统规定参数。取值:AddTemplate。

Container String "Format":"mp4"

容器。

JSON对象,请参见Container详情

Video String "Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10"

视频流配置。

JSON对象,请参见Video详情

说明 不设置Video参数则转码输出不包括视频流,如需保留视频流则必须设置此对象。
Audio String "Codec":"aac","Samplerate":"44100","Bitrate":"500","Channels":"2"

音频流配置。

JSON对象,请参见Audio详情

说明 不设置Audio参数则转码输出不包括音频流,如需保留音频流则必须设置此对象。
TransConfig String "TransMode":"onepass"

转码通用配置。

JSON对象,请参见TransConfig详情

MuxConfig String "Segment":{"Duration":"12"}

封包配置。

JSON对象,请参见MuxConfig详情

返回数据

名称 类型 示例值 描述
RequestId String FA258E67-09B8-4EAA-8F33-BA5678341CF2

请求ID。

Template object

转码模板。

Video object

视频编解码配置。

Bufsize String 1000

缓冲区大小。

  • 取值范围:1000~128000
  • 单位:Kb
  • 默认值:6000
Degrain String 5

独立去噪算法强度。

  • 取值范围:1~9 (Int)
  • 独立去噪算法,设空则不启用,推荐设定值为1~3。
BitrateBnd object

视频平均码率范围。

Max String 10

总码率上限。

  • 取值范围:10~50000
  • 单位:Kbps
Min String 10

总码率下限。

  • 取值范围:10~50000
  • 单位:Kbps
PixFmt String yuv420p

视频颜色格式。

取值范围:yuv420p,yuvj420p等标准颜色格式。

Pad String 1280:800:0:140

贴边效果。

Codec String aac

音频编解码格式。

  • 支持aac、mp3、vorbis、flac
  • 默认值:aac
Height String 800

高。

  • 取值范围:128~4096
  • 单位:px
  • 默认值:视频原始高度
Qscale String 20

视频质量控制度。

取值范围:1~31,设置对应的转码模式后起效。

Crop String 1280:800:0:140

裁剪矩形。

Bitrate String 100

输出文件的音频码率。

  • 取值范围:8~1000
  • 单位:Kbps
  • 默认值:128
Maxrate String 10

视频码率峰值。

  • 取值范围:10~50000
  • 单位:Kbps
MaxFps String 20

视频最大帧率。

取值范围:0~120

Profile String high

编码级别。

支持baseline、main、high。

  • baseline:针对移动设备,
  • main:针对标准分辨率设备,
  • high:针对高分辨率设备,
  • 默认值:high
Crf String 15

码率-质量控制因子。

  • 取值范围:0~51
  • 默认值:26
  • 如果设置了Crf,则Bitrate的设置失效。
Remove String false

是否删除该stream。

Gop String 10

关键帧间最大帧数。

  • 取值范围:1~1080000
  • 默认值:250
Width String 129

宽。

  • 取值范围:128~4096
  • 单位:px
  • 默认值:视频原始宽度
Fps String 50

帧率。

  • 取值范围:0~60
  • 当输入文件帧率超过60时取60
  • 默认值:取输入文件帧率。
Preset String medium

视频算法器预置。

  • 支持veryfast、fast、medium、slow、slower
  • 默认值:medium
ScanMode String interlaced

扫描模式。

支持:interlaced、progressive

ResoPriority String cropFirst

分辨率优先。

支持:cropFirst、widthFirst、 heightFirst

TransConfig object

转码通用配置。

IsCheckAudioBitrate String false

是否允许分辨率检查。

TransMode String onepass

转码模式。

  • 可选范围:onepass、twopass、CBR
  • 默认值:onepass
IsCheckReso String false

是否允许分辨率检查。

IsCheckVideoBitrateFail String false

是否允许视频码率检查错误。

AdjDarMethod String pda

分辨率改写方式。

取值:rescale、 pad、 crop、 none

IsCheckVideoBitrate String false

是否允许视频码率检查。

IsCheckResoFail String false

是否允许分辨率检查错误。

IsCheckAudioBitrateFail String false

是否允许音频码率检查错误。

State String Normal

模板的状态。

取值:Normal、Deleted

MuxConfig object

转码封包配置。

Webp object

webp格式配置。

Loop String 20

循环次数,默认不循环。

Gif object

GIF格式配置。

FinalDelay String 20

循环间隔。

DitherMode String sierra

调色板颜色抖动方式。

  • 默认:sierra
  • 支持:sierra、bayer
Loop String 20

循环次数,默认不循环。

IsCustomPalette String true

自定义调色板功能。

取值:true、false

Segment object

切片配置。

Duration String 5

分片时长。

  • 取值范围:1~60
  • 单位:秒
Name String yourname

模板名称。

最大长度128字节。

Audio object

音频编解码配置。

Profile String aac_eld

音频编码预置。

当Codec为aac时,可以设置如下范围中的值:aac_low、aac_he、aac_he_v2、aac_ld、aac_eld

Remove String false

是否删除该流。

Codec String acc

音频编解码格式。

  • 支持aac、mp3、vorbis、flac
  • 默认值:aac
Samplerate String 22050

采样率。

  • 支持22050、32000、44100、48000、96000
  • 单位:Hz
  • 默认值:44100
Qscale String 20

视频质量控制度。

取值范围:1~31

Channels String 2

声道数。

  • 支持1、2、3、4、5、6、7、8
  • 默认值:2
Volume object

音频音量调整。

Method String auto

音量调整方式

  • 默认:auto
  • 取值范围 auto、dynamic、linear
Level String -100

音量调整幅度。

取值范围:

  • -100~10(db)
  • 默认 -20
Bitrate String 50

输出文件的音频码率。

  • 取值范围:8~1000
  • 单位:Kbps
  • 默认值:128
Id String 16f01ad6175e4230ac42bb5182cd05c3

模板ID。

Container object

容器。

Format String flv

容器格式。

取值:flv、mp4、ts、m3u8、gif、mp3、ogg、flac

示例

请求示例

http(s)://[Endpoint]/?AccessKeyId=X
&Action=AddTemplate
&ResourceOwnerAccount=X
&Name=X
&Container="Format":"mp4"
&Video="Codec":"H.264","Profile":"high","Bitrate":"500","Crf":"15","Width":"256","Height":"800","Fps":"25","Gop":"10"
&Audio="Codec":"aac","Samplerate":"44100","Bitrate":"500","Channels":"2"
&TransConfig="TransMode":"onepass"
&MuxConfig="Segment":{"Duration":"12"}
&OwnerAccount=X
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AddTemplateResponse>
    <RequestId>FA258E67-09B8-4EAA-8F33-BA5678341CF2</RequestId>
    <Template>
        <Video>
            <Bufsize>1000</Bufsize>
            <Degrain>5</Degrain>
            <BitrateBnd>
                <Max>10</Max>
                <Min>10</Min>
            </BitrateBnd>
            <PixFmt>yuv420p</PixFmt>
            <Pad>1280:800:0:140</Pad>
            <Codec>aac</Codec>
            <Height>800</Height>
            <Qscale>20</Qscale>
            <Crop>1280:800:0:140</Crop>
            <Bitrate>100</Bitrate>
            <Maxrate>10</Maxrate>
            <MaxFps>20</MaxFps>
            <Profile>high</Profile>
            <Crf>15</Crf>
            <Remove>false</Remove>
            <Gop>10</Gop>
            <Width>129</Width>
            <Fps>50</Fps>
            <Preset>medium</Preset>
            <ScanMode>interlaced</ScanMode>
            <ResoPriority>cropFirst</ResoPriority>
        </Video>
        <TransConfig>
            <IsCheckAudioBitrate>false</IsCheckAudioBitrate>
            <TransMode>onepass</TransMode>
            <IsCheckReso>false</IsCheckReso>
            <IsCheckVideoBitrateFail>false</IsCheckVideoBitrateFail>
            <AdjDarMethod>pda</AdjDarMethod>
            <IsCheckVideoBitrate>false</IsCheckVideoBitrate>
            <IsCheckResoFail>false</IsCheckResoFail>
            <IsCheckAudioBitrateFail>false</IsCheckAudioBitrateFail>
        </TransConfig>
        <State>Normal</State>
        <MuxConfig>
            <Webp>
                <Loop>20</Loop>
            </Webp>
            <Gif>
                <FinalDelay>20</FinalDelay>
                <DitherMode>sierra</DitherMode>
                <Loop>20</Loop>
                <IsCustomPalette>true</IsCustomPalette>
            </Gif>
            <Segment>
                <Duration>5</Duration>
            </Segment>
        </MuxConfig>
        <Name>yourname</Name>
        <Audio>
            <Profile>aac_eld</Profile>
            <Remove>false</Remove>
            <Codec>acc</Codec>
            <Samplerate>22050</Samplerate>
            <Qscale>20</Qscale>
            <Channels>2</Channels>
            <Volume>
                <Method>auto</Method>
                <Level>-100</Level>
            </Volume>
            <Bitrate>50</Bitrate>
        </Audio>
        <Id>16f01ad6175e4230ac42bb5182cd05c3</Id>
        <Container>
            <Format>flv</Format>
        </Container>
    </Template>
</AddTemplateResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "FA258E67-09B8-4EAA-8F33-BA5678341CF2",
  "Template" : {
    "Video" : {
      "Bufsize" : 1000,
      "Degrain" : 5,
      "BitrateBnd" : {
        "Max" : 10,
        "Min" : 10
      },
      "PixFmt" : "yuv420p",
      "Pad" : "1280:800:0:140",
      "Codec" : "aac",
      "Height" : 800,
      "Qscale" : 20,
      "Crop" : "1280:800:0:140",
      "Bitrate" : 100,
      "Maxrate" : 10,
      "MaxFps" : 20,
      "Profile" : "high",
      "Crf" : 15,
      "Remove" : false,
      "Gop" : 10,
      "Width" : 129,
      "Fps" : 50,
      "Preset" : "medium",
      "ScanMode" : "interlaced",
      "ResoPriority" : "cropFirst"
    },
    "TransConfig" : {
      "IsCheckAudioBitrate" : false,
      "TransMode" : "onepass",
      "IsCheckReso" : false,
      "IsCheckVideoBitrateFail" : false,
      "AdjDarMethod" : "pda",
      "IsCheckVideoBitrate" : false,
      "IsCheckResoFail" : false,
      "IsCheckAudioBitrateFail" : false
    },
    "State" : "Normal",
    "MuxConfig" : {
      "Webp" : {
        "Loop" : 20
      },
      "Gif" : {
        "FinalDelay" : 20,
        "DitherMode" : "sierra",
        "Loop" : 20,
        "IsCustomPalette" : true
      },
      "Segment" : {
        "Duration" : 5
      }
    },
    "Name" : "yourname",
    "Audio" : {
      "Profile" : "aac_eld",
      "Remove" : false,
      "Codec" : "acc",
      "Samplerate" : 22050,
      "Qscale" : 20,
      "Channels" : 2,
      "Volume" : {
        "Method" : "auto",
        "Level" : -100
      },
      "Bitrate" : 50
    },
    "Id" : "16f01ad6175e4230ac42bb5182cd05c3",
    "Container" : {
      "Format" : "flv"
    }
  }
}

错误码

访问错误中心查看更多错误码。