调用GetTranscodeTemplateGroup根据转码模板组ID查询转码配置的详细信息。

说明 获取单个模板组信息,同时会返回该模板组下所有转码模板的配置信息。

调试

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

请求参数

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

系统规定参数。取值:GetTranscodeTemplateGroup

TranscodeTemplateGroupId String a591f697c7167*****6ae1502142d0

转码模板组ID。

返回数据

名称 类型 示例值 描述
RequestId String 6730AC93-7B12-4B*****7F-49EE1FE8BC49

请求ID。

TranscodeTemplateGroup Object

转码模板组数据。

CreationTime String 2018-12-12T10:20:51Z

模板组的创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

IsDefault String NotDefault

是否是默认模板组。取值:

  • Default:默认模板组。
  • NotDefault:非默认模板组。
AppId String app-****

应用ID。

TranscodeTemplateGroupId String a59b11f697c716*****6ae1502142d0

转码模板组ID。

Name String test

模板组的名称。

ModifyTime String 2018-12-12T11:20:51Z

模板组的修改时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Locked String Enabled

模板组是否处理锁定状态。取值:

  • Disabled:未锁定
  • Enabled:锁定
TranscodeTemplateList Array of TranscodeTemplate

转码模板配置信息列表。

Type String Normal

模板类型,取值:

  • Normal(默认):正常转码模板。该类型模板不能设置PackageSetting参数。
  • VideoPackage:视频流打包模板。该类型模板会先转码,后构建自适应码流,且必须要配置PackageSetting参数。
  • SubtitlePackage:字幕打包模板。该类型模板不会转码,仅将对应字幕信息构建到自适应码率输出文件中,且必须要设置PackageSetting参数。但该类型模板不能在模板组中单独存在,需要与VideoPackage类型模板一同配置(一个模板组仅能配置一个该类型模板)。
Video String {"Codec":"H.264","Bitrate":"900","Width":"960","Remove":"false","Fps":"30"}

视频流转码配置参数(JSON字符串)。

TransConfig String {"IsCheckReso":"true","IsCheckResoFail":"false","IsCheckVideoBitrate":"false","IsCheckVideoBitrateFail":"false","IsCheckAudioBitrate":"false","IsCheckAudioBitrateFail":"false"}

条件转码参数。如需要根据源片码率、分辨率进行基本逻辑判断再输出转码视频,则可设置该参数 (JSON字符串)。

Rotate String 90

视频旋转标参数。控制画面的旋转角度,例如:设置180,则视频画面将上下颠倒。取值范围:[0,360]

TranscodeTemplateId String 696d29a11erc057*****a3acc398d02f4

转码模板ID。

TemplateName String test

转码模板名称。

EncryptSetting String "EncryptType":"Private"

转码加密配置信息。

Audio String {\"Codec\":\"AAC\",\"Remove\":\"false\",\"Bitrate\":\"44\",\"Samplerate\":\"32000\",\"Channels\":\"2\",\"Profile\":\"aac_low\"}

音频流转码配置参数(JSON字符串)。

TranscodeFileRegular String {MediaId}/transcoce_1

自定义转码输出路径。

Container String "Format":"m3u8"

封装音视频码流的容器格式(JSON字符串)。

Clip String {\"TimeSpan\":{\"Seek\":\"1\",\"Duration\":\"5\"}

视频裁剪配置(JSON字符串)。例如:需要截取视频中的5s内容,用于生成一个新的视频,则可设置该参数。

Definition String SD

普通转码模板清晰度标记:

  • LD(流畅)
  • SD(标清)
  • HD(高清)
  • FHD(超清)
  • OD(原画,即转封装)
  • 2K
  • 4K
  • SQ(普通音质)
  • HQ(高音质)

窄带高清1.0内置转码模板清晰度标记:

  • LD-NBV1(流畅)
  • SD-NBV1(标清)
  • HD-NBV1(高清)
  • FHD-NBV1(超清)
  • 2K-NBV1
  • 4K-NBV1
说明
  • 所有转码模板不支持清晰度标记修改。
  • 窄带高清1.0转码模板音视频分辨率、码率等参数为系统内置,不支持修改。
  • 窄带高清1.0转码模板创建只支持FLV、M3U8(HLS)、MP4格式。
PackageSetting String "PackageType":"HLSPackage","PackageConfig":{ "BandWidth":"900000" }

打包配置。仅支持HLS自适应码流打包、DASH打包(JSON字符串)。

SubtitleList String [{"SubtitleUrl":"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass","CharEncode":"utf-8"}]

字幕配置 (JSON字符串)。

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

转码的分片设置参数。HLS必传(JSON字符串)。

WatermarkIds Array of String "USER_DEFAULT_WATERMARK","ddddddddd"

关联的水印ID。

示例

请求示例

https://vod.{ApiRegion}.aliyuncs.com/?Action=GetTranscodeTemplateGroup
&TranscodeTemplateGroupId=a591f697c7167*****6ae1502142d0
&<公共请求参数>

正常返回示例

XML格式

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

<GetTranscodeTemplateGroupResponse>
<RequestId>6730AC93-7B12-4B*****7F-49EE1FE8BC49</RequestId>
<TranscodeTemplateGroup>
    <IsDefault>NotDefault</IsDefault>
    <Locked>Enabled</Locked>
    <ModifyTime>2018-12-12T11:20:51Z</ModifyTime>
    <AppId>app-****</AppId>
    <TranscodeTemplateGroupId>a59b11f697c716*****6ae1502142d0</TranscodeTemplateGroupId>
    <TranscodeMode>FastTranscode</TranscodeMode>
    <TranscodeTemplateList>
        <TailSlateList>[{"TailUrl":"http://outin-test.oss-cn-shanghai.aliyuncs.com/tailslates/b6e9ceed-b665-426f-9d9a-277f0f****.mov"}]</TailSlateList>
        <PackageSetting>"PackageType":"HLSPackage","PackageConfig":{   "BandWidth":"900000"  }</PackageSetting>
        <Rotate>90</Rotate>
        <UserData>{}</UserData>
        <Definition>SD</Definition>
        <TranscodeFileRegular>{MediaId}/transcoce_1</TranscodeFileRegular>
        <EncryptSetting>"EncryptType":"Private"</EncryptSetting>
        <Clip>{\"TimeSpan\":{\"Seek\":\"1\",\"Duration\":\"5\"}</Clip>
        <Type>Normal</Type>
        <Container>"Format":"m3u8"</Container>
        <TranscodeTemplateId>696d29a11erc057*****a3acc398d02f4</TranscodeTemplateId>
        <TransConfig>{"IsCheckReso":"true","IsCheckResoFail":"false","IsCheckVideoBitrate":"false","IsCheckVideoBitrateFail":"false","IsCheckAudioBitrate":"false","IsCheckAudioBitrateFail":"false"}</TransConfig>
        <Video>{"Codec":"H.264","Bitrate":"900","Width":"960","Remove":"false","Fps":"30"}</Video>
        <TemplateName>test</TemplateName>
        <SubtitleList>[{"SubtitleUrl":"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass","CharEncode":"utf-8"}]</SubtitleList>
        <Audio>{\"Codec\":\"AAC\",\"Remove\":\"false\",\"Bitrate\":\"44\",\"Samplerate\":\"32000\",\"Channels\":\"2\",\"Profile\":\"aac_low\"}</Audio>
        <MuxConfig>"Segment": { "Duration":"6" }</MuxConfig>
        <OpeningList>[{"OpenUrl":"http://outin-test.oss-cn-shanghai.aliyuncs.com/tailslates/b6e9ceed-b665-426f-9d9a-277f0f****.mov"}]</OpeningList>
    </TranscodeTemplateList>
    <TranscodeTemplateList>
        <WatermarkIds>"USER_DEFAULT_WATERMARK","ddddddddd"</WatermarkIds>
    </TranscodeTemplateList>
    <CreationTime>2018-12-12T10:20:51Z</CreationTime>
    <Name>test</Name>
</TranscodeTemplateGroup>
</GetTranscodeTemplateGroupResponse>

JSON格式

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

{
  "RequestId" : "6730AC93-7B12-4B*****7F-49EE1FE8BC49",
  "TranscodeTemplateGroup" : {
    "IsDefault" : "NotDefault",
    "Locked" : "Enabled",
    "ModifyTime" : "2018-12-12T11:20:51Z",
    "AppId" : "app-****",
    "TranscodeTemplateGroupId" : "a59b11f697c716*****6ae1502142d0",
    "TranscodeMode" : "FastTranscode",
    "TranscodeTemplateList" : [ {
      "TailSlateList" : "[{\"TailUrl\":\"http://outin-test.oss-cn-shanghai.aliyuncs.com/tailslates/b6e9ceed-b665-426f-9d9a-277f0f****.mov\"}]",
      "PackageSetting" : "\"PackageType\":\"HLSPackage\",\"PackageConfig\":{   \"BandWidth\":\"900000\"  }",
      "Rotate" : "90",
      "UserData" : "{}",
      "Definition" : "SD",
      "TranscodeFileRegular" : "{MediaId}/transcoce_1",
      "EncryptSetting" : "\"EncryptType\":\"Private\"",
      "Clip" : "{\\\"TimeSpan\\\":{\\\"Seek\\\":\\\"1\\\",\\\"Duration\\\":\\\"5\\\"}",
      "Type" : "Normal",
      "Container" : "\"Format\":\"m3u8\"",
      "TranscodeTemplateId" : "696d29a11erc057*****a3acc398d02f4",
      "TransConfig" : "{\"IsCheckReso\":\"true\",\"IsCheckResoFail\":\"false\",\"IsCheckVideoBitrate\":\"false\",\"IsCheckVideoBitrateFail\":\"false\",\"IsCheckAudioBitrate\":\"false\",\"IsCheckAudioBitrateFail\":\"false\"}",
      "Video" : "{\"Codec\":\"H.264\",\"Bitrate\":\"900\",\"Width\":\"960\",\"Remove\":\"false\",\"Fps\":\"30\"}",
      "TemplateName" : "test",
      "SubtitleList" : "[{\"SubtitleUrl\":\"http://outin-test.oss-cn-shanghai.aliyuncs.com/subtitles/c737fece-14f1-4364-b107-d5f7f8edde0e.ass\",\"CharEncode\":\"utf-8\"}]",
      "Audio" : "{\\\"Codec\\\":\\\"AAC\\\",\\\"Remove\\\":\\\"false\\\",\\\"Bitrate\\\":\\\"44\\\",\\\"Samplerate\\\":\\\"32000\\\",\\\"Channels\\\":\\\"2\\\",\\\"Profile\\\":\\\"aac_low\\\"}",
      "MuxConfig" : "\"Segment\": { \"Duration\":\"6\" }",
      "OpeningList" : "[{\"OpenUrl\":\"http://outin-test.oss-cn-shanghai.aliyuncs.com/tailslates/b6e9ceed-b665-426f-9d9a-277f0f****.mov\"}]"
    }, {
      "WatermarkIds" : "\"USER_DEFAULT_WATERMARK\",\"ddddddddd\""
    } ],
    "CreationTime" : "2018-12-12T10:20:51Z",
    "Name" : "test"
  }
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

InvalidTranscodeTemplateGroup.NotFound

The transcode template group does not exist.

404

指定的转码模板组不存在。

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参考如下: