CarPlay

Overview

Use the CarPlay framework to create an in-car experience for your app. The framework provides templates for building a version of your app’s interface suitable for presentation on a vehicle’s displays. Add the templates you want to your app and customize them to suit your content. You control the content of the templates, but the framework controls certain aspects of the template interface elements, such as the touch target size, font size, font color, and highlights.

CarPlay features run when the current device supports CarPlay and when that device is connected to an appropriately equipped vehicle. CarPlay handles variations in vehicle systems, letting you focus on your content. When a person runs your app from their vehicle, the system generates and hosts your app’s interface for you. If the device doesn’t support CarPlay, the system doesn’t try to access your app’s CarPlay features.

You can use other technologies to drive portions of your app’s CarPlay interface. Messaging apps can include SiriKit support to allow someone to read or send messages. VoIP apps can use CallKit to manage incoming and outgoing calls, often in combination with SiriKit call support. Navigation apps can include MapKit support.

Topics

CarPlay Integration

• Requesting CarPlay Entitlements
• Displaying Content in CarPlay
• Supporting Previous Versions of iOS
• Using the CarPlay Simulator
• CPTemplateApplicationScene
• CPTemplateApplicationSceneDelegate
• CPSessionConfiguration

General Purpose Templates

• CPListTemplate
• CPGridTemplate
• CPTabBarTemplate
• CPTemplate
• CPBarButtonProviding

Audio

• Integrating CarPlay with Your Music App
• CPNowPlayingTemplate

Instrument cluster

• CPInstrumentClusterController
• CPInstrumentClusterControllerDelegate
• CPTemplateApplicationInstrumentClusterScene
• CPTemplateApplicationInstrumentClusterSceneDelegate

Navigation

• Integrating CarPlay with Your Navigation App
• CPTemplateApplicationDashboardScene
• CPTemplateApplicationDashboardSceneDelegate
• CPMapTemplate
• CPSearchTemplate
• CPVoiceControlTemplate

Location and Information

• CPPointOfInterestTemplate
• CPInformationTemplate
• CPTextButton
• Integrating CarPlay with your quick-ordering app

Maneuvers

• CPManeuver
• CPManeuverState
• CPManeuverType

Routes, lanes and junctions

• CPRouteInformation
• CPLane
• CPLaneGuidance
• CPLaneStatus
• CPJunctionType

Communication

• CPContactTemplate

Actions and Alerts

• CPActionSheetTemplate
• CPAlertTemplate
• CPAlertAction

Related Types

• CPButton
• CPImageSet
• CarPlayErrorDomain

Deprecated

• Deprecated Symbols

Reference

• CarPlay Enumerations
• CarPlay Constants

Classes

• CPImageOverlay
• CPListImageRowItemCardElement
• CPListImageRowItemCondensedElement
• CPListImageRowItemElement
• CPListImageRowItemGridElement
• CPListImageRowItemImageGridElement
• CPListImageRowItemRowElement
• CPListTemplateDetailsHeader
• CPMapTemplateWaypoint
• CPMessageGridItemConfiguration
• CPNavigationWaypoint
• CPNowPlayingMode
• CPNowPlayingModeSports
• CPNowPlayingSportsClock
• CPNowPlayingSportsEventStatus
• CPNowPlayingSportsTeam
• CPNowPlayingSportsTeamLogo
• CPPlaybackConfiguration
• CPRouteSegment
• CPSportsOverlay
• CPThumbnailImage

Protocols

• CPPlayableItem

Structures

• CPLocationCoordinate3D

Variables

• CPMaximumMessageItemLeadingDetailTextImageSize

Functions

• NSStringFromCPJunctionType(_:)
• NSStringFromCPLaneStatus(_:)
• NSStringFromCPManeuverType(_:)
• NSStringFromCPRerouteReason(_:)
• NSStringFromCPTrafficSide(_:)

Enumerations

• CPRerouteReason
• CPRouteSource