https://github.com/agoraio/video-sdk-samples-android

Android reference app for Agora Video SDK
https://github.com/agoraio/video-sdk-samples-android

agora android reference-app rtc video-sdk

Last synced: 3 months ago
JSON representation

Android reference app for Agora Video SDK

• Host: GitHub
• URL: https://github.com/agoraio/video-sdk-samples-android
• Owner: AgoraIO
• License: mit
• Created: 2023-04-03T15:22:23.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-08T09:45:21.000Z (9 months ago)
• Last Synced: 2024-05-08T10:44:25.216Z (9 months ago)
• Topics: agora, android, reference-app, rtc, video-sdk
• Language: Kotlin
• Homepage: https://docs.agora.io/en/video-calling/get-started/get-started-sdk?platform=android
• Size: 14.6 MB
• Stars: 5
• Watchers: 7
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Agora Video SDK for Android reference app

This reference app demonstrates the use of [Agora's Video SDK](https://docs.agora.io/en/video-calling/get-started/get-started-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](#samples-)

- [Prerequisites](#prerequisites)

- [Run this project](#run-this-project)

- [Contact](#contact)

## 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**

- [SDK quickstart](./agora-manager)

- [Secure authentication with tokens](./authentication-workflow)

**Develop**

- [Call quality best practice](./ensure-channel-quality)

- [Stream media to a channel](./play-media)

- [Screen share, volume control, and mute](./product-workflow)

- [Connect through restricted networks with Cloud Proxy](./cloud-proxy)

- [Secure channel encryption](./media-stream-encryption)

- [Custom video and audio sources](./custom-video-and-audio)

- [Raw video and audio processing](./stream-raw-video-and-audio)

- [Live streaming over multiple channels](./live-streaming-over-multiple-channels)

  

**Integrate Features**

- [Audio and voice effects](./audio-and-voice-effects)

- [3D Spatial audio](./spatial-audio)

- [Geofencing](./geofencing)

- [Virtual Background](./virtual-background)

- [AI noise suppression](./ai-noise-suppression)

To view the UI implementation, open the relevant Activity Class file [here]( android-reference-app/app/src/main/java/io/agora/android_reference_app).

## 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:

    ```sh

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

    ```

1. **Open the project**

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

1. **Modify the project configuration**

   The app loads connection parameters from the [`config.json`](./agora-manager/src/main/res/raw/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](https://console.agora.io). 

    - `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](https://agora-token-generator-demo.vercel.app/).

    - `serverUrl`: The URL for the token generator. See [Secure authentication with tokens](authentication-workflow) 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`.

1. **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.

1. **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](https://github.com/AgoraIO/video-sdk-samples-android/issues).