Skip to content

Latest commit

 

History

History

APIExample-Compose

README.md

API Example Android

English | 中文

This project presents you a set of API examples to help you understand how to use Agora APIs.

Prerequisites

  • Android Studio 3.0+
  • Physical Android device
  • Android simulator is supported

Quick Start

This section shows you how to prepare, build, and run the sample application.

Obtain an App Id

To build and run the sample application, get an App Id:

  1. Create a developer account at agora.io. Once you finish the signup process, you will be redirected to the Dashboard.

  2. Navigate in the Dashboard tree on the left to Projects > Project List.

  3. Save the App Id from the Dashboard for later use.

  4. Save the App Certificate from the Dashboard for later use.

  5. Open Android/APIExample-Compose and edit the local.properties file in the project root. Update YOUR APP ID with your App Id. If your Agora project has App Certificate enabled and you want to use the sample's built-in token generation flow, update YOUR APP CERTIFICATE as well.

    AGORA_APP_ID=YOUR APP ID
AGORA_APP_CERT=YOUR APP CERTIFICATE

AGORA_APP_ID is required. If your project does not enable App Certificate, leave AGORA_APP_CERT blank. If you generate tokens on your own server, keep AGORA_APP_CERT empty on the client side and use the token-based examples to paste the token at runtime.

You are all set. Now connect your Android device and run the project.

Contact Us

  • For potential issues, take a look at our FAQ first
  • Dive into Agora SDK Samples to see more tutorials
  • Take a look at Agora Use Case for more complicated real use case
  • Repositories managed by developer communities can be found at Agora Community
  • You can find full API documentation at Document Center
  • If you encounter problems during integration, you can ask question in Stack Overflow
  • You can file bugs about this sample at issue

License

The MIT License (MIT)