Documentation
Voice Call v4.0.0 Beta
Console 官网 Community Technical support
English
search-icon

Network Geofencing

Last updated 2022/06/14 08:29:48

To meet the laws and regulations of different countries or regions, the Agora RTC SDK supports geofencing. After enabling geofencing, the Agora SDK only connects to Agora servers within the specified region.

Understand the tech

To meet the laws and regulations of different countries or regions, the Agora RTC SDK supports geofencing. After enabling geofencing, the SDK only connects to Agora servers within the specified region, regardless of where your app users are located.

For example, if you specify North America as the region for connection, when two users attempt to connect to Agora servers from different locations, the result is as follows:

Specified region for connection App user location Actual region for connection User experience after connection 1
North America North America North America Normal
China Can be less than optimal 2
1 If there is no available server in the specified region, the SDK throws an error.
2 When the user's location is different from the specified region, the public network spanning between the user's location and the specified region might have a poor quality, which can make the audio and video experience less than optimal.
Do not enable geofencing if your scenarios do not have regional restrictions.

Prerequisites

Before adjusting the audio volume, ensure that you have implemented the basic real-time communication functions in your project. For details, see the following quickstart guides:

Implementation

When creating an AgoraRtcEngineKit instance by calling sharedEngineWithConfig, set the areaCode parameter in AgoraRtcEngineConfig to specify the region for connection.

  • AgoraAreaCodeGLOB: (Default) Global
  • AgoraAreaCodeCN: Mainland China
  • AgoraAreaCodeNA: North America
  • AgoraAreaCodeEU: Europe
  • AgoraAreaCodeAS: Asia, excluding Mainland China
  • AgoraAreaCodeJP: Japan
  • AgoraAreaCodeIN: India
The area codes support bitwise operation.

Specify a region

To specify a region for connection (such as North America), add config.areaCode = AgoraAreaCode.NA.rawValue before creating an instance of AgoraRtcEngineKit.

// Initializes AgoraEngine
func initializeAgoraEngine(){
     let config = AgoraRtcEngineConfig()
     // Pass in your App ID here.
     config.appId = "YourAppId"
     //Sets the channel profile as live broadcast.
     config.channelProfile = .liveBroadcasting
     // Specifies North America as the region for connection
     config.areaCode = AgoraAreaCode.NA.rawValue
     agoraKit = AgoraRtcEngineKit.sharedEngine(with: config, delegate: self)
  }

Exclude a region

To exclude a region for connection (such as Mainland China), add config.areaCode = AgoraAreaCode.GLOB.rawValue ^ AgoraAreaCode.CN.rawValue before creating an instance of AgoraRtcEngineKit.

// Initializes AgoraEngine
func initializeAgoraEngine(){
     let config = AgoraRtcEngineConfig()
     // Pass in your App ID here.
     config.appId = "YourAppId"
     // Sets the channel profile as live broadcast.
     config.channelProfile = .liveBroadcasting
     // Excludes Mainland China from the regions for connection.
     config.areaCode = AgoraAreaCode.GLOB.rawValue ^ AgoraAreaCode.CN.rawValue
     agoraKit = AgoraRtcEngineKit.sharedEngine(with: config, delegate: self)
  }

Reference

This section includes links to related pages.

API reference

sharedEngineWithConfig