This page provides links to documentation of the Agora Web SDK 3.x and earlier versions.
Docs | Description |
---|---|
Run the One-to-One-Video sample project | Run the sample project and experience a video call implemented by the Agora Web SDK. |
Run the Basic-Video-Broadcasting Sample Project | Run the sample project and experience live video streaming implemented by the Agora Web SDK. |
Start a Voice Call | Use the Agora Web SDK to implement a basic voice call. |
Start a Video Call | Use the Agora Web SDK to implement a basic video call. |
Start Interactive Live Audio Streaming | Use the Agora Web SDK to implement the live audio streaming. |
Start Interactive Live Video Streaming | Use the Agora Web SDK to implement the live video streaming. |
Docs | Description |
---|---|
Use Cloud Proxy | Use the Agora Web SDK in environments with restricted network access. |
Pre-call Tests | Conduct a last-mile network quality test before joining a channel. |
Test a Media Device | Check if the camera or an audio device (a headset, microphone, or speaker) works before joining a channel. |
Channel Connection | Show how the SDK determines the connection state of a user and transitions between the states. |
Adjust the Volume | Manage the sampling volume of the local audio or the playback volume of the subscribed audio. |
Set the Audio Profile | Set the audio profile according to the scenarios, including the sampling rate, bitrate, and encoding mode. |
Set the Video Profile | Set the video profile according to the scenarios, including the video resolution, frame rate, birtate and orientation mode. |
Share the Screen | Enable the host to display what is on their screen to other users in the channel. |
Docs | Description |
---|---|
Report In-call Statistics | Get the audio and video statistics reflecting the overall quality of a call. |
Channel Encryption | Use the built-in encryption of the SDK to improve data security. |
Play Audio Effects/Audio Mixing Files | Play custom sound or music to all the users in the channel. |
Custom Audio Source | Use custom audio source when the default audio module of the SDK does not meet your requirements. |
Custom Video Source | Use custom video source when the default video module of the SDK does not meet your requirements. |
Co-host Across Channels | Relay the media stream of a host from a live streaming channel to a maximum of four channels |
Media Push | Publish the media stream into the CDN (Content Delivery Network). |
Media Stream Fallback | Enable media stream fallback to ensure smooth communication under poor network conditions. |
Network Geofencing | Connect to Agora servers within the specified region |
Docs | Description |
---|---|
Video for Multiple Users | Implement a video scenario that enables multiple users to publish video streams simultaneously. |
Deal with Autoplay Blocking | Get around the autoplay restriction of web browsers. |
Docs | Description |
---|---|
API Reference | The API details and parameters of the Web SDK. |
Error Codes | Possible error codes that the SDK throws. |
Warning Codes | Possible warning codes that the SDK throws. |