设置全局流配置模板
更新时间不可用
为指定 App ID 设置全局流配置模板。
PUT
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/appconfig注意
调用该接口前,必须有一个已创建的模板,可参考创建或重置流配置模板 API 来创建模板。
鉴权
regionstring必填
使用 RTMP 网关的区域。声网支持分区域创建推流码,目前支持以下区域:
cn:中国大陆ap:除中国大陆以外的亚洲区域na:北美eu:欧洲
注意
- 请确保设置的
region与输入的源流在同一个区域。 - 请确保设置的
region与推流使用的域名在同一个区域。 - 请确保传入
region的值为小写。
appIdstring必填
声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
X-Request-IDstring本次请求的 UUID(通用唯一识别码)。传入该字段后,声网服务器会在响应 Header 中返回该字段。声网推荐你对 X-Request-ID 赋值。如果不赋值,声网服务器会自动生成一个 UUID 传入。
请求包体为 JSON Object 类型的 settings 字段。
defaultStreamTemplatestring流配置模板 ID,必须已经创建。
如果将 defaultStreamTemplate 的值设为 null,那么会清除之前为该 App ID 设置的全局流配置模板。该 App ID 下的所有推流都将按照无模板设置进行,即默认不开启视频转码。
说明
针对使用过 Beta 版本的用户:在 Beta 版本中,此 API 还可以设置 transcoding 转码参数,现在建议你改用创建或重置流配置模板 API 设置。
注意
如果你之前使用此 API 设置过 transcoding,目前的生效机制如下:
- 如果现在重新设置
defaultStreamTemplate,那么之前通过此 API 设置的transcoding就会自动失效,以新模板中的参数为准。 - 如果现在不设置新的
defaultStreamTemplate,那么之前通过此 API 设置的transcoding仍会保留,作为此 App ID 的默认全局配置参数。
响应
请求示例
curl --request PUT \
--url "https://api.sd-rtn.com/:region/v1/projects/:appId/rtls/ingress/appconfig" \
--header 'Authorization: Basic <credentials>' \
--header 'X-Request-ID: <string>' \
--header 'Content-Type: application/json'响应示例
{
"message": "string"
}