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

Classes

class  ConnectionRetryTrigger
 
class  DefaultClient
 
class  EqualizerRuntimeSetup
 
class  ExternalCapabilitiesBuilderInterface
 
class  StubApplicationAudioPipelineFactory
 

Typedefs

using DefaultClientComponent = acsdkManufactory::Component< std::shared_ptr< acsdkAlertsInterfaces::AlertsCapabilityAgentInterface >, std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface >, std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerInterface >, std::shared_ptr< acsdkBluetoothInterfaces::BluetoothLocalInterface >, std::shared_ptr< acsdkBluetoothInterfaces::BluetoothNotifierInterface >, std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface >, std::shared_ptr< acsdkExternalMediaPlayer::ExternalMediaPlayer >, std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface >, std::shared_ptr< acsdkNotificationsInterfaces::NotificationsNotifierInterface >, std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownManagerInterface >, std::shared_ptr< acsdkStartupManagerInterfaces::StartupManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface >, std::shared_ptr< afml::interruptModel::InterruptModel >, std::shared_ptr< avsCommon::avs::DialogUXStateAggregator >, std::shared_ptr< avsCommon::avs::attachment::AttachmentManagerInterface >, 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::ExpectSpeechTimeoutHandlerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface >, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface >, std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface >, std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface >, 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::SystemSoundPlayerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface >, std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorInterface >, std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface >, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface >, std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface >, std::shared_ptr< avsCommon::utils::DeviceInfo >, std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode >, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >, std::shared_ptr< acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface >, std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSender >, std::shared_ptr< capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent >, std::shared_ptr< acsdkInteractionModelInterfaces::InteractionModelNotifierInterface >, 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< settings::DeviceSettingsManager >, std::shared_ptr< settings::storage::DeviceSettingStorageInterface >, std::shared_ptr< speechencoder::SpeechEncoder >, std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface > >
 

Functions

DefaultClientComponent getComponent (const std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > &authDelegate, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface > &localeAssetsManager, const std::shared_ptr< avsCommon::utils::DeviceInfo > &deviceInfo, const std::shared_ptr< registrationManager::CustomerDataManagerInterface > &customerDataManager, const std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > &miscStorage, const std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface > &internetConnectionMonitor, const std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface > &avsGatewayManager, const std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface > &capabilitiesDelegate, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder, const std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > &diagnostics, const std::shared_ptr< alexaClientSDK::acl::TransportFactoryInterface > &transportFactory, const std::shared_ptr< alexaClientSDK::acl::MessageRouterFactoryInterface > &messageRouterFactory, const std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > &channelVolumeFactory, const std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface > &expectSpeechTimeoutHandler, const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface > &equalizerRuntimeSetup, const std::shared_ptr< StubApplicationAudioPipelineFactory > &stubAudioPipelineFactory, const std::shared_ptr< avsCommon::utils::mediaPlayer::PooledMediaResourceProviderInterface > &audioMediaResourceProvider, const std::shared_ptr< certifiedSender::MessageStorageInterface > &messageStorage, const std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > &powerResourceManager, const acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreationMap &adapterCreationMap, const std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface > &systemTimeZone, const std::shared_ptr< settings::storage::DeviceSettingStorageInterface > &deviceSettingStorage, bool startAlertSchedulingOnInitialization, const std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface > &audioFactory, const std::shared_ptr< acsdkAlerts::storage::AlertStorageInterface > &alertStorage, const std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface > &bluetoothDeviceManager, const std::shared_ptr< acsdkBluetoothInterfaces::BluetoothStorageInterface > &bluetoothStorage, const std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceConnectionRulesProviderInterface > &bluetoothConnectionRulesProvider, const std::shared_ptr< acsdkNotificationsInterfaces::NotificationsStorageInterface > &notificationsStorage)
 
static const std::string TAG ("ConnectionRetryTrigger")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("DefaultClient")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("DefaultClientComponent")
 String to identify log entries originating from this file. More...
 
static std::shared_ptr< AlexaEventProcessedNotifierInterfacecreateAlexaEventProcessedNotifierInterface (const std::shared_ptr< CapabilitiesDelegateInterface > &capabilitiesDelegate)
 
static std::function< std::shared_ptr< MessageRouterInterface > std::shared_ptr< ShutdownNotifierInterface > shutdownNotifier, std::shared_ptr< AuthDelegateInterface > authDelegate, std::shared_ptr< AttachmentManagerInterface > attachmentManager, std::shared_ptr< TransportFactoryInterface > transportFactory)> getCreateMessageRouter (const std::shared_ptr< MessageRouterFactoryInterface > &messageRouterFactory)
 
static std::function< std::shared_ptr< ApplicationAudioPipelineFactoryInterface > std::shared_ptr< SpeakerManagerInterface >, std::shared_ptr< captions::CaptionManagerInterface >)> getCreateApplicationAudioPipelineFactory (std::shared_ptr< StubApplicationAudioPipelineFactory > stubAudioPipelineFactory)
 
static std::function< std::shared_ptr< settings::storage::DeviceSettingStorageInterface >)> getCreateDeviceSettingStorageInterface (std::shared_ptr< settings::storage::DeviceSettingStorageInterface > storage)
 
static const std::string TAG ("EqualizerRuntimeSetup")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("StubApplicationAudioPipelineFactory")
 String to identify log entries originating from this file. More...
 

Typedef Documentation

◆ DefaultClientComponent

using alexaClientSDK::defaultClient::DefaultClientComponent = typedef acsdkManufactory::Component< std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface>, std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface>, std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerInterface>, std::shared_ptr<acsdkBluetoothInterfaces::BluetoothLocalInterface>, std::shared_ptr<acsdkBluetoothInterfaces::BluetoothNotifierInterface>, std::shared_ptr<acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface>, std::shared_ptr<acsdkExternalMediaPlayer::ExternalMediaPlayer>, std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface>, std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface>, std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface>, std::shared_ptr<acsdkStartupManagerInterfaces::StartupManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::DirectiveSequencerInterface>, std::shared_ptr<afml::interruptModel::InterruptModel>, std::shared_ptr<avsCommon::avs::DialogUXStateAggregator>, std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface>, 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::ExpectSpeechTimeoutHandlerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>, acsdkManufactory:: Annotated<avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>, acsdkManufactory:: Annotated<avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface>, std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface>, std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>, 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::SystemSoundPlayerInterface>, std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface>, std::shared_ptr<avsCommon::sdkInterfaces::UserInactivityMonitorInterface>, std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>, acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface>, std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface>, std::shared_ptr<avsCommon::utils::DeviceInfo>, std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>, std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>, std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface>, std::shared_ptr<capabilityAgents::alexa::AlexaInterfaceMessageSender>, std::shared_ptr<capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent>, std::shared_ptr<acsdkInteractionModelInterfaces::InteractionModelNotifierInterface>, 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<settings::DeviceSettingsManager>, std::shared_ptr<settings::storage::DeviceSettingStorageInterface>, std::shared_ptr<speechencoder::SpeechEncoder>, std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface> >

Definition of a Manufactory component for the Default Client.

This component provides backwards compatibility for applications that use the Default Client's non-manufactory method of initialization.

Function Documentation

◆ createAlexaEventProcessedNotifierInterface()

static std::shared_ptr<AlexaEventProcessedNotifierInterface> alexaClientSDK::defaultClient::createAlexaEventProcessedNotifierInterface ( const std::shared_ptr< CapabilitiesDelegateInterface > &  capabilitiesDelegate)
static

Factory method for AlexaEventProcessedNotifierInterface.

Parameters
capabilitiesDelegateThe CapabilitiesDelegate that must be added as an observer.
Returns
An implementation of AlexaEventProcessedNotifierInterface.

◆ getComponent()

DefaultClientComponent alexaClientSDK::defaultClient::getComponent ( const std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > &  authDelegate,
const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager,
const std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface > &  localeAssetsManager,
const std::shared_ptr< avsCommon::utils::DeviceInfo > &  deviceInfo,
const std::shared_ptr< registrationManager::CustomerDataManagerInterface > &  customerDataManager,
const std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > &  miscStorage,
const std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface > &  internetConnectionMonitor,
const std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface > &  avsGatewayManager,
const std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface > &  capabilitiesDelegate,
const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder,
const std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > &  diagnostics,
const std::shared_ptr< alexaClientSDK::acl::TransportFactoryInterface > &  transportFactory,
const std::shared_ptr< alexaClientSDK::acl::MessageRouterFactoryInterface > &  messageRouterFactory,
const std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > &  channelVolumeFactory,
const std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface > &  expectSpeechTimeoutHandler,
const std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface > &  equalizerRuntimeSetup,
const std::shared_ptr< StubApplicationAudioPipelineFactory > &  stubAudioPipelineFactory,
const std::shared_ptr< avsCommon::utils::mediaPlayer::PooledMediaResourceProviderInterface > &  audioMediaResourceProvider,
const std::shared_ptr< certifiedSender::MessageStorageInterface > &  messageStorage,
const std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > &  powerResourceManager,
const acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreationMap adapterCreationMap,
const std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface > &  systemTimeZone,
const std::shared_ptr< settings::storage::DeviceSettingStorageInterface > &  deviceSettingStorage,
bool  startAlertSchedulingOnInitialization,
const std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface > &  audioFactory,
const std::shared_ptr< acsdkAlerts::storage::AlertStorageInterface > &  alertStorage,
const std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface > &  bluetoothDeviceManager,
const std::shared_ptr< acsdkBluetoothInterfaces::BluetoothStorageInterface > &  bluetoothStorage,
const std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceConnectionRulesProviderInterface > &  bluetoothConnectionRulesProvider,
const std::shared_ptr< acsdkNotificationsInterfaces::NotificationsStorageInterface > &  notificationsStorage 
)

Get the manufactory Component for (legacy) DefaultClient initialization.

Returns
The manufactory Component for (legacy) DefaultClient initialization.

Instead of using factory methods to instantiate these interfaces, DefaultClientComponent accepts pre-made implementations and adds them to the manufactory.

Baseline SDK components. Applications are not expected to modify these.

Optional, horizontal components.

Capability Agents. Some CAs are still instantiated in DefaultClient.cpp.

Instead of using factory methods to instantiate these interfaces, DefaultClientComponent accepts pre-made implementations and adds them to the manufactory.

Baseline SDK components. Applications are not expected to modify these.

Optional, horizontal components.

Capability Agents. Some CAs are still instantiated in DefaultClient.cpp.

◆ getCreateApplicationAudioPipelineFactory()

static std::function<std::shared_ptr<ApplicationAudioPipelineFactoryInterface> std::shared_ptr<SpeakerManagerInterface>, std::shared_ptr<captions::CaptionManagerInterface>)> alexaClientSDK::defaultClient::getCreateApplicationAudioPipelineFactory ( std::shared_ptr< StubApplicationAudioPipelineFactory stubAudioPipelineFactory)
static

Returns an std::function that finishes configuring the StubAudioPipelineFactory with objects created by the manufactory and forwards the stub factory as the ApplicationAudioPipelineFactoryInterface.

Parameters
stubAudioPipelineFactoryThe stub factory to finish configuring.
Returns
A shared pointer to an ApplicationAudioPipelineFactoryInterface.

◆ getCreateDeviceSettingStorageInterface()

static std::function<std::shared_ptr<settings::storage::DeviceSettingStorageInterface>)> alexaClientSDK::defaultClient::getCreateDeviceSettingStorageInterface ( std::shared_ptr< settings::storage::DeviceSettingStorageInterface storage)
static

Returns an std::function that finishes configuring the DeviceSettingStorageInterface.

Parameters
DeviceSettingStorageInterfaceThe storage interface to finish configuring.
Returns
A shared pointer to an DeviceSettingStorageInterface.

◆ getCreateMessageRouter()

static std::function<std::shared_ptr<MessageRouterInterface> std::shared_ptr<ShutdownNotifierInterface> shutdownNotifier, std::shared_ptr<AuthDelegateInterface> authDelegate, std::shared_ptr<AttachmentManagerInterface> attachmentManager, std::shared_ptr<TransportFactoryInterface> transportFactory)> alexaClientSDK::defaultClient::getCreateMessageRouter ( const std::shared_ptr< MessageRouterFactoryInterface > &  messageRouterFactory)
static

Adapt from a MessageRouter factory object to a std::function to create a MessageRouter.

Parameters
messageRouterFactoryThe factory object to use.
Returns
A std::function for creating MessageRouter instances.

◆ TAG() [1/5]

static const std::string alexaClientSDK::defaultClient::TAG ( "StubApplicationAudioPipelineFactory"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/5]

static const std::string alexaClientSDK::defaultClient::TAG ( "ConnectionRetryTrigger"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/5]

static const std::string alexaClientSDK::defaultClient::TAG ( "EqualizerRuntimeSetup"  )
static

String to identify log entries originating from this file.

◆ TAG() [4/5]

static const std::string alexaClientSDK::defaultClient::TAG ( "DefaultClient"  )
static

String to identify log entries originating from this file.

◆ TAG() [5/5]

static const std::string alexaClientSDK::defaultClient::TAG ( "DefaultClientComponent"  )
static

String to identify log entries originating from this file.

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