其他语言版本： 简体中文
The API-Example-ReactNative project is an open-source demo that will show you different scenes on how to integrate Agora SDK APIs into your project.
Any scene of this project can run successfully alone.
- Basic demos:
| Demo | Description |
|---|---|
| JoinChannelAudio | Audio live streaming |
| JoinChannelVideo | Video live streaming |
| StringUid | String user ID |
- Advanced demos:
| Demo | Description |
|---|---|
| AudioCallRoute | control audio call route |
| AudioMixing | Starts playing the music file |
| AudioSpectrum | Turn on audio spectrum monitoring |
| BeautyEffect | Sets the image enhancement options |
| ChannelMediaRelay | Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels |
| ContentInspect | Content inspect |
| DirectCdnStreaming | Direct CDN streaming |
| Encryption | Enables/Disables the built-in encryption |
| Extension | Enables/Disables extensions |
| JoinMultipleChannel | Joins a channel with the connection ID |
| LocalSpatialAudioEngine | Local spatial audio engine |
| MediaPlayer | This class provides media player functions and supports multiple instances |
| MediaRecorder | Media recorder |
| PlayEffect | Plays the specified local or online audio effect file |
| PushVideoFrame | Pushes the external raw video frame to the SDK |
| RhythmPlayer | Enables the virtual metronome |
| RTMPStreaming | Starts pushing media streams to a CDN without transcoding & Starts Media Push and sets the transcoding configuration |
| ScreenShare | Starts screen sharing |
| SendMetadata | Send data stream |
| SendMultiVideoStream | Send camera & media player stream |
| SpatialAudio | Spatial audio |
| StreamMessage | Sends data stream messages |
| TakeSnapshot | Takes a snapshot of a video stream |
| VideoEncoderConfiguration | Sets the video encoder configuration |
| VirtualBackground | Enables/Disables the virtual background (beta feature) |
| VoiceChanger | Sets the local voice changer option |
- Hooks demos:
| Demo | Description |
|---|---|
| JoinChannelAudio | Audio live streaming |
| JoinChannelVideo | Video live streaming |
| StringUid | String user ID |
| JoinMultipleChannel | Joins a channel with the connection ID |
| VirtualBackground | Enables/Disables the virtual background (beta feature) |
| AudioMixing | Starts playing the music file |
| TakeSnapshot | Takes a snapshot of a video stream |
| ScreenShare | sharing application screen view |
Steps from cloning the code to running the project
-
Open the CONTRIBUTING.md.
-
Read the Development workflow.
-
Open agora.config.json file and specify your App ID and Token.
See Set up Authentication to learn how to get an App ID and access token. You can get a temporary access token to quickly try out this sample project.
The Channel name you used to generate the token must be the same as the channel name you use to join a channel.
To ensure communication security, Agora uses access tokens (dynamic keys) to authenticate users joining a channel.
Temporary access tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating access tokens. See Generate a Token for details.
-
Make the project and run the app in the simulator or connected physical device.
You are all set! Feel free to play with this sample project and explore features of the Agora RTC SDK.
If you have any problems or suggestions regarding the sample projects, feel free to file an issue.
- Check our FAQ to see if your issue has been recorded.
- 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
- If you encounter problems during integration, feel free to ask questions in Stack Overflow
The sample projects are under the MIT license.