This section describes how to implement a Web client for the student.
This flowchart shows the major logic of the students joining and leaving the classroom:
Integrate the SDK
Refer to the following table to download the SDKs, and integrate the SDKs into your project.
|Product||SDK download||Integration guide|
|RTC (Real-time Communication) SDK||Agora SDK for Web||Start a Video Call|
|RTM (Real-time Messaging) SDK||Real-time Messaging SDK||Peer-to-peer or Channel Messaging|
|Agora Edu Cloud Service||/||Agora Edu Cloud Service quickstart|
|Whiteboard||White SDK||Whiteboard quickstart|
Core API call sequence
Refer to the following diagram to implement the basic real-time communication and messaging functions in your project with the Agora RTC SDK, Agora RTM SDK, and Agora Edu Cloud Service.
Core API reference
- Agora Edu Cloud Service
|entry||Enter a room.|
|get room info||Get the room info.|
|change room info||Change the room info.|
|change user info||Change the user info.|
- Agora RTM SDK
|createInstance||Creates an RTM Client object.|
|login||Logs into the Agora RTM system.|
|createChannel||Creates an Agora RTM channel. You can create multiple channels with an RtmClient object.|
|join||Joins an Agora RTM channel.|
|sendMessage||Sends a channel message, which can be received by all the users in the channel.|
|leave||Leaves the RTM channel.|
- Agora RTC SDK
|createClient||Creates an RTC Client object.|
|Client.init||Initializes the RTC Client object.|
|Client.join||Joins an Agora RTC channel.|
|Client.on("stream-added")||Occurs when a remote audio or video stream is added to the channel.|
|createStream||Creates a Stream object for sending and receiving audio and video.|
|Stream.init||Initializes the Stream object.|
|Client.publish||Publishes the local audio and video stream to SD-RTN.|
|Client.subscribe||Subscribes to the remote audio or video stream.|
|Stream.play||Plays the audio or video stream.|
|Client.leave||Leaves the RTC channel.|
For more features and functions available for an online class, you can refer to the following:
Monitor the network qualityUse the
on("network-quality")callback of the Agora RTC SDK to monitor the last-mile uplink and downlink network quality of every user in the channel. For more methods for reporting the real-time network quality, see the following guides:
Mute the local audio or videoCall the following methods provided by the Agora RTC SDK:
unmuteAudio, to stop or resume sending the local video stream.
unmuteVideo, to stop or resume sending the local video stream.
WhiteboardImplement the following whiteboard functions in your project:
Open-source demo project
Agora provides an open-source demo for One-to-one Clasroom on GitHub to download as a source code reference.