#1066 feat: complete action to mute/unmute microphone

Author: sds100

CHANGELOG.md

@@ -17,6 +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.
+- #1066 Action to mute/unmute microphone.
 
 ## Removed
 

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionData.kt

@@ -191,7 +191,7 @@ sealed class ActionData : Comparable<ActionData> {
         }
 
         @Serializable
-        data object UnMute : Microphone() {
+        data object Unmute : Microphone() {
             override val id = ActionId.UNMUTE_MICROPHONE
         }
 

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionDataEntityMapper.kt

@@ -318,7 +318,7 @@ object ActionDataEntityMapper {
             }
 
             ActionId.MUTE_MICROPHONE -> ActionData.Microphone.Mute
-            ActionId.UNMUTE_MICROPHONE -> ActionData.Microphone.UnMute
+            ActionId.UNMUTE_MICROPHONE -> ActionData.Microphone.Unmute
             ActionId.TOGGLE_MUTE_MICROPHONE -> ActionData.Microphone.Toggle
 
             ActionId.TOGGLE_FLASHLIGHT,

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionUiHelper.kt

@@ -60,10 +60,8 @@ class ActionUiHelper(
             }
 
             if (action.device != null) {
-                val name = if (action.device.name.isBlank()) {
+                val name = action.device.name.ifBlank {
                     getString(R.string.unknown_device_name)
-                } else {
-                    action.device.name
                 }
 
                 val nameToShow = if (showDeviceDescriptors) {
@@ -603,6 +601,10 @@ class ActionUiHelper(
             R.string.action_send_sms_description,
             arrayOf(action.message, action.number),
         )
+
+        ActionData.Microphone.Mute -> getString(R.string.action_mute_microphone)
+        ActionData.Microphone.Toggle -> getString(R.string.action_toggle_mute_microphone)
+        ActionData.Microphone.Unmute -> getString(R.string.action_unmute_microphone)
     }
 
     fun getIcon(action: ActionData): ComposeIconInfo = when (action) {

base/src/main/java/io/github/sds100/keymapper/base/actions/ActionUtils.kt

@@ -41,6 +41,8 @@ import androidx.compose.material.icons.outlined.Keyboard
 import androidx.compose.material.icons.outlined.KeyboardHide
 import androidx.compose.material.icons.outlined.Link
 import androidx.compose.material.icons.outlined.Lock
+import androidx.compose.material.icons.outlined.Mic
+import androidx.compose.material.icons.outlined.MicOff
 import androidx.compose.material.icons.outlined.MoreVert
 import androidx.compose.material.icons.outlined.Nfc
 import androidx.compose.material.icons.outlined.NotStarted

base/src/main/java/io/github/sds100/keymapper/base/actions/CreateActionDelegate.kt

@@ -314,7 +314,7 @@ class CreateActionDelegate(
             }
 
             ActionId.UNMUTE_MICROPHONE -> {
-                return ActionData.Microphone.UnMute
+                return ActionData.Microphone.Unmute
             }
 
             ActionId.TOGGLE_MUTE_MICROPHONE -> {

base/src/main/java/io/github/sds100/keymapper/base/actions/PerformActionsUseCase.kt

@@ -360,15 +360,27 @@ class PerformActionsUseCaseImpl @AssistedInject constructor(
             }
 
             is ActionData.Microphone.Mute -> {
-                result = audioAdapter.muteMicrophone()
+                result = audioAdapter.muteMicrophone().onSuccess {
+                    toastAdapter.show(resourceProvider.getString(R.string.toast_microphone_muted))
+                }
             }
 
-            is ActionData.Microphone.UnMute -> {
-                result = audioAdapter.unmuteMicrophone()
+            is ActionData.Microphone.Unmute -> {
+                result = audioAdapter.unmuteMicrophone().onSuccess {
+                    toastAdapter.show(resourceProvider.getString(R.string.toast_microphone_unmuted))
+                }
             }
 
             is ActionData.Microphone.Toggle -> {
-                result = audioAdapter.toggleMuteMicrophone()
+                result = if (audioAdapter.isMicrophoneMuted) {
+                    audioAdapter.unmuteMicrophone().onSuccess {
+                        toastAdapter.show(resourceProvider.getString(R.string.toast_microphone_unmuted))
+                    }
+                } else {
+                    audioAdapter.muteMicrophone().onSuccess {
+                        toastAdapter.show(resourceProvider.getString(R.string.toast_microphone_muted))
+                    }
+                }
             }
 
             is ActionData.TapScreen -> {

base/src/main/res/values/strings.xml

@@ -201,6 +201,8 @@
     <string name="toast_no_sound_files">You have saved no sound files!</string>
     <string name="toast_granted_itself_write_secure_settings_with_shizuku">Key Mapper has used Shizuku to grant itself WRITE_SECURE_SETTINGS permission</string>
     <string name="toast_granted_itself_write_secure_settings_with_root">Key Mapper has used Root to grant itself WRITE_SECURE_SETTINGS permission</string>
+    <string name="toast_microphone_muted">Microphone muted</string>
+    <string name="toast_microphone_unmuted">Microphone unmuted</string>
     <!--  Toasts  -->
 
     <!-- Extra labels -->

system/src/main/AndroidManifest.xml

@@ -24,6 +24,7 @@
     <uses-permission android:name="android.permission.CALL_PHONE" />
     <uses-permission android:name="android.permission.SEND_SMS"
         tools:ignore="SmsAndCallLogPolicy" />
+    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
 
     <uses-feature
         android:name="android.hardware.telephony"

system/src/main/java/io/github/sds100/keymapper/system/volume/AndroidVolumeAdapter.kt

@@ -53,6 +53,9 @@ class AndroidVolumeAdapter @Inject constructor(
             }
         }
 
+    override val isMicrophoneMuted: Boolean
+        get() = audioManager.isMicrophoneMute
+
     override fun raiseVolume(stream: VolumeStream?, showVolumeUi: Boolean): KMResult<*> =
         stream.convert().then { streamType ->
             adjustVolume(AudioManager.ADJUST_RAISE, showVolumeUi, streamType)
@@ -135,11 +138,6 @@ class AndroidVolumeAdapter @Inject constructor(
         return Success(Unit)
     }
 
-    override fun toggleMuteMicrophone(): KMResult<*> {
-        audioManager.isMicrophoneMute = !audioManager.isMicrophoneMute
-        return Success(Unit)
-    }
-
     private fun DndMode.convert(): Int = when (this) {
         DndMode.ALARMS -> NotificationManager.INTERRUPTION_FILTER_ALARMS
         DndMode.PRIORITY -> NotificationManager.INTERRUPTION_FILTER_PRIORITY