简介

为允许用户在有网络访问限制的环境中使用 Agora RTC Native SDK，Agora 提供云代理服务。用户只需在防火墙上将特定的 IP 地址和端口加入白名单，并调用 API 配置 Agora 云代理服务。

工作原理

1. Agora SDK 向 Agora 云代理发起请求。Agora 云代理返回相应代理信息。
2. Agora SDK 向 Agora 云代理发送数据。Agora 云代理接收数据并将数据透传给 Agora SD-RTN™（Software Defined Real-time Network）。
3. Agora SD-RTN™ 向 Agora 云代理返回数据。Agora 云代理接收数据并将数据发送给 Agora SDK。

实现方法

准备工作

1. 下载 Agora RTC Native SDK。

2. 参考《快速开始》文档完成开发环境准备。

3. 联系 sales@agora.io，提供以下信息申请开通云代理服务。

   • App ID
   • 代理服务使用区域
   • 并发规模
   • 网络运营商等信息

添加白名单

请根据你使用的 SDK 版本，参考对应的表格，并将表格中 IP 地址及端口全部添加到防火墙白名单。

v3.3.0 或之后

v3.2.0 或 v3.2.1

v3.2.0 之前

调用 API

v3.3.0 或之后

方式一（推荐）：使用 setCloudProxy

1. 添加白名单后，请根据实际需求，开启 UDP 或 TCP（加密）协议的云代理：

   • 如需开启 UDP 协议的云代理，请调用 setCloudProxy，并将 proxyType 设为 UDP_PROXY(1)。
   • 如需开启 TCP（加密）协议的云代理，请调用 setCloudProxy，并将 proxyType 设为 TCP_PROXY(2)。

2. 测试是否能正常实现音视频通话或直播。

方式二（备选）：使用 setParameters

1. 添加白名单后，请根据实际需求，开启 UDP 或 TCP（加密）协议的云代理：

   • 如需开启 UDP 协议的云代理，请参考 v3.2.1 或之前调用 API。

   • 如需开启 TCP（加密）协议的云代理，请参考如下示例代码：

       // （推荐方案）开启云代理服务，进行 TCP（加密）代理。
       setParameters("{\"rtc.proxy_server\":[13, \"\", 0]}");
       setParameters("{\"rtc.enable_proxy\":true}");

       // （备选方案）开启云代理服务，进行 TCP（加密）代理。以下 IP 地址仅为示例，你需要填所有需要打开的 IP 地址。
       setParameters("{\"rtc.proxy_server\":[14, \"[\"128.1.87.146\",\"164.52.53.77\"]\", 0]}");
       setParameters("{\"rtc.enable_proxy\":true}");

2. 测试是否能正常实现音视频通话或直播。

v3.2.1 或之前

1. 添加白名单后，请参考如下示例代码开启云代理：

    // （推荐方案）开启云代理服务，并通过默认方式配置云代理服务。
    setParameters("{\"rtc.enable_proxy\":true}");

    // （备选方案）开启云代理服务，并通过 IP 地址配置云代理服务。以下 IP 地址仅为示例，你需要填所有需要打开的 IP 地址。
    setParameters("{\"rtc.proxy_server\":[2, \"[\"128.1.87.146\",\"164.52.53.77\",\"164.52.53.78\"]\", 0]}");
    setParameters("{\"rtc.enable_proxy\":true}");

2. 测试是否能正常实现音视频通话或直播。

开发注意事项

• 请在频道外调用用于设置云代理的 API。
• 如果你使用 v3.3.0 或之后的 SDK，当你使用 UDP 协议的云代理时，推流到 CDN 和跨频道媒体流转发功能不可用。
• 如果你使用 v3.3.0 或之后的 SDK，当你使用 TCP（加密）协议的云代理时：
  • 调用 startAudioMixing 方法时无法播放 HTTP 协议的在线音频文件。
  • 推流到 CDN 和跨频道媒体流转发功能会用 TCP 协议的云代理。
• 如果你使用 v3.2.1 或之前的 SDK，当你使用云代理时，推流到 CDN 和跨直播间连麦功能不可用。