Run the Sample Project

Overview

Agora provides an open-source Agora-Android-Tutorial-1to1 sample project on GitHub. This document introduces how to run this project and experience a video call implemented by the Agora SDK.

Prerequisites

• Development environment requirements:
  • Java Development Kit
  • Android Studio 3.0 or later
• If your network has a firewall, follow the instructions in Firewall Requirements to access Agora services.
• A real Android device. Agora recommends you run this sample project on a physical mobile device, as some simulators may not support the full features of this project.
• A valid Agora account.

Procedure

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.

4. Configure the sample project

1. Download the Basic-Video-Call repository.
2. Find the Basic-Video-Call/One-to-One-Video/Agora-Android-Tutorial-1to1 sample project. Fill in the app/src/main/res/values/strings.xml file with the App ID and temporary token generated in Agora Console.

   // Replace <#YOUR APP ID#> with your App ID in the string format
   <string name="agora_app_id"><#YOUR APP ID#></string>
   // Replace #YOUR ACCESS TOKEN# with your temporary token in the string format
   <string name="agora_access_token">#YOUR ACCESS TOKEN#</string>

3. Open the VideoChatViewActivity.java file, and set channelName of the joinChannel method with the channel name that you use to generate the temporary token.

   // Replace demoChannel1 with the channel name that you use to generate the temporary token
   mRtcEngine.joinChannel(token, "demoChannel1", "Extra Optional Data", 0);

5. Integrate the Agora SDK

Integrate the Agora Video SDK into the sample project, as follows:

1. Download the latest version of the Agora Video SDK and extract the files from the downloaded package.

2. Copy the following files or subfolders from the libs folder of the SDK package to the corresponding folder of the sample project:

   File/Folder	Path
   agora-rtc-sdk.jar	/app/libs/
   arm64-v8a folder	/app/src/main/jniLibs/
   armeabi-v7a folder	/app/src/main/jniLibs/
   x86 folder	/app/src/main/jniLibs/
   x86_64 folder	/app/src/main/jniLibs/

6. Build and run the sample project

Connect the Android device to your computer, open the Agora-Android-Tutorial-1to1 sample project on Android Studio, and then build and run the project.

After the IDE successfully installs the app on your Android device, you can see the following user interface:

You have joined the demoChannel1 channel by default. If you want to experience a one-to-one video call, you can use the Agora Web demo app to interact with your Android device. Ensure that you enter the same App ID, channel name, and temporary token in the Agora Web demo app.