video-common-ui/com.kaleyra.video_common_ui/CallUI

CallUI

class CallUI(call: Call, val activityClazz: Class<*>, val actions: MutableStateFlow<Set<CallUI.Action>>? = null, val scope: CoroutineScope = CoroutineScope(Dispatchers.IO), floatingMessagePresenter: FloatingMessagePresenter = CallUIFloatingMessagePresenter(isGlassesSDK = KaleyraVideo.isGlassesSdk, logger = KaleyraVideo.logger), callUIButtonsProvider: CallUIButtonsProvider = DefaultCallUIButtonsProvider(call.type, call.state, actions, scope)) : Call, FloatingMessagePresenter, CallUIButtonsProvider

Constructors

constructor(call: Call, activityClazz: Class<*>, actions: MutableStateFlow<Set<CallUI.Action>>? = null, scope: CoroutineScope = CoroutineScope(Dispatchers.IO), floatingMessagePresenter: FloatingMessagePresenter = CallUIFloatingMessagePresenter(isGlassesSDK = KaleyraVideo.isGlassesSdk, logger = KaleyraVideo.logger), callUIButtonsProvider: CallUIButtonsProvider = DefaultCallUIButtonsProvider(call.type, call.state, actions, scope))

Types

sealed class ~~Action~~

Call Action triggered by the UI

sealed class Button : UIButton

Call Button representing an action on the call UI

sealed class ~~DisplayMode~~

DisplayMode representing the way call UI is displayed

PresentationMode

sealed class PresentationMode

Properties

val ~~actions~~: MutableStateFlow<Set<CallUI.Action>>? = null

MutableStateFlow> The MutableStateFlow containing the set of actions

val activityClazz: Class<*>

Class<*> the activity that will be used to display the call UI

open override val buttons: StateFlow<Set<CallUI.Button>>

Current Call UI buttons

buttonsProvider

open override var buttonsProvider: (MutableSet<CallUI.Button>) -> Set<CallUI.Button>?

Buttons Provider represents an optional callback that is invoked when call buttons hierarchy is about to being displayed on call UI. This callback allows to return an updated set of Call Buttons if some call button must be added or removed in the integration use case.

open override val chatId: SharedFlow<String>

open override val creationDate: Date

displayModeEvent

val ~~displayModeEvent~~: SharedFlow<DisplayModeEvent>

The display events successfully sent

open override val effects: Effects

floatingMessages

open override val floatingMessages: SharedFlow<FloatingMessage?>

A SharedFlow emitting the currently presented floating message, or null if no message is presented.

open override val id: String

open override val inputs: Inputs

val isLink: Boolean

A property that returns true if the call is a link call.

open override val participants: StateFlow<CallParticipants>

open override val ~~preferredType~~: StateFlow<Call.PreferredType>

presentationModeEvent

val presentationModeEvent: SharedFlow<PresentationModeEvent>

The presentation mode events successfully sent

open override val recording: StateFlow<Call.Recording>

val scope: CoroutineScope

open override val serverId: SharedFlow<String>

open override val sharedFolder: SharedFolder

open override val state: StateFlow<Call.State>

open override val time: Call.Time

open override val type: StateFlow<Call.Type>

open override val whiteboard: Whiteboard

var withFeedback: Boolean

A property that indicates whether the user feedback is asked at the end of call.

Functions

fun Call.amIAlone(): Flow<Boolean>

Utility function to detect whenever the logged SDK user is alone in the call

amIWaitingOthers

fun Call.amIWaitingOthers(): Flow<Boolean>

Utility function to retrieve whenever my participant is waiting for other participants to publish their audio or video streams

areOtherParticipantsRinging

fun Call.areOtherParticipantsRinging(): Flow<Boolean>

fun change(presentationMode: CallUI.PresentationMode): Boolean

open override fun connect()

open override fun dismiss(message: FloatingMessage)

Dismisses a floating message.

doAnyOfMyStreamsIsLive

fun Call.doAnyOfMyStreamsIsLive(): Flow<Boolean>

Utility function to retrieve whenever a local stream has been published and currently visible/audible to other call participants

doOthersHaveStreams

fun Call.doOthersHaveStreams(): Flow<Boolean>

Utility function to retrieve whenever any of the other participants have published streams

open override fun end()

fun Call.hasAudioInput(): Flow<Boolean>

Utility function to detect whenever an audio input is available

hasInternalCameraInput

fun Call.hasInternalCameraInput(): Flow<Boolean>

Utility function to detect whenever an internal video input is available

hasScreenSharingInput

fun Call.hasScreenSharingInput(): Flow<Boolean>

Utility function to detect whenever a screen sharing input is available

isAnyScreenInputActive

fun Call.isAnyScreenInputActive(): Flow<Boolean>

Utility function to detect whenever an input is active

isAppScreenInputActive

fun Call.isAppScreenInputActive(): Flow<Boolean>

Utility function to detect whenever the app screen input is active

isDeviceScreenInputActive

fun Call.isDeviceScreenInputActive(): Flow<Boolean>

Utility function to detect whenever the screen input is active

inline fun <T : Input> Call.isInputActive(): Flow<Boolean>

Utility function to detect whenever an input is active

open override fun present(message: FloatingMessage)

Presents a floating message to the user.

fun ~~setDisplayMode~~(displayMode: CallUI.DisplayMode): Boolean

Set the activity display mode

fun show(): Boolean

Show the call ui

fun Call.toAudioInput(): Flow<Input.Audio?>

toCameraStreamAudio

fun Call.toCameraStreamAudio(): Flow<Input.Audio?>

Utility function to detect whenever a stream with audio has been created

toCameraVideoInput

fun Call.toCameraVideoInput(): Flow<Input.Video.My?>

toInCallParticipants

fun Call.toInCallParticipants(): Flow<List<CallParticipant>>

Utility function to retrieve the participants that are in-call

fun Call.toMe(): Flow<CallParticipant.Me>

Utility function to retrieve my participant

fun Call.toMuteEvents(): Flow<Input.Audio.Event.Request.Mute>

Utility function to detect whenever an audio mute event has been sent

toMyCameraStream

fun Call.toMyCameraStream(): Flow<Stream.Mutable>