Voice recording UI state in ViewModel

changelog.d/4515.misc

@@ -0,0 +1 @@
+Voice recording mic button refactor with small animation tweaks in preparation for voice drafts

vector/src/main/java/im/vector/app/features/home/room/detail/RoomDetailFragment.kt

@@ -138,7 +138,8 @@ import im.vector.app.features.home.room.detail.composer.TextComposerView
 import im.vector.app.features.home.room.detail.composer.TextComposerViewEvents
 import im.vector.app.features.home.room.detail.composer.TextComposerViewModel
 import im.vector.app.features.home.room.detail.composer.TextComposerViewState
-import im.vector.app.features.home.room.detail.composer.VoiceMessageRecorderView
+import im.vector.app.features.home.room.detail.composer.voice.VoiceMessageRecorderView
+import im.vector.app.features.home.room.detail.composer.voice.VoiceMessageRecorderView.RecordingUiState
 import im.vector.app.features.home.room.detail.readreceipts.DisplayReadReceiptsBottomSheet
 import im.vector.app.features.home.room.detail.timeline.TimelineEventController
 import im.vector.app.features.home.room.detail.timeline.action.EventSharedAction
@@ -505,7 +506,7 @@ class RoomDetailFragment @Inject constructor(
 
     private fun onCannotRecord() {
         // Update the UI, cancel the animation
-        views.voiceMessageRecorderView.initVoiceRecordingViews()
+        textComposerViewModel.handle(TextComposerAction.OnVoiceRecordingUiStateChanged(RecordingUiState.None))
     }
 
     private fun acceptIncomingCall(event: RoomDetailViewEvents.DisplayAndAcceptCall) {
@@ -692,32 +693,56 @@ class RoomDetailFragment @Inject constructor(
     }
 
     private fun setupVoiceMessageView() {
-        views.voiceMessageRecorderView.voiceMessagePlaybackTracker = voiceMessagePlaybackTracker
-
+        voiceMessagePlaybackTracker.track(VoiceMessagePlaybackTracker.RECORDING_ID, views.voiceMessageRecorderView)
         views.voiceMessageRecorderView.callback = object : VoiceMessageRecorderView.Callback {
-            override fun onVoiceRecordingStarted(): Boolean {
-                return if (checkPermissions(PERMISSIONS_FOR_VOICE_MESSAGE, requireActivity(), permissionVoiceMessageLauncher)) {
+
+            override fun onVoiceRecordingStarted() {
+                if (checkPermissions(PERMISSIONS_FOR_VOICE_MESSAGE, requireActivity(), permissionVoiceMessageLauncher)) {
                     roomDetailViewModel.handle(RoomDetailAction.StartRecordingVoiceMessage)
-                    textComposerViewModel.handle(TextComposerAction.OnVoiceRecordingStateChanged(true))
                     vibrate(requireContext())
-                    true
-                } else {
-                    // Permission dialog is displayed
-                    false
+                    updateRecordingUiState(RecordingUiState.Started)
                 }
             }
 
-            override fun onVoiceRecordingEnded(isCancelled: Boolean) {
-                roomDetailViewModel.handle(RoomDetailAction.EndRecordingVoiceMessage(isCancelled))
-                textComposerViewModel.handle(TextComposerAction.OnVoiceRecordingStateChanged(false))
+            override fun onVoicePlaybackButtonClicked() {
+                roomDetailViewModel.handle(RoomDetailAction.PlayOrPauseRecordingPlayback)
+            }
+
+            override fun onVoiceRecordingCancelled() {
+                roomDetailViewModel.handle(RoomDetailAction.EndRecordingVoiceMessage(isCancelled = true))
+                updateRecordingUiState(RecordingUiState.Cancelled)
+            }
+
+            override fun onVoiceRecordingLocked() {
+                updateRecordingUiState(RecordingUiState.Locked)
+            }
+
+            override fun onVoiceRecordingEnded() {
+                onSendVoiceMessage()
+            }
+
+            override fun onSendVoiceMessage() {
+                roomDetailViewModel.handle(RoomDetailAction.EndRecordingVoiceMessage(isCancelled = false))
+                updateRecordingUiState(RecordingUiState.None)
+            }
+
+            override fun onDeleteVoiceMessage() {
+                roomDetailViewModel.handle(RoomDetailAction.EndRecordingVoiceMessage(isCancelled = true))
+                updateRecordingUiState(RecordingUiState.None)
             }
 
-            override fun onVoiceRecordingPlaybackModeOn() {
+            override fun onRecordingLimitReached() {
                 roomDetailViewModel.handle(RoomDetailAction.PauseRecordingVoiceMessage)
+                updateRecordingUiState(RecordingUiState.Playback)
             }
 
-            override fun onVoicePlaybackButtonClicked() {
-                roomDetailViewModel.handle(RoomDetailAction.PlayOrPauseRecordingPlayback)
+            override fun onRecordingWaveformClicked() {
+                roomDetailViewModel.handle(RoomDetailAction.PauseRecordingVoiceMessage)
+                updateRecordingUiState(RecordingUiState.Playback)
+            }
+
+            private fun updateRecordingUiState(state: RecordingUiState) {
+                textComposerViewModel.handle(TextComposerAction.OnVoiceRecordingUiStateChanged(state))
             }
         }
     }
@@ -1109,7 +1134,7 @@ class RoomDetailFragment @Inject constructor(
 
         // We should improve the UX to support going into playback mode when paused and delete the media when the view is destroyed.
         roomDetailViewModel.handle(RoomDetailAction.EndAllVoiceActions(deleteRecord = false))
-        views.voiceMessageRecorderView.initVoiceRecordingViews()
+        views.voiceMessageRecorderView.display(RecordingUiState.None)
     }
 
     private val attachmentFileActivityResultLauncher = registerStartForActivityResult {
@@ -1405,6 +1430,7 @@ class RoomDetailFragment @Inject constructor(
                 views.composerLayout.isInvisible = !textComposerState.isComposerVisible
                 views.voiceMessageRecorderView.isVisible = textComposerState.isVoiceMessageRecorderVisible
                 views.composerLayout.views.sendButton.isInvisible = !textComposerState.isSendButtonVisible
+                views.voiceMessageRecorderView.display(textComposerState.voiceRecordingUiState)
                 views.composerLayout.setRoomEncrypted(summary.isEncrypted)
                 // views.composerLayout.alwaysShowSendButton = false
                 if (textComposerState.canSendMessage) {
@@ -1959,7 +1985,7 @@ class RoomDetailFragment @Inject constructor(
                 roomDetailViewModel.handle(RoomDetailAction.UpdateQuickReactAction(action.eventId, action.clickedOn, action.add))
             }
             is EventSharedAction.Edit                       -> {
-                if (!views.voiceMessageRecorderView.isActive()) {
+                if (withState(textComposerViewModel) { it.isVoiceMessageIdle }) {
                     textComposerViewModel.handle(TextComposerAction.EnterEditMode(action.eventId, views.composerLayout.text.toString()))
                 } else {
                     requireActivity().toast(R.string.error_voice_message_cannot_reply_or_edit)
@@ -1969,7 +1995,7 @@ class RoomDetailFragment @Inject constructor(
                 textComposerViewModel.handle(TextComposerAction.EnterQuoteMode(action.eventId, views.composerLayout.text.toString()))
             }
             is EventSharedAction.Reply                      -> {
-                if (!views.voiceMessageRecorderView.isActive()) {
+                if (withState(textComposerViewModel) { it.isVoiceMessageIdle }) {
                     textComposerViewModel.handle(TextComposerAction.EnterReplyMode(action.eventId, views.composerLayout.text.toString()))
                 } else {
                     requireActivity().toast(R.string.error_voice_message_cannot_reply_or_edit)

vector/src/main/java/im/vector/app/features/home/room/detail/composer/TextComposerAction.kt

@@ -17,6 +17,7 @@
 package im.vector.app.features.home.room.detail.composer
 
 import im.vector.app.core.platform.VectorViewModelAction
+import im.vector.app.features.home.room.detail.composer.voice.VoiceMessageRecorderView
 
 sealed class TextComposerAction : VectorViewModelAction {
     data class SaveDraft(val draft: String) : TextComposerAction()
@@ -27,5 +28,5 @@ sealed class TextComposerAction : VectorViewModelAction {
     data class EnterRegularMode(val text: String, val fromSharing: Boolean) : TextComposerAction()
     data class UserIsTyping(val isTyping: Boolean) : TextComposerAction()
     data class OnTextChanged(val text: CharSequence) : TextComposerAction()
-    data class OnVoiceRecordingStateChanged(val isRecording: Boolean) : TextComposerAction()
+    data class OnVoiceRecordingUiStateChanged(val uiState: VoiceMessageRecorderView.RecordingUiState) : TextComposerAction()
 }

vector/src/main/java/im/vector/app/features/home/room/detail/composer/TextComposerViewModel.kt

@@ -77,20 +77,20 @@ class TextComposerViewModel @AssistedInject constructor(
     override fun handle(action: TextComposerAction) {
         Timber.v("Handle action: $action")
         when (action) {
-            is TextComposerAction.EnterEditMode                -> handleEnterEditMode(action)
-            is TextComposerAction.EnterQuoteMode               -> handleEnterQuoteMode(action)
-            is TextComposerAction.EnterRegularMode             -> handleEnterRegularMode(action)
-            is TextComposerAction.EnterReplyMode               -> handleEnterReplyMode(action)
-            is TextComposerAction.SaveDraft                    -> handleSaveDraft(action)
-            is TextComposerAction.SendMessage                  -> handleSendMessage(action)
-            is TextComposerAction.UserIsTyping                 -> handleUserIsTyping(action)
-            is TextComposerAction.OnTextChanged                -> handleOnTextChanged(action)
-            is TextComposerAction.OnVoiceRecordingStateChanged -> handleOnVoiceRecordingStateChanged(action)
+            is TextComposerAction.EnterEditMode                  -> handleEnterEditMode(action)
+            is TextComposerAction.EnterQuoteMode                 -> handleEnterQuoteMode(action)
+            is TextComposerAction.EnterRegularMode               -> handleEnterRegularMode(action)
+            is TextComposerAction.EnterReplyMode                 -> handleEnterReplyMode(action)
+            is TextComposerAction.SaveDraft                      -> handleSaveDraft(action)
+            is TextComposerAction.SendMessage                    -> handleSendMessage(action)
+            is TextComposerAction.UserIsTyping                   -> handleUserIsTyping(action)
+            is TextComposerAction.OnTextChanged                  -> handleOnTextChanged(action)
+            is TextComposerAction.OnVoiceRecordingUiStateChanged -> handleOnVoiceRecordingUiStateChanged(action)
         }
     }
 
-    private fun handleOnVoiceRecordingStateChanged(action: TextComposerAction.OnVoiceRecordingStateChanged) = setState {
-        copy(isVoiceRecording = action.isRecording)
+    private fun handleOnVoiceRecordingUiStateChanged(action: TextComposerAction.OnVoiceRecordingUiStateChanged) = setState {
+        copy(voiceRecordingUiState = action.uiState)
     }
 
     private fun handleOnTextChanged(action: TextComposerAction.OnTextChanged) {

vector/src/main/java/im/vector/app/features/home/room/detail/composer/TextComposerViewState.kt

@@ -18,6 +18,7 @@ package im.vector.app.features.home.room.detail.composer
 
 import com.airbnb.mvrx.MavericksState
 import im.vector.app.features.home.room.detail.RoomDetailArgs
+import im.vector.app.features.home.room.detail.composer.voice.VoiceMessageRecorderView
 import org.matrix.android.sdk.api.session.room.timeline.TimelineEvent
 
 /**
@@ -44,13 +45,27 @@ sealed class SendMode(open val text: String) {
 data class TextComposerViewState(
         val roomId: String,
         val canSendMessage: Boolean = true,
-        val isVoiceRecording: Boolean = false,
         val isSendButtonVisible: Boolean = false,
-        val sendMode: SendMode = SendMode.REGULAR("", false)
+        val sendMode: SendMode = SendMode.REGULAR("", false),
+        val voiceRecordingUiState: VoiceMessageRecorderView.RecordingUiState = VoiceMessageRecorderView.RecordingUiState.None
 ) : MavericksState {
 
+    val isVoiceRecording = when (voiceRecordingUiState) {
+        VoiceMessageRecorderView.RecordingUiState.None,
+        VoiceMessageRecorderView.RecordingUiState.Cancelled,
+        VoiceMessageRecorderView.RecordingUiState.Playback -> false
+        VoiceMessageRecorderView.RecordingUiState.Locked,
+        VoiceMessageRecorderView.RecordingUiState.Started  -> true
+    }
+
+    val isVoiceMessageIdle = when (voiceRecordingUiState) {
+        VoiceMessageRecorderView.RecordingUiState.None, VoiceMessageRecorderView.RecordingUiState.Cancelled -> false
+        else                                                                                                -> true
+    }
+
     val isComposerVisible = canSendMessage && !isVoiceRecording
     val isVoiceMessageRecorderVisible = canSendMessage && !isSendButtonVisible
 
+    @Suppress("UNUSED") // needed by mavericks
     constructor(args: RoomDetailArgs) : this(roomId = args.roomId)
 }