Guidelines for Running Sample Codes

Prerequisites

Please ensure that the development environment meets the following technical requirements:

• Windows: Windows 7 or above, with Visual Studio 2019 or above.
• macOS: macOS 11.0 or above, with Xcode 13 or above.
• Linux: Any Linux distro with GLIBC 2.16 or above, supporting x86_64, aarch64, armhf architectures
• CMake has been installed.
• Qt (5.9 ~ 5.15) have been installed. For details please refer to Getting Started with Qt.
• External devices that support audio and video functions such as microphones and cameras are normal.

• A project has been created in ZEGOCLOUD Admin Console and a valid AppID has been applied.

• A token has been generated. For details, please refer to Use Tokens for authentication. You can also obtain a temporary token (valid for 24 hours) in the ZEGOCLOUD Admin Console.

• After installing CMake and Qt, you need to add environment variables:

  The CMake and Qt paths provided below are for reference only, and users need to fill in according to the actual path on their device.

  • Windows system:

    1. Modify Environment Variables: add C:\Program Files\CMake\bin to Path.
    2. Modify Environment Variables: add C:\Qt\Qt5.9.8\5.9.8\msvc201d5\bin to Path.
    3. Add User Variables: add QTDIR user variable as C:\Qt\Qt5.12.12\5.12.12\msvc2017.

  • macOS system:

    export PATH="$PATH:$HOME/Qt5.12.12/5.12.12/clang_64/bin"
    export QTDIR="$HOME/Qt5.12.12/5.12.12/clang_64"

  • Linux system:

    export QTDIR="/usr/local/Qt-5.12.12"
    export PATH="$PATH:$QTDIR/bin"
    export LD_LIBRARY_PATH="$QTDIR/lib:$LD_LIBRARY_PATH"

Sample Codes Directory Structure

The directory tree is showed below, the paths given later will the relative to this directory :

.
├── README_zh.md
├── README.md
├── libs
│   ├── ScreenCapture
│   └── ZegoExpress
│       ├── linux # ZegoExpressVideo Linux SDK
│       ├── mac # ZegoExpressVideo Mac SDK
│       │   └── ZegoExpressEngine.xcframework
│       └── win # ZegoExpressVideo Windows SDK
│           ├── x64
│           └── x86
└── ZegoExpressExample
    ├── KeyCenter.cpp # Fill in the applied AppID and token
    ├── KeyCenter.h
    ├── ZegoExpressExample.pro # Qt project
    ├── Examples
    ├── HomePage
    ...

Run the Sample Codes

1. The AppID, userID and token required for SDK initialization are missing in the sample code. You need to modify the "/ZegoExpressExample/KeyCenter.cpp" file. Please fill in the AppID and Token obtained in Prerequisites correctly, otherwise the sample codes will not run normally.

// Developers can get appID from admin console.
// https://console.zego.im/dashboard
// for example: 123456789;
unsigned int KeyCenter::getAppID() {
    return ; //Input AppID here
}

// Developers should customize a user ID.
// for example: "zego_benjamin";
std::string KeyCenter::getUserID() {
    return ; //Input UserID here
}

// Developers can get token from admin console.
// https://console.zego.im/dashboard
// Note: The user ID used to generate the token needs to be the same as the userID filled in above!
// for example: "04AAAAAxxxxxxxxxxxxxx";
std::string KeyCenter::getToken() {
    return ; //Input Token here
}

2. Open the project.

   Use Qt Creator to open the "./ZegoExpressExample/ZegoExpressExample.pro" project file.

3. Compile and run the project.

   • Method 1: Run or Build the project directly through QtCreator.

     After opening the Qt project, click the "Run", "Debug", and "Build" buttons in the lower left corner to build and run the Demo.

   • Method 2: Build the project with qmake and make

     • Windows

       • Open cmd.exe and execute the cd \path\to\this\folder command to go to the directory where this file is located.

       • Find the path to "vcvarsall.bat" (for example, the VS 2019 version is at "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat").

       • Execute the call "\path\to\your\vcvarsall.bat" x86 command to set up the MSVC environment.

       • Execute the qmake ZegoExpressExample\ZegoExpressExample.pro CONFIG+=Win32 -o .\build\Makefile command to generate the Makefile through qmake.

       • Execute cd build to enter the build directory and build the project with the nmake command.

       • Execute cd .. to return to the parent directory and deploy the Qt App through the windeployqt .\bin\release\ZegoExpressExample.exe command.

     • macOS

       • Open Terminal and execute the cd /path/to/this/folder command to go to the directory where this file is located.

       • Execute the qmake ZegoExpressExample/ZegoExpressExample.pro CONFIG+=x86_64 -o ./build/Makefile command to generate the Makefile through qmake.

       • Execute the cd build command to enter the build directory, and use the make command to build the project.

       • Execute the cd .. command to return to the parent directory, and deploy the Qt App through the macdeployqt ./bin/release/ZegoExpressExample.app command.

     • Linux

       1. Open terminal and cd to the directory where this file is located cd /path/to/this/folder
       2. Select the build environment
          • Native compile (support x86_64, aarch64, armhf)
            1. Execute qmake ZegoExpressExample/ZegoExpressExample.pro CONFIG+=x86_64 -o ./build/Makefile generate Makefile with qmake
            2. cd build and execute make to build the project
            3. Find the ZegoExpressExample project file in the bin/release directory of the upper directory and run it
          • Cross compile
            1. Currently supports cross-compiling for aarch64 or armhf target platform in x86_64 environment (if you need to support other environments, you can modify the project configuration ZegoExpressExample.pro by yourself)
            2. Make sure your machine has Qt everywhere installed for the target platform cross-compilation, the following assumes cross-compile for the aarch64 target and the corresponding Qt has been installed in the /usr/aarch64-linux-gnu/Qt-5.12.12 directory
            3. Execute export TARGET_LINUX_ARCH=aarch64 , this environment variable is for ZegoExpressExample.pro to identify the current target platform to build
            4. Execute /usr/aarch64-linux-gnu/Qt-5.12.12/bin/qmake ZegoExpressExample/ZegoExpressExample.pro -o ./build/Makefile -spec linux-aarch64-gnu-g++ generate Makefile with qmake for the aarch64 target
            5. cd build to enter the build directory and execute make to build the project
            6. Copy the products in the bin/release directory and the /usr/aarch64-linux-gnu/Qt-5.12.12/lib directory to your target platform and run

Experience Real-time Audio and Video Call/Live Streaming 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.