创建或更新转码模板

更新时间不可用

创建或更新指定 App ID 下的转码模板。

POST
https://api.sd-rtn.com/v1/projects/{appId}/rtls/abr/config/codecs/{codecId}

创建或更新指定 App ID 下的转码模板。

  • 发起请求创建转码模板时,Body 中所有字段都是必填。
  • 创建后,如果你想更新转码模板,可以再次发起请求。更新视频属性时,你需要填写完整的 video object,不能只填写 video object 中的单个字段。

鉴权

Basic Auth

声网云端转码 RESTful API 仅支持 HTTPS 协议。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成 Base64 编码凭证,并填入请求头部的 Authorization 字段中。详见实现 HTTP 基本认证。

API Key

HTTP HMAC 认证:每次发送 HTTP 请求时,都必须在请求 Header 部填入 Authorization 字段。关于如何生成该字段的值,请参考实现 HTTP HMAC 认证。

路径参数

codecIdstring
必填

转码模板的 ID。字符串长度不超过 64 字节,支持的字符集范围(共 89 个字符)如下:

  • 26 个小写英文字母 a~z
  • 26 个大写英文字母 A~Z
  • 10 个数字 0~9
  • 空格
  • !、#、$、%、&、(、)、+、-、:、;、<、=、.、>、?、@、[、]、^、_、{、}、|、~、,

用法说明:假设你在频道名为 channel 的频道中开启观众端多码率功能,并且创建转码模板,设置转码模板 ID 为 codecId。那么,观众端进入对应的 channel_codecId 频道即可订阅经过转码模板处理过的多码率主播流。

appIdstring
必填

声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。一个 App ID 是一个项目的唯一标识。

请求 Header

Content-Typestring
必填

application/json

请求 Body

字段
enabledboolean
必填

是否开启该转码模版:

  • true:开启该模板。
  • false:不开启该模板。
widthnumber
必填

转码输出视频的宽度 (px)。

heightnumber
必填

转码输出视频的高度 (px)。

fpsnumber
必填

转码输出视频的帧率 (fps)。

响应

如果状态码为 200,则请求成功。

响应 Body

statusstring

本次请求的状态:

  • success:请求成功。
  • error:请求失败。

请求示例

Example Request
curl --request POST \
  --url "https://api.sd-rtn.com/v1/projects/:appId/rtls/abr/config/codecs/:codecId" \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json'

响应示例

{
  "status": "本次请求的状态:\n- `success`:请求成功。\n- `error`:请求失败。\n"
}