Documentation
Flexible Classroom
Console Agora.io Community Submit ticket
English
search-icon

User Context

Last updated 2021/10/13 09:24:41

UserContext

UserContext class provides user-list-related methods that can be called by your app.

localUserInfo

abstract fun localUserInfo(): EduContextUserInfo

Gets the information of the local user. See EduContextUserInfo.

updateFlexUserProps

abstract fun updateFlexUserProps(userUuid: String,
                                 properties: MutableMap<String, String>,
                                 cause: MutableMap<String, String>?)

Adds or updates custom user properties. For details, see How can I set user properties?

After you successfully update the properties, the remote client receives the onFlexUserPropertiesChanged callback.

Parameter Description
userUuid The user ID.
properties The user properties.
cause The update reason.

muteVideo

abstract fun muteVideo(muted: Boolean)

Enables or disables the local video.

Parameter Description
muted Whether to disable the local video.

muteAudio

abstract fun muteAudio(muted: Boolean)

Enables or disables the local audio.

Parameter Description
muted Whether to disable the local audio.

renderVideo

abstract fun renderVideo(container: ViewGroup?, streamUuid: String)

Starts or stops rendering the local video stream.

Parameter Description
container The video container. Setting viewGroup as null means stopping rendering the video stream.
streamUuid The stream ID.

setVideoEncoderConfig

abstract fun setVideoEncoderConfig(config: EduContextVideoEncoderConfig)

Sets the video encoder configuration.

Parameter Description
config The video encoding configuration. See EduContextVideoEncoderConfig.

IUserHandler

IUserHandler reports user-list-related event callbacks to the app.

onUserListUpdated

fun onUserListUpdated(list: MutableList<EduContextUserDetailInfo>)

Occurs when the user list is updated. Only display the information of online users.

Parameter Description
list The list of online users, which is an array of EduContextUserDetailInfo objects.

onCoHostListUpdated

fun onCoHostListUpdated(list: MutableList<EduContextUserDetailInfo>)

Occurs when the list of on-stage users is updated. Only display the information of users whose status is "on stage", including users who are not online.

Parameter Description
list The list of on-stage users, which is an array of EduContextUserDetailInfo objects.

onUserReward

fun onUserReward(userInfo: EduContextUserInfo)

Occurs when the local user receives a reward.

Parameter Description
userInfo The user information. See EduContextUserInfo for details.

onKickOut

fun onKickOut()

Occurs when the local user is kicked out of the classroom.

onVolumeUpdated

fun onVolumeUpdated(volume: Int, streamUuid: String)

Occurs when the volume of the local user updates.

Parameter Description
volume The volume.
streamUuid The stream ID.

onRoster

fun onRoster(context: Context, anchor: View, type: Int?)

Displays the user list.

Parameter Description
type There are two types of the user list: RosterType.SmallClass and RosterType.LargeClass.

onUserTip

fun onUserTip(tip: String)

Reports the tips related to the user.

There are the following tips:

  • Your camera has been turned off.
  • Your camera has been turned on.
  • Your microphone has been turned off.
  • Your microphone has been turned on.
Parameter Description
string The tip.

onRoster

fun onRoster(context: Context, anchor: View, type: Int?)

Displays the user list.

Parameter Description
context The context of the app.
anchor The Icon-View of the user list.
type There are two types of user lists:
  • RosterType.SmallClass: The user list for the Small Classroom scenario.
  • RosterType.LargeClass: The user list for the Lecture Hall scenario.
    		•

    onFlexUserPropsChanged

    fun onFlexUserPropsChanged(changedProperties: MutableMap<String, Any>,
                           properties: MutableMap<String, Any>,
                           cause: MutableMap<String, Any>?,
                           fromUser: EduContextUserDetailInfo,
                           operator: EduContextUserInfo?)

    Occurs when the custom user properties are updated.

    Parameter Description
    changedProperties The updated user properties.
    properties All user properties.
    cause The update reason.
    fromUser The information of users whose properties are updated. See EduContextUserDetailInfo for details.
    operator The information of the operator. See EduContextUserInfo. operator being empty means that properties are updated by the server.