Go to file
Caleigh Minshall b1ef879eb0 Version 1.18.0 alexa-client-sdk
Changes in this update:

**Enhancements**

* Added support for [Bluetooth Interface 2.0](https://developer.amazon.com/docs/alexa/alexa-voice-service/bluetooth.html). This interface adds support for multiple simultaneous connections to Bluetooth peripherals.
* Added support for [Audio Focus Manager Library (AFML) Multi Activity](https://developer.amazon.com/docs/alexa/avs-device-sdk/sdk-interaction-model.html). This interface enhances the behavior of a device so it can handle more than one Activity per Channel.
* Added the `obfuscatePrivateData` logging method to help remove certain data from logs.
* Updated `MediaPlayerObserverInterface` to include metadata about playback states.
* Added SDK extension point. You can integrate CMake projects into the SDK without cloning those projects into a subdirectory.

**Bug fixes**

* Fixed Mac/OSX issue that caused an unresponsive Sample App when not connected to the internet.
* Fixed issue that prevented sample app from exiting various states.
* Fixed `UIManager` issue that caused an error in the logs when the device with built without the wake word enabled.
* Fixed volume issue that caused timers to ascend in volume when setting up ascending alarms.
* Fixed alert volume issue that caused any changes to the alert volume to notify observers.
* Fixed EQ issue where changes to the EQ band levels didn't notify observers.
* Fixed Bluetooth bug that caused short notification sounds from a connected phone to stop audio playback on the device.

**Known Issues**

* Build errors can occur on the Raspberry Pi due to incorrect linking of the atomic library. A suggested workaround is to add the following `set(CMAKE_CXX_LINK_FLAGS "${CMAKE_CXX_LINK_FLAGS} -latomic")` to the top most CMake file.
* The WebVTT dependency required for `captions` isn't supported for Windows/Android.
* Exiting from the setting option takes you back to the Options Menu directly. It doesn't provide a message to indicate that you're back in the main menu.
* Failing Unit Tests and AIP Unit tests are disabled on Windows
* `AudioInputProcessor` unit tests don't build on Windows when with the `-DCMAKE_BUILD_TYPE=DEBUG` cmake parameter.
* Music playback history isn't displayed in the Alexa app for certain account and device types.
* When using Gnu Compiler Collection 8+ (GCC 8+), `-Wclass-memaccess` triggers warnings. You can ignore these, they don't cause the build to fail.
* Android error `libDefaultClient.so not found` might occur. Resolve this by upgrading to ADB version 1.0.40.
* If a device loses a network connection, the lost connection status isn't returned though local TTS.
* ACL encounters issues if it receives audio attachments but doesn't consume them.
* Media streamed through Bluetooth might abruptly stop. To restart playback, resume the media in the source application or toggle next/previous.
* If a connected Bluetooth device is inactive, the Alexa app might indicates that audio is playing.
* The Bluetooth agent assumes that the Bluetooth adapter is always connected to a power source. Disconnecting from a power source during operation isn't yet supported.
* When using some products, interrupted Bluetooth playback might not resume if other content is locally streamed.
* `make integration` isn't available for Android. To run Android integration tests, manually upload the test binary and input file and run ADB.
* Alexa might truncate the beginning of speech when responding to text-to-speech (TTS)  user events. This only impacts Raspberry Pi devices running Android Things with HDMI output audio.
* A reminder TTS message doesn't play if the sample app restarts and loses a network connection. Instead, the default alarm tone plays twice.
* `ServerDisconnectIntegratonTest` tests are disabled until they are updated to reflect new service behavior.
* The `DirectiveSequencerTest.test_handleBlockingThenImmediatelyThenNonBockingOnSameDialogId` test fails intermittently.
2020-02-19 10:48:07 -08:00
ACL Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
ADSL Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
AFML Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
AVSCommon Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
AVSGatewayManager Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
ApplicationUtilities Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
BluetoothImplementations Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
CapabilitiesDelegate Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
CapabilityAgents Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
Captions Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
CertifiedSender Version 1.17.0 alexa-client-sdk 2019-12-10 13:02:09 -08:00
ContextManager Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
Endpoints Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
EqualizerImplementations Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
Integration Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
InterruptModel Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
KWD Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
MediaPlayer Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
Metrics Version 1.17.0 alexa-client-sdk 2019-12-10 13:02:09 -08:00
PlaylistParser Version 1.17.0 alexa-client-sdk 2019-12-10 13:02:09 -08:00
RegistrationManager Version 1.15 alexa-client-sdk 2019-09-25 11:49:09 -07:00
SampleApp Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
Settings Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
SpeechEncoder Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
Storage Version 1.16 alexa-client-sdk 2019-10-25 13:19:44 -07:00
SynchronizeStateSender Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
ThirdParty Version 1.11 alexa-client-sdk 2018-12-19 11:13:36 -08:00
build Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
doc v1.3.0 released 12/08/2017: 2017-12-08 16:07:37 -08:00
tools Version 1.17.0 alexa-client-sdk 2019-12-10 13:02:09 -08:00
.clang-format Version 1.2.0 alexa-client-sdk 2017-10-31 07:36:26 -07:00
.gitignore Version 1.2.0 alexa-client-sdk 2017-10-31 07:36:26 -07:00
CHANGELOG.md Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
CMakeLists.txt Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
CONTRIBUTING.md CONTRIBUTING.md added to the repository with information on reporting bugs and seeking help from the AVS developer community. 2017-10-19 14:32:58 -07:00
LICENSE.txt Version 0.1 - Alexa Communications Library - This component serves as the main communications channel between the client and Alexa Voice Service, providing an interface with which to send and receive messages. 2017-02-10 15:39:10 -08:00
NOTICE.txt Version 1.18.0 alexa-client-sdk 2020-02-19 10:48:07 -08:00
README.md Update README.md 2019-12-11 12:42:08 -08:00
issue_template.md Version 1.4.0 alexa-client-sdk 2018-01-12 15:45:42 -08:00
pkg-config.pc.cmake Version 1.0.1 alexa-client-sdk 2017-08-16 17:13:40 -07:00

README.md

What is the Alexa Voice Service (AVS)?

The Alexa Voice Service (AVS) enables developers to integrate Alexa directly into their products, bringing the convenience of voice control to any connected device. AVS provides developers with access to a suite of resources to build Alexa-enabled products, including APIs, hardware development kits, software development kits, and documentation.

Learn more »

What is the AVS Device SDK

The Alexa Voice Service (AVS) Device SDK provides you with a set of C ++ libraries to build an Alexa Built-in product, meaning your device has direct access to cloud-based Alexa capabilities to receive voice responses instantly. Your device can be almost anything a smartwatch, a speaker, headphones the choice is yours.

Learn more »

Release Notes and Known Issues

Feature enhancements, updates, and resolved issues from all releases are available on the Amazon developer portal.

Get Started

You can set up the SDK on the following platforms:

SDK Architecture

The SDK is modular and abstract. It provides separate components to handle necessary Alexa functionality including processing audio, maintaining persistent connections, and managing Alexa interactions. Each component exposes Alexa APIs to customize your device integrations as needed. The SDK also includes a Sample App, so you can test interactions before integration.

Learn more »

API References

View the C++ API References for detailed information about implementation.

Security Best Practices and Important Considerations

All Alexa products should adopt the Security Best Practices for Alexa.

When building Alexa with the SDK, you should also adhere to the following security principles.