AgoraEduRoomContext

joinRoom

加入房间。

Objective-C

void joinRoom(Callback<Void> success,
              Callback<AgoraEduContextError> fail)

参数

参数名	描述
success	调用成功，则返回当前的房间信息 AgoraEduContextRoomInfo。
fail	调用失败，则返回 AgoraEduContextError。

leaveRoom

离开房间。

Objective-C

void leaveRoom(Callback<Void> success,
               Callback<AgoraEduContextError> fail)

参数

参数名	描述
success	成功离开房间。
fail	调用失败，则返回 AgoraEduContextError。

getRoomInfo

获取房间信息。

Objective-C

AgoraEduContextRoomInfo getRoomInfo()

返回值

调用成功，则返回 AgoraEduContextRoomInfo。

getRoomProperties

获取自定义房间属性。

Objective-C

Map<String, Any> getRoomProperties()

返回值

调用成功，则返回 Map<String, Any>。

updateRoomProperties

新增或更新自定义房间属性。

Objective-C

void updateRoomProperties(Map<String, Any> properties,
                          Map<String, Any> cause,
                          Callback<Void> success,
                          Callback<AgoraEduContextError> fail)

详见如何设置自定义房间属性。

属性成功更新后，会触发 onRoomPropertiesUpdated 回调。

参数

参数名	描述
properties	房间属性。
cause	更新原因。可为空。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

deleteRoomProperties

删除自定义房间属性。

Objective-C

void deleteRoomProperties(Array<String> keyPaths,
                          Map<String, Any> cause,
                          Callback<Void> success,
                          Callback<AgoraEduContextError> fail)

参数

参数名	描述
keyPaths	你想要删除的属性的 key path，如 key1.subkey1。
cause	删除原因。可为空。
success	调用成功。
fail	调用失败，则返回 AgoraEduContextError。

getClassInfo

获取课堂信息。

Objective-C

AgoraEduContextClassInfo getClassInfo()

返回值

调用成功，则返回 AgoraEduContextClassInfo。

getRecordingState

获取录制状态。

Objective-C

FcrRecordingState getRecordingState()

返回值

调用成功，则返回 FcrRecordingState。