Photon Voice 1 is the original and first major version of Photon Voice. It is now replaced by Photon Voice 2 which is refactored and enhanced. We highly recommend starting new projects with Photon Voice 2 and if possible migrating existing ones from Photon Voice 1 to Photon Voice 2. Photon Voice will be maintained for the coming months. We will fix important bugs and support new Unity versions but new features will be added only to Photon Voice 2.

Regions

Photon Cloud provides you with global connectivity to allow low latency gaming all around the world.

The initial connection of clients goes to a Photon Name Server, which provides the list of available regions. Typically, clients connect with "Best Region" selection enabled, which will detect the region with the lowest ping and connect to it (see below).

Each region is completely separate from the others and consists of a Master Server (for matchmaking) and Game Servers (hosting rooms).

Photon Cloud Regions' Connect Flows
Connect to Photon Cloud regions

The full list of available regions is below. In the Dashboard, you can define which regions should be available for the clients.

Best Region Considerations

"Best Region" option is not deterministic. Sometimes it may be "random" due to little variations or exact same ping calculations.

Theoretically, you could:

  • have the same exact ping to multiple regions from the same device. So its random, if you end up with different regions on clients connected to the same network.
  • different ping values for the same region on different devices (or different retries on the same device) connected to the same network.

For instance, in the case of "us" and "usw" (or "ru" and "rue"), you could either make use of the online regions whitelist to select the ones you want and drop the others or connect to an explicit region.

Back To Top

Available Regions

Photon Cloud has servers in several regions, distributed across multiple hosting centers over the world.

Each Photon Cloud region is identified by a "region token".

List of available regions and tokens:

The strings for region tokens(or codes) are case insensitive. Example: "EU" or "eu" are both accepted and refer to the same Europe region.
RegionHosted inToken
AsiaSingaporeasia
AustraliaMelbourneau
Canada, EastMontrealcae
Chinese Mainland (See Instructions)Shanghaicn
EuropeAmsterdameu
IndiaChennaiin
JapanTokyojp
RussiaMoscowru
Russia, EastKhabarovskrue
South AmericaSao Paulosa
South KoreaSeoulkr
USA, EastWashington D.C.us
USA, WestSan Joséusw

Back To Top

Dashboard Regions Filtering

You can filter the list of available Photon Cloud regions per application on the fly directly from the dashboard.

Photon Cloud: Regions Whitelist
Filter Photon Cloud Regions

Go to the dashboard and then click "Manage" for a chosen application and then click "Edit". You will find an input field where you can enter the list of whitelisted regions as follows:

  • the allowed list should be a string of region tokens seprated by semicolon. e.g. "eu;us".
  • region tokens are case insensitive and are defined here.
  • undefined or unrecognized region tokens will be ignored from the list.
  • empty ("") or malformed string (e.g. ";;;") means empty list.
  • empty list means all available regions are allowed.

Once you confirm and save, the operation GetRegions will return only the filtered list of regions. Thus clients should select from that list but it's fully possible clients connect to any available region explicitly. Take into consideration that dashboard updates propagation can take up to 10 minutes.

Back To Top

Using The Chinese Mainland Region

First, you need to request access to the Chinese Mainland region for your Photon app. Send us an email so we could unlock it for your AppID.
Second, you cannot subscribe to paid plans to be used in Chinese Mainland Region via our website. Please reach out to us by email.

The Photon Name Server has to be local to China, as the firewall might block the traffic otherwise. The Chinese Photon Name Server is "ns.photonengine.cn".

Connecting with clients from outside of China mainland will most likely not produce good results. Also, connecting from the Photon servers to servers outside of China mainland (e.g. for Custom Authentication, WebHooks, WebRPCs) might not be reliable.

Important: in the current phase, changes you make to your app via your dashboard are not automatically reflected in app caches for China. Let us know by e-mail, if you have an update request there.

Also for legal reasons, you need a separate build for China and we recommend to use a separate AppId with it. For example, use a compile condition (of your choice) to change the AppId and the Photon Name Server depending on the build.

Follow the instructions corresponding to your client SDK to make a special build for the Chinese market.

Back To Top

Photon Voice

  1. Set the AppId to the application that has China region unlocked. If you want to use same project and have different builds you can do something like this:
        void Awake()
    {
    // TODO: replace compile condition with your own
    #if CHINA
        PhotonNetwork.PhotonServerSettings.VoiceAppID = "ChinaVoiceAppId"; // TODO: replace with your own AppId
    #else
        PhotonNetwork.PhotonServerSettings.VoiceAppID = "nonChinaVoiceAppId"; // TODO: replace with your own AppId
    #endif
    }
  2. Open "LoadBalancingClient.cs" file and set the NameServerHost to "ns.photonengine.cn":

Since PUN is included in Voice, we also need to follow the steps required for PUN. Photon Voice will automatically connect to the same servers.

Back To Top

PUN

  1. Set the AppId to the application that has China region unlocked. If you want to use same project and have different builds you can do something like this:
        void Awake()
    {
    // TODO: replace compile condition with your own
    #if CHINA
        PhotonNetwork.PhotonServerSettings.AppID = "ChinaPUNAppId"; // TODO: replace with your own AppId
    #else
        PhotonNetwork.PhotonServerSettings.AppID = "nonChinaPUNAppId"; // TODO: replace with your own AppId
    #endif
    }
  2. Open the "NetworkingPeer.cs" file and set the NameServerHost to "ns.photonengine.cn":
  3. Update CloudRegionCode and CloudRegionFlag enums to add new "CN" (or "cn") region token as follows:
  4. Use PhotonNetwork.ConnectToRegion(CloudRegionCode.cn, gameVersion) to connect to Chinese Mainland region.

To Document Top