lib/live.hms.video.interactivity/HmsInteractivityCenter

HmsInteractivityCenter

class HmsInteractivityCenter

Functions

fun add(response: HMSPollResponseBuilder, completion: HmsTypedActionResultListener<PollAnswerResponse>)

Adds a response (vote) to a poll.

fetchLeaderboard

fun fetchLeaderboard(pollId: String, count: Long = 50, startIndex: Long = 0, includeCurrentPeer: Boolean = false, completion: HmsTypedActionResultListener<PollLeaderboardResponse>)

fun fetchPollList(pollState: HmsPollState, completion: HmsTypedActionResultListener<List<HmsPoll>>)

fetchPollQuestions

fun fetchPollQuestions(poll: HmsPoll, completion: HmsTypedActionResultListener<List<HMSPollQuestion>>)

fun getPollResults(poll: HmsPoll, completion: HmsTypedActionResultListener<HmsPoll>)

fun getResponses(poll: HmsPoll, offset: Int = 0, @IntRange(from = 1, to = 50) count: Int = 50, ownResponsesOnly: Boolean, completion: HmsTypedActionResultListener<List<HMSPollQuestionResponse>>)

Retrieve full responses.

fun quickStartPoll(poll: HMSPollBuilder, completion: HMSActionResultListener)

Start a poll.

removeWhiteboardUpdateListener

fun removeWhiteboardUpdateListener(whiteBoardUpdateListener: HMSWhiteboardUpdateListener?)

setWhiteboardUpdateListener

fun setWhiteboardUpdateListener(whiteBoardUpdateListener: HMSWhiteboardUpdateListener?)

This function update state of current whitebaard session HMSWhiteboardUpdate.Start and HMSWhiteboardUpdate.Stop

startWhiteboard

fun startWhiteboard(title: String, completion: HMSActionResultListener)

This function starts a new whiteboard session, make sure you have the admin permission in []

fun stop(poll: HmsPoll, completion: HMSActionResultListener)

End a poll.

fun stopWhiteboard(completion: HMSActionResultListener)

This function stops the current whiteboard session.

Properties

currentWhiteBoardState

var currentWhiteBoardState: State

val polls: List<HmsPoll>

The array of polls managed by the interactivity center.

pollUpdateListener

var pollUpdateListener: HmsPollUpdateListener? = null

Called when a poll is started/stopped/updated.