add convenience function

Author: kmadsen

libnavigation-core/api/current.txt

@@ -1026,6 +1026,7 @@ 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.MapboxTripStarter enableReplayRoute(com.mapbox.navigation.core.replay.route.ReplayRouteSessionOptions? options = null);
     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);

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

@@ -8,6 +8,7 @@ import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
 import com.mapbox.navigation.core.replay.route.ReplayRouteSession
+import com.mapbox.navigation.core.replay.route.ReplayRouteSessionOptions
 import com.mapbox.navigation.core.trip.MapboxTripStarterExtra.MAPBOX_TRIP_STARTER_FOLLOW_DEVICE
 import com.mapbox.navigation.core.trip.MapboxTripStarterExtra.MAPBOX_TRIP_STARTER_REPLAY_ROUTE
 import com.mapbox.navigation.core.trip.session.TripSessionState
@@ -109,6 +110,21 @@ class MapboxTripStarter internal constructor() : MapboxNavigationObserver {
         stateFlow.value = nextState
     }
 
+    /**
+     * Enables a mode where the primary route is simulated by an artificial driver. Set the route
+     * with [MapboxNavigation.setNavigationRoutes].
+     *
+     * @param options optional options to use for route replay.
+     */
+    fun enableReplayRoute(
+        options: ReplayRouteSessionOptions? = null
+    ) = apply {
+        update { builder ->
+            options?.let { builder.replayRouteSessionOptions(options) }
+            builder.tripType(MAPBOX_TRIP_STARTER_REPLAY_ROUTE)
+        }
+    }
+
     /**
      * Throws an error if location permissions are set to true but the location permissions are
      * not actually granted.

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

@@ -29,11 +29,9 @@ import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.directions.session.RoutesObserver
 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
@@ -81,7 +79,7 @@ class RoadObjectsActivity : AppCompatActivity() {
 
     @OptIn(ExperimentalPreviewMapboxNavigationAPI::class)
     private val mapboxTripStarter = MapboxTripStarter.create()
-        .update { it.tripType(MAPBOX_TRIP_STARTER_REPLAY_ROUTE) }
+        .enableReplayRoute()
 
     private val mapCamera: CameraAnimationsPlugin by lazy {
         binding.mapView.camera