Classes
class	ConnectionRetryTrigger

class	DefaultClient

class	EqualizerRuntimeSetup

class	ExternalCapabilitiesBuilderInterface

class	StubApplicationAudioPipelineFactory

Typedefs
using	DefaultClientComponent = acsdkManufactory::Component< std::shared_ptr< acsdkAlerts::AlertsCapabilityAgent >, std::shared_ptr< acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface >, std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerInterface >, std::shared_ptr< acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface >, std::shared_ptr< acsdkExternalMediaPlayer::ExternalMediaPlayer >, std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface >, std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownManagerInterface >, std::shared_ptr< acsdkStartupManagerInterfaces::StartupManagerInterface >, std::shared_ptr< afml::interruptModel::InterruptModel >, 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 >, 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::SystemTimeZoneInterface >, 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< avsCommon::utils::timing::SystemClockMonitor >, 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::CustomerDataManager >, std::shared_ptr< settings::DeviceSettingsManager >, std::shared_ptr< settings::storage::DeviceSettingStorageInterface > >

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::CustomerDataManager > &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)

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< AlexaEventProcessedNotifierInterface >	createAlexaEventProcessedNotifierInterface (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...

Variables
static const std::string	VISUAL_CHANNEL_CONFIG_KEY = "visualChannels"
	Key for visual channel array configurations in configuration node. More...

Typedef Documentation

◆ DefaultClientComponent

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

capabilitiesDelegate The 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::CustomerDataManager > &	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
	)

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. Most 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. Most 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

stubAudioPipelineFactory The 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

DeviceSettingStorageInterface The 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

messageRouterFactory The factory object to use.

Returns: A std::function for creating MessageRouter instances.