Refactor volume action state management and deprecate stream actions

Copilot · sds100 · Copilot · commit 3a6ac1610834 · 2025-10-25T11:39:10.000Z
- Consolidated volumeUpActionState and volumeDownActionState into single volumeActionState
- Added actionId to VolumeActionBottomSheetState to determine which action to create
- Updated bottom sheet to use actionId for dynamic title selection
- Merged onDoneConfigVolumeUpClick and onDoneConfigVolumeDownClick into single handler
- Deprecated VOLUME_INCREASE_STREAM and VOLUME_DECREASE_STREAM ActionIds
- Deprecated Volume.Stream classes (kept for backward compatibility)
- Updated CHANGELOG wording to "Consolidated volume and stream actions"

Co-authored-by: sds100 &lt;16245954+sds100@users.noreply.github.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,7 +17,7 @@
 - #727 Actions to send SMS messages: "Send SMS" and "Compose SMS"
 - #1819 Explain how to enable the accessibility service restricted setting
 - #661 Action to execute shell commands.
-- Volume up/down actions now allow selecting a specific audio stream (e.g., music, notifications) to control, consolidating the functionality of increase/decrease stream actions.
+- Consolidated volume and stream actions.
 
 ## Removed
 
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/actions/ActionData.kt b/base/src/main/java/io/github/sds100/keymapper/base/actions/ActionData.kt
@@ -98,6 +98,7 @@ sealed class ActionData : Comparable<ActionData> {
 
     @Serializable
     sealed class Volume : ActionData() {
+        @Deprecated("Use Volume.Up or Volume.Down with volumeStream parameter instead")
         sealed class Stream : Volume() {
             abstract val volumeStream: VolumeStream
             abstract val showVolumeUi: Boolean
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/actions/ActionId.kt b/base/src/main/java/io/github/sds100/keymapper/base/actions/ActionId.kt
@@ -45,7 +45,9 @@ enum class ActionId {
     VOLUME_UP,
     VOLUME_DOWN,
     VOLUME_SHOW_DIALOG,
+    @Deprecated("Use VOLUME_DOWN with volumeStream parameter instead")
     VOLUME_DECREASE_STREAM,
+    @Deprecated("Use VOLUME_UP with volumeStream parameter instead")
     VOLUME_INCREASE_STREAM,
     CYCLE_RINGER_MODE,
     CHANGE_RINGER_MODE,
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/actions/ChooseActionScreen.kt b/base/src/main/java/io/github/sds100/keymapper/base/actions/ChooseActionScreen.kt
@@ -55,8 +55,7 @@ fun HandleActionBottomSheets(delegate: CreateActionDelegate) {
     ChangeFlashlightStrengthActionBottomSheet(delegate)
     HttpRequestBottomSheet(delegate)
     SmsActionBottomSheet(delegate)
-    VolumeUpActionBottomSheet(delegate)
-    VolumeDownActionBottomSheet(delegate)
+    VolumeActionBottomSheet(delegate)
 }
 
 @Composable
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/actions/CreateActionDelegate.kt b/base/src/main/java/io/github/sds100/keymapper/base/actions/CreateActionDelegate.kt
@@ -54,8 +54,7 @@ class CreateActionDelegate(
 
     var httpRequestBottomSheetState: ActionData.HttpRequest? by mutableStateOf(null)
     var smsActionBottomSheetState: SmsActionBottomSheetState? by mutableStateOf(null)
-    var volumeUpActionState: VolumeActionBottomSheetState? by mutableStateOf(null)
-    var volumeDownActionState: VolumeActionBottomSheetState? by mutableStateOf(null)
+    var volumeActionState: VolumeActionBottomSheetState? by mutableStateOf(null)
 
     init {
         coroutineScope.launch {
@@ -162,26 +161,21 @@ class CreateActionDelegate(
         actionResult.update { action }
     }
 
-    fun onDoneConfigVolumeUpClick() {
-        volumeUpActionState?.also { state ->
-            val action = ActionData.Volume.Up(
-                showVolumeUi = state.showVolumeUi,
-                volumeStream = state.volumeStream,
-            )
-
-            volumeUpActionState = null
-            actionResult.update { action }
-        }
-    }
-
-    fun onDoneConfigVolumeDownClick() {
-        volumeDownActionState?.also { state ->
-            val action = ActionData.Volume.Down(
-                showVolumeUi = state.showVolumeUi,
-                volumeStream = state.volumeStream,
-            )
+    fun onDoneConfigVolumeClick() {
+        volumeActionState?.also { state ->
+            val action = when (state.actionId) {
+                ActionId.VOLUME_UP -> ActionData.Volume.Up(
+                    showVolumeUi = state.showVolumeUi,
+                    volumeStream = state.volumeStream,
+                )
+                ActionId.VOLUME_DOWN -> ActionData.Volume.Down(
+                    showVolumeUi = state.showVolumeUi,
+                    volumeStream = state.volumeStream,
+                )
+                else -> return
+            }
 
-            volumeDownActionState = null
+            volumeActionState = null
             actionResult.update { action }
         }
     }
@@ -291,7 +285,8 @@ class CreateActionDelegate(
 
             ActionId.VOLUME_UP -> {
                 val oldVolumeUpData = oldData as? ActionData.Volume.Up
-                volumeUpActionState = VolumeActionBottomSheetState(
+                volumeActionState = VolumeActionBottomSheetState(
+                    actionId = ActionId.VOLUME_UP,
                     volumeStream = oldVolumeUpData?.volumeStream,
                     showVolumeUi = oldVolumeUpData?.showVolumeUi ?: false,
                 )
@@ -300,7 +295,8 @@ class CreateActionDelegate(
 
             ActionId.VOLUME_DOWN -> {
                 val oldVolumeDownData = oldData as? ActionData.Volume.Down
-                volumeDownActionState = VolumeActionBottomSheetState(
+                volumeActionState = VolumeActionBottomSheetState(
+                    actionId = ActionId.VOLUME_DOWN,
                     volumeStream = oldVolumeDownData?.volumeStream,
                     showVolumeUi = oldVolumeDownData?.showVolumeUi ?: false,
                 )
diff --git a/base/src/main/java/io/github/sds100/keymapper/base/actions/VolumeActionBottomSheet.kt b/base/src/main/java/io/github/sds100/keymapper/base/actions/VolumeActionBottomSheet.kt
@@ -47,58 +47,35 @@ import kotlinx.coroutines.launch
 
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
-fun VolumeUpActionBottomSheet(delegate: CreateActionDelegate) {
+fun VolumeActionBottomSheet(delegate: CreateActionDelegate) {
     val scope = rememberCoroutineScope()
     val sheetState = rememberModalBottomSheetState(skipPartiallyExpanded = true)
 
-    if (delegate.volumeUpActionState != null) {
-        VolumeActionBottomSheet(
-            sheetState = sheetState,
-            onDismissRequest = {
-                delegate.volumeUpActionState = null
-            },
-            state = delegate.volumeUpActionState!!,
-            title = stringResource(R.string.action_volume_up),
-            onSelectStream = {
-                delegate.volumeUpActionState = delegate.volumeUpActionState?.copy(volumeStream = it)
-            },
-            onToggleShowVolumeUi = {
-                delegate.volumeUpActionState = delegate.volumeUpActionState?.copy(showVolumeUi = it)
-            },
-            onDoneClick = {
-                scope.launch {
-                    sheetState.hide()
-                    delegate.onDoneConfigVolumeUpClick()
-                }
-            },
-        )
-    }
-}
-
-@OptIn(ExperimentalMaterial3Api::class)
-@Composable
-fun VolumeDownActionBottomSheet(delegate: CreateActionDelegate) {
-    val scope = rememberCoroutineScope()
-    val sheetState = rememberModalBottomSheetState(skipPartiallyExpanded = true)
+    if (delegate.volumeActionState != null) {
+        val state = delegate.volumeActionState!!
+        val title = when (state.actionId) {
+            ActionId.VOLUME_UP -> stringResource(R.string.action_volume_up)
+            ActionId.VOLUME_DOWN -> stringResource(R.string.action_volume_down)
+            else -> ""
+        }
 
-    if (delegate.volumeDownActionState != null) {
         VolumeActionBottomSheet(
             sheetState = sheetState,
             onDismissRequest = {
-                delegate.volumeDownActionState = null
+                delegate.volumeActionState = null
             },
-            state = delegate.volumeDownActionState!!,
-            title = stringResource(R.string.action_volume_down),
+            state = state,
+            title = title,
             onSelectStream = {
-                delegate.volumeDownActionState = delegate.volumeDownActionState?.copy(volumeStream = it)
+                delegate.volumeActionState = delegate.volumeActionState?.copy(volumeStream = it)
             },
             onToggleShowVolumeUi = {
-                delegate.volumeDownActionState = delegate.volumeDownActionState?.copy(showVolumeUi = it)
+                delegate.volumeActionState = delegate.volumeActionState?.copy(showVolumeUi = it)
             },
             onDoneClick = {
                 scope.launch {
                     sheetState.hide()
-                    delegate.onDoneConfigVolumeDownClick()
+                    delegate.onDoneConfigVolumeClick()
                 }
             },
         )
@@ -220,6 +197,7 @@ private fun VolumeActionBottomSheet(
 }
 
 data class VolumeActionBottomSheetState(
+    val actionId: ActionId,
     val volumeStream: VolumeStream?,
     val showVolumeUi: Boolean,
 )
@@ -238,6 +216,7 @@ private fun PreviewVolumeActionBottomSheet() {
         var state by remember {
             mutableStateOf(
                 VolumeActionBottomSheetState(
+                    actionId = ActionId.VOLUME_UP,
                     volumeStream = VolumeStream.MUSIC,
                     showVolumeUi = true,
                 ),
@@ -269,6 +248,7 @@ private fun PreviewVolumeActionBottomSheetDefaultStream() {
         var state by remember {
             mutableStateOf(
                 VolumeActionBottomSheetState(
+                    actionId = ActionId.VOLUME_DOWN,
                     volumeStream = null,
                     showVolumeUi = false,
                 ),

Original file line number	Diff line number	Diff line change
`@@ -55,8 +55,7 @@ fun HandleActionBottomSheets(delegate: CreateActionDelegate) {`
`55`	`55`	`ChangeFlashlightStrengthActionBottomSheet(delegate)`
`56`	`56`	`HttpRequestBottomSheet(delegate)`
`57`	`57`	`SmsActionBottomSheet(delegate)`
`58`		`- VolumeUpActionBottomSheet(delegate)`
`59`		`- VolumeDownActionBottomSheet(delegate)`
	`58`	`+ VolumeActionBottomSheet(delegate)`
`60`	`59`	`}`
`61`	`60`
`62`	`61`	`@Composable`