Run the Sample Project

Agora provides two open-source sample projects: OpenLive-Windows (based on Qt) and OpenLive-Windows-MFC (based on MFC). This article describes how to run the sample projects.

Get App ID and Token

1. Create an Agora project

To create an Agora project, do the following:

1. Enter the Project Management page.
2. Click Create.
3. Follow the on-screen instructions to enter a project name and use case, and check Secured mode: APP ID + Token (Recommended) as the authentication mechanism.
4. Click Submit. You can now see the project on the Project Management page.

2. Get an App ID

Agora automatically assigns each project an App ID as a unique identifier.

To copy this App ID, find your project on the Project Management page in Agora Console, and click the icon in the App ID column.

3. Generate a temporary token

To ensure communication security, Agora recommends using tokens to authenticate users joining a channel.

For testing purposes, Agora Console supports generating RTC temporary tokens. To generate an RTC temporary token:

1. On the Project Management page, find your project and click Config.
   
2. Click Generate temp RTC token under Primary Certificate.
   
3. Enter the name of the channel that you want to join, and click Generate. When joining the channel later, ensure that the channel name is the same with the one you enter here.
4. Click the copy icon to copy the temporary token.

Run the sample project based on Qt

Prerequisites

• Operating system: Windows 7 or higher
• IDE: Based on Qt 5.6 or higher

Integrate the SDK

1. Clone the Basic-Video-Broadcasting repository. Navigate to the OpenLive-Windows folder.

2. Download the latest version of Video SDK. Unzip the file and perform the following operations:

   1. Create a sdk folder in OpenLive-Windows. In sdk, create two folders: include and lib.
   2. Copy all .h files from libs\include to OpenLive-Windows\sdk\include.
   3. Copy libs\x86 or libs\x86_64 to OpenLive-Windows\sdk\lib.

Procedure

1. Navigate to the OpenLive-Windows folder and open OpenLive.pro with Qt Creator.
2. Click Projects and select the build tool in Build&Run, such as x86-windows-msvc0217-pe-64bit or x86-windows-msvc0217-pe-32bit.
3. Click Edit, open Headers/agoraobject.h, and replace APP_ID and APP_TOKEN with your App ID and Token.
4. Select Release as the build option and click to build the project.
5. When the build is successful, click to run the project. Enter the channel name and select your role. Click Start Live Broadcast to join the channel.

Project structure

The following table shows the structure of the sample project. You can adjust the code per your requirements.

Run the project based on MFC

Prerequisites

• Operating system: Windows 7 or higher
• IDE: Visual Studio 2017 or higher

Integrate the SDK

1. Clone the Basic-Video-Broadcasting repository. Navigate to the OpenLive-Windows-MFC folder.

2. Download the latest version of Video SDK. Unzip the file and perform the following operations:

   1. Create a sdk folder in OpenLive-Windows-MFC. In sdk, create three folders: include, dll, and lib.
   2. Copy all .h files from libs\include to OpenLive-Windows-MFC\sdk\include.
   3. Copy libs\x86\agora_rtc_sdk.dll or libs\x86_64\agora_rtc_sdk.dll to OpenLive-Windows-MFC\sdk\dll.
   4. Copy libs\x86\agora_rtc_sdk.lib or libs\x86_64\agora_rtc_sdk.lib to OpenLive-Windows-MFC\sdk\lib.

Procedure

1. Navigate to the OpenLive-Windows-MFC folder and open OpenLive.sln with Visual Studio.
2. In the solution manager, select OpenLive >> AgoraObject >> SDK >> AgoraObject.h and replace APP_ID and APP_TOKEN with your App ID and Token.
3. In the solution manager, right-click the solution name and select Generate solution.
4. After compilation, press <F5> to run the project. Enter the channel name and select your role. Click Join to join the channel.

Project structure

The following table shows the structure of the sample project in the solution manager. You can adjust the code per your requirements.