avs-device-sdk/README.md

43 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

### 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 »](https://developer.amazon.com/alexa-voice-service)
### 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 »](https://developer.amazon.com/docs/alexa/avs-device-sdk/overview.html)
### Release Notes and Known Issues
Feature enhancements, updates, and resolved issues from all releases are available on the [Amazon developer portal](https://developer.amazon.com/docs/alexa/avs-device-sdk/release-notes.html).
### Get Started
You can set up the SDK on the following platforms:
* [Ubuntu Linux](https://developer.amazon.com/docs/alexa/avs-device-sdk/ubuntu.html)
* [Raspberry Pi](https://developer.amazon.com/docs/alexa/avs-device-sdk/raspberry-pi.html)
* [macOS](https://developer.amazon.com/docs/alexa/avs-device-sdk/mac-os.html)
* [Windows 64-bit](https://developer.amazon.com/docs/alexa/avs-device-sdk/windows-64.html)
* [Generic Linux](https://developer.amazon.com/docs/alexa/avs-device-sdk/linux.html)
* [Android](https://developer.amazon.com/docs/alexa/avs-device-sdk/android.html)
### SDK Architecture
The SDK is modular and abstract. It provides [separate components](https://developer.amazon.com/docs/alexa/avs-device-sdk/overview.html#sdk-architecture) to handle necessary Alexa functionality including processing audio, maintaining persistent connections, and managing Alexa interactions. Each component exposes [Alexa APIs](https://developer.amazon.com/docs/alexa/alexa-voice-service/api-overview.html) to customize your device integrations as needed. The SDK also includes a Sample App, so you can test interactions before integration.
[Learn more »](https://developer.amazon.com/docs/alexa/avs-device-sdk/overview.html#sdk-architecture)
### API References
View the [C++ API References](https://alexa.github.io/avs-device-sdk/) for detailed information about implementation.
### Security Best Practices and Important Considerations
All Alexa products should adopt the [Security Best Practices for Alexa](https://developer.amazon.com/docs/alexa/alexa-voice-service/security-best-practices.html).
When building Alexa with the SDK, you should also adhere to the [following security principles](https://developer.amazon.com/docs/alexa/avs-device-sdk/overview.html#security-best-practices).