core/com.cloudflare.realtimekit/RealtimeKitClient

RealtimeKitClient

class RealtimeKitClient : IRealtimeKitClient

Properties

chat

open override val chat: RtkChat

The chat object stores the chat messages that were sent in the meeting. This includes text messages, images, and files.

livestream

open override val livestream: RtkLivestream

localUser

open override val localUser: RtkSelfParticipant

The localUser object stores information about the local user, their current media state and exposes methods to enable and disable media etc

Functions

addChatEventListener

open override fun addChatEventListener(chatEventListener: RtkChatEventListener)

addDataUpdateListener

open override fun addDataUpdateListener(dataUpdateListener: RtkDataUpdateListener)

addLivestreamEventListener

open override fun addLivestreamEventListener(livestreamEventListener: RtkLivestreamEventListener)

addMeetingRoomEventListener

open override fun addMeetingRoomEventListener(meetingRoomEventListener: RtkMeetingRoomEventListener)

addParticipantsEventListener

open override fun addParticipantsEventListener(participantsEventListener: RtkParticipantsEventListener)

addPluginsEventListener

open override fun addPluginsEventListener(pluginsEventListener: RtkPluginsEventListener)

addPollsEventListener

open override fun addPollsEventListener(pollsEventListener: RtkPollsEventListener)

addRecordingEventListener

open override fun addRecordingEventListener(recordingEventListener: RtkRecordingEventListener)

addSelfEventListener

open override fun addSelfEventListener(selfEventListener: RtkSelfEventListener)

addStageEventListener

open override fun addStageEventListener(stageEventListener: RtkStageEventListener)

addWaitlistEventListener

open override fun addWaitlistEventListener(waitlistEventListener: RtkWaitlistEventListener)

init

open override fun init(meetingInfo: RtkMeetingInfo, onSuccess: () -> Unit, onFailure: (MeetingError) -> Unit)

Initialises the meeting with the given meetingInfo, sets up everything that is required to join the meeting. Once init is complete, you get a callback on onSuccess or onFailure if there was a failure

joinRoom

open override fun joinRoom(onSuccess: () -> Unit, onFailure: (MeetingError) -> Unit)

Join the meeting. Once meeting has been join you get a callback on onSuccess or onFailure in case of failure

leaveRoom

open override fun leaveRoom(onSuccess: () -> Unit, onFailure: (MeetingError) -> Unit)

Leave the meeting. Once meeting has been left you get a callback on onSuccess or onFailure in case of failure

release

open override fun release(onSuccess: () -> Unit, onFailure: (MeetingError) -> Unit)

removeChatEventListener

open override fun removeChatEventListener(chatEventListener: RtkChatEventListener)

removeDataUpdateListener

open override fun removeDataUpdateListener(dataUpdateListener: RtkDataUpdateListener)

removeLivestreamEventListener

open override fun removeLivestreamEventListener(livestreamEventListener: RtkLivestreamEventListener)

removeMeetingRoomEventListener

open override fun removeMeetingRoomEventListener(meetingRoomEventListener: RtkMeetingRoomEventListener)

removeParticipantsEventListener

open override fun removeParticipantsEventListener(participantsEventListener: RtkParticipantsEventListener)

removePluginsEventListener

open override fun removePluginsEventListener(pluginsEventListener: RtkPluginsEventListener)

removePollsEventListener

open override fun removePollsEventListener(pollsEventListener: RtkPollsEventListener)

removeRecordingEventListener

open override fun removeRecordingEventListener(recordingEventListener: RtkRecordingEventListener)

removeSelfEventListener

open override fun removeSelfEventListener(selfEventListener: RtkSelfEventListener)

removeStageEventListener

open override fun removeStageEventListener(stageEventListener: RtkStageEventListener)

removeWaitlistEventListener

open override fun removeWaitlistEventListener(waitlistEventListener: RtkWaitlistEventListener)

setUiKitInfo

open override fun setUiKitInfo(name: String, version: String)