更新流配置模板
更新时间不可用
更新已创建的流配置模板。
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/stream-templates/{templateId}注意
- 该接口只能在流配置模板已经存在的情况下调用。
- 流配置模板的修改只有在重新推流后才会生效，且考虑到网关与数据库之间的同步延迟，请在调用该接口 3 分钟后再重新推流。
鉴权
regionstring使用 RTMP 网关的区域。声网支持分区域创建推流码，目前支持以下区域：
cn：中国大陆ap：除中国大陆以外的亚洲区域na：北美eu：欧洲
注意
- 请确保设置的
region与输入的源流在同一个区域。 - 请确保设置的
region与推流使用的域名在同一个区域。 - 请确保传入
region的值为小写。
appIdstring声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
templateIdstring流配置模板 ID。取值只能为 a-z，A-Z，0-9，且长度不能超过 12 个字节。流配置模板 ID 的值，可根据业务场景需求设置。比如可以根据目标分辨率的不同取值为 "720p", "1080p"；也可以根据不同的游戏场景取值为 "gameA"，"gameB" 等等。
X-Request-IDstring本次请求的 UUID（通用唯一识别码）。传入该字段后，声网服务器会在响应 Header 中返回该字段。声网推荐你对 X-Request-ID 赋值。如果不赋值，声网服务器会自动生成一个 UUID 传入。
请求包体为 JSON Object 类型的 settings 字段。
注意
- 为确保请求成功，请不要将必填字段设为
null或""。 - 更新支持的最小单元为：
transcoding.videotranscoding.audiojitterBuffer举例来说，如果只希望更新transcoding.video中的fps字段，也需要再次传入整个transcoding.video，仅修改fps字段，其他字段保持不变一起传入。不能单独传入fps字段。
transcoding.video、transcoding.audio、jitterBuffer之间相互独立，互不影响。如果只传入transcoding.video，那么就只会更新它的参数，不会影响transcoding.audio和jitterBuffer的参数值。
音视频转码参数配置。
视频转码参数。
enabledboolean是否开启视频转码，默认关闭。
modestring转码模式。
force（默认）：强制开启转码。adaptive：自适应开启转码。- 当源流有 B 帧时，则开启转码。
- 如果推流开始的 2 秒内有 B 帧，则以转码模式开始推流。
- 如果推流中途出现 B 帧，则先以不转码模式推流，待有 B 帧后再切换为转码模式，切换过程观众端会感知到主播先暂停发流，再恢复发流。
codecstring转码的编解码格式。支持取值：H.264，VP8。
widthnumber视频编码宽度，单位为 px。如不填或填 0，则跟随源流的宽度。
heightnumber视频编码高度，单位为 px。如不填或填 0，则跟随源流的高度。
注意
width 和 height 需要同时填入或同时都不填，目前暂不支持只填其中 1 个。
fpsnumber视频编码帧率，单位为 fps。如不填或填 0，则跟随源流的帧率。
bitratenumber视频编码码率，单位为 Kbps。
- 如果开启小流（提供下面的
simulcastStream），则该字段为必填，且要保证值大于simulcastStream.bitrate。 - 如果未开启小流（不提供
simulcastStream），则该字段为选填。如果不填，会跟随源流码率；如果填0，会根据width、height和fps三个字段的值自动匹配声网推荐的码率，详见常用视频属性。建议
在不开启小流的情况下，建议使用自动匹配的码率，无需自行设置码率。
视频小流配置项。如果提供，则开启小流，并指定小流的转码参数。
widthnumber视频小流的宽度，单位为 px。该参数的值需要小于上面 video.width 的值。如不填或填 0，则采用 video.width ÷ 2 的值。
heightnumber视频小流的高度，单位为 px。该参数的值需要小于上面 video.height 的值。如不填或填 0，则采用 video.height ÷ 2 的值。
fpsnumber视频小流的帧率，单位为 fps。该参数的值需要小于等于 video.fps 的值。如不填或填 0，则使用 15 作为默认值。
bitratenumber视频小流的码率，单位为 Kbps。该参数的值需要小于上面 video.bitrate 的值。如果不填或填 0，则根据 video.bitrate、小流的分辨率和 fps，自动计算声网推荐码率。
注意
当开启小流且指定小流 bitrate 时，需要同时指定 video.bitrate。
音频转码参数。
enabledboolean是否开启音频转码，默认开启。
profilenumber编码音频场景。默认值为 0，表示 48 KHz 采样率、音乐编码、单声道、编码码率最大值为 64 Kbps。如果要设置其他 profile，请联系技术支持。
bitratenumber编码码率，单位为 Kbps。如果不填，则码率由 profile 的值确定。
网络抖动缓冲，仅在开启视频转码时生效。
sizenumberjitterBuffer 的数据长谷，单位 ms。默认值为 500，表示 RTMP 网关会增加 500 ms 的端到端延迟，以降低网络抖动带来的卡顿。
maxSizenumberjitterBuffer 的最大长度，单位 ms，默认值为1000。请确保该字段的值大于 jitterBuffer.size。当 jitterBuffer 长度超过此值时，网关就会开启加速，直到恢复至 jitterBuffer.size。
响应
请求示例
curl --request PATCH \
--url "https://api.sd-rtn.com/:region/v1/projects/:appId/rtls/ingress/stream-templates/:templateId" \
--header 'Authorization: Basic <credentials>' \
--header 'X-Request-ID: <string>' \
-H 'Content-Type: application/json' \
-d '{
"settings": {
"transcoding": {
"video": {
"enabled": true,
"codec": "H.264",
"width": 1280,
"height": 720,
"fps": 24,
"bitrate": 2200,
"simulcastStream": {
"width": 960,
"height": 540,
"fps": 24,
"bitrate": 1670
}
}
}
}
}'响应示例
{
"message": "string"
}