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

ControlButton

class ControlButton(options: ControlButtonOptions) : BaseMediaSfuUIComponent, InteractiveComponent, StylableComponent

Individual control button component.

Constructors

Link copied to clipboard
constructor(options: ControlButtonOptions)

Properties

Link copied to clipboard
open override val currentStyle: ComponentStyle

Get the current style of this component.

Link copied to clipboard
open override val id: String

Unique identifier for this UI component.

Link copied to clipboard
val isActive: StateFlow<Boolean>
Link copied to clipboard
open override val isEnabled: Boolean

Whether this component is currently enabled.

Link copied to clipboard
open override val isVisible: Boolean

Whether this component is currently visible.

Functions

Link copied to clipboard
open override fun applyStyle(style: ComponentStyle)

Apply a style to this component.

Link copied to clipboard
open override fun disable()

Disable this component.

Link copied to clipboard
open override fun dispose()

Dispose of this component and release resources.

Link copied to clipboard
open override fun enable()

Enable this component.

Link copied to clipboard
fun getAlternateIcon(): String?

Get the button's alternate icon name (for active state).

Link copied to clipboard
fun getIcon(): String?

Get the button's icon name.

Link copied to clipboard
fun getText(): String?

Get the button's display text.

Link copied to clipboard
open override fun handleInteraction(event: InteractionEvent)

Handle a user interaction event.

Link copied to clipboard
open override fun hide()

Hide this component.

Link copied to clipboard
fun setActive(active: Boolean)

Set the active state of this button.

Link copied to clipboard
open override fun show()

Show this component.

Link copied to clipboard
fun toggleActive()

Toggle the active state of this button.