Real-Time Audio
  • iOS
  • Android : Java
  • macOS
  • Windows
  • Linux
  • Web
  • WeChat Mini Program
  • Flutter
  • Electron
  • Unity3D
  • Cocos2D
  • React Native
  • uni-app
  • Introduction
    • Overview
    • Release notes
    • Restrictions
  • Downloads
  • Quick starts
    • Sample codes
    • Integration
    • Implementation
  • Common features
    • Network speed test
    • Streaming Quality Monitoring
    • Stream mixing
    • Relaying Streams to CDN
    • Playing Streams via URL
    • Media player
    • Real-time messaging
  • Advanced features
  • Error Codes
  • Interface Change Description
  • Server APIs
  • API Documents
  • FAQ
Sample Code

Guidelines for Running Sample Codes

ZEGO no longer classifies environments into production environments and testing environments.

If you create your project in ZEGO Admin Console on/before 2021-11-16, refer to the Testing environment deprecation to upgrade the SDK and adjust related codes.

1 Prepare the Environment

Please ensure that the development environment meets the following technical requirements (the following instructions are based on macOS development computers as examples):

  • Android Studio 2020.3.1 or above.
  • Android SDK 30 and Android SDK Platform-Tools 30.x.x or above.
  • Android 4.4 or above and support audio and video (recommended to use a real device), if it is a real device, please enable the "Allow debugging" option.
  • The Android device and macOS computers are connected to the Internet.
  • When you compile the sample code for the first time, there is no corresponding dependent library or build tool, "Android Studio" will download the sample code by itself, which may take a long time, please be patient.
  • It is recommended to download a specific Gradle and the required dependent libraries. Please make sure that the development computer is connected to the Internet and can be accessed normally The relevant versions of Gradle used in the sample code are as follows:
    • Gradle: 6.7.1 (in the "project/gradle/wrapper/" file).
    • Android Gradle plugin: 4.2.0 (in the "project/build.gradle" file).

For the version dependency between Android Gradle plugin, Gradle, and SDK Tool, please see: Android Gradle plugin release notes

2 Prerequisites

Please go to ZEGO Admin Console to register an account and apply for the AppID and AppSign required to initialize the SDK. For the application process, please refer to ZEGO Admin Console User Manual.

3 Run the Sample Codes

  1. Find the Android Studio software icon on the development computer.

    How to install Android Studio on the development computer
    • Method 1: Log in to Android Studio official website to download and install Android Studio and its related SDK Tools. Due to domestic operator network restrictions and other reasons, the developer needs to ensure that the machine can connect to the website. If you cannot access it, it is recommended to choose method 2.
    • Method 2: Use a search engine to search for "Android Studio download", "Android Studio installation" and "Android Studio SDK Tools installation", find downloadable source websites, and install related software and tools.
  2. Open Android Studio, and click "Open an existing Android Studio project".

  3. Select the downloaded sample code "./video" (Video SDK Demo) or "./audio" (Audio SDK Demo) at the beginning of this document and open it.

  4. (Optional) Integrated SDK.

Choose to integrate the SDK according to the download method
  • Download: The sample source code downloaded from the compressed package already contains the SDK package, please skip this step.
  • GitHub: The SDK package is missing from the sample source code downloaded from Github. You need to download SDK first, and Copy the decompressed jar package and so to the "./video/main/libs/" (Video SDK Demo) or "./audio/app/libs/" (Audio SDK Demo) directory.
  1. The downloaded sample code lacks the appID and appSign required for SDK initialization, so you need to modify "" file of "./video/common/src/main/java/im/zego/common/" (Video SDK Demo) or "./audio/common/src/main/java/im/zego/common/" (Audio SDK Demo) directory. Please use the AppID and AppSign obtained in the "Prerequisites" of this article to fill in correctly (Note: You need to add L after AppID), otherwise the sample code will not run normally.

  2. Select a real Android device (recommended) or emulator that has been connected to the Internet. When the device has successfully turned on the developer mode and USB debugging function, you can see the Android Studio as shown below:

    Change to the following figure:

    Description The Android Studio software has successfully connected to the Android device, and the sample code can be run on the device.

  • When the development computer is connected to an Android device, most devices will pop up a prompt. Different Android manufacturers have different prompts. You can select the USB mode according to the situation.
  • When the Android device is connected to the development computer, you need to enable the developer mode and USB debugging function on the device according to the situation (Android devices of different manufacturers have different opening methods). The specific opening method can be searched by a search engine. For example: There is currently a "xxx" device that has not enabled the developer mode and USB debugging function. You can search for "xxx Open Developer Mode" in the search engine to view the specific opening tutorial.
  1. Click the build and run button on the Android Studio software to compile and run the sample code.

If there is a problem during operation, please contact ZEGO technical support.

4 Experience Real-time Audio and Video Functions

We recommend you run your project on a real device. If your app runs successfully, you should hear the sound and see the video captured locally from your device.

To test out the real-time audio and video features, visit the ZEGO Express Web Demo, and enter the same AppID, Server and RoomID to join the same room. If it runs successfully, you should be able to view the video from both the local side and the remote side, and hear the sound from both sides as well.

In audio-only scenarios, no video will be captured and displayed.


  1. What should I do if it reports "illegal start of expression" when running the downloaded sample code in Android Studio?

 Because AppID and AppSign do not have specific values ​​in the downloaded sample source code, please refer to step 5 in the Run the Sample Codes chapter of this article for processing.

  1. When running the downloaded sample source code in Android Studio, the "package im.zego.zegoexpress does not exist", what should I do?

 Because it is slow to access GitHub in mainland China, the sample source code from Github download does not include the "ZegoExpressEngine" SDK, so It will report that the specified package does not exist, please refer to step 4 in the Run the Sample Codes chapter of this article for processing.