Show it with an example

Author: kmadsen

libnavigation-core/api/current.txt

@@ -1025,15 +1025,18 @@ package com.mapbox.navigation.core.telemetry.events {
 package com.mapbox.navigation.core.trip {
 
   @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class MapboxTripStarter implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
+    method public static com.mapbox.navigation.core.trip.MapboxTripStarter create();
     method public com.mapbox.navigation.core.trip.MapboxTripStarterOptions getOptions();
     method public static com.mapbox.navigation.core.trip.MapboxTripStarter getRegisteredInstance();
     method public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
     method public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
+    method @kotlin.jvm.Throws(exceptionClasses=IllegalStateException::class) public void setLocationPermissionGranted(boolean granted) throws java.lang.IllegalStateException;
     method public com.mapbox.navigation.core.trip.MapboxTripStarter setOptions(com.mapbox.navigation.core.trip.MapboxTripStarterOptions options);
     field public static final com.mapbox.navigation.core.trip.MapboxTripStarter.Companion Companion;
   }
 
   public static final class MapboxTripStarter.Companion {
+    method public com.mapbox.navigation.core.trip.MapboxTripStarter create();
     method public com.mapbox.navigation.core.trip.MapboxTripStarter getRegisteredInstance();
   }
 
@@ -1053,17 +1056,14 @@ package com.mapbox.navigation.core.trip {
   @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class MapboxTripStarterOptions {
     method public com.mapbox.navigation.core.replay.route.ReplayRouteSessionOptions getReplayRouteSessionOptions();
     method public String getTripType();
-    method public boolean isLocationPermissionGranted();
     method public com.mapbox.navigation.core.trip.MapboxTripStarterOptions.Builder toBuilder();
-    property public final boolean isLocationPermissionGranted;
     property public final com.mapbox.navigation.core.replay.route.ReplayRouteSessionOptions replayRouteSessionOptions;
     property public final String tripType;
   }
 
   public static final class MapboxTripStarterOptions.Builder {
     ctor public MapboxTripStarterOptions.Builder();
     method public com.mapbox.navigation.core.trip.MapboxTripStarterOptions build();
-    method public com.mapbox.navigation.core.trip.MapboxTripStarterOptions.Builder isLocationPermissionGranted(boolean isLocationPermissionGranted);
     method public com.mapbox.navigation.core.trip.MapboxTripStarterOptions.Builder replayRouteSessionOptions(com.mapbox.navigation.core.replay.route.ReplayRouteSessionOptions options);
     method public com.mapbox.navigation.core.trip.MapboxTripStarterOptions.Builder tripType(@com.mapbox.navigation.core.trip.MapboxTripStarterExtra.Type String tripType);
   }

libnavigation-core/src/main/java/com/mapbox/navigation/core/trip/MapboxTripStarter.kt

@@ -169,6 +169,12 @@ class MapboxTripStarter internal constructor() : MapboxNavigationObserver {
 
     companion object {
 
+        /**
+         * Construct an instance without registering to [MapboxNavigationApp].
+         */
+        @JvmStatic
+        fun create() = MapboxTripStarter()
+
         /**
          * Get the registered instance or create one and register it to [MapboxNavigationApp].
          */
@@ -185,6 +191,6 @@ class MapboxTripStarter internal constructor() : MapboxNavigationObserver {
 @ExperimentalPreviewMapboxNavigationAPI
 fun MapboxTripStarter.update(
     function: (MapboxTripStarterOptions.Builder) -> MapboxTripStarterOptions.Builder
-) {
+): MapboxTripStarter = apply {
     setOptions(function.invoke(getOptions().toBuilder()).build())
 }

qa-test-app/src/main/java/com/mapbox/navigation/qa_test_app/view/RoadObjectsActivity.kt

@@ -15,6 +15,7 @@ import com.mapbox.maps.plugin.animation.CameraAnimationsPlugin
 import com.mapbox.maps.plugin.animation.MapAnimationOptions
 import com.mapbox.maps.plugin.animation.camera
 import com.mapbox.maps.plugin.locationcomponent.location
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
 import com.mapbox.navigation.base.options.NavigationOptions
 import com.mapbox.navigation.base.trip.model.RouteProgress
@@ -25,15 +26,14 @@ import com.mapbox.navigation.base.trip.model.roadobject.reststop.RestStopType
 import com.mapbox.navigation.base.trip.model.roadobject.tollcollection.TollCollection
 import com.mapbox.navigation.base.trip.model.roadobject.tollcollection.TollCollectionType
 import com.mapbox.navigation.core.MapboxNavigation
-import com.mapbox.navigation.core.MapboxNavigationProvider
 import com.mapbox.navigation.core.directions.session.RoutesObserver
-import com.mapbox.navigation.core.replay.MapboxReplayer
-import com.mapbox.navigation.core.replay.ReplayLocationEngine
-import com.mapbox.navigation.core.replay.route.ReplayProgressObserver
 import com.mapbox.navigation.core.replay.route.ReplayRouteMapper
+import com.mapbox.navigation.core.trip.MapboxTripStarter
+import com.mapbox.navigation.core.trip.MapboxTripStarterExtra.MAPBOX_TRIP_STARTER_REPLAY_ROUTE
 import com.mapbox.navigation.core.trip.session.LocationMatcherResult
 import com.mapbox.navigation.core.trip.session.LocationObserver
 import com.mapbox.navigation.core.trip.session.RouteProgressObserver
+import com.mapbox.navigation.core.trip.update
 import com.mapbox.navigation.qa_test_app.R
 import com.mapbox.navigation.qa_test_app.databinding.LayoutActivityRestStopBinding
 import com.mapbox.navigation.qa_test_app.utils.Utils
@@ -57,8 +57,6 @@ class RoadObjectsActivity : AppCompatActivity() {
         private const val TAG = "RoadObjectsActivity"
     }
 
-    private val replayRouteMapper = ReplayRouteMapper()
-    private val mapboxReplayer = MapboxReplayer()
     private val navigationLocationProvider = NavigationLocationProvider()
 
     private val binding: LayoutActivityRestStopBinding by lazy {
@@ -74,14 +72,17 @@ class RoadObjectsActivity : AppCompatActivity() {
     }
 
     private val mapboxNavigation: MapboxNavigation by lazy {
-        MapboxNavigationProvider.create(
+        MapboxNavigation(
             NavigationOptions.Builder(this)
                 .accessToken(Utils.getMapboxSapaAccessToken(this))
-                .locationEngine(ReplayLocationEngine(mapboxReplayer))
                 .build()
         )
     }
 
+    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+    private val mapboxTripStarter = MapboxTripStarter.create()
+        .update { it.tripType(MAPBOX_TRIP_STARTER_REPLAY_ROUTE) }
+
     private val mapCamera: CameraAnimationsPlugin by lazy {
         binding.mapView.camera
     }
@@ -121,6 +122,7 @@ class RoadObjectsActivity : AppCompatActivity() {
         super.onCreate(savedInstanceState)
         setContentView(binding.root)
         initNavigation()
+        initReplayer()
         initStyle()
         initListeners()
     }
@@ -129,15 +131,15 @@ class RoadObjectsActivity : AppCompatActivity() {
         super.onStop()
         mapboxNavigation.unregisterRoutesObserver(routesObserver)
         mapboxNavigation.unregisterRouteProgressObserver(routeProgressObserver)
-        mapboxNavigation.unregisterRouteProgressObserver(replayProgressObserver)
         mapboxNavigation.unregisterLocationObserver(locationObserver)
     }
 
+    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
     override fun onDestroy() {
         super.onDestroy()
+        mapboxTripStarter.onDetached(mapboxNavigation)
         routeLineApi.cancel()
         routeLineView.cancel()
-        mapboxReplayer.finish()
         mapboxNavigation.onDestroy()
     }
 
@@ -150,10 +152,6 @@ class RoadObjectsActivity : AppCompatActivity() {
             routeLineApi.setRoutes(listOf(RouteLine(route, null))) {
                 routeLineView.renderRouteDrawData(style, it)
             }
-
-            val routeOrigin = Utils.getRouteOriginPoint(route)
-            val cameraOptions = CameraOptions.Builder().center(routeOrigin).zoom(15.0).build()
-            binding.mapView.getMapboxMap().setCamera(cameraOptions)
         }
     }
 
@@ -163,12 +161,16 @@ class RoadObjectsActivity : AppCompatActivity() {
             enabled = true
         }
         mapboxNavigation.registerRoutesObserver(routesObserver)
-        mapboxNavigation.setRoutes(listOf(getRoute()))
         mapboxNavigation.registerLocationObserver(locationObserver)
-        mapboxNavigation.registerRouteProgressObserver(replayProgressObserver)
-        mapboxReplayer.pushRealLocation(this, 0.0)
-        mapboxReplayer.playbackSpeed(1.5)
-        mapboxReplayer.play()
+    }
+
+    @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
+    private fun initReplayer() {
+        mapboxTripStarter.onAttached(mapboxNavigation)
+        val routeOrigin = Utils.getRouteOriginPoint(getRoute())
+        mapboxNavigation.mapboxReplayer.pushEvents(
+            listOf(ReplayRouteMapper.mapToUpdateLocation(0.0, routeOrigin))
+        )
     }
 
     private val locationObserver: LocationObserver = object : LocationObserver {
@@ -202,21 +204,11 @@ class RoadObjectsActivity : AppCompatActivity() {
     private fun initListeners() {
         binding.startNavigation.setOnClickListener {
             mapboxNavigation.registerRouteProgressObserver(routeProgressObserver)
-            mapboxNavigation.startTripSession()
             binding.startNavigation.visibility = View.GONE
-            startSimulation(mapboxNavigation.getRoutes()[0])
+            mapboxNavigation.setRoutes(listOf(getRoute()))
         }
     }
 
-    private fun startSimulation(route: DirectionsRoute) {
-        mapboxReplayer.stop()
-        mapboxReplayer.clearEvents()
-        val replayData = replayRouteMapper.mapDirectionsRouteGeometry(route)
-        mapboxReplayer.pushEvents(replayData)
-        mapboxReplayer.seekTo(replayData[0])
-        mapboxReplayer.play()
-    }
-
     private val routesObserver = RoutesObserver {
         val builder = SpannableStringBuilder("The route has\n\n")
         val navigationRoute = it.navigationRoutes.first()
@@ -342,8 +334,6 @@ class RoadObjectsActivity : AppCompatActivity() {
         return getString(stringResource, formatter.format(distance))
     }
 
-    private val replayProgressObserver = ReplayProgressObserver(mapboxReplayer)
-
     private fun getRoute(): DirectionsRoute {
         val routeAsString = Utils.readRawFileText(this, R.raw.route_with_sapa)
         return DirectionsRoute.fromJson(routeAsString)