SearchTemplate - 搜索自定义转码模板 - 媒体处理

搜索指定状态的自定义模板。

接口说明

本接口通过搜索转码模板状态搜索自定义模板。

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
mts:SearchTemplate	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
PageSize	long	否	结果分页查询时设置的每页大小。上限值：100。默认值：10。	10
PageNumber	long	否	当前页号。默认值：1。	1
State	string	否	需要搜索的转码模板状态。 All 表示所有。 Normal 表示正常。 Deleted 表示已删除。默认值：All。	Normal
NamePrefix	string	否	按模板名称前缀搜索时填入的前缀。	S00000001

返回参数

名称	类型	描述	示例值
	object	返回参数。
TotalCount	long	搜索结果总条数。	1
TemplateList	array<object>	转码模板列表。
Template	object	转码模板。
Video	object	视频编解码配置。
Bufsize	string	缓冲区大小。单位：Kb。默认值：6000。	6000
LongShortMode	string	是否开启横竖屏自适应（即：长短边模式）。转码输出的宽对应输入片源的长边（竖屏为片源的高），高对应输入视频的短边（竖屏为片源的宽）。 true 表示开启。 false 表示关闭。默认值：false。	false
Degrain	string	视频质量控制度。	10
BitrateBnd	object	视频平均码率范围。
Max	string	总码率上限。单位：Kbps。	500
Min	string	总码率下限。单位：Kbps。	100
PixFmt	string	视频颜色格式。范围：yuv420p，yuvj420p 等标准颜色格式。	yuv420p
Pad	string	视频贴黑边。参数格式：width:height:left:top。示例：1280:800:0:140。	1280:800:0:140
Codec	string	编解码格式。可选值 H.264、H.265。默认值：H.264。	H.264
Height	string	视频高。单位：px。默认值：视频原始高度。	800
Qscale	string	独立去噪算法强度。	1
Crop	string	视频画面裁切。自动检测黑边并裁切：设置为“border”。自定义裁切：自定义参数并裁剪。参数格式：width:height:left:top。示例：1280:800:0:140。	border
Bitrate	string	视频平均码率。单位：Kbps。	200
Maxrate	string	视频码率峰值。单位：Kbps。	500
NarrowBand	object	窄带高清设置参数。
Abrmax	float	动态码率上限，设置后平均码率范围 (0, 1000000]。	3000
MaxAbrRatio	float	码率上限最大倍率，设置后 Abrmax 值不会超过视频源码率的 x 倍。范围 (0, 1.0]。	1.0
Version	string	窄带高清版本，可选值：1.0 。	1.0
MaxFps	string	最大帧率。	60
Profile	string	编码级别。 baseline：针对移动设备。 main：针对标准分辨率设备。 high：针对高分辨率设备。默认值：high。	high
Crf	string	码率-质量控制因子。默认值：编码格式为 H264，默认值为 23。编码格式为 H265，默认值为 26。如果设置了 Crf，则 Bitrate 的设置失效。	15
Remove	string	是否删除视频流。 true 表示删除。 false 表示保留。默认值：false。	false
Gop	string	关键帧间最大帧数。默认值：250。	10
Width	string	视频宽。取值范围：[128,4096]。单位：px。默认值：视频原始宽度。	256
Fps	string	帧率。当输入文件帧率超过 60 时取 60。默认值：取输入文件帧率。	25
Preset	string	视频算法器预置。默认值：medium。可选值： veryfast：超快。 fast：快。 medium：中等。 slow：慢。 slower：超慢。	medium
ScanMode	string	扫描模式。可选值： interlaced：交叉扫描。 progressive：顺序扫描。	interlaced
ResoPriority	string	分辨率调整优先级。	1
Hdr2sdr	string	是否开启 hdr2sdr 功能。启用时会把 hdr 的视频转成 sdr。	true
TransConfig	object	转码通用配置。
IsCheckAudioBitrate	string	是否检查音频码率。当输出音频码率大于媒体源音频码率时，则视为输出音频码率等于媒体源音频码率，即设置的音频码率参数不会生效。此值优先级小于 IsCheckAudioBitrateFail。 true 表示检查。 false 表示不检查。默认值：参数为空，并且 codec 和输入源不一样：false。参数为空，并且 codec 和输入源一样：true。	false
TransMode	string	转码模式。默认值：onepass。可选值： onepass twopass CBR	onepass
IsCheckReso	string	是否检查分辨率。如果输出分辨率大于输入分辨率（判断条件是宽或高），则输出分辨率等于输入分辨率。 true 表示检查。 false 表示不检查。默认值：false。	false
IsCheckVideoBitrateFail	string	是否允许视频码率检查错误。此值优先级大于 IsCheckVideoBitrate。 true 表示检查出错时不进行转码。 false 表示不检查。默认值：false。	false
AdjDarMethod	string	分辨率改写方式。默认值：none。可选值： rescale：范围拉伸。 crop：批量裁剪。 none：不改变。	none
IsCheckVideoBitrate	string	是否检查视频码率。如果视频输出码率大于视频输入码率，则视频输出码率等于视频输入码率。 true 表示检查。 false 表示不检查。默认值：false。	false
IsCheckResoFail	string	是否检查分辨率。如果输出分辨率大于输入分辨率（判断条件是宽或高），则返回转码失败。 true 表示检查。 false 表示不检查。默认值：false。	false
IsCheckAudioBitrateFail	string	是否允许音频码率检查错误。此值优先级大于 IsCheckAudioBitrate。 true 表示检查出错时不进行转码。 false 表示不检查。默认值：false。	false
State	string	模板的状态。 Normal：正常。 Deleted：已删除。	Normal
MuxConfig	object	转码封包配置。
Gif	object	Gif 对应的封包配置。
FinalDelay	string	终帧暂停时间，单位厘秒（cs）。	0
DitherMode	string	调色板颜色抖动方式。可选的抖动算法为 sierra 算法和 bayer 算法。	sierra
Loop	string	循环次数。	0
IsCustomPalette	string	自定义调色板功能。	false
Segment	object	切片配置。
Duration	string	分片时长。单位：秒。	10
Name	string	模板名称。	MPS-example
Audio	object	音频编解码配置。
Profile	string	音频编码预置。当 Codec 为 aac 时可选值： aac_low aac_he aac_he_v2 aac_ld aac_eld	aac_low
Remove	string	是否删除音频流。 true 表示删除。 false 表示保留。默认值：false。	false
Codec	string	音频编解码格式。默认值：aac。可选值： aac mp3 vorbis flac	aac
Samplerate	string	采样率。单位：Hz。默认值：44100。	44100
Qscale	string	独立去噪算法强度。取值：[1,9]。	1
Channels	string	声道数。默认值：2。	2
Bitrate	string	输出文件的音频码率。单位：Kbps。默认值：128。	500
Id	string	转码模板 ID。	16f01ad6175e4230ac42bb5182cd****
Container	object	容器。
Format	string	容器格式。可选值： flv mp4 ts m3u8 gif mp3 ogg flac	mp4
CreationTime	string	模板创建时间。	2021-03-04T06:44:43Z
PageSize	long	分页查询时设置的每页大小。	10
RequestId	string	请求 ID。	BC860F04-778A-472F-AB39-E1BF329C****
PageNumber	long	当前页码。	1

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "TemplateList": {
    "Template": [
      {
        "Video": {
          "Bufsize": "6000",
          "LongShortMode": "false",
          "Degrain": "10",
          "BitrateBnd": {
            "Max": "500",
            "Min": "100"
          },
          "PixFmt": "yuv420p",
          "Pad": "1280:800:0:140",
          "Codec": "H.264",
          "Height": "800",
          "Qscale": "1",
          "Crop": "border",
          "Bitrate": "200",
          "Maxrate": "500",
          "NarrowBand": {
            "Abrmax": 3000,
            "MaxAbrRatio": 1,
            "Version": "1.0"
          },
          "MaxFps": "60",
          "Profile": "high",
          "Crf": "15",
          "Remove": "false",
          "Gop": "10",
          "Width": "256",
          "Fps": "25",
          "Preset": "medium",
          "ScanMode": "interlaced",
          "ResoPriority": "1",
          "Hdr2sdr": "true"
        },
        "TransConfig": {
          "IsCheckAudioBitrate": "false",
          "TransMode": "onepass",
          "IsCheckReso": "false",
          "IsCheckVideoBitrateFail": "false",
          "AdjDarMethod": "none",
          "IsCheckVideoBitrate": "false",
          "IsCheckResoFail": "false",
          "IsCheckAudioBitrateFail": "false"
        },
        "State": "Normal",
        "MuxConfig": {
          "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"
        },
        "Id": "16f01ad6175e4230ac42bb5182cd****",
        "Container": {
          "Format": "mp4"
        },
        "CreationTime": "2021-03-04T06:44:43Z"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "BC860F04-778A-472F-AB39-E1BF329C****",
  "PageNumber": 1
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-03-14	OpenAPI 返回结构发生变更	查看变更详情
2024-01-04	OpenAPI 返回结构发生变更	查看变更详情
2023-09-21	OpenAPI 返回结构发生变更	查看变更详情
2023-07-13	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情