shared/com.mediasfu.sdk.ui.components.display

Package-level declarations

Types

interface AlertComponent : MediaSfuUIComponent

data class AlertComponentOptions(val isVisible: Boolean = false, val message: String = "", val type: AlertType = AlertType.SUCCESS, val duration: Long = 3000, val textColor: Int = 0xFF000000.toInt(), val onHide: () -> Unit? = null)

AlertComponent - Displays alert messages with auto-hide functionality.

AlertType

enum AlertType : Enum<AlertType>

AudioCard

interface AudioCard : MediaSfuUIComponent

AudioCardOptions

data class AudioCardOptions(val name: String, val barColor: Int = 0xFFE82E2E.toInt(), val textColor: Int = 0xFF191919.toInt(), val customStyle: Map<String, Any> = emptyMap(), val controlsPosition: String = "topLeft", val infoPosition: String = "topRight", val participant: Participant, val backgroundColor: Int = 0xFF2C678F.toInt(), val audioDecibels: List<AudioDecibels> = emptyList(), val roundedImage: Boolean = false, val imageSource: String = "", val showControls: Boolean = true, val showInfo: Boolean = true, val showWaveform: Boolean = true, val waveformColor: Int = 0xFF4CAF50.toInt(), val onToggleAudio: AudioControlAction? = null, val onToggleVideo: AudioControlAction? = null)

AudioCard - Displays an audio-only participant card with waveform animation.

AudioControlAction

typealias AudioControlAction = (Participant) -> Unit

AudioDecibelCheck

interface AudioDecibelCheck : MediaSfuUIComponent

AudioDecibelCheckOptions

data class AudioDecibelCheckOptions(val name: String, val audioDecibels: List<AudioDecibels> = emptyList(), val barColor: Int = 0xFFE82E2E.toInt(), val waveformColor: Int = 0xFF4CAF50.toInt(), val customStyle: Map<String, Any> = emptyMap())

AudioDecibelCheck - Displays audio waveform animation based on decibel levels.

AudioGrid

interface AudioGrid : MediaSfuUIComponent

AudioGridOptions

data class AudioGridOptions(val participants: List<Participant>, val audioDecibels: List<AudioDecibels> = emptyList(), val backgroundColor: Int = 0xFF000000.toInt(), val columnsPerRow: Int = 4, val showControls: Boolean = true, val customAudioCardComponent: (AudioCardOptions) -> AudioCard? = null)

AudioGrid - Displays a grid of audio-only participants.

BreakoutParticipantLike

interface BreakoutParticipantLike

Simplified breakout participant representation for pagination. Only needs name field to check room membership.

CardVideoDisplay

interface CardVideoDisplay : MediaSfuUIComponent

CardVideoDisplayOptions

data class CardVideoDisplayOptions(val videoStream: MediaStream?, val remoteProducerId: String = "", val eventType: String = "", val forceFullDisplay: Boolean = false, val customStyle: Map<String, Any> = emptyMap(), val backgroundColor: Int = 0xFF2C678F.toInt(), val doMirror: Boolean = false, val displayLabel: String = "", val showControls: Boolean = false, val showInfo: Boolean = true, val controlsPosition: String = "topLeft", val infoPosition: String = "topRight", val participant: Participant? = null, val onAudioToggle: (Participant) -> Unit? = null, val onVideoToggle: (Participant) -> Unit? = null, val audioDecibels: List<AudioDecibels> = emptyList(), val barColor: Int = 0xFFE82E2E.toInt())

CardVideoDisplay - Displays a video stream within a card.

ControlButton

data class ControlButton(val icon: String, val active: Boolean = false, val onPress: () -> Unit, val activeColor: Int = 0xFF4CAF50.toInt(), val inactiveColor: Int = 0xFFFFFFFF.toInt(), val disabled: Boolean = false, val customComponent: MediaSfuUIComponent? = null, val iconComponent: MediaSfuUIComponent? = null, val alternateIconComponent: MediaSfuUIComponent? = null, val name: String = "")

ControlButtonsAltComponent

interface ControlButtonsAltComponent : MediaSfuUIComponent

ControlButtonsAltComponentOptions

data class ControlButtonsAltComponentOptions(val buttons: List<ControlButton> = emptyList(), val position: String = "bottom", val location: String = "center", val direction: String = "horizontal", val showAspect: Boolean = true, val backgroundColor: Int = 0x80000000.toInt())

ControlButtonsAltComponent - Alternative control buttons layout for media controls.

ControlButtonsComponentTouch

interface ControlButtonsComponentTouch : MediaSfuUIComponent

ControlButtonsComponentTouchOptions

data class ControlButtonsComponentTouchOptions(val buttons: List<ControlButtonOptions> = emptyList(), val position: String = "bottom", val direction: String = "horizontal", val showAspect: Boolean = true, val backgroundColor: Int = 0x80000000.toInt(), val buttonBackgroundColor: Int = 0x40FFFFFF.toInt(), val buttonSpacing: Int = 16, val buttonSize: Int = 56)

ControlButtonsComponentTouch - Touch-optimized control buttons for mobile devices.

DefaultAlertComponent

class DefaultAlertComponent(val options: AlertComponentOptions) : AlertComponent

Default implementation of AlertComponent

DefaultAudioCard

class DefaultAudioCard(val options: AudioCardOptions) : AudioCard

Default implementation of AudioCard

DefaultAudioDecibelCheck

class DefaultAudioDecibelCheck(val options: AudioDecibelCheckOptions) : AudioDecibelCheck

Default implementation of AudioDecibelCheck

DefaultAudioGrid

class DefaultAudioGrid(val options: AudioGridOptions) : AudioGrid

Default implementation of AudioGrid

DefaultCardVideoDisplay

class DefaultCardVideoDisplay(val options: CardVideoDisplayOptions) : CardVideoDisplay

Default implementation of CardVideoDisplay

DefaultControlButtonsAltComponent

class DefaultControlButtonsAltComponent(val options: ControlButtonsAltComponentOptions) : ControlButtonsAltComponent

Default implementation of ControlButtonsAltComponent

DefaultControlButtonsComponentTouch

class DefaultControlButtonsComponentTouch(val options: ControlButtonsComponentTouchOptions) : ControlButtonsComponentTouch

Default implementation of ControlButtonsComponentTouch

DefaultFlexibleGrid

class DefaultFlexibleGrid(val options: FlexibleGridOptions) : FlexibleGrid

Default implementation of FlexibleGrid

DefaultFlexibleVideo

class DefaultFlexibleVideo(val options: FlexibleVideoOptions) : FlexibleVideo

Default implementation of FlexibleVideo

DefaultLoadingModal

class DefaultLoadingModal(val options: LoadingModalOptions) : LoadingModal

Default implementation of LoadingModal

DefaultMainAspectComponent

class DefaultMainAspectComponent(val options: MainAspectComponentOptions) : MainAspectComponent

Default implementation of MainAspectComponent

DefaultMainContainerComponent

class DefaultMainContainerComponent(val options: MainContainerComponentOptions) : MainContainerComponent

Default implementation of MainContainerComponent

DefaultMainGridComponent

class DefaultMainGridComponent(val options: MainGridComponentOptions) : MainGridComponent

Default implementation of MainGridComponent

DefaultMainScreenComponent

class DefaultMainScreenComponent(val options: MainScreenComponentOptions) : MainScreenComponent

Default implementation of MainScreenComponent

DefaultMiniAudio

class DefaultMiniAudio(val options: MiniAudioOptions) : MiniAudio

Default implementation of MiniAudio

DefaultMiniCard

class DefaultMiniCard(val options: MiniCardOptions) : MiniCard

Default implementation of MiniCard

DefaultOtherGridComponent

class DefaultOtherGridComponent(val options: OtherGridComponentOptions) : OtherGridComponent

Default implementation of OtherGridComponent

DefaultPagination

class DefaultPagination(val options: PaginationOptions) : Pagination

Default implementation of Pagination

DefaultSubAspectComponent

class DefaultSubAspectComponent(val options: SubAspectComponentOptions) : SubAspectComponent

Default implementation of SubAspectComponent

FlexibleGrid

interface FlexibleGrid : MediaSfuUIComponent

FlexibleGridOptions

data class FlexibleGridOptions(val customWidth: Int, val customHeight: Int, val rows: Int, val columns: Int, val componentsToRender: List<MediaSfuUIComponent>, val backgroundColor: Int = 0xFF2C678F.toInt(), val participants: List<Participant> = emptyList(), val showAspect: Boolean = true, val cardWidthOverride: Int? = null, val cardHeightOverride: Int? = null, val horizontalSpacingDp: Int = 0, val verticalSpacingDp: Int = 0)

FlexibleGrid - Displays a flexible grid of video/audio participants.

FlexibleVideo

interface FlexibleVideo : MediaSfuUIComponent

FlexibleVideoOptions

data class FlexibleVideoOptions(val customWidth: Int, val customHeight: Int, val rows: Int = 1, val columns: Int = 1, val componentsToRender: List<MediaSfuUIComponent> = emptyList(), val backgroundColor: Int = 0xFF2C678F.toInt(), val showAspect: Boolean = false)

FlexibleVideo - Displays a flexible video container that adapts to content.

LoadingModal

interface LoadingModal : MediaSfuUIComponent

LoadingModalOptions

data class LoadingModalOptions(val isVisible: Boolean = false, val backgroundColor: Int = 0x80000000.toInt(), val indicatorColor: Int = 0xFFFFFFFF.toInt(), val displayColor: Int = 0xFFFFFFFF.toInt(), val message: String? = null)

LoadingModal - Displays a loading indicator with backdrop overlay.

MainAspectComponent

interface MainAspectComponent : MediaSfuUIComponent

MainAspectComponentOptions

data class MainAspectComponentOptions(val backgroundColor: Int = 0xFF2C678F.toInt(), val defaultFraction: Double = 1.0, val showControls: Boolean = true, val children: List<MediaSfuUIComponent> = emptyList(), val updateIsWideScreen: (Boolean) -> Unit? = null, val updateIsMediumScreen: (Boolean) -> Unit? = null, val updateIsSmallScreen: (Boolean) -> Unit? = null)

MainAspectComponent - Main aspect ratio container for primary video display.

MainContainerComponent

interface MainContainerComponent : MediaSfuUIComponent

MainContainerComponentOptions

data class MainContainerComponentOptions(val backgroundColor: Int = 0xFF000000.toInt(), val children: List<MediaSfuUIComponent> = emptyList(), val containerWidthFraction: Double = 1.0, val containerHeightFraction: Double = 1.0, val marginLeft: Int = 0, val marginRight: Int = 0, val marginTop: Int = 0, val marginBottom: Int = 0, val padding: Int = 0)

MainContainerComponent - Main container for the entire application layout.

MainGridComponent

interface MainGridComponent : MediaSfuUIComponent

MainGridComponentOptions

data class MainGridComponentOptions(val height: Int, val width: Int, val backgroundColor: Int = 0xFF2C678F.toInt(), val children: List<MediaSfuUIComponent> = emptyList(), val mainSize: Double = 0.0, val showAspect: Boolean = true, val timeBackgroundColor: Int = 0xFFFFFFFF.toInt(), val showTimer: Boolean = true)

MainGridComponent - Main grid layout for displaying multiple participants.

MainScreenComponent

interface MainScreenComponent : MediaSfuUIComponent

MainScreenComponentOptions

data class MainScreenComponentOptions(val children: List<MediaSfuUIComponent> = emptyList(), val backgroundColor: Int = 0xFF2C678F.toInt(), val mainSize: Double = 1.0, val showAspect: Boolean = true, val updateComponentSizes: (Map<String, Any>) -> Unit? = null)

MainScreenComponent - Main screen container for primary content display.

MiniAudio

interface MiniAudio : MediaSfuUIComponent

MiniAudioOptions

data class MiniAudioOptions(val name: String, val visible: Boolean = true, val showWaveform: Boolean = true, val customStyle: Map<String, Any> = emptyMap(), val backgroundColor: Int = 0xFF2C678F.toInt(), val imageSource: String = "", val roundedImage: Boolean = true, val audioDecibels: List<AudioDecibels> = emptyList())

MiniAudio - Displays a mini audio card for compact participant view.

MiniCard

interface MiniCard : MediaSfuUIComponent

MiniCardOptions

data class MiniCardOptions(val name: String, val showVideo: Boolean = true, val customStyle: Map<String, Any> = emptyMap(), val backgroundColor: Int = 0xFF2C678F.toInt(), val imageSource: String = "", val roundedImage: Boolean = false, val videoStream: MediaStream? = null, val participant: Participant)

MiniCard - Displays a mini video/audio card for compact participant view.

OtherGridComponent

interface OtherGridComponent : MediaSfuUIComponent

OtherGridComponentOptions

data class OtherGridComponentOptions(val height: Int, val width: Int, val backgroundColor: Int = 0xFF2C678F.toInt(), val children: List<MediaSfuUIComponent> = emptyList(), val gridSize: Double = 0.0, val showAspect: Boolean = true)

OtherGridComponent - Secondary grid for additional participants.

Pagination

interface Pagination : MediaSfuUIComponent

PaginationOptions

data class PaginationOptions(val totalPages: Int, val currentUserPage: Int, val handlePageChange: suspend (GeneratePageContentOptions) -> Unit, val parameters: PaginationParameters, val position: String = "middle", val location: String = "top", val direction: String = "horizontal", val showAspect: Boolean = true, val backgroundColor: Int = 0xFFFFFFFF.toInt(), val activeColor: Int = 0xFF2c678f.toInt(), val inactiveColor: Int = 0xFFFFFFFF.toInt(), val paginationHeight: Int = 40)

Pagination - Displays pagination controls for navigating through pages.

PaginationParameters

interface PaginationParameters : GeneratePageContentParameters

Extended parameters interface for Pagination with breakout room support. Matches Flutter's PaginationParameters.

SubAspectComponent

interface SubAspectComponent : MediaSfuUIComponent

SubAspectComponentOptions

data class SubAspectComponentOptions(val backgroundColor: Int = 0xFF2C678F.toInt(), val showControls: Boolean = false, val children: List<MediaSfuUIComponent> = emptyList(), val defaultFraction: Double = 0.0)

SubAspectComponent - Sub aspect ratio container for secondary video displays.