This section describes how to implement an iOS client for the student.

Flowchart

This flowchart shows the major logic of the student 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 iOS Start Live Interactive Streaming
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
API Function
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
API Function
initWithAppId Creates an AgoraRtmKit object.
loginByToken Logs into the Agora RTM system.
createChannelWithId Creates an Agora RTM channel. You can create multiple channels with an AgoraRtmKit object.
joinWithCompletion Joins an Agora RTM channel.
initWithText Creates an AgoraRtmMessage object.
sendMessage Sends a channel message, which can be received by all the users in the channel.
leaveWithCompletion Leaves the RTM channel.
logoutWithCompletion Logs out of the RTM system.
  • Agora RTC SDK
API Function
sharedEngineWithAppId Initialize an AgoraRtcEngineKit object.
setChannelProfile Sets the channel profile. In this scenario, we set the channel profile as Live Broadcast.
setClientRole Sets the user role in a live broadcast. In this scenario, we set the role of students as broadcaster before they join the channel. During the class, the students and the teacher can see and talk to each other in real time.
enableVIdeo Enables the video module.
setVideoEncoderConfiguration Sets the video encoder configuration.
setupLocalVideo Sets the local video view.
joinChannelByToken Joins an Agora RTC channel. You can call startPreview to start the local video preview before joining a channel.
setupRemoteVideo Sets the remote video view.
leaveChannel Leaves the RTC channel.

Additional functions

For more features and functions available for an online class, you can refer to the following:

Monitor the network quality Use the networkQuality 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:
  • Lastmile tests
  • In-call Stats
  • Mute the local audio or video Call the following methods provided by the Agora RTC SDK:
  • muteLocalAudioStream, to stop or resume sending the local audio stream.
  • muteLocalVideoStream, to stop or resume sending the local video stream.
  • Voice detection For RTC SDKs later than v2.9.2, you can enable voice detection by calling enableAudioVolumeInfication, and setting the report_vad parameter as true. Once enabled, the reportAudioVolumeIndicationOfSpeakers callback reports whether the local user is speaking in the AgoraRtcAudioVolumeInfo struct.
    Whiteboard Implement the following whiteboard functions in your project:
  • Document Conversion
  • State Management
  • Tools
  • Perspective operation
  • Whiteboard Operation
  • Page (Scene) Management
  • Open-source demo project

    Agora provides an open-source demo for Small Classroom on GitHub to download as a source code reference.