CarPlayNavigationViewController

@MainActor
open class CarPlayNavigationViewController : UIViewController, BuildingHighlighting

extension CarPlayNavigationViewController: StyleManagerDelegate

extension CarPlayNavigationViewController: NavigationServiceDelegate

extension CarPlayNavigationViewController: NavigationMapViewDelegate

extension CarPlayNavigationViewController: CPSessionConfigurationDelegate

extension CarPlayNavigationViewController: CPListTemplateDelegate

CarPlayNavigationViewController is a fully-featured turn-by-turn navigation UI for CarPlay.

Seealso

NavigationViewController

Child Views and Styling Configuration

compassView
A view indicating what direction the vehicle is traveling towards, snapped to eight cardinal directions in steps of 45°.

This view is hidden by default.
Declaration
Swift

@MainActor public var compassView: CarPlayCompassView!
View Source on GitHub
speedLimitView
A view that displays the current speed limit.
Declaration
Swift

@MainActor public var speedLimitView: SpeedLimitView!
View Source on GitHub
wayNameView
A view that displays the current road name.
Declaration
Swift

@MainActor public var wayNameView: WayNameView!
View Source on GitHub
styles
The interface styles available for display.

These are the styles available to the view controller’s internal StyleManager object. In CarPlay, Style objects primarily affect the appearance of the map, not guidance-related overlay views.
Declaration
Swift

@MainActor public var styles: [Style] { get set }
View Source on GitHub
routeLineTracksTraversal
Controls whether the main route style layer and its casing disappears as the user location puck travels over it. Defaults to false.

If true, the part of the route that has been traversed will be rendered with full transparency, to give the illusion of a disappearing route. To customize the color that appears on the traversed section of a route, override the traversedRouteColor property for the NavigationMapView.appearance().
Declaration
Swift

@MainActor public var routeLineTracksTraversal: Bool { get set }
View Source on GitHub
showsContinuousAlternatives
Toggles displaying alternative routes.

If enabled, view will draw actual alternative route lines on the map. Default value is true.
Declaration
Swift

@MainActor public var showsContinuousAlternatives: Bool { get set }
View Source on GitHub
annotatesIntersectionsAlongRoute
A Boolean value that determines whether the map annotates the intersections on current step during active navigation.

If true, the map would display an icon of a traffic control device on the intersection, such as traffic signal, stop sign, yield sign, or railroad crossing. Defaults to true.
Declaration
Swift

@MainActor public var annotatesIntersectionsAlongRoute: Bool { get set }
View Source on GitHub
continuousAlternatives
AlternativeRoutes user might take during this trip to reach the destination using another road.

Array contents are updated automatically duting the trip. Alternative routes may be slower or longer then the main route. To get updates, subscribe to Notification.Name.routeControllerDidUpdateAlternatives notification.
Declaration
Swift

@MainActor public var continuousAlternatives: [AlternativeRoute] { get }
View Source on GitHub
usesNightStyleWhileInTunnel
Controls whether night style will be used whenever traversing through a tunnel. Defaults to true.
Declaration
Swift

@MainActor public var usesNightStyleWhileInTunnel: Bool
View Source on GitHub
styleManager
Controls the styling of CarPlayNavigationViewController and its components.

The style can be modified programmatically by using StyleManager.applyStyle(type:).
Declaration
Swift

@MainActor public private(set) var styleManager: StyleManager? { get }
View Source on GitHub
waypointStyle
Allows to control highlighting of the destination building on arrival. By default destination buildings will not be highlighted.
Declaration
Swift

@MainActor public var waypointStyle: WaypointStyle
View Source on GitHub

Collecting User Feedback

eventsManager
Provides methods for creating and sending user feedback.
Declaration
Swift

@MainActor public var eventsManager: NavigationEventsManager { get }
View Source on GitHub
showFeedback()
Shows the interface for providing feedback about the route.
Declaration
Swift

@MainActor public func showFeedback()
View Source on GitHub

Navigating the Route

delegate
The view controller’s delegate, that is used by the CarPlayManager.

Do not overwrite this property and use CarPlayManagerDelegate methods directly.
Declaration
Swift

@MainActor public weak var delegate: CarPlayNavigationViewControllerDelegate?
View Source on GitHub
carPlayManager
CarPlayManager instance, which contains main UIWindow content and is used by CarPlayNavigationViewController for presentation.
Declaration
Swift

@MainActor public var carPlayManager: CarPlayManager
View Source on GitHub
navigationService
Provides all routing logic for the user.

See NavigationService for more information.
Declaration
Swift

@MainActor public var navigationService: NavigationService
View Source on GitHub
navigationMapView
The map view showing the route and the user’s location.
Declaration
Swift

@MainActor public fileprivate(set) var navigationMapView: NavigationMapView? { get }
View Source on GitHub


                    
                    
                    startNavigationSession(for:)

Begins a navigation session along the given trip.

Declaration

Swift

@MainActor
public func startNavigationSession(for trip: CPTrip)

Parameters


                                  trip

The trip to begin navigating along.

View Source on GitHub


                    
                    
                    exitNavigation(byCanceling:)

Ends the current navigation session.

Declaration

Swift

@MainActor
public func exitNavigation(byCanceling canceled: Bool = false)

Parameters


                                  canceled

A Boolean value indicating whether this method is being called because the user intends to cancel the trip, as opposed to letting it run to completion.

View Source on GitHub


                    
                    
                    init(navigationService:mapTemplate:interfaceController:manager:styles:)

Creates a new CarPlay navigation view controller for the given route controller and user interface.

Postcondition

Call startNavigationSession(for:) after initializing this object to begin navigation.

Declaration

Swift

@MainActor
public required init(navigationService: NavigationService,
                     mapTemplate: CPMapTemplate,
                     interfaceController: CPInterfaceController,
                     manager: CarPlayManager,
                     styles: [Style]? = nil)

Parameters

`navigationService`	The navigation service managing location updates for the navigation session.
`mapTemplate`	The map template visible during the navigation session.
`interfaceController`	The interface controller for CarPlay.
`manager`	The manager for CarPlay.
`styles`	The interface styles that the view controller’s internal `StyleManager` object can select from for display.

View Source on GitHub

StyleManagerDelegate Methods


                    
                    
                    location(for:)

Declaration

Swift

@MainActor
public func location(for styleManager: StyleManager) -> CLLocation?

View Source on GitHub


                    
                    
                    styleManager(_:didApply:)

Declaration

Swift

@MainActor
public func styleManager(_ styleManager: StyleManager, didApply style: Style)

View Source on GitHub


                    
                    
                    styleManagerDidRefreshAppearance(_:)

Declaration

Swift

@MainActor
public func styleManagerDidRefreshAppearance(_ styleManager: StyleManager)

View Source on GitHub

NavigationServiceDelegate Methods


                    
                    
                    navigationService(_:didArriveAt:)

Declaration

Swift

@MainActor
public func navigationService(_ service: NavigationService, didArriveAt waypoint: Waypoint) -> Bool

View Source on GitHub

NavigationMapViewDelegate Methods


                    
                    
                    navigationMapView(_:waypointCircleLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

@MainActor
public func navigationMapView(_ navigationMapView: NavigationMapView, 
                              waypointCircleLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> CircleLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:waypointSymbolLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

@MainActor
public func navigationMapView(_ navigationMapView: NavigationMapView, 
                              waypointSymbolLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> SymbolLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:didAdd:pointAnnotationManager:)

Declaration

Swift

@MainActor
public func navigationMapView(_ navigationMapView: NavigationMapView,
                              didAdd finalDestinationAnnotation: PointAnnotation,
                              pointAnnotationManager: PointAnnotationManager)

View Source on GitHub


                    
                    
                    navigationMapView(_:routeLineLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

@MainActor
public func navigationMapView(_ navigationMapView: NavigationMapView,
                              routeLineLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> LineLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:routeCasingLineLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

@MainActor
public func navigationMapView(_ navigationMapView: NavigationMapView,
                              routeCasingLineLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> LineLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:routeRestrictedAreasLineLayerWithIdentifier:sourceIdentifier:)

Declaration

Swift

@MainActor
public func navigationMapView(_ navigationMapView: NavigationMapView,
                              routeRestrictedAreasLineLayerWithIdentifier identifier: String,
                              sourceIdentifier: String) -> LineLayer?

View Source on GitHub


                    
                    
                    navigationMapView(_:willAdd:)

Declaration

Swift

@MainActor
public func navigationMapView(_ navigationMapView: NavigationMapView, willAdd layer: Layer) -> Layer?

View Source on GitHub