Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 4.37 KB

README.md

File metadata and controls

86 lines (58 loc) · 4.37 KB
Raw

Agora Video SDK for Android reference app

This reference app demonstrates the use of Agora's Video SDK for real-time audio and video communication. It is a robust and comprehensive documentation reference app for Android, designed to enhance your productivity and understanding. It's built to be flexible, easily extensible, and beginner-friendly.

Clone the repo, run and test the samples, and use the code in your own projects. Enjoy!

Samples

This reference app includes several samples that illustrate the functionality and features of Agora Video and Voice SDKs. Each sample is self-contained and the relevant code can be found in its own folder in the root directory. For more information about each sample, see:

Get Started

Develop

Integrate Features

To view the UI implementation, open the relevant Activity Class file here.

Prerequisites

Before getting started with this reference app, ensure you have the following set up:

  • Android Studio 4.1 or higher
  • Android SDK API Level 24 or higher
  • A mobile device that runs Android 4.1 or higher
  • An Agora account and project
  • A computer with Internet access. Ensure that no firewall is blocking your network communication.

Run the app

  1. Clone the repository

    To clone the repository to your local machine, open Terminal and navigate to the directory where you want to clone the repository. Then, use the following command:

    git clone https://github.com/AgoraIO/video-sdk-samples-android.git

  2. Open the project

    Launch Android Studio. From the File menu, select Open... and navigate to the android-reference-app folder. Start Gradle sync to automatically install all project dependencies.

  3. Modify the project configuration

    The app loads connection parameters from the config.json file. Ensure that the file is populated with the required parameter values before running the application.

    • uid: The user ID associated with the application.
    • appId: (Required) The unique ID for the application obtained from Agora Console.
    • channelName: The default name of the channel to join.
    • rtcToken:An token generated for channelName. You generate a temporary token using the Agora token builder.
    • serverUrl: The URL for the token generator. See Secure authentication with tokens for information on how to set up a token server.
    • tokenExpiryTime: The time in seconds after which a token expires.

    If a valid serverUrl is provided, all samples use the token server to obtain a token except the SDK quickstart project that uses the rtcToken. If a serverUrl is not specified, all samples except Secure authentication with tokens use the rtcToken from config.json.

  4. Build and run the project

    To build and run the project, select your connected Android device or emulator and press the Run button in Android Studio.

  5. Run the samples in the reference app

    From the main app screen, choose and launch a sample.

Contact

If you have any questions, issues, or suggestions, please file an issue in our GitHub Issue Tracker.