Class ConnectionStore
ConnectionStore
类用于管理连接状态。
Properties
classroomState
classroomState: ClassroomState
房间连接状态
engine
engine?: AgoraRteEngine
RTE 引擎
rtcState
rtcState: AGRtcState
RTC 连接状态
Accessors
scene
get scene(): undefined | AgoraRteScene
当前场景对象
sceneId
get sceneId(): string
当前场景 ID
Methods
addCloudProxyObserver
addCloudProxyObserver(observer: AgoraCloudProxyObserver): void
添加一个云代理观察者,joinClassroom 成功调用后才能调用此方法
参数
参数名 | 描述 |
---|---|
返回值
checkIn
checkIn(sessionInfo: EduSessionInfo, sceneType: SceneType, mode: "check-in" | "entry"): Promise<void>
进入房间预检,进入房间前请先调用此方法
参数
参数名 | 描述 |
---|---|
返回值
getEngine
getEngine(): AgoraRteEngine
获取当前 RteEngine,调用此方法获取实例前需要先调用 connectionStore.initialize, 否则将抛出异常
返回值
RTE engine
getRtcState
getRtcState(connectionType: AGRtcConnectionType): AGRtcState
获取房间 RTC 状态
参数
参数名 | 描述 |
---|---|
返回值
initialize
joinClassroom
joinRTC
joinRTC(options?: AgoraRteSceneJoinRTCOptions): Promise<void>
加入 RTC 频道
参数
参数名 | 描述 |
---|---|
RTC 配置 |
返回值
joinSubRoom
leaveClassroom
leaveClassroom(reason: LeaveReason, promise?: Promise<void>): Promise<void>
离开房间
参数
参数名 | 描述 |
---|---|
原因 |
返回值
leaveRTC
leaveRTC(connectionType?: AGRtcConnectionType): Promise<void>
离开 RTC 频道
参数
参数名 | 描述 |
---|---|
大小 scene |
返回值
leaveSubRoom
removeCloudProxyObserver
removeCloudProxyObserver(observer: AgoraCloudProxyObserver): void
移除一个云代理观察者,joinClassroom 成功调用后才能调用此方法
参数
参数名 | 描述 |
---|---|