media-ui-material3/com.google.android.horologist.media.ui.material3.components.ambient/CustomActionAmbientMediaButton

CustomActionAmbientMediaButton

@Composable
fun CustomActionAmbientMediaButton(onClick: () -> Unit, icon: Paintable, contentDescription: String?, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = CircleShape, colorScheme: ColorScheme = MaterialTheme.colorScheme, interactionSource: MutableInteractionSource? = null, iconSize: Dp = IconButtonDefaults.SmallIconSize, buttonPadding: PaddingValues = PaddingValues(0.dp), colors: IconButtonColors = MediaButtonDefaults.mediaButtonAmbientColors(colorScheme), border: BorderStroke? = MediaButtonDefaults.ambientButtonBorder(enabled = enabled, colorScheme = colorScheme))

A base button to display in ambient mode for custom action media controls.

Parameters

onClick

Will be called when the user clicks the button.

icon

The icon to display inside the button.

contentDescription

The content description for the icon.

modifier

Modifier to be applied to the button.

enabled

Controls the enabled state of the button. When false, this button will not be clickable (Optional).

shape

Defines the shape for this button (Optional).

colorScheme

The ColorScheme used for the button (Optional).

interactionSource

an optional hoisted MutableInteractionSource for observing and emitting interactions for this button (Optional).

iconSize

The size of the icon (Optional).

buttonPadding

The padding around the button (Optional).

colors

IconButtonColors that will be used to resolve the background and icon color for this button in different states (Optional).

border

Optional BorderStroke to be applied to the button. If null, no border is drawn. Defaults to a thin border with primary-dim color and 0.5f alpha.