Agora Edu Store provides methods and callbacks for developers to implement the modular features in Flexible Classroom.
The CloudDriveStore
class provides abilities related the cloud drive.
Core methods
Method | Description |
---|---|
cancelUpload | Cancels uploading the file |
fetchPersonalResources | Gets all personal resources |
removePersonalResources | Removes files from personal resources |
retryUpload | Retries uploading the file |
uploadPersonalResource | Uploads a file to personal resources |
The GroupStore
class provides abilities related to breakout rooms.
Core methods
Method | Description |
---|---|
acceptGroupInvite | Accepts the invitation of joining a group |
addGroups | Creates a group |
joinSubRoom | Joins a group |
leaveSubRoom | Leaves the group |
moveIntoSubRoom | A user moves from a group to another group |
moveUsersToGroup | Moves users from a group to another group |
rejectGroupInvite | Rejects the invitation of joining a group |
removeGroupUsers | Removes users from a group |
removeGroups | Removes groups |
startGroup | Starts the breakout session |
stopGroup | Stops the breakout session |
updateGroupInfo | Updates the grouping options |
updateGroupUsers | Updates the grouping options |
The HandUpStore
class provides abilities related to the hand-raising feature.
Core methods
Method | Description |
---|---|
cancelHandUp | The student lowers the hand to cancel the application for speaking up |
offPodium | Lets a student "go off the stage" |
offPodiumAll | Lets all students "go off the stage" |
onPodium | Allows a student to "go onto the stage" |
rejectHandUp | The teacher rejects the student's application for speaking up |
waveArm | The student wave's an arm |
The MediaStore
class is used for processing media streams.
Core methods
Method | Description |
---|---|
enableLocalAudio | Enables or disables the local audio |
enableLocalVideo | Enables or disables the local video |
getWindowDevices | Gets the window ID when using the video source |
hasScreenSharePermission | Whether has the permission of sharing the screen |
isScreenDeviceEnumerateSupported | Whether screen sharing is supported |
setupLocalScreenShare | Sets a node for rendering the local screen-sharing stream |
startScreenShareCapture | Starts sharing the screen |
stopScreenShareCapture | Stops sharing the screen |
updateLocalMediaState | Updates the local media state |
The RecordingStore
class provides recording-related abilities.
Core methods
Method | Description |
---|---|
startRecording | Starts recording |
stopRecording | Stops recording |
The RoomStore
class is used for initializing rooms and listening for the room data.
Core methods
Method | Description |
---|---|
sendRewards | Sends rewards to users |
startCarousel | Starts the video gallery rotation |
stopCarousel | Stops the video gallery rotation |
updateClassState | Updates the class state |
The StatisticsStore
class provides network statistics.
The StreamStore
class is used for managing media streams.
Core methods
Method | Description |
---|---|
updateLocalPublishState | Updates the local audio ad video publishing states |
updateRemotePublishState | Updates the remote audio ad video publishing states |
setLatencyLevel | Sets the delay level |
The UserStore
class is used for managing users.
Core methods
Method | Description |
---|---|
fetchUserList | Gets the user list |
kickOutOnceOrBan | Kicks a user out of the room |
The ConnectionStore
class is used for managing connection states.
Core methods
Method | Description |
---|---|
checkIn | Sets the check-in data |
enableDualStream | Enables dual-stream mode |
getEngine | Gets RteEngine |
getRtcState | Gets the RTC state |
initialize | Initializes RteEngine |
joinClassroom | Joins the room |
joinRTC | Joins an RTC channel |
joinSubRoom | Joins a sub-room |
leaveClassroom | Leaves the room |
leaveRTC | Leaves the RTC channel |
leaveSubRoom | Leaves the sub-room |
setLowStreamParameter | Sets the video profile of the low-quality video stream |
setRemoteVideoStreamType | Sets which video stream of a remote user to subscribe to |