RealtimeKitClient

class RealtimeKitClient : IRealtimeKitClient

Properties

Link copied to clipboard
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.

Link copied to clipboard
open override val livestream: RtkLivestream
Link copied to clipboard
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

Link copied to clipboard
open override val meta: RtkMeta

The meta object stores meeting metadata information like title, startedAt time etc

Link copied to clipboard
open override val participants: RtkParticipants

The participants object consists of 4 lists of participants described below and methods that work on multiple participants

Link copied to clipboard
open override val plugins: RtkPlugins

The plugins object consists of 2 lists of plugins described below

Link copied to clipboard
open override val polls: RtkPolls

The polls object stores the polls created in the meeting and also exposes methods to create and vote on polls.

Link copied to clipboard
open override val recording: RtkRecording

The recording object stores the current state of meeting recording and also exposed methods to start and stop recording

Link copied to clipboard
open override val stage: RtkStage
Link copied to clipboard
open override val stores: RtkStoreManager

Functions

Link copied to clipboard
open override fun addChatEventListener(chatEventListener: RtkChatEventListener)
Link copied to clipboard
open override fun addDataUpdateListener(dataUpdateListener: RtkDataUpdateListener)
Link copied to clipboard
open override fun addLivestreamEventListener(livestreamEventListener: RtkLivestreamEventListener)
Link copied to clipboard
open override fun addMeetingRoomEventListener(meetingRoomEventListener: RtkMeetingRoomEventListener)
Link copied to clipboard
open override fun addParticipantsEventListener(participantsEventListener: RtkParticipantsEventListener)
Link copied to clipboard
open override fun addPluginsEventListener(pluginsEventListener: RtkPluginsEventListener)
Link copied to clipboard
open override fun addPollsEventListener(pollsEventListener: RtkPollsEventListener)
Link copied to clipboard
open override fun addRecordingEventListener(recordingEventListener: RtkRecordingEventListener)
Link copied to clipboard
open override fun addSelfEventListener(selfEventListener: RtkSelfEventListener)
Link copied to clipboard
open override fun addStageEventListener(stageEventListener: RtkStageEventListener)
Link copied to clipboard
open override fun addWaitlistEventListener(waitlistEventListener: RtkWaitlistEventListener)
Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
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

Link copied to clipboard
open override fun release(onSuccess: () -> Unit, onFailure: (MeetingError) -> Unit)
Link copied to clipboard
open override fun removeChatEventListener(chatEventListener: RtkChatEventListener)
Link copied to clipboard
open override fun removeDataUpdateListener(dataUpdateListener: RtkDataUpdateListener)
Link copied to clipboard
open override fun removeLivestreamEventListener(livestreamEventListener: RtkLivestreamEventListener)
Link copied to clipboard
open override fun removeMeetingRoomEventListener(meetingRoomEventListener: RtkMeetingRoomEventListener)
Link copied to clipboard
open override fun removeParticipantsEventListener(participantsEventListener: RtkParticipantsEventListener)
Link copied to clipboard
open override fun removePluginsEventListener(pluginsEventListener: RtkPluginsEventListener)
Link copied to clipboard
open override fun removePollsEventListener(pollsEventListener: RtkPollsEventListener)
Link copied to clipboard
open override fun removeRecordingEventListener(recordingEventListener: RtkRecordingEventListener)
Link copied to clipboard
open override fun removeSelfEventListener(selfEventListener: RtkSelfEventListener)
Link copied to clipboard
open override fun removeStageEventListener(stageEventListener: RtkStageEventListener)
Link copied to clipboard
open override fun removeWaitlistEventListener(waitlistEventListener: RtkWaitlistEventListener)
Link copied to clipboard
open override fun setUiKitInfo(name: String, version: String)