v3.18.0-beta.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.18.0-beta.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.18.0-beta.1

Routing

• Fixed an issue where extra faster route requests could be initiated by the SDK.

v3.17.0

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.17.0
• MapboxNavigationCore now requires MapboxNavigationNative v324.17.0

API Deprecations

• Deprecated RouteVoiceController.init(routeProgressing:rerouteStarted:fasterRouteSet:speechSynthesizer:) in favor of the new RouteVoiceController.init(routeProgressing:rerouteSoundTrigger:speechSynthesizer:).

Audio

• Audio playback operations (play, stop, set volume) of the AVAudioPlayer within the MapboxSpeechSynthesizer are now triggered on a background thread. This change minimizes the risk of the application hanging during voice instruction playback.
• Improved reroute sound logic. The reroute sound now plays only when a new route is fetched and applied, rather than when rerouting starts. This applies to both automatic reroutes and faster route scenarios.
• Fixed an issue that audio sessions activated by the SDK (for playback of voice instructions and reroute sound) were not interrupting spoken audio content playback from other applications (e.g. Podcasts).

Directions

• Added detection of duplicated URL request parameters derived from DirectionsOptions, IsochroneOptions, and MatrixOptions - an error is logged when duplicates are found.

v3.17.0-rc.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.17.0-rc.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.17.0-rc.1

Audio

• Audio playback operations (play, stop, set volume) of the AVAudioPlayer within the MapboxSpeechSynthesizer are now triggered on a background thread. This change minimizes the risk of the application hanging during voice instruction playback.

v3.17.0-beta.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.17.0-beta.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.17.0-beta.1

v2.20.3

Changes since v2.20.2:

Routing

• NavigationRouteOptions.init(waypoints:profileIdentifier:queryItems:) and NavigationMatchOptions.init(waypoints:profileIdentifier:queryItems:) set the default values for shapeFormat, locale, distanceMeasurementSystem, routeShapeResolution, includesSpokenInstructions, and includesVisualInstructions only if the values were not passed in queryItems. (#4794)

Map

• Fixed an issue where the initially set CarPlay navigation camera values were being overwritten when updates to this property were disabled.

Audio

• Fixed an issue that audio sessions activated by the SDK (for playback of voice instructions and reroute sound) were not interrupting spoken audio content playback from other applications (e.g. Podcasts).

Documentation is available online or within Xcode.

v3.16.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.16.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.16.1

Map

• Added the congestion configuration CongestionColorsConfiguration.displaySoftGradientForTraffic to customize if the color transition between traffic congestion changes should use a soft gradient appearance or abrupt color change.

v3.16.0

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.16.0
• MapboxNavigationCore now requires MapboxNavigationNative v324.16.0

API Deprecations

• ViewportState.routeProgress is deprecated and is always nil now. Use ViewportState.navigationProgress instead.
• ViewportState.heading is deprecated and is always nil now. Use ViewportState.navigationHeading instead.
• ViewportState.location is deprecated in favor of ViewportState.navigationLocation instead.
• ViewportState.init(location:routeProgress:viewportPadding:heading:) is deprecated in favor of ViewportState.init(navigationLocation:navigationProgress:viewportPadding:navigationHeading:).
• NavigationRoute.nativeRoute, NavigationRoute.init?(nativeRoute:), and AlternativeRoute.init?(mainRoute:alternativeRoute:) are deprecated and should no longer be used.
• CoreConfig.routeRequestConfig is deprecated. Configure request options directly using RouteOptions and MatchOptions.
• TelemetryAppMetadata.userId and TelemetryAppMetadata.sessionId are deprecated and no longer have any effect.

Routing

• Fixed an issue where request parameters could be lost on reroutes when using a custom RouteOptions subclass. If you subclass RouteOptions, make sure to implement urlQueryItems, init(from:), encode(to:), and init(waypoints:profileIdentifier:queryItems:).
• NavigationRouteOptions.init(waypoints:profileIdentifier:queryItems:) and NavigationMatchOptions.init(waypoints:profileIdentifier:queryItems:) set the default values for shapeFormat, locale, distanceMeasurementSystem, routeShapeResolution, includesSpokenInstructions, and includesVisualInstructions only if the values were not passed in queryItems.
• RoutingConfig.datasetProfileIdentifier was added to configure the dataset profile for routing tiles. It is important to set this value before initializing MapboxNavigationProvider and use the same value for the following ProfileIdentifier in route requests options.
• Fixed an issue where authentication route request parameters could be duplicated when using a custom DirectionsOptions subclass.

Navigation Camera

• When implementing a custom ViewportDataSource for the navigation camera, migrate to viewportState.navigationProgress for tracking active guidance progress.

Map

• Fixed the crash on an alternative map route annotation offset calculation when a deviation point is further than 80% of the main route.

CarPlay

• Fixed an incorrect CarPlayActivity value passed in CarPlayManagerDelegate function calls:

  • carPlayManager(_:, leadingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, trailingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, mapButtonsCompatibleWith traitCollection:, in:, for:).

  Now CarPlayActivity.panningInBrowsingMode and CarPlayActivity.panningInNavigationMode are passed in the above delegate function calls when the map is panned after showing the panning interface. Previously, those values were only passed at the moment of initial presentation of the panning interface and immediately after performing any panning (or any action that exits the map camera's follow mode), the passed CarPlayActivity was reverted to CarPlayActivity.browsing or CarPlayActivity.navigating even though the panning interface was still shown.

  In addition, CarPlayManager.currentActivity is also updated correctly in the mentioned scenarios.

• Fixed a problem that navigation bar buttons would not be updated properly for navigation mode when customized with CarPlayManagerDelegate implementation, because of too early execution of calls to CarPlayManagerDelegate functions:

  • carPlayManager(_:, leadingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, trailingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, mapButtonsCompatibleWith traitCollection:, in:, for:).

  Those calls were previously executed before CarPlayNavigationViewController instantiation. Now they are performed after CarPlayNavigationViewController instantiation, right after calling CarPlayManagerDelegate.carPlayManager(_:, willPresent:).

Other changes

• Fixed a possible race condition in NavigationCamera state updates.
• Fixed memory leaks caused by Task.detached usage in NavigationController.
• Fixed memory leaks in NWPathMonitor caused by a non-stopped monitor.
• Removed excessive Sendable conformance for types from Turf and Maps.
• StepsViewController.measurementSystem is now public.

v3.16.0-rc.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.16.0-rc.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.16.0-rc.1

API Deprecations

• ViewportState.routeProgress is deprecated and is always nil now. Use ViewportState.navigationProgress instead.
• ViewportState.heading is deprecated and is always nil now. Use ViewportState.navigationHeading instead.
• ViewportState.location is deprecated in favor of ViewportState.navigationLocation instead.
• ViewportState.init(location:routeProgress:viewportPadding:heading:) is deprecated in favor of ViewportState.init(navigationLocation:navigationProgress:viewportPadding:navigationHeading:).

Navigation Camera

• When implementing a custom ViewportDataSource for the navigation camera, migrate to viewportState.navigationProgress for tracking active guidance progress.

Other changes

• Fixed a possible race condition in NavigationCamera state updates.
• Fixed memory leaks caused by Task.detached usage in NavigationController.
• Fixed memory leaks in NWPathMonitor caused by a non-stopped monitor.
• Removed excessive Sendable conformance for types from Turf and Maps.

v3.12.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.15.2
• MapboxNavigationCore now requires MapboxNavigationNative v324.15.2

v3.11.4

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.14.7
• MapboxNavigationCore now requires MapboxNavigationNative v324.14.7