Agora Cloud Proxy is a feature of Agora's Voice and Video SDKs. It ensures reliable audio and video connectivity for end users when they connect from restricted network environments.
The following figure illustrates how Agora Cloud Proxy works:
To accommodate your end users’ firewall settings and business needs, Agora Cloud Proxy offers the following operating modes:
Automatic: This is the default setting in the latest version of the Agora RTC Native SDK and Agora Web SDK. In this mode, the Agora SDK first attempts a direct connection to Agora SD-RTN™; if the attempt fails, the Agora SDK automatically falls back to securely send media over TCP/TLS 443. This mode is recommended when you are not sure if your end users are behind a firewall.
Force UDP: The Agora SDK securely sends media over UDP only. Your end users’ firewall must be configured to trust a list of allowed IP addresses (see Allowed IP List on Agora Console). This mode is recommended when your end users are behind a firewall and require media with the highest possible quality.
Force TCP: The Agora SDK securely sends media over TCP/TLS 443 only. This mode is recommended when your end users are behind a firewall and the firewall's security policies only allow media to flow through TCP/TLS 443. In some cases the firewall might trust any traffic over TCP/TLS 443; however, in many cases the firewall is configured to trust only a specific range of IP addresses sending traffic over TCP/TLS 443. In this case, your end user's firewall must be configured to trust a list of allowed IP addresses (see Allowed IP List on Agora Console).
If you do not select a specific proxy mode within the Native or Web SDK, the SDK always uses Automatic mode.
Automatic mode is free of charge and covers the majority of customer scenarios. Force UDP and Force TCP modes are provided for a fee.
Agora offers Force UDP and Force TCP cloud proxy modes with tiered capacity and sets a minimum monthly base fee for each tier. Once you enable the Force UDP or Force TCP cloud proxy service at a specified capacity, Agora charges either a usage-based fee or a minimum monthly base fee according to the following rule:
The Agora Cloud Proxy service has a tiered capacity structure based on your monthly Peak Concurrent Users (PCU). The minimum monthly base fee for each tier is as follows:
|Capacity tier||PCU||Minimum monthly base fee (US$)|
|200 or fewer||500|
|Tier 2||From 201 to 1,000||1,000|
|Tier 3||From 1,001 to 2,000||2,000|
|Tier 4||2,001 or more||Contact Sales or request support through the Agora Console|
The usage of the Force UDP or Force TCP cloud proxy service is measured in minutes and is calculated separately based on the media type. The unit prices are as follows:
|Force UDP or Force TCP usage||Unit price (US$/1,000 minutes)|
|Video HD (720P or below)||3.99|
|Video Full HD (above 720p, up to 1080p)||8.99|
|Video 2K (above 1080p, up to 2K)||15.99|
|Video 2K+ (above 2K)||35.99|
Force UDP and Force TCP cloud proxy minutes count toward the 10,000 free-of-charge minutes that Agora provides to every account. In addition, Agora automatically applies the following tiered discounts when your Force UDP and Force TCP cloud proxy usage exceeds 100,000 minutes:
|Minutes used/month||Automatic discount|
|100,000 to 499,999||5%|
|500,000 to 999,999||7%|
|1,000,000 to 3,000,000||10%|
|Above 3,000,000||Contact Sales|
Once the Force UDP or Force TCP cloud proxy service is activated per your request, you are billed according to the minimum monthly base fee or based upon minutes of usage, whichever is greater. Billing occurs at the end of each calendar month.
You can deactivate the Cloud Proxy Force UDP or Force TCP modes at any time on the Agora Console. The deactivation takes effect immediately, and you are billed either the minimum monthly base fee or the usage-based fee for that month, whichever is greater.
Follow these steps to enable the Force UDP or Force TCP cloud proxy service on the Agora Console:
Log in to the Agora Console, and click the Project Management icon on the left navigation panel.
On the Project Management page, click Config for the project for which you want to enable the cloud proxy service.
Under Real-time engagement core, find Cloud Proxy (Force UDP and Force TCP modes), and click Enable.
Read the pop-up prompt carefully, check the box at the bottom, and click Enable.
Check the Status of Cloud Proxy (Force UDP and Force TCP modes). Once it turns to Enabled, you can configure your SDKs by following the implementation guide.
You can click Config to get the Cloud Proxy Allowed IP List on the Cloud Proxy Configuration page.
Before enabling the cloud proxy modes in the SDK, ensure you meet the following prerequisites:
To enable Force UDP or Force TCP cloud proxy mode, do the following:
setCloudProxy, and set
To disable Force UDP or Force TCP cloud proxy mode, call
setCloudProxy, and set
NONE_PROXY(0), which enables the SDK to return Automatic (default) mode.
setCloudProxybefore joining the channel or after leaving the channel.