低码高清快速开始

简介

Agora 为 CDN 直播推流场景研发出低码高清服务，用于接收并处理你的 RTMP 流。经过 Agora 低码高清服务处理后，RTMP 流可以在同等视频清晰度下使用更低的视频码率，也可以在同等码率下提升视频画质。

CDN 直播推流时，你往往需要在推流工具或 API 中填写用于推流的 RTMP URL。联系 sales@agora.io 开通低码高清服务后，请参考如下步骤进行推流：

1. 使用低码高清 RESTful API，在请求 Body 中填入你的原始推流 RTMP URL，从响应 Body 中获得相应的新 RTMP URL。
2. 在你使用的推流工具或 API 中填写新的 RTMP URL，以发起推流。

HTTP 请求

POST https://api.sd-rtn.com/v1/projects/<appId>/rtmp-pusher

或

POST https://api.sd-rtn.com/v1/projects/<appId>/rtmp-pusher?streamIp={streamIp}

请求报文的 Header 字段

• Content-Type: application/json
• X-Request-ID: UUID（通用唯一识别码），标识本次请求。传入该字段后，Agora 服务器会在响应 Header 中返回该字段。

  Agora 推荐你对 X-Request-ID 赋值。如果你不赋值，Agora 服务器会自动生成一个 UUID 传入。

• 鉴权字段：
  • 如果你未在控制台启用 App 证书，请你使用 HTTP Basic 认证。鉴权字段为 Authorization。字段值请参考 HTTP Basic 认证说明。
  • 如果你已经在控制台启用 App 证书，你可以使用 HTTP Basic 认证或 Agora 的 Token 认证。Agora Token 认证的鉴权字段如下：
    • x-agora-token: 项目 Token。
    • x-agora-uid: 整型的用户 ID。

请求报文的 Body

{
    "rtmpUrl": "rtmp://{host}/{app}/{name}?{query_parameter}"
}

Note：为正常使用低码高清服务，请确保你的原始 RTMP URL 满足如下要求：

• 原始 RTMP URL 包含 host、app 和 name 这三个路径参数：
  • host: CDN 厂商的 host 地址。如 xxx.agora.io。
  • app: RTMP 协议中的 app 字段。如 live。
  • name: RTMP 协议中的 name 字段。
• 原始 RTMP URL 包含的 name 字段需满足如下要求：
  • 请对不同的 RTMP 流使用不同的 name 值。
  • name 的字符长度不得超过 31 位。
  • 推荐使用的字符集范围为：
    • 数字 0-9
    • 所有小写英文字母（a-z）
    • 所有大写英文字母（A-Z）
    • "-", "_"

响应报文的 Header 字段

X-Request-ID: UUID（通用唯一识别码），标识本次请求。该值为本次请求 Header 中 X-Request-ID。

响应报文的 Body

如果响应的 HTTP 状态码为 200，请求成功。响应 Body 示例如下：

{
    "rtmpUrl": "your new rtmp url"
}

Note：收到 Agora 响应的 rtmpUrl 后，请在 15 分钟内使用该 URL 发起推流。如果超时使用，你将无法成功发起推流。此时，你需要重新向 Agora 发起 HTTP 请求，重新获取一个 Agora 为你生成的 rtmpUrl。

如果响应的 HTTP 状态码不为 200，请求失败。Body 中包含 String 型的 message 字段，描述请求失败的具体原因。

{
    "message": "Unauthorized"
}

开发注意事项

• 为保障安全性，Agora 强烈推荐你在服务端调用低码高清 RESTful API。
• 为正常使用低码高清服务，请不要将上行 RTMP 流的 metadata 中的视频码率设为 0。比如，OBS 推流时，请不要将 OBS 的码率控制模式设置为 CRF。
• HTTP 请求失败时，请通过 X-Request-ID 和 message 字段排查问题。
• 成功发起推流后，如果遇到推流中断的情况，你需要再次向 Agora 发起 HTTP 请求，重新获取一个 Agora 为你生成的 rtmpUrl，并使用该 URL 重新发起推流。