blob: 8f05d4ff26e6e577a2b1a8b96d586b9714c23c80 [file] [log] [blame]
Robert Ly20555292014-06-13 23:28:19 -07001fullpage=true
2page.viewport_width=970
3no_footer_links=true
4excludeFromSuggestions=true
5page.metaDescription=Android Auto
6
7@jd:body
8
Ricardo Cervera5fa67542014-06-15 21:23:16 -07009<style>
10.jd-descr {
11 height:auto;
12}
13#copyright {
14 margin-top:-35px;
15}
Ricardo Cervera6d615302014-06-20 18:42:30 -070016.auto-img-container {
17 position:relative;
18}
19.auto-img-frame {
20 z-index:2;
21 position:relative;
22}
23.auto-img-shot {
24 position:absolute;
25 top:9px;
26 left:8px;
27 z-index:1;
28}
29.auto-img-container-cols {
30 position:relative;
31 margin-top:10px;
32}
33.auto-img-frame-cols {
Ricardo Cerverac5f20772014-06-23 13:11:30 -070034 width:380px;
Ricardo Cervera6d615302014-06-20 18:42:30 -070035 z-index:2;
36 position:relative;
37}
38.auto-img-shot-cols {
Ricardo Cerverac5f20772014-06-23 13:11:30 -070039 width:369px;
Ricardo Cervera6d615302014-06-20 18:42:30 -070040 position:absolute;
Ricardo Cerverac5f20772014-06-23 13:11:30 -070041 top:7px;
42 left:6px;
Ricardo Cervera6d615302014-06-20 18:42:30 -070043 z-index:1;
Ricardo Cervera6d615302014-06-20 18:42:30 -070044}
45.auto-col-2 {
46 width:380px;
47 display: inline;
48 float: left;
49 margin-left: 10px;
50 margin-right: 10px;
51}
52.auto-img-container-single {
53 width:380px;
54 margin:0 auto;
55 margin-top:20px;
56}
Ricardo Cervera5fa67542014-06-15 21:23:16 -070057</style>
58
Robert Ly20555292014-06-13 23:28:19 -070059<div style="width:780px; margin:0 auto;">
60
61<div id="qv-wrapper">
62<div id="qv">
63<h2>In this document</h2>
64<ol>
65 <li><a href="#design">Design</a>
66 <ol>
67 <li><a href="#designprinciples">Design Principles</a></li>
68 <li><a href="#uioverview">UI Overview</a></li>
69 </ol>
70 </li>
71 <li><a href="#architecture">Architecture</a></li>
72 <li><a href="#uitemplates">UI Templates</a>
73 <ol>
74 <li><a href="#launchapp">Launch App</a></li>
75 <li><a href="#useractions">User Actions</a></li>
76 <li><a href="#drawertransitions">Drawer Transitions</a></li>
77 <li><a href="#daynighttransitions">Day and Night Transitions</a></li>
78 <li><a href="#customizetemplates">Customizing Templates</a></li>
79 </ol>
80 </li>
81 <li><a href="#devprocess">Development Process</a></li>
82 <li><a href="#emulator">Testing Your App</a></li>
83 <li><a href="#running">Running Your App</a></li>
84</ol>
85</div>
86</div>
87
88<h1>Android Auto Developer Overview</h1>
89
Ricardo Cervera98375d02014-06-22 14:02:30 -070090<p>Android Auto extends the Android platform into the car. When users connect
91their Android handheld device to a compatible vehicle, Android Auto provides a car-optimized
92Android experience on the vehicle's screen. Users interact with compatible apps and services
93through voice actions and the vehicle's input controls.</p>
94
95<p>The Android Auto SDK lets you easily extend your existing apps to work in the car, without
96having to worry about vehicle-specific hardware differences. You can use many Android APIs and
97services you are already familiar with. Android Auto provides easy to use UI templates and
98supports notifications and voice actions:</p>
Robert Ly20555292014-06-13 23:28:19 -070099
100<dl>
101<dt style="margin-bottom:10px"><strong>UI Templates</strong></dt>
102<dd style="margin-bottom:20px">
Ricardo Cervera98375d02014-06-22 14:02:30 -0700103Android Auto defines interaction models and UI templates for apps. The
Robert Ly20555292014-06-13 23:28:19 -0700104first version of Android Auto supports media apps, such as music, podcast, live radio, and
Ricardo Cervera98375d02014-06-22 14:02:30 -0700105audio news apps.
Robert Ly20555292014-06-13 23:28:19 -0700106</dd>
107<dt style="margin-bottom:10px"><strong>Notifications</strong></dt>
108<dd style="margin-bottom:20px">
109The platform will integrate with existing Android APIs for notifications. Users will get
Ricardo Cervera98375d02014-06-22 14:02:30 -0700110car appropiate notifications from Android apps on the vehicle's screen.</dd>
Robert Ly20555292014-06-13 23:28:19 -0700111
112<dt style="margin-bottom:10px"><strong>Voice Actions</strong></dt>
113<dd style="margin-bottom:20px">
Ricardo Cervera98375d02014-06-22 14:02:30 -0700114Android Auto supports a set of voice actions to interact with compatible apps and services.
115Apps can respond to the voice actions they're interested in, such as playing a particular song
116or taking a note.</dd>
Robert Ly20555292014-06-13 23:28:19 -0700117
118<dt style="margin-bottom:10px"><strong>Easy Development Workflow</strong></dt>
119<dd style="margin-bottom:20px">
120To extend an existing Android app for Android Auto, you implement a set of interfaces and
121services defined in the platform. You can reuse existing functionality and many Android APIs
122you already know.</dd>
123</dl>
124
125<p>We’ll release the Android Auto SDK in the coming months, which will let you test your
126Android Auto experience on a regular Android device.</p>
127
128
Ricardo Cervera6d615302014-06-20 18:42:30 -0700129<h2 id="design">Design</h2>
Robert Ly20555292014-06-13 23:28:19 -0700130
Ricardo Cervera98375d02014-06-22 14:02:30 -0700131<p>Android Auto extends users' digital ecosystem into their cars, allowing drivers to stay
132connected to their virtual worlds while staying focused on the road ahead.</p>
Robert Ly20555292014-06-13 23:28:19 -0700133
Ricardo Cervera98375d02014-06-22 14:02:30 -0700134<p>Because driving is the primary activity in the car, any digital experiences should be designed
135to complement and augment that activity. They should never demand the user's attention.</p>
Robert Ly20555292014-06-13 23:28:19 -0700136
Ricardo Cervera98375d02014-06-22 14:02:30 -0700137<p>Designing for cars is fundamentally different than designing for phones or tablets, and
138requires rethinking how experiences unfold. Because attention is limited and not all tasks are
139possible in the car, effective apps leverage the entire set of devices that drivers have,
140leveraging the app experience on those devices, outside of the car, to set the stage for simple
141experiences while driving.</p>
142
143<p>Android Auto experiences are:</p>
144
145<p><strong>Glanceable and simple</strong>. Driving requires users' full attention. In-car software
146should not. Android Auto was designed to simplify not only the UI, but to optimize interactions
147and require less thinking, induce lower cognitive load, and ultimately, be safer. Effective apps
148provide just enough information in the minimum amount of time the user needs to glance at it and
149return their attention back to the road. Apps should also reduce the number of features to only
150those that are safe and drive-appropriate.</p>
Robert Ly20555292014-06-13 23:28:19 -0700151
152<p><strong>Predictive, yet predictable</strong>. Android Auto leverages rich, contextual awareness
Ricardo Cervera98375d02014-06-22 14:02:30 -0700153to keep the driver informed about important situations during the drive. Rich, timely help is
154combined with predictable functions. Effective apps make use of the patterns for common tasks and
155show timely information only when relevant.</p>
Robert Ly20555292014-06-13 23:28:19 -0700156
Ricardo Cervera98375d02014-06-22 14:02:30 -0700157<p><strong>Connected</strong>. By leveraging the user's personal ecosystem of apps and services,
158Android Auto promotes a continuous experience from phone to car to other devices. The user's
159music, destinations, and virtual ecosystem are always available to augment the drive. Experiences
160that leverage personal context and other devices are naturally part of Android Auto.</p>
Robert Ly20555292014-06-13 23:28:19 -0700161
Ricardo Cervera98375d02014-06-22 14:02:30 -0700162<p><strong>Naturally integrated</strong>. Android Auto blends the user's apps with the car,
163creating a truly integrated experience that leverages what is unique about each car. By using
164the screens, controls, and capabilities of the vehicle, Android Auto feels like an extension of
165the car.</p>
166
Robert Ly20555292014-06-13 23:28:19 -0700167
Robert Ly20555292014-06-13 23:28:19 -0700168
169
Ricardo Cervera6d615302014-06-20 18:42:30 -0700170<h2 id="architecture">Architecture</h2>
Robert Ly20555292014-06-13 23:28:19 -0700171
Ricardo Cervera98375d02014-06-22 14:02:30 -0700172<p>The Android Auto app shows your app's customized UI on the vehicle's screen. To communicate
Robert Ly20555292014-06-13 23:28:19 -0700173with the Android Auto app, your media app implements a set of media interfaces.</p>
174
175<div style="width:750px;margin:0 auto">
Ricardo Cervera98375d02014-06-22 14:02:30 -0700176<img src="{@docRoot}auto/images/figure01.png" alt="" />
Robert Ly20555292014-06-13 23:28:19 -0700177<p class="img-caption">
178  <strong>Figure 1</strong> - Architecture of Android Auto.
179</p>
180</div>
181
182<p>The architecture consists of the following components:</p>
183
184<p><strong>Media App</strong> - Runs a media service that exposes content through browsing and
185playback APIs. The service provides content to the Android Auto app. This is your Android app.</p>
186
187<p><strong>Android Auto App</strong> - Creates a templated UI and handles user interactions.
188This app uses a media client to request content from the media service running in the media
189app. The client requests data from the media service and monitors service states.</p>
190
191<p><strong>Vehicle Display</strong> - Shows app content and supports user interaction via
192on-screen soft buttons and other components, such as physical buttons or steering
193wheel controls.</p>
194
195<p>Android media apps must implement binders to these APIs:</p>
196
197<ul>
198<li><strong>Browsing</strong> - Enables a media client to browse a hierarchy of a user’s
199media collection, presented as a virtual file system with containers (similar to directories)
200and items (similar to files).</li>
201<li><strong>Playback</strong> - Enables a media client to control media playback and monitor
202playback state through callbacks.</li>
203</ul>
204
205
Ricardo Cervera6d615302014-06-20 18:42:30 -0700206<h2 id="uitemplates">UI Templates</h2>
Robert Ly20555292014-06-13 23:28:19 -0700207
208<p>The Android Auto app uses a templated UI to display content and user interaction
209opportunities. Android Auto provides you with a set of standard UI templates that follow
210international guidelines for minimizing driving distraction. You do not have to test your
211app's UI for for driver distraction, which is a lengthy and expensive process involving
212multiple legislations across the globe and different standards for each vehicle OEM.</p>
213
214<p>The UI templates define interfaces for browsing, searching, and listening to content from
215media apps. Although you cannot change the standard template format or layout, you can customize
216the template colors, action icons, background images, and more.</p>
217
Ricardo Cervera6d615302014-06-20 18:42:30 -0700218<h3 id="launchapp">Launch App Template</h3>
Robert Ly20555292014-06-13 23:28:19 -0700219
220<p>The Launcher template shows all the compatible media apps installed on the user’s
221Android device and lets users select one of them from an scrollable list:</p>
222
Ricardo Cervera6d615302014-06-20 18:42:30 -0700223<div class="auto-img-container-single">
224 <div class="auto-img-container">
225 <img class="auto-img-frame-cols" src="/auto/images/assets/00_frame.png" />
226 <img class="auto-img-shot-cols" src="/auto/images/assets/do_01_switcher.png" />
227 </div>
228 <p class="img-caption" style="margin-top:0px">
229  <strong>Figure 2.</strong> The Launcher template.
230 </p>
Robert Ly20555292014-06-13 23:28:19 -0700231</div>
232
Ricardo Cervera6d615302014-06-20 18:42:30 -0700233<h3>Primary App Template</h3>
Robert Ly20555292014-06-13 23:28:19 -0700234
Ricardo Cervera98375d02014-06-22 14:02:30 -0700235<p>After the user selects a media app, the display shows the primary app template.
236You can customize this template to show your own icons, app name, and
237background images. Figure 3 shows an example of a customized template:</p>
Robert Ly20555292014-06-13 23:28:19 -0700238
Ricardo Cervera6d615302014-06-20 18:42:30 -0700239<div class="cols">
240<div class="auto-col-2">
241 <div class="auto-img-container-cols">
242 <img class="auto-img-frame-cols" src="{@docRoot}auto/images/assets/00_frame.png" />
243 <img class="auto-img-shot-cols" src="{@docRoot}auto/images/assets/do_05_template.png" />
244 </div>
245</div>
246<div class="auto-col-2">
247 <div class="auto-img-container-cols">
248 <img class="auto-img-frame-cols" src="{@docRoot}auto/images/assets/00_frame.png" />
249 <img class="auto-img-shot-cols" src="{@docRoot}auto/images/assets/do_02_music.png" />
250 </div>
251</div>
252</div>
Robert Ly20555292014-06-13 23:28:19 -0700253<p class="img-caption">
Ricardo Cervera98375d02014-06-22 14:02:30 -0700254  <strong>Figure 3.</strong> A customized template.
Robert Ly20555292014-06-13 23:28:19 -0700255</p>
Robert Ly20555292014-06-13 23:28:19 -0700256
Ricardo Cervera6d615302014-06-20 18:42:30 -0700257
258
259<h3 id="useractions">User Actions</h3>
Robert Ly20555292014-06-13 23:28:19 -0700260
261<p>The primary app template supports four main actions on the action bar, four auxiliary actions
262on the overflow bar, and the <em>Return</em> action. You can use standard controls and customize
Ricardo Cervera98375d02014-06-22 14:02:30 -0700263the actions and icons, as shown in Figure 4.</p>
Robert Ly20555292014-06-13 23:28:19 -0700264
Ricardo Cervera6d615302014-06-20 18:42:30 -0700265<div class="auto-img-container-single">
266 <div class="auto-img-container">
267 <img class="auto-img-frame-cols" src="/auto/images/assets/00_frame.png" />
268 <img class="auto-img-shot-cols" src="/auto/images/assets/do_03_more.png" />
269 </div>
270 <p class="img-caption" style="margin-top:0px">
Ricardo Cervera98375d02014-06-22 14:02:30 -0700271  <strong>Figure 4.</strong> Custom extra actions.
Ricardo Cervera6d615302014-06-20 18:42:30 -0700272 </p>
Robert Ly20555292014-06-13 23:28:19 -0700273</div>
274
Ricardo Cervera6d615302014-06-20 18:42:30 -0700275<h3 id="drawertransitions">Drawer Transitions</h3>
Robert Ly20555292014-06-13 23:28:19 -0700276
Ricardo Cervera98375d02014-06-22 14:02:30 -0700277<p>For browse actions, the display shows the drawer transition and template, as shown in
278Figure 5.</p>
Robert Ly20555292014-06-13 23:28:19 -0700279
Ricardo Cervera6d615302014-06-20 18:42:30 -0700280<div class="cols">
281<div class="auto-col-2">
282 <div class="auto-img-container-cols">
283 <img class="auto-img-frame-cols" src="{@docRoot}auto/images/assets/00_frame.png" />
284 <img class="auto-img-shot-cols" src="{@docRoot}auto/images/assets/do_06_gdrawer.png" />
285 </div>
Robert Ly20555292014-06-13 23:28:19 -0700286</div>
Ricardo Cervera6d615302014-06-20 18:42:30 -0700287<div class="auto-col-2">
288 <div class="auto-img-container-cols">
289 <img class="auto-img-frame-cols" src="{@docRoot}auto/images/assets/00_frame.png" />
290 <img class="auto-img-shot-cols" src="{@docRoot}auto/images/assets/do_04_mdrawer.png" />
291 </div>
292</div>
293</div>
294<p class="img-caption">
Ricardo Cervera98375d02014-06-22 14:02:30 -0700295  <strong>Figure 5.</strong> Generic and customized drawer templates.
Ricardo Cervera6d615302014-06-20 18:42:30 -0700296</p>
Robert Ly20555292014-06-13 23:28:19 -0700297
Ricardo Cervera98375d02014-06-22 14:02:30 -0700298<p>After the transition from the primary app template to the drawer template, the drawer
299appears on the center. The customized drawer template shows the media containers and
300media files provided by the media service in your app. You can also customize drawers
301with icons for list items.</p>
302
303
Ricardo Cervera6d615302014-06-20 18:42:30 -0700304<h3 id="daynighttransitions">Day and Night Transitions</h3>
Robert Ly20555292014-06-13 23:28:19 -0700305
Ricardo Cervera98375d02014-06-22 14:02:30 -0700306<p>All the templates support different color schemes for day and night.
307The platform provides the state (day or night) and makes adjustments automatically.</p>
Robert Ly20555292014-06-13 23:28:19 -0700308
Ricardo Cervera245528732014-06-23 17:04:53 -0700309<div class="cols">
310<div class="auto-col-2">
311 <div class="auto-img-container-cols">
312 <img class="auto-img-frame-cols" src="{@docRoot}auto/images/assets/00_frame.png" />
313 <img class="auto-img-shot-cols" src="{@docRoot}auto/images/assets/do_02_music.png" />
314 </div>
315</div>
316<div class="auto-col-2">
317 <div class="auto-img-container-cols">
318 <img class="auto-img-frame-cols" src="{@docRoot}auto/images/assets/00_frame.png" />
319 <img class="auto-img-shot-cols" src="{@docRoot}auto/images/assets/do_02_music_night.png" />
320 </div>
321</div>
322</div>
323<p class="img-caption">
324  <strong>Figure 6.</strong> Day and night modes.
325</p>
326
Ricardo Cervera6d615302014-06-20 18:42:30 -0700327<h3 id="customizetemplates">Customizing Templates</h3>
Robert Ly20555292014-06-13 23:28:19 -0700328
329<p>To customize the templates, provide the following app-specific resources and actions
330to the Android Auto media client.</p>
331
332<ul>
333<li><strong>Resources</strong> - App logo, app name, theme colors, and background images.</li>
334<li><strong>Actions</strong> - Multiple custom actions; for example: <em>Thumbs Up/Down</em>,
335<em>Favorite</em>, and <em>Bookmark</em>. These actions are app-specific.</li>
336</ul>
337
338<p>If provided, the media client automatically uses them in the templated UI.</p>
339
340
Ricardo Cervera6d615302014-06-20 18:42:30 -0700341<h2 id="devprocess">Development Process</h2>
Robert Ly20555292014-06-13 23:28:19 -0700342
343<p class="note"><strong>Note:</strong> When released, the Android Auto SDK will provide
344media service interfaces, an APK for handheld devices that simulates the Android Auto
345app, and other tools for Android Auto development.</p>
346
347<p>To create a media app for Android Auto, you include an Android service in your app
348that implements the media service interfaces provided by the Android Auto SDK. These
349interfaces define functionality for browsing and finding content, playing media,
350customizing the UI template, and performing app-specific actions.</p>
351
352<p>The media service interfaces present the content library as a navigable tree and enable
353clients to play media, get album art, obtain theme resources for the UI template, and
354invoke app-specific actions.</p>
355
356<p>You don’t have to create a new app for Android Auto: you can extend your existing
357Android app with implementations of the media service interfaces. Your service exposes
358your app’s media content, theme resources, and app-specific actions using the methods and
359data types specified by the media service interfaces. This simplifies the development
360cycle because:</p>
361
362<ul>
363<li>You do not have to maintain a separate project for Android Auto</li>
364<li>You can reuse existing functionality from your Android app</li>
365</ul>
366
367<p>The Android Auto client presents the customized UI to users and invokes the
368functionality from your service as needed. This has two additional advantages:</p>
369
370<ul>
371<li>Your app does not implement a UI for Android Auto</li>
372<li>Your app does not manage user interactions directly</li>
373</ul>
374
375<p>This also means that you do not have to worry about vehicle-specific hardware
376differences such as screen resolutions, software interfaces, knobs and touch
377controls.</p>
378
379
Ricardo Cervera6d615302014-06-20 18:42:30 -0700380<h2 id="emulator">Testing Your App on an Android Device</h2>
Robert Ly20555292014-06-13 23:28:19 -0700381
382<p>The Android Auto SDK includes an APK with a media client implementation, which is
383similar to those available in compatible vehicles. To test your app with this
384client:</p>
385
386<ol>
387<li>Get an Android device with a similar form factor to a dashboard screen (like a
388Nexus 7).</li>
389<li>Configure the device for Android development.</li>
390<li>Install the APK for the media client from the Android Auto SDK on the device.</li>
391<li>Install the APK for your app on the device.</li>
392<li>Open the media client app from the Android Auto SDK on the device.</li>
393<li>Select your app from the list of available services.</li>
394</ol>
395
396<p>The customized UI for your app appears on the client. You can navigate the content
397library and play media. If your app provides app-specific actions, these actions appear
398in the UI controls.</p>
399
400
Ricardo Cervera6d615302014-06-20 18:42:30 -0700401<h2 id="running">Running Your App on Android Auto</h2>
Robert Ly20555292014-06-13 23:28:19 -0700402
403<p>Media apps are available on the Google Play Store for compatible Android devices.
404When users connect their Android device to a compatible vehicle, the
405Android Auto media client shows a list of all the Android apps installed on the phone
406that implement the media service interfaces.</p>
407
408<p>When users select one of these apps, the Android Auto media client uses the app’s
409service to respond to user input and invoke the methods in the media service interfaces
410to build the UI, navigate the content library, and play media.</p>
411
412<div style="margin-bottom:40px"> </div>
413</div>