API examples
Updated
Open-source sample projects for Voice Calling across supported platforms.
Agora provides open-source sample projects on GitHub to demonstrate basic and advanced Voice Calling features across supported platforms.
Sample project repositories
Use the following repositories to explore and test Voice SDK capabilities:
| Platform | Repository | Notes |
|---|---|---|
| Web | AgoraIO/API-Examples-Web | Includes basic, advanced, plugin, and framework examples. |
| Android | AgoraIO/API-Examples | Native Android sample projects for Voice SDK features. |
| iOS | AgoraIO/API-Examples | Native iOS sample projects for Voice SDK features. |
| macOS | AgoraIO/API-Examples | Native macOS sample projects for Voice SDK features. |
| Windows | AgoraIO/API-Examples | Native Windows sample projects for Voice SDK features. |
| React Native | AgoraIO-Extensions/react-native-agora | Example app for basic and advanced scenarios. |
| Unity | AgoraIO-Extensions/Agora-Unity-Quickstart | Includes the API-Example-Unity project. |
| Unreal Engine | AgoraIO-Extensions/Agora-Unreal-RTC-SDK | Includes both Blueprint and C++ API examples. |
Web example structure
For Web projects, clone the repository locally:
git clone https://github.com/AgoraIO/API-Examples-Web
cd API-Examples-WebThe API-Examples-Web repository provides the following examples:
| Description | Path |
|---|---|
| Basic examples | /src/example/basic |
| Advanced examples | /src/example/advanced |
| Plug-in examples | /src/example/plugin |
| Other examples | /src/example/others |
| Vue framework examples | /src/example/framework/vue |
| React framework examples | /src/example/framework/react |
To run the Web examples:
npm install
npm run devNative and engine example locations
The native and engine repositories organize examples by platform:
| Platform | Example path |
|---|---|
| React Native | /example/src/examples/basic, /example/src/examples/advanced, /example/src/examples/hook |
| Unity | /API-Example-Unity |
| Unreal Blueprint | /Agora-Unreal-SDK-Blueprint-Example/Content/API-Example/Basic, /Agora-Unreal-SDK-Blueprint-Example/Content/API-Example/Advance |
| Unreal C++ | /Agora-Unreal-SDK-CPP-Example/Content/API-Example/Basic, /Agora-Unreal-SDK-CPP-Example/Content/API-Example/Advance |
Next steps
- For a guided setup flow, see Run the sample project.
- For Web quickstart guidance, see Quickstart.