One Logo Pool Ball
App Services · IOS API REFERENCE

CarPlay

Integrate CarPlay in apps related to audio, communication, navigation, parking, EV charging, food ordering, and more.

148 types

837 callable entries

141 skipped

86% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

CPActionSheetTemplate

class · iOS 12.0+

CPAlertAction

class · iOS 12.0+

CPAlertAction.Style

enum · iOS 12.0+

CPAlertActionHandler

typealias

CPAlertTemplate

class · iOS 12.0+

CPApplicationDelegate

protocol · iOS 12.0+ · Deprecated in iOS 13.0

CPAssistantCellActionType

enum · iOS 15.0+

CPAssistantCellConfiguration

class · iOS 15.0+

CPBarButton

class · iOS 12.0+

CPBarButton.Type

enum · iOS 12.0+

CPBarButtonHandler

typealias

CPBarButtonProviding

protocol · iOS 12.0+

CPBarButtonStyle

enum · iOS 14.0+

CPButton

class · iOS 14.0+

CPChargingStationConnection

class · iOS 27.0+

CPChargingStationConnection.Connector

enum

CPContact

class · iOS 14.0+

CPContactCallButton

class · iOS 14.0+

CPContactDirectionsButton

class · iOS 14.0+

CPContactMessageButton

class · iOS 14.0+

CPContactTemplate

class · iOS 14.0+

CPContentStyle

struct · iOS 13.0+

CPDashboardButton

class · iOS 13.4+

CPDashboardController

class · iOS 13.4+

CPGridButton

class · iOS 12.0+

CPGridTemplate

class · iOS 12.0+

CPImageOverlay

class · iOS 26.4+

CPImageOverlay.Alignment

enum · iOS 26.4+

CPImageSet

class · iOS 12.0+

CPInformationItem

class · iOS 14.0+

CPInformationRatingItem

class · iOS 14.0+

CPInformationTemplate

class · iOS 14.0+

CPInformationTemplateLayout

enum · iOS 14.0+

CPInstrumentClusterController

class · iOS 15.4+

CPInstrumentClusterControllerDelegate

protocol · iOS 15.4+

CPInstrumentClusterSetting

enum · iOS 15.4+

CPInterfaceController

class · iOS 12.0+

CPInterfaceControllerDelegate

protocol · iOS 12.0+

CPJunctionType

enum · iOS 17.4+

CPLane

class · iOS 17.4+

CPLaneGuidance

class · iOS 17.4+

CPLaneStatus

enum · iOS 17.4+

CPLimitableUserInterface

struct · iOS 12.0+

CPListImageRowItem

class · iOS 14.0+

CPListImageRowItemCardElement

class · iOS 26.0+

CPListImageRowItemCondensedElement

class · iOS 26.0+

CPListImageRowItemCondensedElement.Shape

enum · iOS 26.0+

CPListImageRowItemElement

class · iOS 26.0+

CPListImageRowItemGridElement

class · iOS 26.0+

CPListImageRowItemImageGridElement

class · iOS 26.0+

CPListImageRowItemImageGridElement.Shape

enum · iOS 26.0+

CPListImageRowItemRowElement

class · iOS 26.0+

CPListItem

class · iOS 12.0+

CPListItem.AssistantCellPosition

enum · iOS 15.0+

CPListItem.AssistantCellVisibility

enum · iOS 15.0+

CPListItemAccessoryType

enum · iOS 14.0+

CPListItemPlayingIndicatorLocation

enum · iOS 14.0+

CPListSection

class · iOS 12.0+

CPListTemplate

class · iOS 12.0+

CPListTemplateDelegate

protocol · iOS 12.0+ · Deprecated in iOS 14.0

CPListTemplateDetailsHeader

class · iOS 26.4+

CPListTemplateItem

protocol · iOS 14.0+

CPLocationCoordinate3D

struct · iOS 26.4+

CPManeuver

class · iOS 12.0+

CPManeuverDisplayStyle

struct · iOS 12.0+

CPManeuverState

enum · iOS 17.4+

CPManeuverType

enum · iOS 17.4+

CPMapButton

class · iOS 12.0+

CPMapPanel

class · iOS 27.0+

CPMapPanel.Delegate

protocol · iOS 27.0+

CPMapPanelButtonConfiguration

class · iOS 27.0+

CPMapPanelItem

class · iOS 27.0+

CPMapPanelSection

class · iOS 27.0+

CPMapTemplate

class · iOS 12.0+

CPMapTemplate.PanDirection

struct · iOS 12.0+

CPMapTemplateDelegate

protocol · iOS 12.0+

CPMapTemplateWaypoint

class · iOS 26.4+

CPMessageComposeBarButton

class · iOS 14.0+

CPMessageGridItemConfiguration

class · iOS 26.0+

CPMessageLeadingItem

enum

CPMessageListItem

class · iOS 14.0+

CPMessageListItemLeadingConfiguration

class · iOS 14.0+

CPMessageListItemTrailingConfiguration

class · iOS 14.0+

CPMessageTrailingItem

enum

CPMultiStopCardConfiguration

class · iOS 27.0+

CPNavigationAlert

class · iOS 12.0+

CPNavigationAlert.DismissalContext

enum · iOS 12.0+

CPNavigationSession

class · iOS 12.0+

CPNavigationSession.PauseReason

enum · iOS 12.0+

CPNavigationWaypoint

class · iOS 26.4+

CPNowPlayingAddToLibraryButton

class · iOS 14.0+

CPNowPlayingButton

class · iOS 14.0+

CPNowPlayingImageButton

class · iOS 14.0+

CPNowPlayingMode

class · iOS 18.4+

CPNowPlayingModeSports

class · iOS 18.4+

CPNowPlayingMoreButton

class · iOS 14.0+

CPNowPlayingPlaybackRateButton

class · iOS 14.0+

CPNowPlayingRepeatButton

class · iOS 14.0+

CPNowPlayingShuffleButton

class · iOS 14.0+

CPNowPlayingSportsClock

class · iOS 18.4+

CPNowPlayingSportsEventStatus

class · iOS 18.4+

CPNowPlayingSportsTeam

class · iOS 18.4+

CPNowPlayingSportsTeamLogo

class · iOS 18.4+

CPNowPlayingTemplate

class · iOS 14.0+

CPNowPlayingTemplateObserver

protocol · iOS 14.0+

CPPanel

class · iOS 27.0+

CPPanelButtonConfiguration

class · iOS 27.0+

CPPanelItem

class · iOS 27.0+

CPPlayableItem

protocol · iOS 26.4+

CPPlaybackConfiguration

class · iOS 26.4+

CPPlaybackConfiguration.Action

enum · iOS 26.4+

CPPlaybackConfiguration.Presentation

enum · iOS 26.4+

CPPointOfInterest

class · iOS 14.0+

CPPointOfInterestTemplate

class · iOS 14.0+

CPPointOfInterestTemplateDelegate

protocol · iOS 14.0+

CPRerouteReason

enum · iOS 26.4+

CPRouteChoice

class · iOS 12.0+

CPRouteDetail

class · iOS 27.0+

CPRouteInformation

class · iOS 17.4+

CPRouteSegment

class · iOS 26.4+

CPRouteSource

enum · iOS 26.4+

CPSearchTemplate

class · iOS 12.0+

CPSearchTemplateDelegate

protocol · iOS 12.0+

CPSelectableListItem

protocol · iOS 14.0+

CPSessionConfiguration

class · iOS 12.0+

CPSessionConfigurationDelegate

protocol · iOS 12.0+

CPSportsOverlay

class · iOS 26.4+

CPTabBarTemplate

class · iOS 14.0+

CPTabBarTemplateDelegate

protocol · iOS 14.0+

CPTemplate

class · iOS 12.0+

CPTemplateApplicationDashboardScene

class · iOS 13.4+

CPTemplateApplicationDashboardSceneDelegate

protocol · iOS 13.4+

CPTemplateApplicationInstrumentClusterScene

class · iOS 15.4+

CPTemplateApplicationInstrumentClusterSceneDelegate

protocol · iOS 15.4+

CPTemplateApplicationScene

class · iOS 13.0+

CPTemplateApplicationSceneDelegate

protocol · iOS 13.0+

CPTextButton

class · iOS 14.0+

CPTextButtonStyle

enum · iOS 14.0+

CPThumbnailImage

class · iOS 26.4+

CPTimeRemainingColor

enum · iOS 12.0+

CPTrafficSide

enum · iOS 17.4+

CPTravelEstimates

class · iOS 12.0+

CPTrip

class · iOS 12.0+

CPTripEstimateStyle

enum · iOS 12.0+

CPTripPreviewTextConfiguration

class · iOS 12.0+

CPVoiceControlState

class · iOS 12.0+

CPVoiceControlTemplate

class · iOS 12.0+

CPWindow

class · iOS 12.0+

Functions and constants

get

CPButtonMaximumImageSize

TypeScript
const CPButtonMaximumImageSize: { width: number; height: number }
Swift declaration
let CPButtonMaximumImageSize: CGSize
get · iOS 15.0+

CPGridTemplateMaximumItems

TypeScript
const CPGridTemplateMaximumItems: number
Swift declaration
let CPGridTemplateMaximumItems: Int
get

CPMaximumListSectionImageSize

TypeScript
const CPMaximumListSectionImageSize: { width: number; height: number }
Swift declaration
let CPMaximumListSectionImageSize: CGSize
get

CPMaximumMessageItemImageSize

TypeScript
const CPMaximumMessageItemImageSize: { width: number; height: number }
Swift declaration
let CPMaximumMessageItemImageSize: CGSize
get

CPMaximumMessageItemLeadingDetailTextImageSize

TypeScript
const CPMaximumMessageItemLeadingDetailTextImageSize: { width: number; height: number }
Swift declaration
let CPMaximumMessageItemLeadingDetailTextImageSize: CGSize
get

CPMaximumNumberOfGridImages

TypeScript
const CPMaximumNumberOfGridImages: number
Swift declaration
let CPMaximumNumberOfGridImages: Int
get

CPNavigationAlertMinimumDuration

TypeScript
const CPNavigationAlertMinimumDuration: number
Swift declaration
var CPNavigationAlertMinimumDuration: TimeInterval { get }
get

CPNowPlayingButtonMaximumImageSize

TypeScript
const CPNowPlayingButtonMaximumImageSize: { width: number; height: number }
Swift declaration
let CPNowPlayingButtonMaximumImageSize: CGSize
get · iOS 13.4+

CPTemplateApplicationDashboardSceneSessionRoleApplication

TypeScript
get CPTemplateApplicationDashboardSceneSessionRoleApplication(): _UIKit_UISceneSession_Role
Swift declaration
static let CPTemplateApplicationDashboardSceneSessionRoleApplication: UISceneSession.Role
get · iOS 15.4+

CPTemplateApplicationInstrumentClusterSceneSessionRoleApplication

TypeScript
get CPTemplateApplicationInstrumentClusterSceneSessionRoleApplication(): _UIKit_UISceneSession_Role
Swift declaration
static let CPTemplateApplicationInstrumentClusterSceneSessionRoleApplication: UISceneSession.Role
get · iOS 13.0+

carTemplateApplication

TypeScript
get carTemplateApplication(): _UIKit_UISceneSession_Role
Swift declaration
static let carTemplateApplication: UISceneSession.Role
get

CarPlayErrorDomain

TypeScript
const CarPlayErrorDomain: string
Swift declaration
let CarPlayErrorDomain: String
function · iOS 17.4+

NSStringFromCPJunctionType

TypeScript
NSStringFromCPJunctionType(junctionType: CPJunctionType): (string) | null
Swift declaration
func NSStringFromCPJunctionType(_ junctionType: CPJunctionType) -> String!
function · iOS 17.4+

NSStringFromCPLaneStatus

TypeScript
NSStringFromCPLaneStatus(laneStatus: CPLaneStatus): (string) | null
Swift declaration
func NSStringFromCPLaneStatus(_ laneStatus: CPLaneStatus) -> String!
function · iOS 17.4+

NSStringFromCPManeuverType

TypeScript
NSStringFromCPManeuverType(maneuverType: CPManeuverType): (string) | null
Swift declaration
func NSStringFromCPManeuverType(_ maneuverType: CPManeuverType) -> String!
function · iOS 26.4+

NSStringFromCPRerouteReason

TypeScript
NSStringFromCPRerouteReason(reason: CPRerouteReason): (string) | null
Swift declaration
func NSStringFromCPRerouteReason(_ reason: CPRerouteReason) -> String!
function · iOS 17.4+

NSStringFromCPTrafficSide

TypeScript
NSStringFromCPTrafficSide(trafficSide: CPTrafficSide): (string) | null
Swift declaration
func NSStringFromCPTrafficSide(_ trafficSide: CPTrafficSide) -> String!

Skipped declarations

141 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CPListItem.handler

The iOS SDK compiler rejected this binding: converting non-escaping value to 'T' may allow it to escape

CPBarButton.init(type:handler:)

The iOS SDK compiler rejected this binding: cannot convert value of type 'CPBarButton.Type' to expected argument type 'CPBarButton.`Type`'

CPBarButton.Type.init(rawValue:)

The iOS SDK compiler rejected this binding: type 'CPBarButton.Type' has no member 'init'

CPListImageRowItem.handler

The iOS SDK compiler rejected this binding: converting non-escaping value to 'T' may allow it to escape

CPListImageRowItem.listImageRowHandler

The iOS SDK compiler rejected this binding: converting non-escaping value to 'T' may allow it to escape

CPInterfaceController.setRootTemplate(_:animated:)

The iOS SDK compiler rejected this binding: call can throw but is not marked with 'try'

CPInterfaceController.pushTemplate(_:animated:)

The iOS SDK compiler rejected this binding: call can throw but is not marked with 'try'

CPInterfaceController.popTemplate(animated:)

The iOS SDK compiler rejected this binding: call can throw but is not marked with 'try'

CPInterfaceController.popToRootTemplate(animated:)

The iOS SDK compiler rejected this binding: call can throw but is not marked with 'try'

CPInterfaceController.pop(to:animated:)

The iOS SDK compiler rejected this binding: call can throw but is not marked with 'try'

CPInterfaceController.presentTemplate(_:animated:)

The iOS SDK compiler rejected this binding: call can throw but is not marked with 'try'

CPInterfaceController.dismissTemplate(animated:)

The iOS SDK compiler rejected this binding: call can throw but is not marked with 'try'

CPSportsOverlay.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CPPanelButtonConfiguration.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CPChargingStationConnection.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CPListImageRowItemCondensedElement.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CPNowPlayingAddToLibraryButton.init()

inherited init: clang: 'init' is unavailable

CPNowPlayingButton.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CPNowPlayingImageButton.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CPNowPlayingMoreButton.init()

inherited init: clang: 'init' is unavailable

CPNowPlayingPlaybackRateButton.init()

inherited init: clang: 'init' is unavailable

CPNowPlayingRepeatButton.init()

inherited init: clang: 'init' is unavailable

CPNowPlayingShuffleButton.init()

inherited init: clang: 'init' is unavailable

CPVoiceControlState.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

CPVoiceControlTemplate.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

CPNavigationSession.init()

inherited init: clang: 'init' is unavailable

CPAlertAction.init()

inherited init: cannot prove legal (class declares 2 custom initializers)

CPInstrumentClusterController.init()

inherited init: clang: 'init' is unavailable

CPListItem.init()

inherited init: cannot prove legal (class declares 4 custom initializers)

CPInformationRatingItem.init()

inherited init: cannot prove legal (class declares 1 custom initializer)