文档中心
灵动课堂
API 参考
ConnectionStore | agora classroom sdk
Edu Store API Reference for Web/Electron
Properties
Optional _mainRoomCheckInData
Optional _mainRoomScene
_mainRoomScene?: AgoraRteScene
Optional _subRoomCheckInData
Optional _subRoomScene
_subRoomScene?: AgoraRteScene
Optional classroomStateErrorReason
classroomStateErrorReason?: string
Protected Readonly classroomStore
Optional engine
engine?: AgoraRteEngine
Protected Readonly logger
logger: Logger
rtcState
rtcState: AGRtcState
rtcSubState
rtcSubState: AGRtcState
Accessors
mainRoomScene
- get mainRoomScene(): undefined | AgoraRteScene
Returns undefined | AgoraRteScene
scene
- get scene(): undefined | AgoraRteScene
Returns undefined | AgoraRteScene
subRoomScene
- get subRoomScene(): undefined | AgoraRteScene
Returns undefined | AgoraRteScene
Methods
checkIn
Parameters
Returns Promise<void>
getEngine
- getEngine(): AgoraRteEngine
getRtcState
- getRtcState(connectionType: AGRtcConnectionType): AGRtcState
Parameters
connectionType: AGRtcConnectionType
Returns AGRtcState
joinClassroom
- joinClassroom(): Promise<undefined>
Returns Promise<undefined>
joinRTC
- joinRTC(options?: AgoraRteSceneJoinRTCOptions): Promise<void>
Parameters
Optional options: AgoraRteSceneJoinRTCOptions
Returns Promise<void>
joinSubRoom
- joinSubRoom(roomUuid: string): Promise<undefined>
Parameters
Returns Promise<undefined>
leaveClassroom
- leaveClassroom(reason: LeaveReason, promise?: Promise<void>): Promise<void>
Parameters
Optional promise: Promise<void>
Returns Promise<void>
leaveRTC
- leaveRTC(connectionType?: AGRtcConnectionType): Promise<void>
Parameters
Optional connectionType: AGRtcConnectionType
Returns Promise<void>
leaveSubRoom
- leaveSubRoom(): Promise<void>
ConnectionStore
类用于管理连接状态。