 |
AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
|
AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Classes | |
| class | PreviewAlexaClient |
Functions | |
| static constexpr const char * | SAMPLE_APP_CONFIG_KEY ("sampleApp") |
| Key for the root node value containing configuration values for SampleApp. More... | |
| PreviewAlexaClientComponent | getComponent (std::unique_ptr< avsCommon::avs::initialization::InitializationParameters > initParams, const std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > &diagnostics, const std::shared_ptr< sampleApp::PlatformSpecificValues > &platformSpecificValues, const std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface > &expectSpeechTimeoutHandler, const std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > &powerResourceManager) |
| static const std::string | FIRMWARE_VERSION_KEY ("firmwareVersion") |
Key for the firmwareVersion value under the SAMPLE_APP_CONFIG_KEY configuration node. More... | |
| static const std::string | ENDPOINT_KEY ("endpoint") |
Key for the endpoint value under the SAMPLE_APP_CONFIG_KEY configuration node. More... | |
| static const std::string | DISPLAY_CARD_KEY ("displayCardsSupported") |
Key for setting if display cards are supported or not under the SAMPLE_APP_CONFIG_KEY configuration node. More... | |
| static const std::string | TAG ("PreviewAlexaClient") |
| String to identify log entries originating from this file. More... | |
| static alexaClientSDK::avsCommon::utils::logger::Level | getLogLevelFromUserInput (std::string userInputLogLevel) |
| static bool | ignoreSigpipeSignals () |
| static std::shared_ptr< UIManagerInterface > | createUIManagerInterface (const std::shared_ptr< sampleApp::UIManager > &uiManager) |
| static std::function< std::shared_ptr< EventTracerInterface >)> | getCreateEventTracker (const std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > &diagnostics) |
| static Annotated< AVSConnectionManagerInterface, LibcurlSetCurlOptionsCallbackFactoryInterface > | createSetCurlOptionsCallbackForAVSConnectionManager () |
| static Annotated< HTTPContentFetcherInterfaceFactoryInterface, LibcurlSetCurlOptionsCallbackFactoryInterface > | createSetCurlOptionsCallbackForHTTPContentFetcherInterfaceFactory () |
Variables | |
| static const std::set< alexaClientSDK::avsCommon::utils::logger::Level > | allLevels |
| A set of all log levels. More... | |
| using alexaClientSDK::acsdkPreviewAlexaClient::ApplicationMediaInterfaces = typedef alexaClientSDK::avsCommon::sdkInterfaces::ApplicationMediaInterfaces |
| using alexaClientSDK::acsdkPreviewAlexaClient::DefaultEndpointAnnotation = typedef avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation |
| using alexaClientSDK::acsdkPreviewAlexaClient::MediaPlayerInterface = typedef alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface |
Definition of a Manufactory Component for PreviewAlexaClient.
This Manufactory will change significantly over the next several releases while manufactory integration is incrementally completed in the SDK. In the meantime, applications should not expect this definition to remain stable.
The PreviewAlexaClientManufactory will change significantly while manufactory integration is completed over the next several releases. Applications should not expect this template to be stable until manufactory integration is finished.
|
static |
Function to create a LibcurlSetCurlOptionsCallbackFactoryInterface that is Annotated<> to target the instance for consumption by AVSConnectionManager.
|
static |
Function to create a LibcurlSetCurlOptionsCallbackFactoryInterface that is Annotated<> to target the instance for consumption by HTTPContentFetcherInterfaceFactory.
|
static |
UIManagerInterface factory that just forwards the instance of UIManager.
| uiManager | The UIManager instance that will provide the implementation. |
CBLAuthRequesterInterface to use.
|
static |
Key for setting if display cards are supported or not under the SAMPLE_APP_CONFIG_KEY configuration node.
|
static |
Key for the endpoint value under the SAMPLE_APP_CONFIG_KEY configuration node.
|
static |
Key for the firmwareVersion value under the SAMPLE_APP_CONFIG_KEY configuration node.
| PreviewAlexaClientComponent alexaClientSDK::acsdkPreviewAlexaClient::getComponent | ( | std::unique_ptr< avsCommon::avs::initialization::InitializationParameters > | initParams, |
| const std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > & | diagnostics, | ||
| const std::shared_ptr< sampleApp::PlatformSpecificValues > & | platformSpecificValues, | ||
| const std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface > & | expectSpeechTimeoutHandler, | ||
| const std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > & | powerResourceManager | ||
| ) |
Get the manufactory Component for PreviewAlexaClient.
Component for PreviewAlexaClient. This component is provided as a preview of changes to come. The imports, exports, and factory methods will change while manufactory integration is incrementally released over the next several releases.
Initialize the SDK with InitalizationParameters. For example, low-power mode is initialized using InitializationParamters.
This allows applications to provide platform-specific objects to factory methods. For example, AndroidApplicationAudioPipelineFactory requires the AndroidSLESEngine.
Implementations created at the application level, added to the manufactory to satisfy dependencies.
Baseline SDK components. Applications are not expected to modify these.
Although these are the default options for PreviewAlexaClient, applications may modify or replace these with custom implementations. These include components like ACL, the logger, and AuthDelegateInterface, among others.
For example, to replace the default null MetricRecorder with your own implementation, you could remove the default applications/acsdkNullMetricRecorder library and instead define your own metric recorder component in the same acsdkMetricRecorder namespace.
Sample implementations used to satisfy dependencies for Capability Agents and other components. Applications may choose to provide their own custom implementations.
For example, to use a custom CaptionPresenterInterface, you can replace this line:
.addRequiredFactory(sampleApp::CaptionPresenter::createCaptionPresenterInterface)
with your own factory method:
.addRequiredFactory(myCustomApp::CustomCaptionPresenter::createCaptionPresenterInterface)
SQLite implementations of databases used by Capability Agents and other components. Applications may choose to replace these with their own database implementations.
Optional, horizontal components. These may be enabled via cmake or AlexaClientSDKConfig.json. Applications are not expected to modify these.
KWD Component. Default component is the null component.
Capability Agents. Some CAs are still created in Default Client.
This component is provided as a preview of changes to come. The imports, exports, and factory methods will change while manufactory integration is incrementally released over the next several releases.
Initialize the SDK with InitalizationParameters. For example, low-power mode is initialized using InitializationParamters.
This allows applications to provide platform-specific objects to factory methods. For example, AndroidApplicationAudioPipelineFactory requires the AndroidSLESEngine.
Implementations created at the application level, added to the manufactory to satisfy dependencies.
Baseline SDK components. Applications are not expected to modify these.
Although these are the default options for PreviewAlexaClient, applications may modify or replace these with custom implementations. These include components like ACL, the logger, and AuthDelegateInterface, among others.
For example, to replace the default null MetricRecorder with your own implementation, you could remove the default applications/acsdkNullMetricRecorder library and instead define your own metric recorder component in the same acsdkMetricRecorder namespace.
Sample implementations used to satisfy dependencies for Capability Agents and other components. Applications may choose to provide their own custom implementations.
For example, to use a custom CaptionPresenterInterface, you can replace this line:
.addRequiredFactory(sampleApp::CaptionPresenter::createCaptionPresenterInterface)
with your own factory method:
.addRequiredFactory(myCustomApp::CustomCaptionPresenter::createCaptionPresenterInterface)
SQLite implementations of databases used by Capability Agents and other components. Applications may choose to replace these with their own database implementations.
Optional, horizontal components. These may be enabled via cmake or AlexaClientSDKConfig.json. Applications are not expected to modify these.
KWD Component. Default component is the null component.
Capability Agents. Some CAs are still created in Default Client.
|
static |
Function to create a std::function that creates instances of EventTrackerInterface.
| diagnostics | An instance of DiagnosticsInterface. If non-null, it is used to get an instance of EventTracerInterface. |
EventTrackerInterface.
|
static |
Gets a log level consumable by the SDK based on the user input string for log level.
| userInputLogLevel | The string to be parsed into a log level. |
|
static |
Allows the process to ignore the SIGPIPE signal. The SIGPIPE signal may be received when the application performs a write to a closed socket. This is a case that arises in the use of certain networking libraries.
|
staticconstexpr |
Key for the root node value containing configuration values for SampleApp.
|
static |
String to identify log entries originating from this file.
|
static |
A set of all log levels.
AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0