Skip to main content

You are viewing Agora Docs forBetaproducts and features. Switch to Docs

  • Core Products
  • Add-Ons
  • Extensions Marketplace
Android
iOS
macOS
Web
Windows
Electron
Flutter
React Native
React JS
Unity
Unreal Engine
Unreal (Blueprint)

Restrict media zones

When a user joins a channel, Video SDK automatically connects them to the Agora SD-RTN™ media zone that is geographically closest to the user. However, to meet the laws and regulations of the user's country, you may need to specify, or filter out connections to a specific geographical zone. Agora enables you to control and customize data routing in your app by specifying the Agora SD-RTN™ media zone users connect to.

information

This is an advanced feature suitable only for scenarios with access security restrictions.

Understand the tech​

After you turn on the restricted media zones feature, the SDK only accesses the Agora server in the specified zone(s), irrespective of the geographical location of the user. As an example, the following table shows the outcome if you specify North America as the access zone, and users connect to Agora SD-RTN™ from North America and China respectively:

Designated access zone User's location Zone actually accessed by the SDK User experience
North America North America North America Normal
China Quality may be affected
information
  • If a server in the specified zone is not available, the SDK reports an error.
  • Due to cross-regional public internet between the designated zone and the geographical location where the app user is located, the audio and video experience may be affected.

The following figure shows the workflow you implement to restrict access to media zones:

Restrict media zones

Prerequisites​

Ensure that you have implemented the SDK quickstart in your project.

Implement restricted media zones​

This section shows you how to restrict access to media zones in your app.

You specify the access zones by setting the RtcEngineConfig.mAreaCode parameter when calling the create method to create an RtcEngine instance. The available zones are:

  • AREA_CODE_GLOB: Global (Default)
  • AREA_CODE_CN : Mainland China
  • AREA_CODE_NA : North America
  • AREA_CODE_EU : Europe
  • AREA_CODE_AS : Asia excluding Mainland China
  • AREA_CODE_JP : Japan
  • AREA_CODE_IN : India
information

Media zones support bitwise operations.

Include a media zone​

To limit access to servers in only one zone, such as North America, set config.mAreaCode = AREA_CODE_NA; before creating the RtcEngine instance:


_14
// Initialize the App and join the channel
_14
private void initializeAndJoinChannel() {
_14
try {
_14
RtcEngineConfig config = new RtcEngineConfig();
_14
config.mAppId = appId;
_14
config.mContext = mContext;
_14
config.mEventHandler = mEngineEventHandler.mRtcEventHandler;
_14
// Restrict access to servers in North America only
_14
config.mAreaCode = AREA_CODE_NA;
_14
mRtcEngine = RtcEngine.create(config);
_14
} catch (Exception e) {
_14
throw new RuntimeException("Check the error.");
_14
}
_14
}

Exclude a media zone​

To exclude servers in a zone, such as Mainland China, set config.mAreaCode = AREA_CODE_GLOB ^ AREA_CODE_CN; before creating the RtcEngine instance:


_14
// Initialize the App and join the channel
_14
private void initializeAndJoinChannel() {
_14
try {
_14
RtcEngineConfig config = new RtcEngineConfig();
_14
config.mAppId = appId;
_14
config.mContext = mContext;
_14
config.mEventHandler = mEngineEventHandler.mRtcEventHandler;
_14
// Exclude Mainland China from access zones
_14
config.mAreaCode = AREA_CODE_GLOB ^ AREA_CODE_CN;
_14
mRtcEngine = RtcEngine.create(config);
_14
} catch (Exception e) {
_14
throw new RuntimeException("Check the error.");
_14
}
_14
}

Reference​

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Video Calling