AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Typedefs | Functions | Variables
alexaClientSDK::acsdkPreviewAlexaClient Namespace Reference

Classes

class  PreviewAlexaClient
 

Typedefs

using PreviewAlexaClientComponent = acsdkManufactory::Component< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface >, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface >, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface >, std::shared_ptr< acsdkAlertsInterfaces::AlertsCapabilityAgentInterface >, std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface >, std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerInterface >, std::shared_ptr< acsdkBluetoothInterfaces::BluetoothNotifierInterface >, std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface >, std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface >, std::shared_ptr< acsdkExternalMediaPlayer::ExternalMediaPlayer >, std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface >, std::shared_ptr< acsdkInteractionModelInterfaces::InteractionModelNotifierInterface >, std::shared_ptr< acsdkNotificationsInterfaces::NotificationsNotifierInterface >, std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownManagerInterface >, std::shared_ptr< acsdkStartupManagerInterfaces::StartupManagerInterface >, std::shared_ptr< acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface >, std::shared_ptr< afml::interruptModel::InterruptModel >, std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface >, std::shared_ptr< avsCommon::avs::AudioInputStream >, std::shared_ptr< avsCommon::avs::DialogUXStateAggregator >, std::shared_ptr< avsCommon::avs::initialization::AlexaClientSDKInit >, std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface >, std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface >, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface >, std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface >, std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >, std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface >, std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface >, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface >, std::shared_ptr< avsCommon::sdkInterfaces::SystemSoundPlayerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface >, std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorInterface >, std::shared_ptr< avsCommon::utils::AudioFormat >, std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode >, std::shared_ptr< avsCommon::utils::DeviceInfo >, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >, std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSender >, std::shared_ptr< capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent >, std::shared_ptr< captions::CaptionManagerInterface >, std::shared_ptr< certifiedSender::CertifiedSender >, std::shared_ptr< registrationManager::CustomerDataManagerInterface >, std::shared_ptr< registrationManager::RegistrationManagerInterface >, std::shared_ptr< registrationManager::RegistrationNotifierInterface >, std::shared_ptr< sampleApp::UIManager >, std::shared_ptr< settings::DeviceSettingsManager >, std::shared_ptr< settings::storage::DeviceSettingStorageInterface >, std::shared_ptr< speechencoder::SpeechEncoder > >
 
using MediaPlayerInterface = alexaClientSDK::avsCommon::utils::mediaPlayer::MediaPlayerInterface
 
using ApplicationMediaInterfaces = alexaClientSDK::avsCommon::sdkInterfaces::ApplicationMediaInterfaces
 
using PreviewAlexaClientManufactory = Manufactory< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface >, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface >, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface >, std::shared_ptr< acsdkAlertsInterfaces::AlertsCapabilityAgentInterface >, std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface >, std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerInterface >, std::shared_ptr< acsdkBluetoothInterfaces::BluetoothNotifierInterface >, std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface >, std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface >, std::shared_ptr< acsdkExternalMediaPlayer::ExternalMediaPlayer >, std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface >, std::shared_ptr< acsdkInteractionModelInterfaces::InteractionModelNotifierInterface >, std::shared_ptr< acsdkNotificationsInterfaces::NotificationsNotifierInterface >, std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownManagerInterface >, std::shared_ptr< acsdkStartupManagerInterfaces::StartupManagerInterface >, std::shared_ptr< acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface >, std::shared_ptr< afml::interruptModel::InterruptModel >, std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface >, std::shared_ptr< avsCommon::avs::AudioInputStream >, std::shared_ptr< avsCommon::avs::DialogUXStateAggregator >, std::shared_ptr< avsCommon::avs::initialization::AlexaClientSDKInit >, std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface >, std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface >, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface >, std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface >, std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >, std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface >, std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface >, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface >, std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface >, std::shared_ptr< avsCommon::sdkInterfaces::SystemSoundPlayerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface >, std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorInterface >, std::shared_ptr< avsCommon::utils::AudioFormat >, std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode >, std::shared_ptr< avsCommon::utils::DeviceInfo >, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >, std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSender >, std::shared_ptr< capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent >, std::shared_ptr< captions::CaptionManagerInterface >, std::shared_ptr< certifiedSender::CertifiedSender >, std::shared_ptr< registrationManager::CustomerDataManagerInterface >, std::shared_ptr< registrationManager::RegistrationManagerInterface >, std::shared_ptr< registrationManager::RegistrationNotifierInterface >, std::shared_ptr< sampleApp::UIManager >, std::shared_ptr< settings::DeviceSettingsManager >, std::shared_ptr< settings::storage::DeviceSettingStorageInterface >, std::shared_ptr< speechencoder::SpeechEncoder > >
 
using DefaultEndpointAnnotation = avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation
 

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< UIManagerInterfacecreateUIManagerInterface (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, LibcurlSetCurlOptionsCallbackFactoryInterfacecreateSetCurlOptionsCallbackForAVSConnectionManager ()
 
static Annotated< HTTPContentFetcherInterfaceFactoryInterface, LibcurlSetCurlOptionsCallbackFactoryInterfacecreateSetCurlOptionsCallbackForHTTPContentFetcherInterfaceFactory ()
 

Variables

static const std::set< alexaClientSDK::avsCommon::utils::logger::LevelallLevels
 A set of all log levels. More...
 

Typedef Documentation

◆ ApplicationMediaInterfaces

◆ DefaultEndpointAnnotation

◆ MediaPlayerInterface

◆ PreviewAlexaClientComponent

using alexaClientSDK::acsdkPreviewAlexaClient::PreviewAlexaClientComponent = typedef acsdkManufactory::Component< acsdkManufactory:: Annotated<avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>, acsdkManufactory:: Annotated<avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface>, std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface>, std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface>, std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerInterface>, std::shared_ptr<acsdkBluetoothInterfaces::BluetoothNotifierInterface>, std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface>, std::shared_ptr<acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface>, std::shared_ptr<acsdkExternalMediaPlayer::ExternalMediaPlayer>, std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface>, std::shared_ptr<acsdkInteractionModelInterfaces::InteractionModelNotifierInterface>, std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface>, std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface>, std::shared_ptr<acsdkStartupManagerInterfaces::StartupManagerInterface>, std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface>, std::shared_ptr<afml::interruptModel::InterruptModel>, std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface>, std::shared_ptr<avsCommon::avs::AudioInputStream>, std::shared_ptr<avsCommon::avs::DialogUXStateAggregator>, std::shared_ptr<avsCommon::avs::initialization::AlexaClientSDKInit>, std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>, std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>, std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::CapabilitiesDelegateInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::DirectiveSequencerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface>, std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface>, std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>, std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface>, std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface>, std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface>, std::shared_ptr<avsCommon::sdkInterfaces::SystemSoundPlayerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface>, std::shared_ptr<avsCommon::sdkInterfaces::UserInactivityMonitorInterface>, std::shared_ptr<avsCommon::utils::AudioFormat>, std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>, std::shared_ptr<avsCommon::utils::DeviceInfo>, std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>, std::shared_ptr<capabilityAgents::alexa::AlexaInterfaceMessageSender>, std::shared_ptr<capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent>, std::shared_ptr<captions::CaptionManagerInterface>, std::shared_ptr<certifiedSender::CertifiedSender>, std::shared_ptr<registrationManager::CustomerDataManagerInterface>, std::shared_ptr<registrationManager::RegistrationManagerInterface>, std::shared_ptr<registrationManager::RegistrationNotifierInterface>, std::shared_ptr<sampleApp::UIManager>, std::shared_ptr<settings::DeviceSettingsManager>, std::shared_ptr<settings::storage::DeviceSettingStorageInterface>, std::shared_ptr<speechencoder::SpeechEncoder> >

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.

◆ PreviewAlexaClientManufactory

using alexaClientSDK::acsdkPreviewAlexaClient::PreviewAlexaClientManufactory = typedef Manufactory< acsdkManufactory:: Annotated<avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>, acsdkManufactory:: Annotated<avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface>, std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface>, std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface>, std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerInterface>, std::shared_ptr<acsdkBluetoothInterfaces::BluetoothNotifierInterface>, std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface>, std::shared_ptr<acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface>, std::shared_ptr<acsdkExternalMediaPlayer::ExternalMediaPlayer>, std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface>, std::shared_ptr<acsdkInteractionModelInterfaces::InteractionModelNotifierInterface>, std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface>, std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface>, std::shared_ptr<acsdkStartupManagerInterfaces::StartupManagerInterface>, std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface>, std::shared_ptr<afml::interruptModel::InterruptModel>, std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface>, std::shared_ptr<avsCommon::avs::AudioInputStream>, std::shared_ptr<avsCommon::avs::DialogUXStateAggregator>, std::shared_ptr<avsCommon::avs::initialization::AlexaClientSDKInit>, std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>, std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>, std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::CapabilitiesDelegateInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::DirectiveSequencerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface>, std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface>, std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::MessageSenderInterface>, std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface>, std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface>, std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface>, std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface>, std::shared_ptr<avsCommon::sdkInterfaces::SystemSoundPlayerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface>, std::shared_ptr<avsCommon::sdkInterfaces::UserInactivityMonitorInterface>, std::shared_ptr<avsCommon::utils::AudioFormat>, std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>, std::shared_ptr<avsCommon::utils::DeviceInfo>, std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>, std::shared_ptr<capabilityAgents::alexa::AlexaInterfaceMessageSender>, std::shared_ptr<capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent>, std::shared_ptr<captions::CaptionManagerInterface>, std::shared_ptr<certifiedSender::CertifiedSender>, std::shared_ptr<registrationManager::CustomerDataManagerInterface>, std::shared_ptr<registrationManager::RegistrationManagerInterface>, std::shared_ptr<registrationManager::RegistrationNotifierInterface>, std::shared_ptr<sampleApp::UIManager>, std::shared_ptr<settings::DeviceSettingsManager>, std::shared_ptr<settings::storage::DeviceSettingStorageInterface>, std::shared_ptr<speechencoder::SpeechEncoder> >

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.

Function Documentation

◆ createSetCurlOptionsCallbackForAVSConnectionManager()

static Annotated<AVSConnectionManagerInterface, LibcurlSetCurlOptionsCallbackFactoryInterface> alexaClientSDK::acsdkPreviewAlexaClient::createSetCurlOptionsCallbackForAVSConnectionManager ( )
static

Function to create a LibcurlSetCurlOptionsCallbackFactoryInterface that is Annotated<> to target the instance for consumption by AVSConnectionManager.

Returns
Pointer to LibcurlSetCurlOptionsCallbackFactoryInterface Annotated<> for consumption by AVSCnnectonManager.

◆ createSetCurlOptionsCallbackForHTTPContentFetcherInterfaceFactory()

static Annotated<HTTPContentFetcherInterfaceFactoryInterface, LibcurlSetCurlOptionsCallbackFactoryInterface> alexaClientSDK::acsdkPreviewAlexaClient::createSetCurlOptionsCallbackForHTTPContentFetcherInterfaceFactory ( )
static

Function to create a LibcurlSetCurlOptionsCallbackFactoryInterface that is Annotated<> to target the instance for consumption by HTTPContentFetcherInterfaceFactory.

Returns
Pointer to LibcurlSetCurlOptionsCallbackFactoryInterface Annotated<> for consumption by HTTPContentFetcherInterfaceFactory.

◆ createUIManagerInterface()

static std::shared_ptr<UIManagerInterface> alexaClientSDK::acsdkPreviewAlexaClient::createUIManagerInterface ( const std::shared_ptr< sampleApp::UIManager > &  uiManager)
static

UIManagerInterface factory that just forwards the instance of UIManager.

Parameters
uiManagerThe UIManager instance that will provide the implementation.
Returns
The implementation of CBLAuthRequesterInterface to use.

◆ DISPLAY_CARD_KEY()

static const std::string alexaClientSDK::acsdkPreviewAlexaClient::DISPLAY_CARD_KEY ( "displayCardsSupported"  )
static

Key for setting if display cards are supported or not under the SAMPLE_APP_CONFIG_KEY configuration node.

◆ ENDPOINT_KEY()

static const std::string alexaClientSDK::acsdkPreviewAlexaClient::ENDPOINT_KEY ( "endpoint"  )
static

Key for the endpoint value under the SAMPLE_APP_CONFIG_KEY configuration node.

◆ FIRMWARE_VERSION_KEY()

static const std::string alexaClientSDK::acsdkPreviewAlexaClient::FIRMWARE_VERSION_KEY ( "firmwareVersion"  )
static

Key for the firmwareVersion value under the SAMPLE_APP_CONFIG_KEY configuration node.

◆ getComponent()

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.

Returns
The manufactory 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.

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.

Capability Agents. Some CAs are still created in Default Client.

◆ getCreateEventTracker()

static std::function<std::shared_ptr<EventTracerInterface>)> alexaClientSDK::acsdkPreviewAlexaClient::getCreateEventTracker ( const std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > &  diagnostics)
static

Function to create a std::function that creates instances of EventTrackerInterface.

Parameters
diagnosticsAn instance of DiagnosticsInterface. If non-null, it is used to get an instance of EventTracerInterface.
Returns
A new instance of EventTrackerInterface.

◆ getLogLevelFromUserInput()

static alexaClientSDK::avsCommon::utils::logger::Level alexaClientSDK::acsdkPreviewAlexaClient::getLogLevelFromUserInput ( std::string  userInputLogLevel)
static

Gets a log level consumable by the SDK based on the user input string for log level.

Parameters
userInputLogLevelThe string to be parsed into a log level.
Returns
The log level. This will default to NONE if the input string is not properly parsable.

◆ ignoreSigpipeSignals()

static bool alexaClientSDK::acsdkPreviewAlexaClient::ignoreSigpipeSignals ( )
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.

Returns
true if the action for handling SIGPIPEs was correctly set to ignore, else false.

◆ SAMPLE_APP_CONFIG_KEY()

static constexpr const char* alexaClientSDK::acsdkPreviewAlexaClient::SAMPLE_APP_CONFIG_KEY ( "sampleApp"  )
static

Key for the root node value containing configuration values for SampleApp.

◆ TAG()

static const std::string alexaClientSDK::acsdkPreviewAlexaClient::TAG ( "PreviewAlexaClient"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ allLevels

const std::set<alexaClientSDK::avsCommon::utils::logger::Level> alexaClientSDK::acsdkPreviewAlexaClient::allLevels
static
Initial value:
= {
Most verbose debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Log of a event that indicates an unrecoverable error.
Logs of normal operations, to be used in release builds.
Log of an event that indicates an error.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Least verbose debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Log of an event that may indicate a problem.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.
Intermediate debug log level. Compiled out when ACSDK_DEBUG_LOG_ENABLED is not defined.

A set of all log levels.

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0