#include <ExternalCapabilitiesBuilderInterface.h>

Inheritance diagram for alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface:

Classes
struct	Capability

Public Member Functions
virtual	~ExternalCapabilitiesBuilderInterface ()=default

virtual ExternalCapabilitiesBuilderInterface &	withSettingsStorage (std::shared_ptr< settings::storage::DeviceSettingStorageInterface > settingStorage)=0

virtual ExternalCapabilitiesBuilderInterface &	withTemplateRunTime (std::shared_ptr< templateRuntimeInterfaces::TemplateRuntimeInterface > templateRuntime)=0

virtual std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::CallManagerInterface >	getCallManager ()=0

virtual ExternalCapabilitiesBuilderInterface &	withInternetConnectionMonitor (std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface > internetConnectionMonitor)=0

virtual ExternalCapabilitiesBuilderInterface &	withAlexaInterfaceMessageSender (std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > alexaMessageSender)=0

virtual ExternalCapabilitiesBuilderInterface &	withDialogUXStateAggregator (std::shared_ptr< avsCommon::avs::DialogUXStateAggregator > dialogUXStateAggregator)=0

virtual std::pair< std::list< Capability >, std::list< std::shared_ptr< avsCommon::utils::RequiresShutdown > > >	buildCapabilities (std::shared_ptr< acsdkExternalMediaPlayer::ExternalMediaPlayer > externalMediaPlayer, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > connectionManager, std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< certifiedSender::CertifiedSender > certifiedSender, std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface > audioFocusManager, std::shared_ptr< registrationManager::CustomerDataManagerInterface > dataManager, std::shared_ptr< capabilityAgents::system::ReportStateHandler > stateReportHandler, std::shared_ptr< capabilityAgents::aip::AudioInputProcessor > audioInputProcessor, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > speakerManager, std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > directiveSequencer, std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorInterface > userInactivityMonitor, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface > avsGatewayManager, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > ringtoneMediaPlayer, std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface > audioFactory, std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeInterface > ringtoneChannelVolumeInterface, std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > powerResourceManager, std::shared_ptr< avsCommon::sdkInterfaces::ComponentReporterInterface > softwareComponentReporter, std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface > playbackRouter, std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface > endpointRegistrationManager, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder)=0

Detailed Description

This interface provides a facility to add external capabilities to default client.

Default client will provide its core components in the build call.

Note: Any object created during the buildCapabilities that keep a pointer to a core component should be added or managed by an object in the list of RequiresShutdown objects returned by buildCapabilities(). This will ensure that these objects are shutdown during DefaultClient shutdown and before any core component is shutdown.

Constructor & Destructor Documentation

◆ ~ExternalCapabilitiesBuilderInterface()

virtual alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::~ExternalCapabilitiesBuilderInterface ( )

virtualdefault

Destructor.

Member Function Documentation

◆ buildCapabilities()

virtual std::pair<std::list<Capability>, std::list<std::shared_ptr<avsCommon::utils::RequiresShutdown> > > alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::buildCapabilities	(	std::shared_ptr< acsdkExternalMediaPlayer::ExternalMediaPlayer >	externalMediaPlayer,
		std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface >	connectionManager,
		std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface >	messageSender,
		std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >	exceptionSender,
		std::shared_ptr< certifiedSender::CertifiedSender >	certifiedSender,
		std::shared_ptr< avsCommon::sdkInterfaces::FocusManagerInterface >	audioFocusManager,
		std::shared_ptr< registrationManager::CustomerDataManagerInterface >	dataManager,
		std::shared_ptr< capabilityAgents::system::ReportStateHandler >	stateReportHandler,
		std::shared_ptr< capabilityAgents::aip::AudioInputProcessor >	audioInputProcessor,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface >	speakerManager,
		std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface >	directiveSequencer,
		std::shared_ptr< avsCommon::sdkInterfaces::UserInactivityMonitorInterface >	userInactivityMonitor,
		std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >	contextManager,
		std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface >	avsGatewayManager,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	ringtoneMediaPlayer,
		std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface >	audioFactory,
		std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeInterface >	ringtoneChannelVolumeInterface,
		std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface >	powerResourceManager,
		std::shared_ptr< avsCommon::sdkInterfaces::ComponentReporterInterface >	softwareComponentReporter,
		std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface >	playbackRouter,
		std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface >	endpointRegistrationManager,
		std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >	metricRecorder
	)

pure virtual

Build the capabilities with the given core components.

Parameters

externalMediaPlayer	Object used to manage external media playback.
connectionManager	Object responsible for managing the SDK connection with AVS.
messageSender	Object that can be used to send events to AVS.
exceptionSender	Object that can be used to send exceptions to AVS.
certifiedSender	Object that can be used to send events to AVS that require stronger guarantee.
audioFocusManager	The focus manager for audio channels.
dataManager	Object used to manage objects that store customer data.
stateReportHandler	Object used to report the device state and its settings.
audioInputProcessor	Object used to recognize voice interactions.
speakerManager	Object used to manage all speaker instances that can be controlled by Alexa.
directiveSequencer	Object used to sequence and handle a stream of `AVSDirective` instances.
userInactivityMonitor	Object used to notify an implementation of the user activity.
contextManager	Object used to provide the context for various components.
avsGatewayManager	Object used to get the AVS gateway URL data.
ringtoneMediaPlayer	The media player to play Comms ringtones.
audioFactory	The audioFactory is a component the provides unique audio streams.
ringtoneChannelVolumeInterface	The ChannelVolumeInterface used for ringtone channel volume attenuation. #ifdef ENABLE_COMMS_AUDIO_PROXY
commsMediaPlayer	The media player to play Comms calling audio.
commsSpeaker	The speaker to control volume of Comms calling audio.
sharedDataStream	The stream to use which has the audio from microphone. #endif
powerResourceManager	Object to manage power resource.
softwareComponentReporter	Object to report adapters' versions.
playbackRouter	Object to route local playback control command.
endpointRegistrationManager	Object to manage endpoints.
metricRecorder	Object to manage AVS SDK metric reporting.

Returns: A list with all capabilities as well as objects that require explicit shutdown. Shutdown will be performed in the reverse order of occurrence.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.

◆ getCallManager()

virtual std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::CallManagerInterface> alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::getCallManager ( )

pure virtual

Get the CallManager reference.

Returns: A reference of CallManager.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder, and alexaClientSDK::sampleApp::ExternalCapabilitiesBuilder.

◆ withAlexaInterfaceMessageSender()

virtual ExternalCapabilitiesBuilderInterface& alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::withAlexaInterfaceMessageSender ( std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > alexaMessageSender )

pure virtual

This method sets the Alexa Interface Message Sender to send Alexa Interface response events.

Parameters

alexaMessageSender The AlexaInterfaceMessageSenderInterface object.

Implemented in alexaClientSDK::sampleApp::ExternalCapabilitiesBuilder, and alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.

◆ withDialogUXStateAggregator()

virtual ExternalCapabilitiesBuilderInterface& alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::withDialogUXStateAggregator ( std::shared_ptr< avsCommon::avs::DialogUXStateAggregator > dialogUXStateAggregator )

pure virtual

This method sets the DialogUXStateAggregator for CallManager.

Parameters

dialogUXStateAggregator The DialogUXStateAggregator object.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.

◆ withInternetConnectionMonitor()

virtual ExternalCapabilitiesBuilderInterface& alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::withInternetConnectionMonitor ( std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface > internetConnectionMonitor )

pure virtual

This method sets the InternetConnectionMonitor for CallManager.

Parameters

internetConnectionMonitor The InternetConnectionMonitor object.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.

◆ withSettingsStorage()

virtual ExternalCapabilitiesBuilderInterface& alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::withSettingsStorage ( std::shared_ptr< settings::storage::DeviceSettingStorageInterface > settingStorage )

pure virtual

This method sets the storage using for setting.

Warning: The settings storage is opened and closed by DefaultClient during creation and shutdown respectively. You can add your objects that use this storage inside the list of RequiresShutdown objects managed by DefaultClient to ensure the storage usage will not be done after it closure.

◆ withTemplateRunTime()

virtual ExternalCapabilitiesBuilderInterface& alexaClientSDK::defaultClient::ExternalCapabilitiesBuilderInterface::withTemplateRunTime ( std::shared_ptr< templateRuntimeInterfaces::TemplateRuntimeInterface > templateRuntime )

pure virtual

This method sets the TemplateRuntime Capability Agent for visual interactions.

This method will only get called if GUI supports has been enabled.

Parameters

templateRuntime The TemplateRuntime object.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder, and alexaClientSDK::sampleApp::ExternalCapabilitiesBuilder.

The documentation for this class was generated from the following file:

/workplace/avs-device-sdk/ApplicationUtilities/DefaultClient/include/DefaultClient/ExternalCapabilitiesBuilderInterface.h

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ExternalCapabilitiesBuilderInterface()

Member Function Documentation

◆ buildCapabilities()

◆ getCallManager()

◆ withAlexaInterfaceMessageSender()

◆ withDialogUXStateAggregator()

◆ withInternetConnectionMonitor()

◆ withSettingsStorage()

◆ withTemplateRunTime()