expose voiceInstructionsPlayer in drop-in

Author: korshaknn

CHANGELOG.md

@@ -17,6 +17,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed an issue with `NavigationView` that caused unexpected camera movements when switching between navigation states. [#6487](https://github.com/mapbox/mapbox-navigation-android/pull/6487)
 - Supported changing `MapboxVoiceInstructionsPlayer` language in runtime via `updateLanguage` method. [#6491](https://github.com/mapbox/mapbox-navigation-android/pull/6491)
 - Deprecated `MapboxVoiceInstructionsPlayer` constructors that accept access token and introduced the ones without it. [#6491](https://github.com/mapbox/mapbox-navigation-android/pull/6491)
+- Updated `NavigationViewApi` and `MapboxAudioGuidance`. Introduced `currentVoiceInstructionsPlayer` which allows playing customers voice instructions. [#6475](https://github.com/mapbox/mapbox-navigation-android/pull/6475)
 
 ## Mapbox Navigation SDK 2.9.0-beta.2 - 14 October, 2022
 ### Changelog

libnavui-dropin/api/current.txt

@@ -37,6 +37,7 @@ package com.mapbox.navigation.dropin {
 
   @UiThread @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public abstract class NavigationViewApi {
     ctor public NavigationViewApi();
+    method public abstract com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer? getCurrentVoiceInstructionsPlayer();
     method public abstract boolean isReplayEnabled();
     method public abstract void routeReplayEnabled(boolean enabled);
     method public abstract com.mapbox.bindgen.Expected<com.mapbox.navigation.dropin.NavigationViewApiError,kotlin.Unit> startActiveGuidance();
@@ -47,6 +48,7 @@ package com.mapbox.navigation.dropin {
     method public abstract void startFreeDrive();
     method public abstract com.mapbox.bindgen.Expected<com.mapbox.navigation.dropin.NavigationViewApiError,kotlin.Unit> startRoutePreview();
     method public abstract com.mapbox.bindgen.Expected<com.mapbox.navigation.dropin.NavigationViewApiError,kotlin.Unit> startRoutePreview(java.util.List<com.mapbox.navigation.base.route.NavigationRoute> routes);
+    property public abstract com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer? currentVoiceInstructionsPlayer;
   }
 
   public final class NavigationViewApiError extends java.lang.Throwable {

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/NavigationViewApi.kt

@@ -8,6 +8,7 @@ import com.mapbox.bindgen.Expected
 import com.mapbox.geojson.Point
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.route.NavigationRoute
+import com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer
 
 /**
  * Api that gives you the ability to change the state for navigation apps.
@@ -112,4 +113,9 @@ abstract class NavigationViewApi {
      * Enable/Disable replay trip session based on simulated locations.
      */
     abstract fun routeReplayEnabled(enabled: Boolean)
+
+    /**
+     * Current instance of a voice instructions player.
+     */
+    abstract val currentVoiceInstructionsPlayer: MapboxVoiceInstructionsPlayer?
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/navigationview/MapboxNavigationViewApi.kt

@@ -19,6 +19,7 @@ import com.mapbox.navigation.ui.app.internal.showRoutePreview
 import com.mapbox.navigation.ui.app.internal.startActiveNavigation
 import com.mapbox.navigation.ui.app.internal.startArrival
 import com.mapbox.navigation.ui.app.internal.tripsession.TripSessionStarterAction
+import com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance
 
 @ExperimentalPreviewMapboxNavigationAPI
 internal class MapboxNavigationViewApi(
@@ -100,6 +101,9 @@ internal class MapboxNavigationViewApi(
         }
     }
 
+    override val currentVoiceInstructionsPlayer
+        get() = MapboxAudioGuidance.getRegisteredInstance().currentVoiceInstructionsPlayer
+
     @Throws(NavigationViewApiError::class)
     private fun checkDestination() {
         if (store.state.value.destination == null) {

libnavui-voice/api/current.txt

@@ -23,13 +23,15 @@ package com.mapbox.navigation.ui.voice.api {
 
   public final class MapboxAudioGuidance implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
     method public static com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance create();
+    method public com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer? getCurrentVoiceInstructionsPlayer();
     method public static com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance getRegisteredInstance();
     method public void mute();
     method public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
     method public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
     method public kotlinx.coroutines.flow.StateFlow<com.mapbox.navigation.ui.voice.api.MapboxAudioGuidanceState> stateFlow();
     method public void toggle();
     method public void unmute();
+    property public final com.mapbox.navigation.ui.voice.api.MapboxVoiceInstructionsPlayer? currentVoiceInstructionsPlayer;
     field public static final com.mapbox.navigation.ui.voice.api.MapboxAudioGuidance.Companion Companion;
   }
 

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

@@ -49,6 +49,11 @@ internal constructor(
 
     private var job: Job? = null
 
+    /**
+     * Current instance of a [VoiceInstructionsPlayer].
+     */
+    val currentVoiceInstructionsPlayer get() = audioGuidanceServices.voiceInstructionsPlayer
+
     /**
      * @see [MapboxNavigationApp]
      */

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/internal/impl/MapboxAudioGuidanceServices.kt

@@ -11,7 +11,7 @@ import com.mapbox.navigation.ui.voice.internal.MapboxVoiceInstructions
 
 class MapboxAudioGuidanceServices {
 
-    private var voiceInstructionsPlayer: MapboxVoiceInstructionsPlayer? = null
+    var voiceInstructionsPlayer: MapboxVoiceInstructionsPlayer? = null
 
     fun mapboxAudioGuidanceVoice(
         mapboxNavigation: MapboxNavigation,