Expand description
§Bindings to the CarPlay framework
See Apple’s docs and the general docs on framework crates for more information.
Structs§
- CPAction
Sheet Template CPActionSheetTemplateandCPTemplate CPActionSheetTemplaterepresents an action sheet that must be dismissed with a button press before the user may return to using the app.- CPAlert
Action CPAlertAction CPAlertActionrepresents a single action that appears inside of aCPActionSheetTemplateorCPAlertTemplate.The style of the parent template and the style of theCPAlertActionwill together determine the action’s appearance.- CPAlert
Action Style CPAlertAction - Apple’s documentation
- CPAlert
Template CPAlertTemplateandCPTemplate CPAlertTemplaterepresents a modal alert that must be dismissed with a button press before the user may return to using the app.- CPAssistant
Cell Action Type CPListTemplate - Apple’s documentation
- CPAssistant
Cell Configuration CPListTemplate CPAssistantCellConfigurationencapsulates the configuration options for your assistant cell.- CPAssistant
Cell Position CPListTemplate - Apple’s documentation
- CPAssistant
Cell Visibility CPListTemplate - Apple’s documentation
- CPBar
Button CPBarButton - A button for placement in a navigation bar.
- CPBar
Button Style CPBarButton - Specifies the style used to display a
CPBarButton. - CPBar
Button Type CPBarButton - Specifies the type of a
CPBarButton. - CPButton
CPButton - Apple’s documentation
- CPContact
CPContact - Apple’s documentation
- CPContact
Call Button CPButtonandCPContact - Apple’s documentation
- CPContact
Directions Button CPButtonandCPContact - Apple’s documentation
- CPContact
Message Button CPButtonandCPContact - Apple’s documentation
- CPContact
Template CPContactTemplateandCPTemplate - Apple’s documentation
- CPContent
Style CPSessionConfiguration - Apple’s documentation
- CPDashboard
Button CPDashboardButton - Apple’s documentation
- CPDashboard
Controller CPDashboardController - Apple’s documentation
- CPGrid
Button CPGridButton - Apple’s documentation
- CPGrid
Template CPGridTemplateandCPTemplate - Apple’s documentation
- CPImage
Set CPImageSet - Apple’s documentation
- CPInformation
Item CPInformationItem - Apple’s documentation
- CPInformation
Rating Item CPInformationItemandCPInformationRatingItem - Apple’s documentation
- CPInformation
Template CPInformationTemplateandCPTemplate - Apple’s documentation
- CPInformation
Template Layout CPInformationTemplate - Apple’s documentation
- CPInstrument
Cluster Controller CPInstrumentClusterController - Apple’s documentation
- CPInstrument
Cluster Setting CPInstrumentClusterController - Apple’s documentation
- CPInterface
Controller CPInterfaceController - Apple’s documentation
- CPJunction
Type CPManeuver - Apple’s documentation
- CPLane
CPLane CPLanerepresents information about a single lane.- CPLane
Guidance CPLaneGuidance CPLaneGuidancerepresents guidance to give the user which lane or lanes are preferred.- CPLane
Status CPLane - Apple’s documentation
- CPLimitable
User Interface CPSessionConfiguration - Apple’s documentation
- CPList
Image RowItem CPListImageRowItem - Apple’s documentation
- CPList
Image RowItem Card Element CPListImageRowItemCardElementandCPListImageRowItemElement - Apple’s documentation
- CPList
Image RowItem Condensed Element CPListImageRowItemCondensedElementandCPListImageRowItemElement - Apple’s documentation
- CPList
Image RowItem Condensed Element Shape CPListImageRowItemCondensedElement - Types of shape used to draw a condensed row element.
- CPList
Image RowItem Element CPListImageRowItemElement - Abstract superclass for a a row item element object.
- CPList
Image RowItem Grid Element CPListImageRowItemElementandCPListImageRowItemGridElement - Apple’s documentation
- CPList
Image RowItem Image Grid Element CPListImageRowItemElementandCPListImageRowItemImageGridElement - Apple’s documentation
- CPList
Image RowItem Image Grid Element Shape CPListImageRowItemImageGridElement - Types of shape used to draw a list item.
- CPList
Image RowItem RowElement CPListImageRowItemElementandCPListImageRowItemRowElement - Apple’s documentation
- CPList
Item CPListItem CPListItemdescribes a single object appearing in a list template. EachCPListItemis displayed as a single cell in the list.- CPList
Item Accessory Type CPListItem - Apple’s documentation
- CPList
Item Playing Indicator Location CPListItem - Apple’s documentation
- CPList
Section CPListSection CPListSectionmodels a single section of items appearing in aCPListTemplate.- CPList
Template CPListTemplateandCPTemplate - Apple’s documentation
- CPManeuver
CPManeuver CPManeuverdescribes a navigation instruction.- CPManeuver
Display Style CPMapTemplate - Apple’s documentation
- CPManeuver
State CPManeuver - Apple’s documentation
- CPManeuver
Type CPManeuver - Apple’s documentation
- CPMap
Button CPMapButton - Apple’s documentation
- CPMap
Template CPMapTemplateandCPTemplate - Apple’s documentation
- CPMessage
Compose BarButton CPBarButtonandCPMessageComposeBarButton - Apple’s documentation
- CPMessage
Grid Item Configuration CPGridButton CPMessageGridItemConfigurationencapsulates the message configuration options for the grid item.- CPMessage
Leading Item CPMessageListItem - Types of glyphs that may appear in the leading region of a message cell.
- CPMessage
List Item CPMessageListItem CPMessageListItemis a special variant of a list item for use in aCPListTemplate.UnlikeCPListItem,your application will not receive a callback when the user selects aCPMessageListItemin your list template. Instead, Siri will be invoked using the parameters you specify in your message item and the user will continue a message compose, read, or reply flow through Siri.- CPMessage
List Item Leading Configuration CPMessageListItem CPMessageListItemLeadingConfigurationencapsulates the configuration options for the leading side of your message list cell.- CPMessage
List Item Trailing Configuration CPMessageListItem CPMessageListItemTrailingConfigurationencapsulates the configuration options for the trailing side of your message list cell.- CPMessage
Trailing Item CPMessageListItem - Types of glyphs that may appear in the trailing region of a message cell.
- CPNavigation
Alert CPNavigationAlert CPNavigationAlertis a banner alert that can display map or navigation-related information to the user.- CPNavigation
Alert Dismissal Context CPNavigationAlert - Reasons why your navigation alert was dismissed.
- CPNavigation
Session CPNavigationSession CPNavigationSessionrepresents the active navigation session. ACPNavigationSessionwill be created for you when calling startNavigationSessionForTrip: onCYMapTemplate- CPNow
Playing AddTo Library Button CPNowPlayingButton - A now playing button that can be used to allow the user to add the current playing item to a collection, like their library.
- CPNow
Playing Button CPNowPlayingButton - Apple’s documentation
- CPNow
Playing Image Button CPNowPlayingButton - A now playing button that shows a custom image provided by your app for any other custom actions on the now playing screen.
- CPNow
Playing Mode CPNowPlayingMode - Apple’s documentation
- CPNow
Playing Mode Sports CPNowPlayingMode - The sports mode represents a layout for now playing suited to live-streaming or recorded playback of a sporting event that features exactly two teams.
- CPNow
Playing More Button CPNowPlayingButton - A now playing button that shows a callout-style action. For example,
your app could present a
CPActionSheetTemplateto show more actions when the user taps this button. - CPNow
Playing Playback Rate Button CPNowPlayingButton - A now playing button that shows the current playback rate and allows the user to cycle between different playback rates provided by your app.
- CPNow
Playing Repeat Button CPNowPlayingButton - A now playing button that shows the current repeat state, like “once” or “all”.
- CPNow
Playing Shuffle Button CPNowPlayingButton - A now playing button that indicates the current shuffle mode for your app.
- CPNow
Playing Sports Clock CPNowPlayingMode - A representation of the amount of time elapsed so far in this event, for events where the clock counts UP.
- CPNow
Playing Sports Event Status CPNowPlayingMode - A representation of the status of a sporting event.
- CPNow
Playing Sports Team CPNowPlayingMode - A representation of a sports team for the now playing screen, in sports that have exactly two teams.
- CPNow
Playing Sports Team Logo CPNowPlayingMode - A logo image or, if no image is available, an abbreviation or initialism for this team.
- CPNow
Playing Template CPNowPlayingTemplateandCPTemplate - Apple’s documentation
- CPPan
Direction CPMapTemplate - Apple’s documentation
- CPPoint
OfInterest CPPointOfInterest - Apple’s documentation
- CPPoint
OfInterest Template CPPointOfInterestTemplateandCPTemplate - Apple’s documentation
- CPRoute
Choice CPTrip CPRouteChoicedescribes a possible route for aCPTrip.- CPRoute
Information CPRouteInformation - CPRouteInformation describes information pertaining to a route that is necessary for rerouting.
- CPSearch
Template CPSearchTemplateandCPTemplate - Apple’s documentation
- CPSession
Configuration CPSessionConfiguration - Apple’s documentation
- CPTab
BarTemplate CPTabBarTemplateandCPTemplate - Apple’s documentation
- CPTemplate
CPTemplate - Abstract superclass for a template object.
- CPTemplate
Application Dashboard Scene CPTemplateApplicationDashboardSceneandobjc2-ui-kit - Apple’s documentation
- CPTemplate
Application Instrument Cluster Scene CPTemplateApplicationInstrumentClusterSceneandobjc2-ui-kit - Apple’s documentation
- CPTemplate
Application Scene CPTemplateApplicationSceneandobjc2-ui-kit - Apple’s documentation
- CPText
Button CPTextButton - Apple’s documentation
- CPText
Button Style CPTextButton - Apple’s documentation
- CPTime
Remaining Color CPMapTemplate - Apple’s documentation
- CPTraffic
Side CPManeuver - Apple’s documentation
- CPTravel
Estimates CPTravelEstimates CPTravelEstimatesdescribes the time and distance remaining for the active navigation session.- CPTrip
CPTrip CPTriprepresents an origin and destination with route choices.- CPTrip
Estimate Style CPMapTemplate - Apple’s documentation
- CPTrip
Pause Reason CPNavigationSession - Apple’s documentation
- CPTrip
Preview Text Configuration CPTripPreviewTextConfiguration - Apple’s documentation
- CPVoice
Control State CPVoiceControlTemplate CPVoiceControlStateencapsulates the title variants and image(s) for a single voice control state, like listening, loading, or recognized.- CPVoice
Control Template CPTemplateandCPVoiceControlTemplate - Apple’s documentation
- CPWindow
CPWindowandobjc2-ui-kit CPWindowis the main window for content presented on the car screen.
Statics§
- CPButton
Maximum ⚠Image Size CPButtonandobjc2-core-foundation - Apple’s documentation
- CPGrid
Template ⚠Maximum Items CPGridTemplate - Apple’s documentation
- CPMaximum
List ⚠Section Image Size CPListSectionandobjc2-core-foundation - The expected maximum size of an image size for your
CPListSection.To properly size your images, your app should size them to the display scale of the car screen. See -[CPInterfaceController carTraitCollection]. - CPMaximum
Message ⚠Item Image Size CPMessageListItemandobjc2-core-foundation - Maximum size of an image or accessory image in a
CPMessageListItem. - CPMaximum
Message ⚠Item Leading Detail Text Image Size CPMessageListItemandobjc2-core-foundation - Maximum size of an image for the detailed text leading image.
- CPMaximum
Number ⚠OfGrid Images CPListImageRowItem - The maximum number of images allowed in a
CPListImageRowItem.The system may display fewer than this number of images, depending on the available width of the car screen. - CPNavigation
Alert Minimum Duration CPNavigationAlert - Your
CPNavigationAlertmay specify a duration for which the alert will be visible onscreen, or 0 for an alert that is visible indefinitely. - CPNow
Playing ⚠Button Maximum Image Size CPNowPlayingButtonandobjc2-core-foundation - Apple’s documentation
- CPTemplate
Application ⚠Dashboard Scene Session Role Application CPTemplateApplicationDashboardSceneandobjc2-ui-kit - Apple’s documentation
- CPTemplate
Application ⚠Instrument Cluster Scene Session Role Application CPTemplateApplicationInstrumentClusterSceneandobjc2-ui-kit - Apple’s documentation
- CPTemplate
Application ⚠Scene Session Role Application CPTemplateApplicationSceneandobjc2-ui-kit - Apple’s documentation
- CarPlay
Error ⚠Domain CPInterfaceController - Apple’s documentation
Traits§
- CPApplication
Delegate Deprecated CPInterfaceControllerandobjc2-ui-kit - A set of methods that are called by the
UIApplicationsingleton in response to CarPlay lifecycle events. - CPBar
Button Providing CPBarButtonProviding - Apple’s documentation
- CPInstrument
Cluster Controller Delegate CPInstrumentClusterController - Apple’s documentation
- CPInterface
Controller Delegate CPInterfaceController - CPInterfaceControllerDelegate allows your app to observe template visibility lifecycles for the templates presented by your app.
- CPList
Template Delegate Deprecated CPListTemplate - Apple’s documentation
- CPList
Template Item CPListItemTypes CPListTemplateItemdescribes common properties of list items that can be displayed in aCPListTemplate.- CPMap
Template Delegate CPMapTemplate - Apple’s documentation
- CPNow
Playing Template Observer CPNowPlayingTemplate - Apple’s documentation
- CPPoint
OfInterest Template Delegate CPPointOfInterestTemplate - Apple’s documentation
- CPSearch
Template Delegate CPSearchTemplate - Apple’s documentation
- CPSelectable
List Item CPListItemTypes CPListSelectabledescribes list items that accept a list item handler, called when the user selects this list item.- CPSession
Configuration Delegate CPSessionConfiguration - Apple’s documentation
- CPTab
BarTemplate Delegate CPTabBarTemplate - Apple’s documentation
- CPTemplate
Application Dashboard Scene Delegate CPTemplateApplicationDashboardSceneandobjc2-ui-kit - Apple’s documentation
- CPTemplate
Application Instrument Cluster Scene Delegate CPTemplateApplicationInstrumentClusterSceneandobjc2-ui-kit - Apple’s documentation
- CPTemplate
Application Scene Delegate CPTemplateApplicationSceneandobjc2-ui-kit - Apple’s documentation
Type Aliases§
- CPAlert
Action Handler CPAlertActionandblock2 - Apple’s documentation
- CPBar
Button Handler CPBarButtonandblock2 - Apple’s documentation