文档

QueryTemplateList - 通过自定义模版ID查询转码模板详情

更新时间:

查询转码模板详细信息。

接口说明

本接口一次最多可查询 10 个模板信息。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TemplateIdsstring

需要查询的模板 ID 列表。最多一次查询 10 个,用半角逗号(,)分隔。

16f01ad6175e4230ac42bb5182cd****,88c6ca184c0e424d5w5b665e2a12****

返回参数

名称类型描述示例值
object

返回参数。

NonExistTidsarray

不存在的模板列表。

string

不存在的模板列表,无数据时该参数不返回。

88c6ca184c0e424d5w5b665e2a12****
TemplateListobject []

转码模板列表。

Videoobject

视频编解码配置。

Bufsizestring

缓冲区大小。

  • 单位:Kb。
  • 默认值:6000
6000
LongShortModestring

是否开启横竖屏自适应(即:长短边模式)。

  • 转码输出的宽对应输入片源的长边(竖屏为片源的高),高对应输入视频的短边(竖屏为片源的宽)。
  • true 表示开启。
  • false 表示关闭。
  • 默认值:false
false
Degrainstring

视频质量控制度 。

10
BitrateBndobject

视频平均码率范围。

Maxstring

总码率上限。单位:Kbps。

100
Minstring

总码率下限。单位:Kbps。

500
PixFmtstring

视频颜色格式。范围:yuv420p,yuvj420p 等标准颜色格式。

yuv420p
Padstring

视频贴黑边。参数格式:width:height:left:top。示例:1280:800:0:140。

1280:800:0:140
Codecstring

编解码格式。默认值:H.264

H.264
Heightstring

视频高。

  • 单位:px。
  • 默认值:视频原始高度
800
Qscalestring

独立去噪算法强度。

1
Cropstring

视频画面裁切。

  • 自动检测黑边并裁切:设置为“border”.
  • 自定义裁切:自定义参数并裁剪。参数格式:width:height:left:top。示例:1280:800:0:140。
border
Bitratestring

视频平均码率。单位:Kbps。

200
Maxratestring

视频码率峰值。单位:Kbps。

500
MaxFpsstring

最大帧率。

60
Profilestring

编码级别。

  • baseline:针对移动设备。
  • main:针对标准分辨率设备。
  • high:针对高分辨率设备。
  • 默认值:high
high
Crfstring

码率-质量控制因子。

  • 默认值:编码格式为 H264,默认值为 23。编码格式为 H265,默认值为 26
  • 如果设置了 Crf,则 Bitrate 的设置失效。
15
Removestring

是否删除视频流。

  • true 表示删除。
  • false 表示保留。
  • 默认值:false
false
Gopstring

关键帧间最大帧数。默认值:250

10
Widthstring

宽。

  • 单位:px。
  • 默认值:视频原始宽度
256
Fpsstring

帧率。

  • 当输入文件帧率超过 60 时取 60。
  • 默认值:取输入文件帧率
25
Presetstring

视频算法器预置。支持 veryfast(超快)、fast(快)、medium(中等)、slow(慢)、slower(超慢)。默认值:medium

medium
ScanModestring

扫描模式。可选值:

  • interlaced:交叉扫描。

  • progressive:顺序扫描。

interlaced
ResoPrioritystring

分辨率调整优先级。支持 cropFirst(裁剪优先)、widthFirst(宽度优先)、heightFirst(高度优先)。

heightFirst
TransConfigobject

转码通用配置。

IsCheckAudioBitratestring

是否检查音频码率。当输出音频码率大于媒体源音频码率时,则视为输出音频码率等于媒体源音频码率,即设置的音频码率参数不会生效。此值优先级小于 IsCheckAudioBitrateFail。

  • true 表示检查。
  • false 表示不检查。
  • 默认值:
    • 参数为空,并且 codec 和输入源不一样:false。
    • 参数为空,并且 codec 和输入源一样:true。
false
TransModestring

转码模式。默认值:onepass。可选值:

  • onepass

  • twopass

  • CBR

onepass
IsCheckResostring

是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则输出分辨率等于输入分辨率。

  • true 表示检查。
  • false 表示不检查。
  • 默认值:false
false
IsCheckVideoBitrateFailstring

是否允许视频码率检查错误。此值优先级大于 IsCheckVideoBitrate。

  • true 表示检查出错时不进行转码。
  • false 表示不检查。
  • 默认值:false
false
AdjDarMethodstring

分辨率改写方式。默认值:none。可选值:

  • rescale:范围拉伸。

  • crop:批量裁剪。

  • none:不改变。

none
IsCheckVideoBitratestring

是否检查视频码率。如果视频输出码率大于视频输入码率,则视频输出码率等于视频输入码率。

  • true 表示检查。
  • false 表示不检查。
  • 默认值:false
false
IsCheckResoFailstring

是否检查分辨率。如果输出分辨率大于输入分辨率(判断条件是宽或高),则返回转码失败。

  • true 表示检查。
  • false 表示不检查。
  • 默认值:false
false
IsCheckAudioBitrateFailstring

是否允许音频码率检查错误。此值优先级大于 IsCheckAudioBitrate。

  • true 表示检查出错时不进行转码。
  • false 表示不检查。
  • 默认值:false
false
Statestring

模板的状态。

  • Normal:正常。

  • Deleted:已删除。

Normal
MuxConfigobject

转码封包配置。

Webpobject

Webp 对应的封包配置。

Loopstring

循环次数。

0
Gifobject

Gif 对应的封包配置。

FinalDelaystring

终帧暂停时间。

0
DitherModestring

调色板颜色抖动方式。抖动算法可选值为 sierra 算法和 bayer 算法。

sierra
Loopstring

循环次数。

0
IsCustomPalettestring

自定义调色板功能。

false
Segmentobject

切片配置。

Durationstring

分片时长。单位:秒。

10
Namestring

模板名称。

MPS-example
Audioobject

音频编解码配置。

Profilestring

音频编码预置。当 Codec 为 aac 时可选值:

  • aac_low

  • aac_he

  • aac_he_v2

  • aac_ld

  • aac_eld

aac_low
Removestring

是否删除音频流。

  • true 表示删除。
  • false 表示保留。
  • 默认值:false
false
Codecstring

音频编解码格式。默认值:aac。可选值:

  • aac

  • mp3

  • vorbis

  • flac

aac
Sampleratestring

采样率。

  • 单位:Hz。
  • 默认值:44100
44100
Qscalestring

独立去噪算法强度。

1
Channelsstring

声道数。默认值:2

2
Bitratestring

输出文件的音频码率。

  • 取值范围:[8,1000]
  • 单位:Kbps。
  • 默认值:128
500
Volumeobject

音量控制。

Methodstring

音量调整方式。可取值:

  • auto:自动调整。

  • dynamic:动态调整。

  • linear:线性调整。

  • 默认值:dynamic。

auto
TruePeakstring

最大峰值。

  • 当指定 Method 为 dynamic 时生效。
  • 单位:db。
  • 值范围:[-9,0]。
  • 默认值:-1。
-1
IntegratedLoudnessTargetstring

目标音量。

  • 当指定 Method 为 dynamic 时生效。
  • 单位:db。
  • 值范围:[-70,-5]。
  • 默认值:-6。
-6
LoudnessRangeTargetstring

相对目标音量的波动范围。

  • 当指定 Method 为 dynamic 时生效。
  • 单位:db。
  • 值范围:[1,20]。
  • 默认值:8。
8
Levelstring

相对输入音频的音量提升的幅度。

  • 当指定 Method 为 linear 时生效。
  • 单位:db。
  • 值范围:不超过 20db。
  • 默认值:-20db。
-20
PeakLevelstring

音量调整系数。

当指定 Method 为 adaptive 时生效。

值范围:[0,1]。

默认值:0.9。

Idstring

转码模板 ID。

16f01ad6175e4230ac42bb5182cd****
Containerobject

容器。

Formatstring

容器格式。可选范围 flv、mp4、ts、m3u8、gif、mp3、ogg、flac。

flv
CreationTimestring

模板创建时间。

2021-03-04T06:44:43Z
RequestIdstring

请求 ID。

BC860F04-778A-472F-AB39-E1BF329C1EA8

示例

正常返回示例

JSON格式

{
  "NonExistTids": {
    "String": [
      "88c6ca184c0e424d5w5b665e2a12****"
    ]
  },
  "TemplateList": {
    "Template": [
      {
        "Video": {
          "Bufsize": "6000",
          "LongShortMode": "false",
          "Degrain": "10",
          "BitrateBnd": {
            "Max": "100",
            "Min": "500"
          },
          "PixFmt": "yuv420p",
          "Pad": "1280:800:0:140",
          "Codec": "H.264",
          "Height": "800",
          "Qscale": "1",
          "Crop": "border",
          "Bitrate": "200",
          "Maxrate": "500",
          "MaxFps": "60",
          "Profile": "high",
          "Crf": "15",
          "Remove": "false",
          "Gop": "10",
          "Width": "256",
          "Fps": "25",
          "Preset": "medium",
          "ScanMode": "interlaced",
          "ResoPriority": "heightFirst",
          "Hdr2sdr": ""
        },
        "TransConfig": {
          "IsCheckAudioBitrate": "false",
          "TransMode": "onepass",
          "IsCheckReso": "false",
          "IsCheckVideoBitrateFail": "false",
          "AdjDarMethod": "none",
          "IsCheckVideoBitrate": "false",
          "IsCheckResoFail": "false",
          "IsCheckAudioBitrateFail": "false"
        },
        "State": "Normal",
        "MuxConfig": {
          "Webp": {
            "Loop": "0"
          },
          "Gif": {
            "FinalDelay": "0",
            "DitherMode": "sierra",
            "Loop": "0",
            "IsCustomPalette": "false"
          },
          "Segment": {
            "Duration": "10"
          }
        },
        "Name": "MPS-example",
        "Audio": {
          "Profile": "aac_low",
          "Remove": "false",
          "Codec": "aac",
          "Samplerate": "44100",
          "Qscale": "1",
          "Channels": "2",
          "Bitrate": "500",
          "Volume": {
            "Method": "auto",
            "TruePeak": "-1",
            "IntegratedLoudnessTarget": "-6",
            "LoudnessRangeTarget": "8",
            "Level": "-20",
            "PeakLevel": ""
          }
        },
        "Id": "16f01ad6175e4230ac42bb5182cd****",
        "Container": {
          "Format": "flv"
        },
        "CreationTime": "2021-03-04T06:44:43Z"
      }
    ]
  },
  "RequestId": "BC860F04-778A-472F-AB39-E1BF329C1EA8"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈