refactor: rename 'replay audio' to 'replay media'

david-allison · david-allison · commit 0ddfcb7c3ee2 · 2025-06-12T21:47:50.000+01:00
Aside from in Bindings, as this is stored in Preferences

Part of 18442
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/AbstractFlashcardViewer.kt b/AnkiDroid/src/main/java/com/ichi2/anki/AbstractFlashcardViewer.kt
@@ -1433,24 +1433,24 @@ abstract class AbstractFlashcardViewer :
     /**
      * Plays sounds (or TTS, if configured) for currently shown side of card.
      *
-     * @param doAudioReplay indicates an anki desktop-like replay call is desired, whose behavior is identical to
+     * @param doMediaReplay indicates an anki desktop-like replay call is desired, whose behavior is identical to
      * pressing the keyboard shortcut R on the desktop
      */
     @NeedsTest("audio is not played if opExecuted occurs when viewer is in the background")
-    protected open fun playSounds(doAudioReplay: Boolean) {
+    protected open fun playSounds(doMediaReplay: Boolean) {
         // this can occur due to OpChanges when the viewer is on another screen
         if (!this.lifecycle.currentState.isAtLeast(RESUMED)) {
             Timber.w("sounds are not played as the activity is inactive")
             return
         }
-        if (!cardMediaPlayer.config.autoplay && !doAudioReplay) return
+        if (!cardMediaPlayer.config.autoplay && !doMediaReplay) return
         // Use TTS if TTS preference enabled and no other sound source
         val useTTS = tts.enabled && !cardMediaPlayer.hasSounds(displayAnswer)
         // We need to play the sounds from the proper side of the card
         if (!useTTS) {
             launchCatchingTask {
                 val side = if (displayAnswer) SingleCardSide.BACK else SingleCardSide.FRONT
-                when (doAudioReplay) {
+                when (doMediaReplay) {
                     true -> cardMediaPlayer.replayAllSounds(side)
                     false -> cardMediaPlayer.playAllSounds(side)
                 }
@@ -1462,7 +1462,7 @@ abstract class AbstractFlashcardViewer :
         // Text to speech is in effect here
         // If the question is displayed or if the question should be replayed, read the question
         if (ttsInitialized) {
-            if (!displayAnswer || doAudioReplay && replayQuestion) {
+            if (!displayAnswer || doMediaReplay && replayQuestion) {
                 readCardTts(SingleCardSide.FRONT)
             }
             if (displayAnswer) {
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/Reviewer.kt b/AnkiDroid/src/main/java/com/ichi2/anki/Reviewer.kt
@@ -433,8 +433,8 @@ open class Reviewer :
                 onMark(currentCard)
             }
             R.id.action_replay -> {
-                Timber.i("Reviewer:: Replay audio button pressed (from menu)")
-                playSounds(true)
+                Timber.i("Reviewer:: Replay media button pressed (from menu)")
+                playSounds(doMediaReplay = true)
             }
             R.id.action_toggle_mic_tool_bar -> {
                 Timber.i("Reviewer:: Voice playback visibility set to %b", !isMicToolBarVisible)
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/CardMediaPlayer.kt b/AnkiDroid/src/main/java/com/ichi2/anki/cardviewer/CardMediaPlayer.kt
@@ -200,7 +200,7 @@ class CardMediaPlayer : Closeable {
             } catch (e: CancellationException) {
                 throw e
             } catch (e: Exception) {
-                Timber.w(e, "failed to replay audio")
+                Timber.w(e, "failed to replay media")
             }
         }
 
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/previewer/PreviewerAction.kt b/AnkiDroid/src/main/java/com/ichi2/anki/previewer/PreviewerAction.kt
@@ -29,6 +29,8 @@ enum class PreviewerAction : MappableAction<MappableBinding> {
     MARK,
     EDIT,
     TOGGLE_BACKSIDE_ONLY,
+
+    // TODO: rename to REPLAY_MEDIA and handle previewer_replay_audio_key
     REPLAY_AUDIO,
     TOGGLE_FLAG_RED,
     TOGGLE_FLAG_ORANGE,
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/previewer/PreviewerFragment.kt b/AnkiDroid/src/main/java/com/ichi2/anki/previewer/PreviewerFragment.kt
@@ -39,6 +39,7 @@ import com.ichi2.anki.DispatchKeyEventListener
 import com.ichi2.anki.Flag
 import com.ichi2.anki.R
 import com.ichi2.anki.browser.IdsFile
+import com.ichi2.anki.previewer.PreviewerFragment.Companion.CARD_IDS_FILE_ARG
 import com.ichi2.anki.reviewer.BindingMap
 import com.ichi2.anki.reviewer.BindingProcessor
 import com.ichi2.anki.reviewer.MappableBinding
@@ -229,7 +230,7 @@ class PreviewerFragment :
             PreviewerAction.MARK -> viewModel.toggleMark()
             PreviewerAction.EDIT -> editCard()
             PreviewerAction.TOGGLE_BACKSIDE_ONLY -> viewModel.toggleBackSideOnly()
-            PreviewerAction.REPLAY_AUDIO -> viewModel.replayAudios()
+            PreviewerAction.REPLAY_AUDIO -> viewModel.replayMedia()
             PreviewerAction.TOGGLE_FLAG_RED -> viewModel.toggleFlag(Flag.RED)
             PreviewerAction.TOGGLE_FLAG_ORANGE -> viewModel.toggleFlag(Flag.ORANGE)
             PreviewerAction.TOGGLE_FLAG_GREEN -> viewModel.toggleFlag(Flag.GREEN)
diff --git a/AnkiDroid/src/main/java/com/ichi2/anki/previewer/PreviewerViewModel.kt b/AnkiDroid/src/main/java/com/ichi2/anki/previewer/PreviewerViewModel.kt
@@ -183,7 +183,7 @@ class PreviewerViewModel(
 
     suspend fun getNoteEditorDestination() = NoteEditorLauncher.EditNoteFromPreviewer(currentCard.await().id)
 
-    fun replayAudios() {
+    fun replayMedia() {
         launchCatchingIO {
             val side = if (showingAnswer.value) SingleCardSide.BACK else SingleCardSide.FRONT
             cardMediaPlayer.replayAllSounds(side)
diff --git a/AnkiDroid/src/main/res/menu/reviewer.xml b/AnkiDroid/src/main/res/menu/reviewer.xml
@@ -174,7 +174,7 @@
     </item>
     <item
         android:id="@+id/action_replay"
-        android:title="@string/replay_audio"
+        android:title="@string/replay_media"
         android:icon="@drawable/ic_play_circle_white"
         ankidroid:showAsAction="ifRoom"/>
     <item
diff --git a/AnkiDroid/src/main/res/values/02-strings.xml b/AnkiDroid/src/main/res/values/02-strings.xml
@@ -47,7 +47,7 @@
     <string name="show_whiteboard">Show whiteboard</string>
     <string name="hide_whiteboard" maxLength="28">Hide whiteboard</string>
     <string name="clear_whiteboard" maxLength="28">Clear whiteboard</string>
-    <string name="replay_audio" maxLength="28">Replay audio</string>
+    <string name="replay_media" maxLength="28">Replay media</string>
     <string name="leech_suspend_notification">Card marked as leech and suspended</string>
     <string name="leech_notification">Card marked as leech</string>
     <string name="webview_crash_unknown">Unknown error</string>
diff --git a/AnkiDroid/src/main/res/values/preferences.xml b/AnkiDroid/src/main/res/values/preferences.xml
@@ -144,7 +144,7 @@
     <string name="previewer_back_key">previewer_BACK</string>
     <string name="previewer_mark_key">previewer_MARK</string>
     <string name="previewer_edit_key">previewer_EDIT</string>
-    <string name="previewer_replay_audio_key">previewer_REPLAY_AUDIO</string>
+    <string name="previewer_replay_media_key">previewer_REPLAY_AUDIO</string>
     <string name="previewer_backside_only_action_key">previewer_BACKSIDE_ONLY</string>
     <string name="previewer_flag_red_key">previewer_TOGGLE_FLAG_RED</string>
     <string name="previewer_flag_orange_key">previewer_TOGGLE_FLAG_ORANGE</string>
diff --git a/AnkiDroid/src/main/res/xml/preferences_custom_buttons.xml b/AnkiDroid/src/main/res/xml/preferences_custom_buttons.xml
@@ -87,7 +87,7 @@ TODO: Add a unit test
             android:entries="@array/custom_button_labels"
             android:entryValues="@array/custom_button_values"
             android:key="@string/custom_button_replay_key"
-            android:title="@string/replay_audio"
+            android:title="@string/replay_media"
             app:useSimpleSummaryProvider="true"/>
         <ListPreference
             android:defaultValue="3"
diff --git a/AnkiDroid/src/main/res/xml/preferences_previewer_controls.xml b/AnkiDroid/src/main/res/xml/preferences_previewer_controls.xml
@@ -25,8 +25,8 @@
         android:icon="@drawable/ic_popup_menu_item_editor"
         />
     <com.ichi2.preferences.ControlPreference
-        android:key="@string/previewer_replay_audio_key"
-        android:title="@string/replay_audio"
+        android:key="@string/previewer_replay_media_key"
+        android:title="@string/replay_media"
         android:icon="@drawable/ic_replay"
         />
     <com.ichi2.preferences.ControlPreference
diff --git a/AnkiDroid/src/test/java/com/ichi2/anki/ReviewerKeyboardInputTest.kt b/AnkiDroid/src/test/java/com/ichi2/anki/ReviewerKeyboardInputTest.kt
@@ -167,17 +167,17 @@ class ReviewerKeyboardInputTest : RobolectricTest() {
     }
 
     @Test
-    fun pressingRShouldReplayAudio() {
+    fun pressingRShouldReplayMedia() {
         val underTest = KeyboardInputTestReviewer.displayingAnswer()
         underTest.handleAndroidKeyPress(KEYCODE_R)
-        assertThat("Replay Audio should be called", underTest.replayAudioCalled)
+        assertThat("Replay Media should be called", underTest.replayMediaCalled)
     }
 
     @Test
-    fun pressingF5ShouldReplayAudio() {
+    fun pressingF5ShouldReplayMedia() {
         val underTest = KeyboardInputTestReviewer.displayingAnswer()
         underTest.handleKeyPress(KEYCODE_F5, '\u0000')
-        assertThat("Replay Audio should be called", underTest.replayAudioCalled)
+        assertThat("Replay Media should be called", underTest.replayMediaCalled)
     }
 
     @Test
@@ -249,7 +249,7 @@ class ReviewerKeyboardInputTest : RobolectricTest() {
             private set
         var undoCalled = false
             private set
-        var replayAudioCalled = false
+        var replayMediaCalled = false
             private set
 
         private val cardFlips = mutableListOf<String>()
@@ -420,8 +420,8 @@ class ReviewerKeyboardInputTest : RobolectricTest() {
             return true
         }
 
-        override fun playSounds(doAudioReplay: Boolean) {
-            replayAudioCalled = true
+        override fun playSounds(doMediaReplay: Boolean) {
+            replayMediaCalled = true
         }
 
         override fun buryNote(): Boolean {

Original file line number	Diff line number	Diff line change
`@@ -433,8 +433,8 @@ open class Reviewer :`
`433`	`433`	`onMark(currentCard)`
`434`	`434`	`}`
`435`	`435`	`R.id.action_replay -> {`
`436`		`- Timber.i("Reviewer:: Replay audio button pressed (from menu)")`
`437`		`- playSounds(true)`
	`436`	`+ Timber.i("Reviewer:: Replay media button pressed (from menu)")`
	`437`	`+ playSounds(doMediaReplay = true)`
`438`	`438`	`}`
`439`	`439`	`R.id.action_toggle_mic_tool_bar -> {`
`440`	`440`	`Timber.i("Reviewer:: Voice playback visibility set to %b", !isMicToolBarVisible)`
Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,7 @@ class CardMediaPlayer : Closeable {`
`200`	`200`	`} catch (e: CancellationException) {`
`201`	`201`	`throw e`
`202`	`202`	`} catch (e: Exception) {`
`203`		`- Timber.w(e, "failed to replay audio")`
	`203`	`+ Timber.w(e, "failed to replay media")`
`204`	`204`	`}`
`205`	`205`	`}`
`206`	`206`