NAVAND-979: rename predownloadTrigger into prefetcher

Author: dzinad

CHANGELOG.md

@@ -30,6 +30,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Each newly instantiated MapboxRouteArrowView class will initialize the layers with the provided options on the first render call. Previously this would only be done if the layers hadn't already been initialized.  [#6466](https://github.com/mapbox/mapbox-navigation-android/pull/6466)
 - Fixed an issue where the first voice instruction might have been played twice. [#6766](https://github.com/mapbox/mapbox-navigation-android/pull/6766)
 - Introduced `VoiceInstructionsDownloadTrigger` `MapboxSpeechAPI#generatePredownloaded` to use predownloaded voice instructions instead of downloading them on demand. Example usage can be found in the examples directory ( see `MapboxVoiceActivity`). [#6771](https://github.com/mapbox/mapbox-navigation-android/pull/6771)
+- Introduced `VoiceInstructionsPrefetcher` `MapboxSpeechAPI#generatePredownloaded` to use predownloaded voice instructions instead of downloading them on demand. Example usage can be found in the examples directory ( see `MapboxVoiceActivity`). [#6771](https://github.com/mapbox/mapbox-navigation-android/pull/6771)
 - Enabled voice instructions predownloading for those who use `MapboxAudioGuidance`. [#6771](https://github.com/mapbox/mapbox-navigation-android/pull/6771)
 - Fixed an issue where with low connectivity voice instruction might have been played too late for those who use `MapboxAudioGuidance`. If you use `MapboxSpeechAPI` directly, switch to voice instructions predownloading as described above if you encounter said issue. [#6771](https://github.com/mapbox/mapbox-navigation-android/pull/6771)
 

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxVoiceActivity.kt

@@ -61,7 +61,7 @@ import com.mapbox.navigation.ui.utils.internal.resource.ResourceLoadRequest
 import com.mapbox.navigation.ui.utils.internal.resource.ResourceLoaderFactory
 import com.mapbox.navigation.ui.voice.api.MapboxSpeechApi
 import com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer
-import com.mapbox.navigation.ui.voice.api.VoiceInstructionsDownloadTrigger
+import com.mapbox.navigation.ui.voice.api.VoiceInstructionsPrefetcher
 import com.mapbox.navigation.ui.voice.model.SpeechAnnouncement
 import com.mapbox.navigation.ui.voice.model.SpeechError
 import com.mapbox.navigation.ui.voice.model.SpeechValue
@@ -204,8 +204,8 @@ class MapboxVoiceActivity : AppCompatActivity(), OnMapLongClickListener {
     }
 
     @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
-    private val voiceInstructionsDownloadTrigger by lazy {
-        VoiceInstructionsDownloadTrigger(speechApi)
+    private val voiceInstructionsPrefetcher by lazy {
+        VoiceInstructionsPrefetcher(speechApi)
     }
 
     private val voiceInstructionsObserver =
@@ -397,7 +397,7 @@ class MapboxVoiceActivity : AppCompatActivity(), OnMapLongClickListener {
         if (::mapboxNavigation.isInitialized) {
             mapboxNavigation.registerRoutesObserver(routesObserver)
             mapboxNavigation.registerLocationObserver(locationObserver)
-            voiceInstructionsDownloadTrigger.onAttached(mapboxNavigation)
+            voiceInstructionsPrefetcher.onAttached(mapboxNavigation)
             mapboxNavigation.registerRouteProgressObserver(routeProgressObserver)
             mapboxNavigation.registerRouteProgressObserver(replayProgressObserver)
             mapboxNavigation.registerVoiceInstructionsObserver(voiceInstructionsObserver)
@@ -410,7 +410,7 @@ class MapboxVoiceActivity : AppCompatActivity(), OnMapLongClickListener {
         super.onStop()
         ResourceLoaderFactory.getInstance().unregisterObserver(resourceLoadObserver)
         mapboxNavigation.unregisterRoutesObserver(routesObserver)
-        voiceInstructionsDownloadTrigger.onDetached(mapboxNavigation)
+        voiceInstructionsPrefetcher.onDetached(mapboxNavigation)
         mapboxNavigation.unregisterLocationObserver(locationObserver)
         mapboxNavigation.unregisterRouteProgressObserver(routeProgressObserver)
         mapboxNavigation.unregisterRouteProgressObserver(replayProgressObserver)
@@ -425,7 +425,7 @@ class MapboxVoiceActivity : AppCompatActivity(), OnMapLongClickListener {
         mapboxReplayer.finish()
         mapboxNavigation.onDestroy()
         speechApi.cancel()
-        voiceInstructionsDownloadTrigger.destroy()
+        voiceInstructionsPrefetcher.destroy()
         voiceInstructionsPlayer.shutdown()
     }
 

libnavui-voice/api/current.txt

@@ -85,26 +85,26 @@ package com.mapbox.navigation.ui.voice.api {
     method @kotlin.jvm.Throws(exceptionClasses=IllegalArgumentException::class) public void volume(com.mapbox.navigation.ui.voice.model.SpeechVolume state) throws java.lang.IllegalArgumentException;
   }
 
-  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class VoiceInstructionsDownloadTrigger implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
-    ctor public VoiceInstructionsDownloadTrigger(com.mapbox.navigation.ui.voice.api.MapboxSpeechApi speechApi);
-    ctor public VoiceInstructionsDownloadTrigger(int observableTime, double timePercentageToTriggerAfter, com.mapbox.navigation.ui.voice.api.MapboxSpeechApi speechApi);
+  public abstract sealed class VoiceInstructionsPlayerAttributes {
+    method protected abstract kotlin.jvm.functions.Function1<android.media.AudioFocusRequest.Builder,kotlin.Unit> configureAudioFocusRequestBuilder(com.mapbox.navigation.ui.voice.model.AudioFocusOwner owner);
+    method protected abstract kotlin.jvm.functions.Function1<android.media.MediaPlayer,kotlin.Unit> configureMediaPlayer();
+    method protected abstract kotlin.jvm.functions.Function2<android.speech.tts.TextToSpeech,android.os.Bundle,kotlin.Unit> configureTextToSpeech();
+    method public abstract com.mapbox.navigation.ui.voice.options.VoiceInstructionsPlayerOptions getOptions();
+    property public abstract com.mapbox.navigation.ui.voice.options.VoiceInstructionsPlayerOptions options;
+  }
+
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class VoiceInstructionsPrefetcher implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
+    ctor public VoiceInstructionsPrefetcher(com.mapbox.navigation.ui.voice.api.MapboxSpeechApi speechApi);
+    ctor public VoiceInstructionsPrefetcher(int observableTime, double timePercentageToTriggerAfter, com.mapbox.navigation.ui.voice.api.MapboxSpeechApi speechApi);
     method public void destroy();
     method public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
     method public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
-    field public static final com.mapbox.navigation.ui.voice.api.VoiceInstructionsDownloadTrigger.Companion Companion;
+    field public static final com.mapbox.navigation.ui.voice.api.VoiceInstructionsPrefetcher.Companion Companion;
     field public static final int DEFAULT_OBSERVABLE_TIME_SECONDS = 180; // 0xb4
     field public static final double DEFAULT_TIME_PERCENTAGE_TO_TRIGGER_AFTER = 0.5;
   }
 
-  public static final class VoiceInstructionsDownloadTrigger.Companion {
-  }
-
-  public abstract sealed class VoiceInstructionsPlayerAttributes {
-    method protected abstract kotlin.jvm.functions.Function1<android.media.AudioFocusRequest.Builder,kotlin.Unit> configureAudioFocusRequestBuilder(com.mapbox.navigation.ui.voice.model.AudioFocusOwner owner);
-    method protected abstract kotlin.jvm.functions.Function1<android.media.MediaPlayer,kotlin.Unit> configureMediaPlayer();
-    method protected abstract kotlin.jvm.functions.Function2<android.speech.tts.TextToSpeech,android.os.Bundle,kotlin.Unit> configureTextToSpeech();
-    method public abstract com.mapbox.navigation.ui.voice.options.VoiceInstructionsPlayerOptions getOptions();
-    property public abstract com.mapbox.navigation.ui.voice.options.VoiceInstructionsPlayerOptions options;
+  public static final class VoiceInstructionsPrefetcher.Companion {
   }
 
 }

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/MapboxAudioGuidance.kt

@@ -165,7 +165,7 @@ internal constructor(
 
     @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
     private fun MapboxNavigation.audioGuidanceVoice(): Flow<MapboxAudioGuidanceVoice> {
-        var trigger: VoiceInstructionsDownloadTrigger? = null
+        var trigger: VoiceInstructionsPrefetcher? = null
         return combine(
             mapboxVoiceInstructions.voiceLanguage(),
             configOwner!!.language(),
@@ -176,7 +176,7 @@ internal constructor(
                 trigger?.onDetached(this)
                 audioGuidanceServices.mapboxAudioGuidanceVoice(this, language).also {
                     audioGuidanceVoice = it
-                    trigger = VoiceInstructionsDownloadTrigger(it.mapboxSpeechApi).also { trigger ->
+                    trigger = VoiceInstructionsPrefetcher(it.mapboxSpeechApi).also { trigger ->
                         trigger.onAttached(this)
                     }
                 }

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/MapboxSpeechApi.kt

@@ -42,7 +42,7 @@ class MapboxSpeechApi @JvmOverloads constructor(
      * voice instruction [SpeechAnnouncement] including the synthesized speech mp3 file
      * from Mapbox's API Voice.
      * NOTE: this method will try downloading an mp3 file from server. If you use voice instructions
-     * predownloading (see [VoiceInstructionsDownloadTrigger]), invoke [generatePredownloaded]
+     * predownloading (see [VoiceInstructionsPrefetcher]), invoke [generatePredownloaded]
      * instead of this method in your [VoiceInstructionsObserver].
      * @param voiceInstruction VoiceInstructions object representing [VoiceInstructions]
      * @param consumer is a [SpeechValue] including the announcement to be played when the
@@ -65,7 +65,7 @@ class MapboxSpeechApi @JvmOverloads constructor(
      * from Mapbox's API Voice.
      * NOTE: this method will NOT try downloading an mp3 file from server. It will either use
      * an already predownloaded file or an onboard speech synthesizer. Only invoke this method
-     * if you use voice instructions predownloading (see [VoiceInstructionsDownloadTrigger]),
+     * if you use voice instructions predownloading (see [VoiceInstructionsPrefetcher]),
      * otherwise invoke [generatePredownloaded] in your [VoiceInstructionsObserver].
      * @param voiceInstruction VoiceInstructions object representing [VoiceInstructions]
      * @param consumer is a [SpeechValue] including the announcement to be played when the

…/api/VoiceInstructionsDownloadTrigger.kt …voice/api/VoiceInstructionsPrefetcher.ktlibnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsDownloadTrigger.kt renamed to libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsPrefetcher.kt libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsDownloadTrigger.kt renamed to libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsPrefetcher.kt

@@ -20,7 +20,7 @@ import com.mapbox.navigation.utils.internal.ifNonNull
  * or invoke [onAttached] and [onDetached] manually if you are not using [MapboxNavigationApp].
  */
 @ExperimentalPreviewMapboxNavigationAPI
-class VoiceInstructionsDownloadTrigger internal constructor(
+class VoiceInstructionsPrefetcher internal constructor(
     private val observableTime: Int,
     private val timePercentageToTriggerAfter: Double,
     private val speechApi: MapboxSpeechApi,
@@ -29,7 +29,7 @@ class VoiceInstructionsDownloadTrigger internal constructor(
 ) : MapboxNavigationObserver {
 
     /**
-     * Creates [VoiceInstructionsDownloadTrigger] with default
+     * Creates [VoiceInstructionsPrefetcher] with default
      * observableTime and timePercentageToTriggerAfter.
      * See [DEFAULT_OBSERVABLE_TIME_SECONDS] and [DEFAULT_TIME_PERCENTAGE_TO_TRIGGER_AFTER].
      *
@@ -42,7 +42,7 @@ class VoiceInstructionsDownloadTrigger internal constructor(
     )
 
     /**
-     * Creates [VoiceInstructionsDownloadTrigger] with custom
+     * Creates [VoiceInstructionsPrefetcher] with custom
      * observableTime and timePercentageToTriggerAfter.
      *
      * @param observableTime voice instructions will be predownloaded for `observableTime` seconds

libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/TestMapboxAudioGuidanceServices.kt

@@ -36,7 +36,7 @@ class TestMapboxAudioGuidanceServices(
 
     private val mapboxSpeechApi = mockk<MapboxSpeechApi>(relaxed = true)
 
-    private val mapboxAudioGuidanceVoice = mockk<MapboxAudioGuidanceVoice> {
+    val mapboxAudioGuidanceVoice = mockk<MapboxAudioGuidanceVoice> {
         coEvery { speak(any()) } coAnswers {
             val voiceInstructions = firstArg<VoiceInstructions?>()
             val speechAnnouncement: SpeechAnnouncement? = voiceInstructions?.let {

libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/api/MapboxVoiceApiTest.kt

@@ -22,25 +22,25 @@ import java.io.InputStream
 internal class MapboxVoiceApiTest {
 
     private lateinit var sut: MapboxVoiceApi
-    private lateinit var mockSpeechLoder: MapboxSpeechLoader
+    private lateinit var mockSpeechLoader: MapboxSpeechLoader
     private lateinit var mockSpeechFileProvider: MapboxSpeechFileProvider
 
     @Before
     fun setUp() {
-        mockSpeechLoder = mockk(relaxed = true)
+        mockSpeechLoader = mockk(relaxed = true)
         mockSpeechFileProvider = mockk(relaxed = true)
 
-        sut = MapboxVoiceApi(mockSpeechLoder, mockSpeechFileProvider)
+        sut = MapboxVoiceApi(mockSpeechLoader, mockSpeechFileProvider)
     }
 
     @Test
     fun `retrieveVoiceFile should download audio data using MapboxSpeechProvider`() = runBlocking {
         val voiceInstructions = Fixtures.ssmlInstructions()
-        coEvery { mockSpeechLoder.load(any(), any()) } returns ExpectedFactory.createError(Error())
+        coEvery { mockSpeechLoader.load(any(), any()) } returns ExpectedFactory.createError(Error())
 
         sut.retrieveVoiceFile(voiceInstructions, true)
 
-        coVerify { mockSpeechLoder.load(voiceInstructions, true) }
+        coVerify { mockSpeechLoader.load(voiceInstructions, true) }
     }
 
     @Test
@@ -49,7 +49,7 @@ internal class MapboxVoiceApiTest {
             val voiceInstructions = Fixtures.ssmlInstructions()
             val blob = byteArrayOf(11, 22)
             val blobInputStream = slot<InputStream>()
-            coEvery { mockSpeechLoder.load(any(), false) } returns ExpectedFactory.createValue(blob)
+            coEvery { mockSpeechLoader.load(any(), false) } returns ExpectedFactory.createValue(blob)
             coEvery {
                 mockSpeechFileProvider.generateVoiceFileFrom(capture(blobInputStream))
             } returns File("ignored")
@@ -65,7 +65,7 @@ internal class MapboxVoiceApiTest {
             val voiceInstructions = Fixtures.ssmlInstructions()
             val blob = byteArrayOf(11, 22)
             val file = File("saved-audio-file")
-            coEvery { mockSpeechLoder.load(any(), true) } returns ExpectedFactory.createValue(blob)
+            coEvery { mockSpeechLoader.load(any(), true) } returns ExpectedFactory.createValue(blob)
             coEvery { mockSpeechFileProvider.generateVoiceFileFrom(any()) } returns file
 
             val result = sut.retrieveVoiceFile(voiceInstructions, true)
@@ -78,7 +78,7 @@ internal class MapboxVoiceApiTest {
         runBlocking {
             val voiceInstructions = Fixtures.emptyInstructions()
             coEvery {
-                mockSpeechLoder.load(any(), false)
+                mockSpeechLoader.load(any(), false)
             } returns ExpectedFactory.createError(Error())
             coEvery { mockSpeechFileProvider.generateVoiceFileFrom(any()) } throws Error()
 
@@ -144,6 +144,6 @@ internal class MapboxVoiceApiTest {
     fun `destroy cancels speech loader`() {
         sut.destroy()
 
-        verify { mockSpeechLoder.cancel() }
+        verify { mockSpeechLoader.cancel() }
     }
 }

…/VoiceInstructionsDownloadTriggerTest.kt …e/api/VoiceInstructionsPrefetcherTest.ktlibnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsDownloadTriggerTest.kt renamed to libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsPrefetcherTest.kt libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsDownloadTriggerTest.kt renamed to libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsPrefetcherTest.kt

@@ -24,7 +24,7 @@ import org.junit.Before
 import org.junit.Test
 
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
-class VoiceInstructionsDownloadTriggerTest {
+class VoiceInstructionsPrefetcherTest {
 
     private val observableTime = 100
     private val timePercentageToTriggerAfter = 0.5
@@ -42,7 +42,7 @@ class VoiceInstructionsDownloadTriggerTest {
         VoiceInstructions.builder().announcement("ann2").build()
     )
     private val currentTimeSeconds = 9988L
-    private val sut = VoiceInstructionsDownloadTrigger(
+    private val sut = VoiceInstructionsPrefetcher(
         observableTime,
         timePercentageToTriggerAfter,
         speechAPI,
@@ -387,12 +387,12 @@ class VoiceInstructionsDownloadTriggerTest {
     private fun validLegProgress(
         stepProgress: RouteStepProgress? = validStepProgress()
     ): RouteLegProgress = mockk {
-        every { legIndex } returns this@VoiceInstructionsDownloadTriggerTest.legIndex
+        every { legIndex } returns this@VoiceInstructionsPrefetcherTest.legIndex
         every { currentStepProgress } returns stepProgress
     }
 
     private fun validStepProgress(): RouteStepProgress = mockk {
-        every { stepIndex } returns this@VoiceInstructionsDownloadTriggerTest.stepIndex
+        every { stepIndex } returns this@VoiceInstructionsPrefetcherTest.stepIndex
         every { distanceRemaining } returns stepDistanceRemaining
         every { durationRemaining } returns stepDurationRemaining
     }

libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/internal/impl/MapboxAudioGuidanceVoiceTest.kt

@@ -106,7 +106,7 @@ class MapboxAudioGuidanceVoiceTest {
 
     @Test
     fun destroy() {
-        carAppAudioGuidanceVoice.destroy()
+        sut.destroy()
 
         verify { speechApi.destroy() }
     }