Update audio guidance for AA compatibility

Author: kmadsen

CHANGELOG.md

@@ -4,6 +4,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## Unreleased
 #### Features
+- Moved `MapboxAudioGuidance` and `MapboxAudioGuidanceState` into public api. [#6336](https://github.com/mapbox/mapbox-navigation-android/pull/6336)
 #### Bug fixes and improvements
 
 ## Mapbox Navigation SDK 2.9.0-alpha.1 - 15 September, 2022

LICENSE.md

@@ -5,6 +5,7 @@ Mapbox welcomes participation and contributions from everyone.
 ## Unreleased
 #### Features
 #### Bug fixes and improvements
+- Use `MapboxAudioGuidance` from public api. [#6336](https://github.com/mapbox/mapbox-navigation-android/pull/6336)
 
 ## androidauto-v0.11.0 - Sep 16, 2022
 ### Changelog

libnavui-androidauto/CHANGELOG.md

@@ -17,10 +17,10 @@ package com.mapbox.androidauto {
   }
 
   public final class MapboxCarApp {
-    method public com.mapbox.navigation.ui.voice.internal.MapboxAudioGuidance carAppAudioGuidanceService();
+    method public com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance carAppAudioGuidanceService();
     method public com.mapbox.androidauto.navigation.location.CarAppLocation carAppLocationService();
     method public kotlinx.coroutines.flow.StateFlow<com.mapbox.androidauto.CarAppState> getCarAppState();
-    method public void setup(android.app.Application application);
+    method public void setup();
     method public void updateCarAppState(com.mapbox.androidauto.CarAppState carAppState);
     property public final kotlinx.coroutines.flow.StateFlow<com.mapbox.androidauto.CarAppState> carAppState;
     field public static final com.mapbox.androidauto.MapboxCarApp INSTANCE;

libnavui-androidauto/api/current.txt

@@ -45,10 +45,9 @@ dependencies {
     def carSearchVersion = "1.0.0-beta.36"
     api("com.mapbox.search:mapbox-search-android:${carSearchVersion}")
 
-    debugApi project(":libnavigation-android")
-    releaseApi("com.mapbox.navigation:android:${carNavVersion}")
-    debugImplementation project(":libnavui-app")
-    releaseImplementation("com.mapbox.navigation:ui-app:${carNavVersion}")
+    // TODO use the carNavVersion when 2.9.0-alpha.2 is available
+    api(project(":libnavigation-android"))
+//    api("com.mapbox.navigation:android:${carNavVersion}")
 
     implementation(dependenciesList.androidXAppCompat)
     implementation(dependenciesList.coroutinesCore)

libnavui-androidauto/build.gradle

@@ -1,19 +1,16 @@
 package com.mapbox.androidauto
 
-import android.app.Application
 import com.mapbox.androidauto.navigation.location.CarAppLocation
 import com.mapbox.androidauto.navigation.location.impl.CarAppLocationImpl
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
-import com.mapbox.navigation.ui.app.internal.SharedApp
-import com.mapbox.navigation.ui.voice.internal.MapboxAudioGuidance
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 
 /**
  * The entry point for your Mapbox Android Auto app.
  */
-@OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
 object MapboxCarApp {
 
     private val carAppStateFlow = MutableStateFlow<CarAppState>(FreeDriveState)
@@ -43,12 +40,15 @@ object MapboxCarApp {
     }
 
     /**
-     * Setup android auto from your [Application.onCreate]
-     *
-     * @param application used to detect when activities are foregrounded
+     * Setup android auto with defaults
      */
-    fun setup(application: Application) {
-        SharedApp.setup(application)
-        MapboxNavigationApp.registerObserver(CarAppLocationImpl())
+    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+    fun setup() {
+        if (MapboxNavigationApp.getObservers(MapboxAudioGuidance::class).isEmpty()) {
+            MapboxNavigationApp.registerObserver(MapboxAudioGuidance())
+        }
+        if (MapboxNavigationApp.getObservers(CarAppLocation::class).isEmpty()) {
+            MapboxNavigationApp.registerObserver(CarAppLocationImpl())
+        }
     }
 }

libnavui-androidauto/src/main/java/com/mapbox/androidauto/MapboxCarApp.kt

@@ -8,7 +8,7 @@ import androidx.lifecycle.LifecycleOwner
 import androidx.lifecycle.lifecycleScope
 import androidx.lifecycle.repeatOnLifecycle
 import com.mapbox.androidauto.MapboxCarApp
-import com.mapbox.navigation.ui.voice.internal.MapboxAudioGuidance
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidanceState
 import com.mapbox.navigation.ui.voice.view.MapboxSoundButton
 import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.launch
@@ -40,7 +40,7 @@ fun Fragment.attachAudioGuidance(
  */
 fun Lifecycle.muteAudioGuidance() {
     addObserver(object : DefaultLifecycleObserver {
-        lateinit var initialState: MapboxAudioGuidance.State
+        lateinit var initialState: MapboxAudioGuidanceState
         override fun onResume(owner: LifecycleOwner) {
             with(MapboxCarApp.carAppAudioGuidanceService()) {
                 initialState = stateFlow().value

libnavui-androidauto/src/main/java/com/mapbox/androidauto/navigation/audioguidance/AppAudioGuidanceUi.kt

@@ -1,6 +1,5 @@
 package com.mapbox.navigation.ui.app.internal
 
-import android.content.Context
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.internal.extensions.attachCreated
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
@@ -17,9 +16,7 @@ import com.mapbox.navigation.ui.app.internal.controller.StateResetController
 import com.mapbox.navigation.ui.app.internal.controller.TripSessionStarterStateController
 import com.mapbox.navigation.ui.maps.internal.ui.RouteAlternativeComponent
 import com.mapbox.navigation.ui.maps.internal.ui.RouteAlternativeContract
-import com.mapbox.navigation.ui.utils.internal.datastore.NavigationDataStoreOwner
-import com.mapbox.navigation.ui.voice.internal.MapboxAudioGuidance
-import com.mapbox.navigation.ui.voice.internal.impl.MapboxAudioGuidanceImpl
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance
 import java.util.concurrent.atomic.AtomicBoolean
 
 @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
@@ -55,8 +52,6 @@ object SharedApp {
 
     @JvmOverloads
     fun setup(
-        context: Context,
-        audioGuidance: MapboxAudioGuidance? = null,
         routeAlternativeContract: RouteAlternativeContract? = null
     ) {
         if (isSetup) return
@@ -69,7 +64,12 @@ object SharedApp {
             }
         )
         MapboxNavigationApp.lifecycleOwner.attachCreated(*navigationObservers)
-        MapboxNavigationApp.registerObserver(audioGuidance ?: defaultAudioGuidance(context))
+
+        // TODO Remove this from SharedApp. The components that use `MapboxAudioGuidance`
+        //   will "ensureAudioGuidanceRegistered". See the `ComponentInstaller.audioGuidanceButton`
+        if (MapboxNavigationApp.getObservers(MapboxAudioGuidance::class).isEmpty()) {
+            MapboxNavigationApp.registerObserver(MapboxAudioGuidance())
+        }
     }
 
     fun tripSessionTransaction(updateSession: () -> Unit) {
@@ -80,12 +80,4 @@ object SharedApp {
         updateSession()
         ignoreTripSessionUpdates.set(false)
     }
-
-    private fun defaultAudioGuidance(context: Context): MapboxAudioGuidance {
-        return MapboxAudioGuidanceImpl.create(context).also {
-            it.dataStoreOwner = NavigationDataStoreOwner(context, DEFAULT_DATA_STORE_NAME)
-        }
-    }
-
-    private const val DEFAULT_DATA_STORE_NAME = "mapbox_navigation_preferences"
 }

libnavui-app/src/main/java/com/mapbox/navigation/ui/app/internal/SharedApp.kt

@@ -8,7 +8,7 @@ import com.mapbox.navigation.ui.app.internal.State
 import com.mapbox.navigation.ui.app.internal.Store
 import com.mapbox.navigation.ui.app.internal.audioguidance.AudioAction
 import com.mapbox.navigation.ui.app.internal.audioguidance.AudioGuidanceState
-import com.mapbox.navigation.ui.voice.internal.MapboxAudioGuidance
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance
 
 /**
  * This class is responsible for playing voice instructions. Use the [AudioAction] to turning the

libnavui-app/src/main/java/com/mapbox/navigation/ui/app/internal/controller/AudioGuidanceStateController.kt

@@ -1,7 +1,5 @@
 package com.mapbox.navigation.ui.app.internal.controller
 
-import com.mapbox.api.directions.v5.models.VoiceInstructions
-import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
 import com.mapbox.navigation.testing.MainCoroutineRule
@@ -10,8 +8,8 @@ import com.mapbox.navigation.ui.app.internal.audioguidance.AudioAction
 import com.mapbox.navigation.ui.app.internal.audioguidance.AudioGuidanceState
 import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.app.testing.TestStore
-import com.mapbox.navigation.ui.voice.internal.MapboxAudioGuidance
-import com.mapbox.navigation.ui.voice.model.SpeechAnnouncement
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidanceState
 import io.mockk.every
 import io.mockk.mockk
 import io.mockk.mockkObject
@@ -27,13 +25,13 @@ import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 
-@OptIn(ExperimentalPreviewMapboxNavigationAPI::class, ExperimentalCoroutinesApi::class)
+@OptIn(ExperimentalCoroutinesApi::class)
 class AudioGuidanceStateControllerTest {
 
     @get:Rule
     var coroutineRule = MainCoroutineRule()
 
-    private lateinit var audioGuidanceState: MutableStateFlow<MapboxAudioGuidance.State>
+    private lateinit var audioGuidanceState: MutableStateFlow<MapboxAudioGuidanceState>
     private lateinit var mockAudioGuidance: MapboxAudioGuidance
     private lateinit var testStore: TestStore
 
@@ -42,7 +40,7 @@ class AudioGuidanceStateControllerTest {
         mockkObject(MapboxNavigationApp)
 
         audioGuidanceState = MutableStateFlow(
-            TestAudioGuidanceState(isMuted = false)
+            mockk { every { isMuted } returns false }
         )
         mockAudioGuidance = mockk(relaxed = true) {
             every { stateFlow() } returns audioGuidanceState
@@ -68,7 +66,7 @@ class AudioGuidanceStateControllerTest {
                     audio = AudioGuidanceState(isMuted = false)
                 )
             )
-            audioGuidanceState.value = TestAudioGuidanceState(isMuted = true)
+            audioGuidanceState.value = mockk { every { isMuted } returns true }
 
             sut.onAttached(mockMapboxNavigation())
             assertTrue(testStore.state.value.audio.isMuted)
@@ -83,7 +81,7 @@ class AudioGuidanceStateControllerTest {
                     audio = AudioGuidanceState(isMuted = false)
                 )
             )
-            audioGuidanceState.value = TestAudioGuidanceState(isMuted = false)
+            audioGuidanceState.value = mockk { every { isMuted } returns false }
 
             sut.onAttached(mockMapboxNavigation())
             testStore.setState(
@@ -118,11 +116,4 @@ class AudioGuidanceStateControllerTest {
         every { MapboxNavigationApp.current() } returns mapboxNavigation
         return mapboxNavigation
     }
-
-    private data class TestAudioGuidanceState(
-        override val isMuted: Boolean,
-        override val isPlayable: Boolean = false,
-        override val voiceInstructions: VoiceInstructions? = null,
-        override val speechAnnouncement: SpeechAnnouncement? = null
-    ) : MapboxAudioGuidance.State
 }