diff options
author | Clay Murphy <claym@google.com> | 2014-11-02 10:42:48 -0800 |
---|---|---|
committer | Clay Murphy <claym@google.com> | 2014-11-02 10:42:48 -0800 |
commit | 2845de394cec7efbb6f9fcc021914b0b8c92add3 (patch) | |
tree | 19e2bb6f182b5c6d267e827c7983c8b1b8cf80f0 | |
parent | f9d451e8a2c6391bab1e09d6d0c88e2b63be5043 (diff) | |
download | source.android.com-2845de394cec7efbb6f9fcc021914b0b8c92add3.tar.gz |
Docs: Refactoring accessories docs for L.
Bug: 18192817
Change-Id: If6176e745f260a49255d4225132cc3d9ca5556a7
-rw-r--r-- | src/accessories/accessories_toc.cs | 34 | ||||
-rw-r--r-- | src/accessories/audio.jd | 62 | ||||
-rw-r--r-- | src/accessories/custom.jd | 36 | ||||
-rw-r--r-- | src/accessories/index.jd | 25 |
4 files changed, 100 insertions, 57 deletions
diff --git a/src/accessories/accessories_toc.cs b/src/accessories/accessories_toc.cs index 95748f24..654ff7b9 100644 --- a/src/accessories/accessories_toc.cs +++ b/src/accessories/accessories_toc.cs @@ -1,5 +1,5 @@ <!-- - Copyright 2013 The Android Open Source Project + Copyright 2014 The Android Open Source Project Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -17,7 +17,7 @@ <ul id="nav"> <!-- Accessories --> <li class="nav-section"> - <div class="nav-section-header"> +<div class="nav-section-header"> <a href="<?cs var:toroot ?>accessories/index.html"> <span class="en">Overview</span> </a> @@ -25,26 +25,32 @@ <ul> <li class="nav-section"> <div class="nav-section-header"> - <a href="<?cs var:toroot ?>accessories/protocol.html"> - <span class="en">Open Accessory Protocol</span> + <a href="<?cs var:toroot ?>accessories/audio.html"> + <span class="en">Audio Accessories</span> </a> </div> <ul> - <li><a href="<?cs var:toroot ?>accessories/aoa2.html">Version 2.0</a></li> - <li><a href="<?cs var:toroot ?>accessories/aoa.html">Version 1.0</a></li> + <li><a href="<?cs var:toroot ?>accessories/headset-spec.html">Headset specification</a></li> </ul> - </li> + </li> + <li class="nav-section"> +<div class="nav-section-header"> + <a href="<?cs var:toroot ?>accessories/custom.html"> + <span class="en">Custom Accessories</span> + </a> + </div> + <ul> <li class="nav-section"> - <div class="nav-section-header"> - <a href="<?cs var:toroot ?>accessories/audio.html"> - <span class="en">Audio Accessories</span> - </a> + <div class="nav-section-header"><a href="<?cs var:toroot ?>accessories/protocol.html"><span class="en">Open Accessory Protocol</span> + </a> </div> <ul> - <li><a href="<?cs var:toroot ?>accessories/headset-spec.html">Headset specification</a></li> + <li><a href="<?cs var:toroot ?>accessories/aoa2.html">Version 2.0</a></li> + <li><a href="<?cs var:toroot ?>accessories/aoa.html">Version 1.0</a></li> </ul> - </li> - <li><a href="<?cs var:toroot ?>accessories/custom.html">Custom Accessories</a></li> + </li> + </ul> + </li> </li> <!-- End Accessories --> </ul> diff --git a/src/accessories/audio.jd b/src/accessories/audio.jd index 240f4ea9..16747104 100644 --- a/src/accessories/audio.jd +++ b/src/accessories/audio.jd @@ -2,7 +2,7 @@ page.title=Building Audio Accessories @jd:body <!-- - Copyright 2013 The Android Open Source Project + Copyright 2014 The Android Open Source Project Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -16,33 +16,40 @@ page.title=Building Audio Accessories See the License for the specific language governing permissions and limitations under the License. --> -<p>In building an audio accessory, such as an audio dock or other playback device, you should -consider how your accessory will connect with Android devices. In particular, you should decide -if your accessory will use Universal Serial Bus (USB) or a Bluetooth connection to stream music or -other audio content.</p> +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol id="auto-toc"> + </ol> + </div> +</div> + +<p>In implementing an audio accessory, such as a headset, headphone amplifier, +microphone, DAC/ADC, or dock, you should consider how your accessory will +connect with Android devices. In particular, you should decide +if your accessory will use wired a 3.5 mm headset connector, Universal Serial +Bus (USB), or a Bluetooth connection to stream music or other audio content.</p> +<h2 id="audio-over-35mm">Audio over 3.5 mm headset connector</h2> +<p>Many Android-based devices include a 3.5 mm (“mini”) headset connector. In +addition to the traditional stereo output and mono input features, the <a +href="headset-spec.html">Wired audio headset specification</a> defines standard +impedances and functions so a range of Android devices and headsets can inter-operate.</p> + <h2 id="audio-over-usb">Audio over USB</h2> -<p>An accessory that connects with Android over USB connection must use the Android Open -Accessory (AOA) protocol version 2.0. This version of the AOA protocol is supported on Android 4.1 -(API Level 16) and higher. Once an Android device connects to an accessory that supports this -protocol, the Android system treats it as a standard audio output device and routes all audio to -that accessory. No secondary software application is required on the Android device.</p> -<p><strong>Note:</strong> Due to the low power output of Android devices, the Android Open Accessory -Protocol requires that accessories act as a USB host, which means that the connecting accessory -must power the bus.</p> -<h3 id="next-steps">Next steps</h3> -<p>To get started on building an audio accessory that uses a USB connection:</p> -<ul> -<li>Select a hardware platform or build a hardware device that can support USB host mode.</li> -<li>Review the <a href="{@docRoot}accessories/aoa2.html">AOA 2.0 protocol</a> specification to understand - how to implement this protocol on your accessory hardware.</li> -<li>Review the ADK 2012 <a href="http://developer.android.com/tools/adk/adk2.html#src-download">firmware source code</a> - (<code><adk-src>/adk2012/board/library/ADK2/</code>), which includes an example implementation - of an audio playback accessory using a USB connection.</li> -</ul> -<p><strong>Note:</strong> The AOA 2.0 protocol also supports the -<a href="{@docRoot}accessories/aoa2.html#hid-support">human interface device</a> (HID) protocol through a USB -connection, enabling accessories such as audio docks to provide hardware play back controls such -as pause, fast-forward or volume buttons.</p> +<p>Android can use USB in several modes:</p> + <ul> + <li>debug + <li>accessory + <li>host + </ul> +<p>In the traditional debug mode, there is no audio capability.</p> +<p>Accessory mode is provided by the Open Accessory (AOA) protocol version 2.0. +There is limited audio capability in accessory mode, as described in <a +href="custom.html#audio-over-usb">Connecting custom audio over USB</a>.</p> +<p>Host mode enables the Android device to drive the USB bus and operate with a +wide range of USB-based peripherals, including audio interfaces. Host mode +audio is described in <a href="{@docRoot}devices/audio_usb.html">USB Digital Audio</a> + <h2 id="audio-over-bluetooth">Audio over Bluetooth</h2> <p>An accessory that connects with Android over Bluetooth can use an Advanced Audio Distribution Profile (A2DP) connection stream music for playback. Playing audio over a Bluetooth with A2DP is @@ -67,4 +74,3 @@ class.</p> <p><strong>Note:</strong> The ADK 2012 source code includes an open source Bluetooth stack that is built for the Texas Instruments CC2564 chip, but can work with any Bluetooth chip that implements a standard Host/Controller Interface (HCI).</p> - diff --git a/src/accessories/custom.jd b/src/accessories/custom.jd index 3f84d50b..560f182a 100644 --- a/src/accessories/custom.jd +++ b/src/accessories/custom.jd @@ -1,8 +1,8 @@ -page.title=Building Custom Accessories +page.title=Custom Accessories @jd:body <!-- - Copyright 2013 The Android Open Source Project + Copyright 2014 The Android Open Source Project Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -16,6 +16,14 @@ page.title=Building Custom Accessories See the License for the specific language governing permissions and limitations under the License. --> +<div id="qv-wrapper"> + <div id="qv"> + <h2>In this document</h2> + <ol id="auto-toc"> + </ol> + </div> +</div> + <p>An accessory for Android can be anything: keyboard, thermometer, robot, lighting control or anything else you can imagine. Accessories for Android all have one thing in common; they all connect to an Android device in some way. When starting out to build an accessory, you should @@ -77,3 +85,27 @@ communication, such as data input or control outputs, to interface with your acc <p><strong>Note:</strong> The ADK 2012 source code includes an open source Bluetooth stack which is built for the Texas Instruments CC2564 chip, but can work with any Bluetooth chip that supports a standard Host/Controller Interface (HCI).</p> + +<h2 id="audio-over-usb">Connecting audio over USB</h2> +<p>An accessory that connects with Android over USB connection may use the Android Open +Accessory (AOA) protocol version 2.0. This version of the AOA protocol is supported on Android 4.1 +(API Level 16) and higher. Once an Android device connects to an accessory that supports this +protocol, the Android system treats it as a standard audio output device and routes all audio to +that accessory. No secondary software application is required on the Android device.</p> +<p><strong>Note:</strong> Due to the low power output of Android devices, the Android Open Accessory +Protocol requires that accessories act as a USB host, which means that the connecting accessory +must power the bus.</p> +<h3 id="next-steps">Next steps</h3> +<p>To get started on building an audio accessory that uses a USB connection:</p> +<ul> +<li>Select a hardware platform or build a hardware device that can support USB host mode.</li> +<li>Review the <a href="{@docRoot}accessories/aoa2.html">AOA 2.0 protocol</a> specification to understand + how to implement this protocol on your accessory hardware.</li> +<li>Review the ADK 2012 <a href="http://developer.android.com/tools/adk/adk2.html#src-download">firmware source code</a> + (<code><adk-src>/adk2012/board/library/ADK2/</code>), which includes an example implementation + of an audio playback accessory using a USB connection.</li> +</ul> +<p><strong>Note:</strong> The AOA 2.0 protocol also supports the +<a href="{@docRoot}accessories/aoa2.html#hid-support">human interface device</a> (HID) protocol through a USB +connection, enabling accessories such as audio docks to provide hardware play back controls such +as pause, fast-forward or volume buttons.</p> diff --git a/src/accessories/index.jd b/src/accessories/index.jd index adf3f5cd..1157d5df 100644 --- a/src/accessories/index.jd +++ b/src/accessories/index.jd @@ -1,8 +1,8 @@ -page.title=Build Accessories for Android +page.title=Accessories for Android @jd:body <!-- - Copyright 2013 The Android Open Source Project + Copyright 2014 The Android Open Source Project Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -16,28 +16,27 @@ page.title=Build Accessories for Android See the License for the specific language governing permissions and limitations under the License. --> -<p>Build compelling USB and Bluetooth Accessories to extend - the capabilities of your user's Android-powered devices. Android defines an standard - protocol that you can implement in your accessories and have it compatible with - a wide range of Android-powered devices. +<p>Implement compelling accessories to extend the capabilities of your users' +Android-powered devices. Android relies on a suite of standard protocols you +can implement in your accessories to be compatible with a wide range of +Android-powered devices. </p> <div class="layout-content-row"> <div class="layout-content-col span-6"> <h4 id="audio-accessories">Audio Accessories</h4> - <p>Android 4.1 and higher has support for audio output over a USB connection or Bluetooth. Find out - how to build audio docks and other plug-in audio output hardware for Android.</p> - <p><a href="{@docRoot}accessories/audio.html">» Build Audio Accessories</a></p> + <p>Android supports local on-device audio and remote off-device audio + over a wired 3.5 mm headset jack, USB connection, or Bluetooth.</p> + <p><a href="{@docRoot}accessories/audio.html">» Audio Accessories</a></p> </div> <div class="layout-content-col span-6"> <h4 id="custom-accessories">Custom Accessories</h4> <p>What do you want to connect to your Android device? Alarm clock? Keyboard? Thermostat? Robot? - Learn how to connect existing equipment or your own unique hardware to Android.</p> - <p><a href="{@docRoot}accessories/custom.html">» Build Custom Accessories</a></p> + Learn how to connect existing equipment or your own unique hardware to + Android using the Android Open Accessory Protocol.</p> + <p><a href="{@docRoot}accessories/custom.html">» Custom Accessories</a></p> </div> </div> - - |