new web demo has been moved to : https://github.com/AgoraIO/API-Examples-Web/tree/new
English | 简体中文
This repository contains sample projects using the Agora RTC Web SDK 4.x.
If you are still not familiar with Agora RTC Web SDK 4.x, please follow our community interactive tutorial to quickly understand the SDK and use CodePen iframes to call the SDK in your browser.
The Web SDK 4.x refactors the Web SDK 3.x. Based on the features of 3.x, 4.x fully optimizes the internal architecture of the SDK and provides more flexible and easy-to-use APIs.
Compared to the Web SDK 3.x, the Web SDK 4.x has the following advantages:
- Uses promises for asynchronous operations, which improves the robustness and readability of your code.
- Supports TypeScript.
- Replaces the Stream object with Track objects for separate and flexible control over audio and video.
- Improves the channel event notification mechanism, making it easier for you to deal with reconnection.
- Provides more accurate and comprehensive error codes for troubleshooting.
| Feature | Sample project location |
|---|---|
| Adjust video profile | /Demo/adjustVideoProfile |
| Audio mixing and audio effect | /Demo/audioMixingAndAudioEffect |
| Live streaming | /Demo/basicLive |
| Enable/disable Video/Audio track | /Demo/basicMute |
| Video call | /Demo/basicVideoCall |
| Cloud proxy | /Demo/cloudProxy |
| Custom video source | /Demo/customVideoSource |
| Display call status | /Demo/displayCallStats |
| Dual stream | /Demo/dualStream |
| Geofencing | /Demo/geoFencing |
| Join multiple channels | /Demo/joinMultipleChannel |
| Push stream to CDN | /Demo/pushStreamToCDN |
| Control recording devices | /Demo/recordingDeviceControl |
| Custom rendering | /Demo/selfRendering |
| Custom Capturing | /Demo/selfCapturing |
| Share the screen | /Demo/shareTheScreen |
| Video beauty effect | /Demo/videoBeautyEffect |
You need a supported browser to run the sample projects. See Product Overview for a list of supported browsers.
- Use a supported browser to open
Demo/index.htmland select a demo. - In the demo page, enter your App ID, token, and channel name and join the channel.
- See Get Started with Agora to learn how to get an App ID and token. You can get a temporary access token to quickly try out this sample project.
- The channel name must be the same as the channel ID used to generate the token.
| Feature | Sample project location |
|---|---|
| React api example | /react/api-examples |
- You need a supported browser to run the sample projects. See Product Overview for a list of supported browsers.
- npm
-
Navigate to /react/api-examples and run the following command to install dependencies.
npm install
-
Use the following command to run the sample project.
npm run dev
-
In the demo page, enter your App ID, token, and channel name and join the channel.
- See Get Started with Agora to learn how to get an App ID and token. You can get a temporary access token to quickly try out this sample project.
- The channel name must be the same as the channel ID used to generate the token.
| Feature | Sample project location |
|---|---|
| Vue api example | /vue/api-examples |
- You need a supported browser to run the sample projects. See Product Overview for a list of supported browsers.
- npm
-
Navigate to /vue/api-examples and run the following command to install dependencies.
npm install
-
Use the following command to run the sample project.
npm run dev
-
In the demo page, enter your App ID, token, and channel name and join the channel.
- See Get Started with Agora to learn how to get an App ID and token. You can get a temporary access token to quickly try out this sample project.
- The channel name must be the same as the channel ID used to generate the token.
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. See the LICENSE file for details.