为指定发布点创建自定义转码模版。
POST https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/transcode/custom?id={name}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
name |
String | 必填。自定义转码模版的名字。不能与预置转码模版的 name 相同,否则会报错。 |
请求包体为 JSON Object 类型,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
width |
Integer | 必填。视频的宽,取值范围 [0,1920],0 表示按原视频比例自适应。 |
height |
Integer | 必填。视频的高,取值范围 [0,1920],0 表示按原视频比例自适应。 |
videoCodec |
String | 选填。视频编码格式,目前只支持 H.264。如果 videoBitrate 和 profile 指定了值,该字段必填。 |
videoBitrate |
Integer | 选填。视频码率(bit/s),取值范围 [200,6000]。 |
profile |
String | 选填。编码级别,每个级别对应一组特定的编码参数。一般来说级别越高,画面质量越好,同时编解码消耗的资源也越高。取值包括:base :基础级别,适合移动设备。main :标准级别,适合标准分辨率设备。high :高等级别,适合高分辨率设备。 |
audioCodec |
String | 选填。音频编码格式,目前只支持 AAC。如果指定了 audioBitrate 和 audioSampleRate ,该字段必填。 |
audioBitrate |
Integer | 选填。音频码率(bit/s),取值范围 [100,500]。 |
audioSampleRate |
Integer | 选填。音频采样率(Hz),取值包括:96000、88200、64000、48000、44100、32000、16000。 |
advancedTranscode |
Boolean | 选填。是否开启低码高清服务。低码高清服务可以在主观画质不受影响的前提下平均降低 50% 码率,详见低码高清产品概述。 |
如果返回的 HTTP 状态码为 200,表示请求成功。
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
POST https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/transcode/custom?id={name} HTTP/1.1
请求 body
{
"width": 0,
"height": 360,
"videoCodec": "h264",
"videoBitrate": 1200,
"profile": "base",
"audioCodec": "aac",
"audioBitrate": 320,
"audioSampleRate": 44100,
"advancedTranscode": true
}
响应行
HTTP/1.1 200 OK
更新指定发布点的自定义转码模版。
PATCH https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/transcode/custom/{name}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
name |
String | 必填。自定义转码模版的名称。 |
请求包体为 JSON Object 类型,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
width |
Integer | 选填。视频的宽,取值范围 [0,1920],0 表示按原视频比例自适应。如果指定了 height ,该字段必填。 |
height |
Integer | 选填。视频的高,取值范围 [0,1920],0 表示按原视频比例自适应。如果指定了 width ,该字段必填。 |
videoCodec |
String | 选填。视频编码格式,目前只支持 H.264。如果 videoBitrate 和 profile 指定了值,该字段必填。 |
videoBitrate |
Integer | 选填。视频码率(bit/s),取值范围 [200,6000]。 |
profile |
String | 选填。编码级别,每个级别对应一组特定的编码参数。一般来说级别越高,画面质量越好,同时编解码消耗的资源也越高。取值包括:base :基础级别,适合移动设备。main :标准级别,适合标准分辨率设备。high :高等级别,适合高分辨率设备。 |
audioCodec |
String | 选填。音频编码格式,目前只支持 AAC。如果指定了 audioBitrate 和 audioSampleRate ,该字段必填。 |
audioBitrate |
Integer | 选填。音频码率(bit/s),取值范围 [100,500]。 |
audioSampleRate |
Integer | 选填。音频采样率(Hz),取值包括:96000、88200、64000、48000、44100、32000、16000。 |
advancedTranscode |
Boolean | 选填。是否开启低码高清服务。低码高清服务可以在主观画质不受影响的前提下平均降低 50% 码率,详见低码高清产品概述。 |
如果返回的 HTTP 状态码为 200,表示请求成功。
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
PATCH https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/transcode/custom/{name} HTTP/1.1
请求 body
{
"width": 0,
"height": 360,
"videoCodec": "h264",
"videoBitrate": 1200,
"profile": "base",
"audioCodec": "aac",
"audioBitrate": 320,
"audioSampleRate": 44100,
"advancedTranscode": true
}
响应行
HTTP/1.1 200 OK
删除指定发布点的自定义转码模版。
DELETE https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/transcode/custom/{name}
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
name |
String | 必填。自定义转码模版的名称。 |
如果返回的 HTTP 状态码为 200,表示请求成功。
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
DELETE https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/transcode/custom/{name} HTTP/1.1
响应行
HTTP/1.1 200 OK
获取指定发布点的自定义转码模版列表。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/transcode/custom
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
name |
String | 必填。自定义转码模版的名称。 |
如果返回的 HTTP 状态码为 200,表示请求成功。响应包体中包含以下字段:
transcodeList
:JSON Array 型,该发布点的自定义转码模版列表。一个自定义转码模版对应一个 JSON Object,包含以下字段:字段 | 类型 | 描述 |
---|---|---|
name |
String | 必填。转码模版的名称。 |
width |
Integer | 必填。视频的宽。 |
height |
Integer | 必填。视频的高。 |
videoCodec |
String | 选填。视频编码格式,目前只支持 H.264。 |
videoBitrate |
Integer | 选填。视频码率(bit/s)。 |
profile |
String | 选填。编码级别。base :基础级别,适合移动设备。main :标准级别,适合标准分辨率设备。high :高等级别,适合高分辨率设备。 |
audioCodec |
String | 选填。音频编码格式,目前只支持 AAC。 |
audioBitrate |
Integer | 选填。音频码率(bit/s)。 |
audioSampleRate |
Integer | 选填。音频采样率(Hz)。 |
advancedTranscode |
Boolean | 选填。低码高清服务是否已经开启。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/transcode/custom HTTP/1.1
响应 body:
{
"transcodeList": [
{
"name": "{your_transcode_name}",
"width": 0,
"height": 360,
"videoCodec": "h264",
"videoBitrate": 1200,
"profile": "base",
"audioCodec": "aac",
"audioBitrate": 320,
"audioSampleRate": 44100,
"advancedTranscode": true
}
]
}
响应行
HTTP/1.1 200 OK
状态码 | 描述 |
---|---|
200 | 请求成功。 |
400 | 参数非法,如 appid 或者 name 为空。 |
401 | 未经授权(客户 ID/客户密钥匹配错误)。 |
404 | 服务器无法根据请求找到资源,即请求的发布点不存在,或者请求的 URI 路径非法。 |
500 | 服务器内部错误,无法完成请求。 |
504 | 服务器内部错误。充当网关或代理的服务器未从远端服务器获取请求。 |