Documentation
Interactive Live Streaming Premium
Agora.io Community
English
search-icon
Run the Sample Project
Last updated 2020/12/01 02:25:25

Agora provides an open-source OpenLive-Voice-Only-Android sample project on GitHub. This document introduces how to run this project and experience a live audio streaming implemented by the Agora SDK.

Prerequisites

  • Development environment requirements:
  • 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

Create a project in Agora Console, as follows:

  1. Log in to Console, and click img in the left navigation menu to enter the Project Management page.

  2. Click Create.

    create button

  3. Enter your project name, and select Secure mode: APP ID + Token for the authentication mechanism in the pop-up window.

  4. Click Submit. You can see the created 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 eye icon to the right of the App ID.

get app id

3. Generate a temporary token

To ensure communication security, Agora uses tokens (dynamic keys) to authenticate users joining a channel.

Agora Console supports generating temporary tokens for testing purposes.

  1. On the Project Management page, find your project, and click img to open the Token page.

    img

  2. Enter a channel name, and click Generate Temp Token to get a temporary token. When joining the channel, ensure that the channel name is the same with the one that you use to generate the temporary token.

    img

Temporary tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating tokens. See Generate a Token for details.
Set the channel name as test for this sample project.

4. Configure the sample project

  1. Download the Basic-Audio-Broadcasting repository.
  2. Find the Basic-Audio-Broadcasting/OpenLive-Voice-Only-Android 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>

5. Integrate the Agora SDK

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

  1. Download the latest version of the Agora Voice 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/
    arm-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 OpenLive-Voice-Only-Android 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 test channel by default. If you want to experience a live audio streaming, 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.

score