{"id":20268602,"url":"https://github.com/agoraio/video-sdk-samples-android","last_synced_at":"2025-09-02T20:48:28.411Z","repository":{"id":195812978,"uuid":"623043738","full_name":"AgoraIO/video-sdk-samples-android","owner":"AgoraIO","description":"Android reference app for Agora Video SDK","archived":false,"fork":false,"pushed_at":"2024-05-08T09:45:21.000Z","size":15273,"stargazers_count":7,"open_issues_count":3,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-25T01:42:16.043Z","etag":null,"topics":["agora","android","reference-app","rtc","video-sdk"],"latest_commit_sha":null,"homepage":"https://docs.agora.io/en/video-calling/get-started/get-started-sdk?platform=android","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-03T15:22:23.000Z","updated_at":"2025-01-06T17:23:21.000Z","dependencies_parsed_at":"2023-09-19T18:26:47.966Z","dependency_job_id":"21f5f4cc-4aae-47db-b011-528a598eeace","html_url":"https://github.com/AgoraIO/video-sdk-samples-android","commit_stats":null,"previous_names":["agoraio/video-sdk-samples-android"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO%2Fvideo-sdk-samples-android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO","download_url":"https://codeload.github.com/AgoraIO/video-sdk-samples-android/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248339287,"owners_count":21087213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agora","android","reference-app","rtc","video-sdk"],"created_at":"2024-11-14T12:19:02.158Z","updated_at":"2025-04-11T03:41:58.444Z","avatar_url":"https://github.com/AgoraIO.png","language":"Kotlin","readme":"# Agora Video SDK for Android reference app\n\nThis 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.\n\nClone the repo, run and test the samples, and use the code in your own projects. Enjoy!\n\n- [Samples](#samples-)\n- [Prerequisites](#prerequisites)\n- [Run this project](#run-this-project)\n- [Contact](#contact)\n\n## Samples\n\nThis 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:\n\n**Get Started**\n- [SDK quickstart](./agora-manager)\n- [Secure authentication with tokens](./authentication-workflow)\n\n**Develop**\n- [Call quality best practice](./ensure-channel-quality)\n- [Stream media to a channel](./play-media)\n- [Screen share, volume control, and mute](./product-workflow)\n- [Connect through restricted networks with Cloud Proxy](./cloud-proxy)\n- [Secure channel encryption](./media-stream-encryption)\n- [Custom video and audio sources](./custom-video-and-audio)\n- [Raw video and audio processing](./stream-raw-video-and-audio)\n- [Live streaming over multiple channels](./live-streaming-over-multiple-channels)\n  \n**Integrate Features**\n- [Audio and voice effects](./audio-and-voice-effects)\n- [3D Spatial audio](./spatial-audio)\n- [Geofencing](./geofencing)\n- [Virtual Background](./virtual-background)\n- [AI noise suppression](./ai-noise-suppression)\n\nTo view the UI implementation, open the relevant Activity Class file [here]( android-reference-app/app/src/main/java/io/agora/android_reference_app).\n\n## Prerequisites\n\nBefore getting started with this reference app, ensure you have the following set up:\n\n- Android Studio 4.1 or higher\n- Android SDK API Level 24 or higher\n- A mobile device that runs Android 4.1 or higher\n- An Agora account and project\n- A computer with Internet access. Ensure that no firewall is blocking your network communication.\n\n## Run the app\n\n1. **Clone the repository**\n\n    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:\n\n    ```sh\n    git clone https://github.com/AgoraIO/video-sdk-samples-android.git\n    ```\n\n1. **Open the project**\n\n    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.\n\n1. **Modify the project configuration**\n\n   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.\n\n    - `uid`: The user ID associated with the application.\n    - `appId`: (Required) The unique ID for the application obtained from [Agora Console](https://console.agora.io). \n    - `channelName`: The default name of the channel to join.\n    - `rtcToken`:An token generated for `channelName`. You generate a temporary token using the [Agora token builder](https://agora-token-generator-demo.vercel.app/).\n    - `serverUrl`: The URL for the token generator. See [Secure authentication with tokens](authentication-workflow) for information on how to set up a token server.\n    - `tokenExpiryTime`: The time in seconds after which a token expires.\n\n    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`.\n\n1. **Build and run the project**\n\n    To build and run the project, select your connected Android device or emulator and press the **Run** button in Android Studio.\n\n1. **Run the samples in the reference app**\n\n    From the main app screen, choose and launch a sample.\n\n## Contact\n\nIf 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).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio%2Fvideo-sdk-samples-android/lists"}