产品文档

媒体处理服务

listTranscodeTemplates

描述

查询转码模板列表。 允许通过条件过滤查询,支持的过滤字段如下:

  • transcodeType[eq] 按转码方式精确查询

请求方式

GET

请求地址

https://mps.jdcloud-api.com/v1/transcodeTemplates

请求参数

名称 类型 是否必需 默认值 描述
pageNumber Integer False 1 页码;默认值为 1
pageSize Integer False 10 分页大小;默认值为 10;取值范围 [10, 100]
filters Filter[ ] False

Filter

名称 类型 是否必需 默认值 描述
name String True 过滤器属性名
operator String False 过滤器操作符,默认值为 eq
values String[ ] True 过滤器属性值

返回参数

名称 类型 描述
result Result 查询转码模板列表信息结果
requestId String 请求ID

Result

名称 类型 描述
pageNumber Integer 当前页码
pageSize Integer 每页数量
totalElements Integer 查询总数
totalPages Integer 总页数
content TranscodeTemplateInfo[ ] 分页内容

TranscodeTemplateInfo

名称 类型 描述
templateId String 模板ID
title String 模板标题。长度不超过 128 个字符,最少 2 个字符。UTF-8 编码。
video VideoStreamSettings 视频参数配置
audio AudioStreamSettings 音频参数配置
container ContainerSettings 容器设置
encryption EncryptionSettings 加密配置
definition String 清晰度规格标记。取值范围:
SD - 标清
HD - 高清
FHD - 超清
2K
4K
transcodeType String 转码方式。取值范围:
normal - 普通转码
jdchd - 京享超清
jdchs - 极速转码
createTime String 创建时间
updateTime String 修改时间

EncryptionSettings

名称 类型 描述
hlsKey String HLS加密公钥,按指定编码方式编码
必须为 16 字节值,按照 hlsKeyEncodeType 所指定的编码方式进行编码后的字符串
hlsKeyUrl String HLS加密公钥地址,仅支持HTTP(s)地址
若 hlsKey 已设置,则表示开启 HLS 加密,此时为必须参数
hlsKeyEncodeType String HLS加密公钥编码方式。取值范围:base16, base32, base64
若 hlsKey 已设置,则表示开启 HLS 加密,此时为必须参数

ContainerSettings

名称 类型 描述
format String 输出的音视频文件封装格式。取值范围:mp4、hls、flv

AudioStreamSettings

名称 类型 描述
codec String 音频编码。取值范围:aac 。目前仅支持 acc
bitrate Integer 音频目标码率。取值范围:[8, 1000],单位为 Kbps
sampleRate Integer 音频采样率。
若容器封装格式为 flv ,该字段为必须参数,其取值范围:22050、44100
若容器封装格式不为 flv ,则此字段为非必须参数,未设置时,与源文件音频采样率保持一致,若设置值,其取值范围:22050、24000、32000、44100、48000、64000、88200、96000
channels Integer 音频声道数。取值范围:1、2 。默认值为 2
comfortable Boolean 是否开启舒适音频。取值范围:true、false,默认值为 true

VideoStreamSettings

名称 类型 描述
codec String 视频编码。取值范围:h264、h265
rcmode String 码率控制模式。取值范围:
crf - 恒定码率系数模式。设置此模式时,rateFactor 生效,bitrate 会被忽略
abr - 平均码率模式。设置此模式时,bitrate 生效,rateFactor 会被忽略
默认值为 abr
rateFactor String 码率控制因子。取值范围:[0, 51],支持2位小数的浮点数
当 codec 为 h264 时,默认值为 23;当 codec 为 h265 时,默认值为 28
bitrate Integer 视频码率。取值范围:[128, 10000],单位为 Kbps
frameRate Integer 视频帧率。取值范围:[1, 60],单位为 fps
未设置时,与源文件视频帧率保持一致
width Integer 视频输出宽度。取值范围:[128, 4096] 整数。单位为 px
未设置时,若 height 也未设置值,则 width 和 height 与原视频保持一致;若 height 设置值,则 width 按照原视频的分辨率等比缩放
height Integer 视频输出高度。取值范围:[128, 4096] 整数。单位为 px
未设置时,若 width 也未设置值,则 width 和 height 与原视频保持一致;若 width 设置值,则 height 按照原视频的分辨率等比缩放

返回码

返回码 描述
200 OK
400 Invalid parameter
401 Authentication failed
500 Internal server error
503 Service unavailable

请求示例

GET

https://mps.jdcloud-api.com/v1/transcodeTemplates?pageNumber=1&pageSize=10&filters.1.name=transcodeType&filters.1.values.1=jdchd&filters.1.operator=eq

返回示例

{
    "requestId": "bgvmivir54gddpgi764se9f4kfr7ge41", 
    "result": {
        "content": [
            {
                "audio": {
                    "bitrate": 256, 
                    "channels": 2, 
                    "codec": "aac", 
                    "comfortable": true, 
                    "sampleRate": 44100
                }, 
                "container": {
                    "format": "mp4"
                }, 
                "createTime": "2019-04-16T15:51:32Z", 
                "definition": "HD", 
                "encryption": {
                    "hlsKey": "5ZSv5pyJ5YyX6bG877yM5Q==", 
                    "hlsKeyEncodeType": "base64", 
                    "hlsKeyUrl": "https://example.com/hlsenc.key"
                }, 
                "templateId": 10001, 
                "title": "我的转码模板", 
                "transcodeType": "jdchd", 
                "updateTime": "2019-04-16T15:51:32Z", 
                "video": {
                    "bitrate": 1024, 
                    "codec": "h264", 
                    "frameRate": "25", 
                    "height": 240, 
                    "rateFactor": "23", 
                    "width": 320
                }
            }
        ], 
        "pageNumber": 1, 
        "pageSize": 10, 
        "totalElements": 100, 
        "totalPages": 10
    }
}
更新时间:2020-05-09 10:43:02