#include <DefaultClient.h>

Inheritance diagram for alexaClientSDK::defaultClient::DefaultClient:

Collaboration diagram for alexaClientSDK::defaultClient::DefaultClient:

Public Types
using	DefaultClientSubsetManufactory = acsdkManufactory::Manufactory< 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< 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< 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 >, 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< 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< settings::DeviceSettingsManager >, std::shared_ptr< settings::storage::DeviceSettingStorageInterface >, std::shared_ptr< audioEncoderInterfaces::AudioEncoderInterface >, std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface > >

using	DefaultClientManufactory = acsdkManufactory::Manufactory< 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< 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< 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 >, 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< 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< settings::DeviceSettingsManager >, std::shared_ptr< settings::storage::DeviceSettingStorageInterface >, std::shared_ptr< audioEncoderInterfaces::AudioEncoderInterface >, std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface > >

Public Member Functions
void	connect (bool performReset=true)

void	disconnect ()

std::string	getAVSGateway ()

void	stopForegroundActivity ()

void	stopAllActivities ()

void	localStopActiveAlert ()

void	addAlexaDialogStateObserver (std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface > observer)

void	removeAlexaDialogStateObserver (std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface > observer)

void	addMessageObserver (std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)

void	removeMessageObserver (std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)

void	addConnectionObserver (std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface > observer)

void	removeConnectionObserver (std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface > observer)

void	addInternetConnectionObserver (std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer)

void	removeInternetConnectionObserver (std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer)

void	addAlertsObserver (std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer)

void	removeAlertsObserver (std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer)

void	addAudioPlayerObserver (std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer)

void	removeAudioPlayerObserver (std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer)

void	addTemplateRuntimeObserver (std::shared_ptr< templateRuntimeInterfaces::TemplateRuntimeObserverInterface > observer)

void	removeTemplateRuntimeObserver (std::shared_ptr< templateRuntimeInterfaces::TemplateRuntimeObserverInterface > observer)

void	addNotificationsObserver (std::shared_ptr< acsdkNotificationsInterfaces::NotificationsObserverInterface > observer)

void	removeNotificationsObserver (std::shared_ptr< acsdkNotificationsInterfaces::NotificationsObserverInterface > observer)

void	addExternalMediaPlayerObserver (std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer)

void	removeExternalMediaPlayerObserver (std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer)

void	addBluetoothDeviceObserver (std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface > observer)

void	removeBluetoothDeviceObserver (std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface > observer)

void	addCaptionPresenter (std::shared_ptr< captions::CaptionPresenterInterface > presenter)

void	setCaptionMediaPlayers (const std::vector< std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> &mediaPlayers)

std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface >	getPlaybackRouter () const

void	addSpeakerManagerObserver (std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerObserverInterface > observer)

void	removeSpeakerManagerObserver (std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerObserverInterface > observer)

std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface >	getSpeakerManager ()

void	addSpeechSynthesizerObserver (std::shared_ptr< avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface > observer)

void	removeSpeechSynthesizerObserver (std::shared_ptr< avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface > observer)

std::shared_ptr< registrationManager::RegistrationManagerInterface >	getRegistrationManager ()

void	addRegistrationObserver (const std::shared_ptr< registrationManager::RegistrationObserverInterface > &observer)

void	removeRegistrationObserver (const std::shared_ptr< registrationManager::RegistrationObserverInterface > &observer)

std::shared_ptr< acsdkEqualizer::EqualizerController >	getEqualizerController ()

void	addEqualizerControllerListener (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener)

void	removeEqualizerControllerListener (std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener)

void	addContextManagerObserver (std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerObserverInterface > observer)

void	removeContextManagerObserver (std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerObserverInterface > observer)

bool	setFirmwareVersion (avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion firmwareVersion)


bool	configure (const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry) override

void	doShutdown () override

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface
virtual	~SpeechInteractionHandlerInterface ()=default

Public Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientInterface
	FeatureClientInterface (const std::string &name)

virtual bool	configure (const std::shared_ptr< SDKClientRegistry > &sdkClientRegistry)=0

virtual	~FeatureClientInterface ()=default
	Destructor. More...

Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)

virtual	~RequiresShutdown ()
	Destructor. More...

const std::string &	name () const

void	shutdown ()

bool	isShutdown () const

Static Public Member Functions
static std::unique_ptr< DefaultClient >	create (const std::shared_ptr< DefaultClientSubsetManufactory > &manufactory, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > ringtoneMediaPlayer, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface > ringtoneSpeaker, const std::multimap< avsCommon::sdkInterfaces::ChannelVolumeInterface::Type, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >> additionalSpeakers, std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface >> alexaDialogStateObservers, std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface >> connectionObservers, bool isGuiSupported, avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion firmwareVersion=avsCommon::sdkInterfaces::softwareInfo::INVALID_FIRMWARE_VERSION, bool sendSoftwareInfoOnConnected=false, std::shared_ptr< avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface > softwareInfoSenderObserver=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > diagnostics=nullptr, const std::shared_ptr< ExternalCapabilitiesBuilderInterface > &externalCapabilitiesBuilder=nullptr, capabilityAgents::aip::AudioProvider firstInteractionAudioProvider=capabilityAgents::aip::AudioProvider::null(), const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry=nullptr)

static std::unique_ptr< DefaultClient >	create (std::shared_ptr< avsCommon::utils::DeviceInfo > deviceInfo, std::shared_ptr< registrationManager::CustomerDataManagerInterface > customerDataManager, const std::unordered_map< std::string, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> &externalMusicProviderMediaPlayers, const std::unordered_map< std::string, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >> &externalMusicProviderSpeakers, const acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreationMap &adapterCreationMap, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > speakMediaPlayer, std::unique_ptr< avsCommon::utils::mediaPlayer::MediaPlayerFactoryInterface > audioMediaPlayerFactory, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > alertsMediaPlayer, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > notificationsMediaPlayer, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > bluetoothMediaPlayer, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > ringtoneMediaPlayer, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface > systemSoundMediaPlayer, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface > speakSpeaker, std::vector< std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >> audioSpeakers, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface > alertsSpeaker, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface > notificationsSpeaker, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface > bluetoothSpeaker, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface > ringtoneSpeaker, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface > systemSoundSpeaker, const std::multimap< avsCommon::sdkInterfaces::ChannelVolumeInterface::Type, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >> additionalSpeakers, std::shared_ptr< EqualizerRuntimeSetup > equalizerRuntimeSetup, std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface > audioFactory, std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > authDelegate, std::shared_ptr< acsdkAlerts::storage::AlertStorageInterface > alertStorage, std::shared_ptr< certifiedSender::MessageStorageInterface > messageStorage, std::shared_ptr< acsdkNotificationsInterfaces::NotificationsStorageInterface > notificationsStorage, std::shared_ptr< settings::storage::DeviceSettingStorageInterface > deviceSettingStorage, std::shared_ptr< acsdkBluetoothInterfaces::BluetoothStorageInterface > bluetoothStorage, std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > miscStorage, std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface >> alexaDialogStateObservers, std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface >> connectionObservers, std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface > internetConnectionMonitor, bool isGuiSupported, std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface > capabilitiesDelegate, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< alexaClientSDK::acl::TransportFactoryInterface > transportFactory, std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface > avsGatewayManager, std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface > localeAssetsManager, std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface >> enabledConnectionRules=std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface >>(), std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface > systemTimezone=nullptr, avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion firmwareVersion=avsCommon::sdkInterfaces::softwareInfo::INVALID_FIRMWARE_VERSION, bool sendSoftwareInfoOnConnected=false, std::shared_ptr< avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface > softwareInfoSenderObserver=nullptr, std::unique_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface > bluetoothDeviceManager=nullptr, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface > powerResourceManager=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > diagnostics=nullptr, const std::shared_ptr< ExternalCapabilitiesBuilderInterface > &externalCapabilitiesBuilder=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface > channelVolumeFactory=speakerManager::createChannelVolumeFactory(), bool startAlertSchedulingOnInitialization=true, std::shared_ptr< alexaClientSDK::acl::MessageRouterFactoryInterface > messageRouterFactory=std::make_shared< alexaClientSDK::acl::MessageRouterFactory >(), const std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface > &expectSpeechTimeoutHandler=nullptr, capabilityAgents::aip::AudioProvider firstInteractionAudioProvider=capabilityAgents::aip::AudioProvider::null(), const std::shared_ptr< alexaClientSDK::cryptoInterfaces::CryptoFactoryInterface > &cryptoFactory=nullptr, const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry=nullptr)

SpeechInteractionHandlerInterface Methods
std::future< bool >	notifyOfWakeWord (capabilityAgents::aip::AudioProvider wakeWordAudioProvider, avsCommon::avs::AudioInputStream::Index beginIndex, avsCommon::avs::AudioInputStream::Index endIndex, std::string keyword, std::chrono::steady_clock::time_point startOfSpeechTimestamp, std::shared_ptr< const std::vector< char >> KWDMetadata=nullptr) override
	The directive sequencer. More...

std::future< bool >	notifyOfTapToTalk (capabilityAgents::aip::AudioProvider tapToTalkAudioProvider, avsCommon::avs::AudioInputStream::Index beginIndex=capabilityAgents::aip::AudioInputProcessor::INVALID_INDEX, std::chrono::steady_clock::time_point startOfSpeechTimestamp=std::chrono::steady_clock::now()) override
	The directive sequencer. More...

std::future< bool >	notifyOfHoldToTalkStart (capabilityAgents::aip::AudioProvider holdToTalkAudioProvider, std::chrono::steady_clock::time_point startOfSpeechTimestamp=std::chrono::steady_clock::now(), avsCommon::avs::AudioInputStream::Index beginIndex=capabilityAgents::aip::AudioInputProcessor::INVALID_INDEX) override
	The directive sequencer. More...

std::future< bool >	notifyOfHoldToTalkEnd () override
	The directive sequencer. More...

std::future< bool >	notifyOfTapToTalkEnd () override
	The directive sequencer. More...

std::shared_ptr< settings::DeviceSettingsManager >	getSettingsManager ()
	} More...

std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface >	createEndpointBuilder ()

std::future< endpoints::EndpointRegistrationManager::RegistrationResult >	registerEndpoint (std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointInterface > endpoint)

std::future< endpoints::EndpointRegistrationManager::UpdateResult >	updateEndpoint (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointModificationData > &endpointModificationData)

std::future< endpoints::EndpointRegistrationManager::DeregistrationResult >	deregisterEndpoint (avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId)

std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface >	getDefaultEndpointBuilder ()

void	addEndpointRegistrationManagerObserver (const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface > &observer)

void	removeEndpointRegistrationManagerObserver (const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface > &observer)

void	addAudioInputProcessorObserver (const std::shared_ptr< avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface > &observer)

void	removeAudioInputProcessorObserver (const std::shared_ptr< avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface > &observer)

void	addCallStateObserver (std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer)

void	removeCallStateObserver (std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer)

bool	isCommsEnabled ()

void	acceptCommsCall ()

void	sendDtmf (avsCommon::sdkInterfaces::CallManagerInterface::DTMFTone dtmfTone)

void	stopCommsCall ()

void	audioPlayerLocalStop ()

bool	isCommsCallMuted ()

void	muteCommsCall ()

void	unmuteCommsCall ()

void	enableVideo ()

void	disableVideo ()

void	onSystemClockSynchronized ()
	The directive sequencer. More...

void	registerExternalMediaPlayerAdapterHandler (std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface > externalMediaPlayerAdapterHandler)

std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownManagerInterface >	getShutdownManager ()

	~DefaultClient ()

bool	setEncodingAudioFormat (avsCommon::utils::AudioFormat::Encoding encoding)

capabilityAgents::aip::AudioInputProcessor::EncodingFormatResponse	requestEncodingAudioFormats (const capabilityAgents::aip::AudioInputProcessor::EncodingFormatRequest &encodings)

std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface >	getDeviceSetup ()

std::shared_ptr< acsdkBluetoothInterfaces::BluetoothLocalInterface >	getBluetoothLocal ()

void	stopInteraction ()

std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::FocusManagerInterface >	getAudioFocusManager ()

Additional Inherited Members

Detailed Description

This class serves to instantiate each default component with of the SDK with no specializations to provide an "out-of-box" component that users may utilize for AVS interaction.

Member Typedef Documentation

◆ DefaultClientManufactory

◆ DefaultClientSubsetManufactory

Constructor & Destructor Documentation

◆ ~DefaultClient()

alexaClientSDK::defaultClient::DefaultClient::~DefaultClient ( )

Destructor.

Member Function Documentation

◆ acceptCommsCall()

void alexaClientSDK::defaultClient::DefaultClient::acceptCommsCall ( )

Accepts an incoming phone-call.

◆ addAlertsObserver()

void alexaClientSDK::defaultClient::DefaultClient::addAlertsObserver ( std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer )

Adds an observer to be notified of alert state changes.

Parameters

observer The observer to add.

◆ addAlexaDialogStateObserver()

void alexaClientSDK::defaultClient::DefaultClient::addAlexaDialogStateObserver ( std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface > observer )

Adds an observer to be notified of Alexa dialog related UX state.

Parameters

observer The observer to add.

◆ addAudioInputProcessorObserver()

void alexaClientSDK::defaultClient::DefaultClient::addAudioInputProcessorObserver ( const std::shared_ptr< avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface > & observer )

Adds an AudioInputProcessorObserver to be alerted on AudioInputProcessor related state changes.

Parameters

observer The observer to be notified upon AudioInputProcessor related state changes.

◆ addAudioPlayerObserver()

void alexaClientSDK::defaultClient::DefaultClient::addAudioPlayerObserver ( std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer )

Adds an observer to be notified of AudioPlayer state changes. This can be used to be be notified of the PlayerActivity of the AudioPlayer.

Parameters

observer The observer to add.

◆ addBluetoothDeviceObserver()

void alexaClientSDK::defaultClient::DefaultClient::addBluetoothDeviceObserver ( std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface > observer )

Adds an observer to be notified of bluetooth device changes.

Parameters

observer The BluetoothDeviceObserverInterface to add.

◆ addCallStateObserver()

void alexaClientSDK::defaultClient::DefaultClient::addCallStateObserver ( std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer )

Adds an observer to be notified when the call state has changed.

Parameters

observer The observer to add.

◆ addCaptionPresenter()

void alexaClientSDK::defaultClient::DefaultClient::addCaptionPresenter ( std::shared_ptr< captions::CaptionPresenterInterface > presenter )

Adds a presenter responsible for displaying formatted captions content.

Deprecated:: Applications should use the manufactory to create their CaptionPresenterInterface and inject it with the CaptionManagerInterface. See the SampleApplicationComponent for an example.

Parameters

presenter The CaptionPresenterInterface to add.

◆ addConnectionObserver()

void alexaClientSDK::defaultClient::DefaultClient::addConnectionObserver ( std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface > observer )

Adds an observer to be notified of connection status changes.

Parameters

observer The observer to add.

◆ addContextManagerObserver()

void alexaClientSDK::defaultClient::DefaultClient::addContextManagerObserver ( std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerObserverInterface > observer )

Adds a ContextManagerObserver to be notified of Context state changes.

Parameters

observer The observer to be notified of Context state changes.

◆ addEndpointRegistrationManagerObserver()

void alexaClientSDK::defaultClient::DefaultClient::addEndpointRegistrationManagerObserver ( const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface > & observer )

Add observer for endpoint registration manager.

Parameters

observer The observer to add.

◆ addEqualizerControllerListener()

void alexaClientSDK::defaultClient::DefaultClient::addEqualizerControllerListener ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener )

Adds a EqualizerControllerListener to be notified of Equalizer state changes.

Parameters

listener The listener to be notified of Equalizer state changes.

◆ addExternalMediaPlayerObserver()

void alexaClientSDK::defaultClient::DefaultClient::addExternalMediaPlayerObserver ( std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer )

Adds an observer to be notified of ExternalMediaPlayer changes

Parameters

observer The observer to add.

◆ addInternetConnectionObserver()

void alexaClientSDK::defaultClient::DefaultClient::addInternetConnectionObserver ( std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer )

Adds an observer to be notified of internet connection status changes.

Parameters

observer The observer to add.

◆ addMessageObserver()

void alexaClientSDK::defaultClient::DefaultClient::addMessageObserver ( std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer )

Adds an observer to be notified when a message arrives from AVS.

Parameters

observer The observer to add.

◆ addNotificationsObserver()

void alexaClientSDK::defaultClient::DefaultClient::addNotificationsObserver ( std::shared_ptr< acsdkNotificationsInterfaces::NotificationsObserverInterface > observer )

Adds an observer to be notified of IndicatorState changes.

Parameters

observer The observer to add.

◆ addRegistrationObserver()

void alexaClientSDK::defaultClient::DefaultClient::addRegistrationObserver ( const std::shared_ptr< registrationManager::RegistrationObserverInterface > & observer )

Adds an RegistrationObserverInterface to the RegistrationNotifier.

Parameters

observer - The RegistrationObserverInterfaces to be notified of logout events.

◆ addSpeakerManagerObserver()

void alexaClientSDK::defaultClient::DefaultClient::addSpeakerManagerObserver ( std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerObserverInterface > observer )

Adds a SpeakerManagerObserver to be alerted when the volume and mute changes.

Parameters

observer The observer to be notified upon volume and mute changes.

◆ addSpeechSynthesizerObserver()

void alexaClientSDK::defaultClient::DefaultClient::addSpeechSynthesizerObserver ( std::shared_ptr< avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface > observer )

Adds a SpeechSynthesizerObserver to be alerted on SpeechSynthesizer state changes

Parameters

observer The observer to be notified upon the state change

◆ addTemplateRuntimeObserver()

void alexaClientSDK::defaultClient::DefaultClient::addTemplateRuntimeObserver ( std::shared_ptr< templateRuntimeInterfaces::TemplateRuntimeObserverInterface > observer )

Adds an observer to be notified when a TemplateRuntime directive is received.

Parameters

observer The observer to add.

◆ audioPlayerLocalStop()

void alexaClientSDK::defaultClient::DefaultClient::audioPlayerLocalStop ( )

This function stops playback of the current song in the AudioPlayer.

◆ configure()

bool alexaClientSDK::defaultClient::DefaultClient::configure ( const std::shared_ptr< sdkClient::SDKClientRegistry > & sdkClientRegistry )

override

FeatureClientInterface functions

◆ connect()

void alexaClientSDK::defaultClient::DefaultClient::connect ( bool performReset = true )

Connects the client to AVS. After this call, users can observe the state of the connection asynchronously by using a connectionObserver that was passed in to the create() function.

Parameters

performReset True if the client wishes to reset the AVS gateway and clear the previous user's registration status as well on connection.

◆ create() [1/2]

static std::unique_ptr<DefaultClient> alexaClientSDK::defaultClient::DefaultClient::create	(	const std::shared_ptr< DefaultClientSubsetManufactory > &	manufactory,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	ringtoneMediaPlayer,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >	ringtoneSpeaker,
		const std::multimap< avsCommon::sdkInterfaces::ChannelVolumeInterface::Type, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >>	additionalSpeakers,
		std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface >>	alexaDialogStateObservers,
		std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface >>	connectionObservers,
		bool	isGuiSupported,
		avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion	firmwareVersion = `avsCommon::sdkInterfaces::softwareInfo::INVALID_FIRMWARE_VERSION`,
		bool	sendSoftwareInfoOnConnected = `false`,
		std::shared_ptr< avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface >	softwareInfoSenderObserver = `nullptr`,
		std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface >	diagnostics = `nullptr`,
		const std::shared_ptr< ExternalCapabilitiesBuilderInterface > &	externalCapabilitiesBuilder = `nullptr`,
		capabilityAgents::aip::AudioProvider	firstInteractionAudioProvider = `capabilityAgents::aip::AudioProvider::null()`,
		const std::shared_ptr< sdkClient::SDKClientRegistry > &	sdkClientRegistry = `nullptr`
	)

static

Creates and initializes a default AVS SDK client. To connect the client to AVS, users should make a call to connect() after creation.

Parameters

manufactory	`Manufactory` for creating various instances used by DefaultClient.
ringtoneMediaPlayer	The media player to play Comms ringtones.
ringtoneSpeaker	The speaker to control volume of Comms ringtones.
additionalSpeakers	A map of additional speakers to receive volume changes. #ifdef ENABLE_PCC
phoneSpeaker	Interface to speaker for phone calls.
phoneCaller	Interface for making phone calls. #endif #ifdef ENABLE_MCC
meetingSpeaker	Interface to speaker for meetings.
meetingClient	Meeting client for meeting client controller.
calendarClient	Calendar client for meeting client controller. #endif #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
alexaDialogStateObservers	Observers that can be used to be notified of Alexa dialog related UX state changes.
connectionObservers	Observers that can be used to be notified of connection status changes.
isGuiSupported	Whether the device supports GUI.
firmwareVersion	The firmware version to report to `AVS` or `INVALID_FIRMWARE_VERSION`.
sendSoftwareInfoOnConnected	Whether to send SoftwareInfo upon connecting to `AVS`.
softwareInfoSenderObserver	Object to receive notifications about sending SoftwareInfo.
diagnostics	Diagnostics interface which provides suite of APIs for diagnostic insight into SDK.
externalCapabilitiesBuilder	Optional object used to build capabilities that are not included in the SDK.
firstInteractionAudioProvider	Optional object used in the first interaction started from the alexa voice service
sdkClientRegistry	Optional object used when the `SDKClientBuilder` is used to construct DefaultClient

Returns: A std::unique_ptr to a DefaultClient if all went well or nullptr otherwise.

◆ create() [2/2]

static std::unique_ptr<DefaultClient> alexaClientSDK::defaultClient::DefaultClient::create	(	std::shared_ptr< avsCommon::utils::DeviceInfo >	deviceInfo,
		std::shared_ptr< registrationManager::CustomerDataManagerInterface >	customerDataManager,
		const std::unordered_map< std::string, std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> &	externalMusicProviderMediaPlayers,
		const std::unordered_map< std::string, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >> &	externalMusicProviderSpeakers,
		const acsdkExternalMediaPlayer::ExternalMediaPlayer::AdapterCreationMap &	adapterCreationMap,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	speakMediaPlayer,
		std::unique_ptr< avsCommon::utils::mediaPlayer::MediaPlayerFactoryInterface >	audioMediaPlayerFactory,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	alertsMediaPlayer,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	notificationsMediaPlayer,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	bluetoothMediaPlayer,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	ringtoneMediaPlayer,
		std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >	systemSoundMediaPlayer,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >	speakSpeaker,
		std::vector< std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >>	audioSpeakers,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >	alertsSpeaker,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >	notificationsSpeaker,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >	bluetoothSpeaker,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >	ringtoneSpeaker,
		std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >	systemSoundSpeaker,
		const std::multimap< avsCommon::sdkInterfaces::ChannelVolumeInterface::Type, std::shared_ptr< avsCommon::sdkInterfaces::SpeakerInterface >>	additionalSpeakers,
		std::shared_ptr< EqualizerRuntimeSetup >	equalizerRuntimeSetup,
		std::shared_ptr< avsCommon::sdkInterfaces::audio::AudioFactoryInterface >	audioFactory,
		std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface >	authDelegate,
		std::shared_ptr< acsdkAlerts::storage::AlertStorageInterface >	alertStorage,
		std::shared_ptr< certifiedSender::MessageStorageInterface >	messageStorage,
		std::shared_ptr< acsdkNotificationsInterfaces::NotificationsStorageInterface >	notificationsStorage,
		std::shared_ptr< settings::storage::DeviceSettingStorageInterface >	deviceSettingStorage,
		std::shared_ptr< acsdkBluetoothInterfaces::BluetoothStorageInterface >	bluetoothStorage,
		std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface >	miscStorage,
		std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface >>	alexaDialogStateObservers,
		std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface >>	connectionObservers,
		std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionMonitorInterface >	internetConnectionMonitor,
		bool	isGuiSupported,
		std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesDelegateInterface >	capabilitiesDelegate,
		std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >	contextManager,
		std::shared_ptr< alexaClientSDK::acl::TransportFactoryInterface >	transportFactory,
		std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayManagerInterface >	avsGatewayManager,
		std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface >	localeAssetsManager,
		std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface >>	enabledConnectionRules = `std::unordered_set< std::shared_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface >>()`,
		std::shared_ptr< avsCommon::sdkInterfaces::SystemTimeZoneInterface >	systemTimezone = `nullptr`,
		avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion	firmwareVersion = `avsCommon::sdkInterfaces::softwareInfo::INVALID_FIRMWARE_VERSION`,
		bool	sendSoftwareInfoOnConnected = `false`,
		std::shared_ptr< avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface >	softwareInfoSenderObserver = `nullptr`,
		std::unique_ptr< avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface >	bluetoothDeviceManager = `nullptr`,
		std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >	metricRecorder = `nullptr`,
		std::shared_ptr< avsCommon::sdkInterfaces::PowerResourceManagerInterface >	powerResourceManager = `nullptr`,
		std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface >	diagnostics = `nullptr`,
		const std::shared_ptr< ExternalCapabilitiesBuilderInterface > &	externalCapabilitiesBuilder = `nullptr`,
		std::shared_ptr< avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface >	channelVolumeFactory = `speakerManager::createChannelVolumeFactory()`,
		bool	startAlertSchedulingOnInitialization = `true`,
		std::shared_ptr< alexaClientSDK::acl::MessageRouterFactoryInterface >	messageRouterFactory = `std::make_shared< alexaClientSDK::acl::MessageRouterFactory >()`,
		const std::shared_ptr< avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface > &	expectSpeechTimeoutHandler = `nullptr`,
		capabilityAgents::aip::AudioProvider	firstInteractionAudioProvider = `capabilityAgents::aip::AudioProvider::null()`,
		const std::shared_ptr< alexaClientSDK::cryptoInterfaces::CryptoFactoryInterface > &	cryptoFactory = `nullptr`,
		const std::shared_ptr< sdkClient::SDKClientRegistry > &	sdkClientRegistry = `nullptr`
	)

static

Creates and initializes a default AVS SDK client. To connect the client to AVS, users should make a call to connect() after creation.

Deprecated:

Parameters

deviceInfo	DeviceInfo which reflects the device setup credentials.
customerDataManager	CustomerDataManager instance to be used by RegistrationManager and instances of all classes extending CustomDataHandler.
externalMusicProviderMediaPlayers	The map of <players, mediaPlayer> to use to play content from each external music provider.
externalMusicProviderSpeakers	The map of <players, speaker> to use to track volume of each external music provider media player.
adapterCreationMap	The map of <players, adapterCreationMethod> to use when creating the adapters for the different music providers supported by ExternalMediaPlayer.
speakMediaPlayer	The media player to use to play Alexa speech from.
audioMediaPlayerFactory	The media player factory to use to generate players for Alexa audio content.
alertsMediaPlayer	The media player to use to play alerts from.
notificationsMediaPlayer	The media player to play notification indicators.
bluetoothMediaPlayer	The media player to play bluetooth content.
ringtoneMediaPlayer	The media player to play Comms ringtones.
systemSoundMediaPlayer	The media player to play system sounds.
speakSpeaker	The speaker to control volume of Alexa speech.
audioSpeakers	A list of speakers to control volume of Alexa audio content.
alertsSpeaker	The speaker to control volume of alerts.
notificationsSpeaker	The speaker to control volume of notifications.
bluetoothSpeaker	The speaker to control volume of bluetooth.
ringtoneSpeaker	The speaker to control volume of Comms ringtones.
systemSoundSpeaker	The speaker to control volume of system sounds.
additionalSpeakers	A map of additional speakers to receive volume changes. #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
equalizerRuntimeSetup	Equalizer component runtime setup
audioFactory	The audioFactory is a component that provides unique audio streams.
authDelegate	The component that provides the client with valid LWA authorization.
alertStorage	The storage interface that will be used to store alerts.
messageStorage	The storage interface that will be used to store certified sender messages.
notificationsStorage	The storage interface that will be used to store notification indicators.
deviceSettingStorage	The storage interface that will be used to store device settings.
bluetoothStorage	The storage interface that will be used to store bluetooth data.
miscStorage	The storage interface that will be used to store key / value pairs.
alexaDialogStateObservers	Observers that can be used to be notified of Alexa dialog related UX state changes.
connectionObservers	Observers that can be used to be notified of connection status changes.
isGuiSupported	Whether the device supports GUI.
capabilitiesDelegate	The component that provides the client with the ability to send messages to the Capabilities API.
contextManager	The `ContextManager` which will provide the context for various components.
transportFactory	The object passed in here will be used whenever a new transport object for AVS communication is needed.
avsGatewayManager	The `AVSGatewayManager` instance used to create the ApiGateway CA.
localeAssetsManager	The device locale assets manager.
enabledConnectionRules	The set of `BluetoothDeviceConnectionRuleInterface` instances used to create the Bluetooth CA.
systemTimezone	Optional object used to set the system timezone.
firmwareVersion	The firmware version to report to `AVS` or `INVALID_FIRMWARE_VERSION`.
sendSoftwareInfoOnConnected	Whether to send SoftwareInfo upon connecting to `AVS`.
softwareInfoSenderObserver	Object to receive notifications about sending SoftwareInfo.
bluetoothDeviceManager	The `BluetoothDeviceManager` instance used to create the Bluetooth CA.
metricRecorder	The metric recorder object used to capture metrics.
powerResourceManager	Object to manage power resource.
diagnostics	Diagnostics interface which provides suite of APIs for diagnostic insight into SDK.
externalCapabilitiesBuilder	Optional object used to build capabilities that are not included in the SDK.
channelVolumeFactory	Optional object used to build `ChannelVolumeInterface` in the SDK.
startAlertSchedulingOnInitialization	Whether to start scheduling alerts after client initialization. If this is set to false, no alert scheduling will occur until onSystemClockSynchronized is called.
messageRouterFactory	Object used to instantiate `MessageRouter` in the SDK.
expectSpeechTimeoutHandler	An optional object that applications may provide to specify external handling of the `ExpectSpeech` directive's timeout. If provided, this function must remain valid for the lifetime of the `AudioInputProcessor`.
firstInteractionAudioProvider	Optional object used in the first interaction started from the alexa voice service
cryptoFactory	Optional Encryption facilities factory.
sdkClientRegistry	Optional object used when the `SDKClientBuilder` is used to construct DefaultClient

Returns: A std::unique_ptr to a DefaultClient if all went well or nullptr otherwise.

◆ createEndpointBuilder()

std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface> alexaClientSDK::defaultClient::DefaultClient::createEndpointBuilder ( )

Creates an endpoint builder which can be used to configure a new endpoint.

Note: Endpoints must be registered with the Endpoint Registration Manager to be controlled by the device.

Returns: An endpoint builder.

◆ deregisterEndpoint()

std::future<endpoints::EndpointRegistrationManager::DeregistrationResult> alexaClientSDK::defaultClient::DefaultClient::deregisterEndpoint ( avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId )

Deregisters an endpoint with the EndpointRegistrationManagerInterface.

Parameters

endpointId The EndpointIdentifier of the endpoint to deregister.

Returns: A future that will resolve to the DeregistratonResult for deregistering this endpoint.

◆ disableVideo()

void alexaClientSDK::defaultClient::DefaultClient::disableVideo ( )

Disable the video of local device in an active call.

◆ disconnect()

void alexaClientSDK::defaultClient::DefaultClient::disconnect ( )

Disconnects the client from AVS if it is connected. After the call, users can observer the state of the connection asynchronously by using a connectionObserver that was passed in to the create() function.

◆ doShutdown()

void alexaClientSDK::defaultClient::DefaultClient::doShutdown ( )

overridevirtual

FeatureClientInterface functions

Implements alexaClientSDK::avsCommon::utils::RequiresShutdown.

◆ enableVideo()

void alexaClientSDK::defaultClient::DefaultClient::enableVideo ( )

Enable the video of local device in an active call.

◆ getAudioFocusManager()

std::shared_ptr<alexaClientSDK::avsCommon::sdkInterfaces::FocusManagerInterface> alexaClientSDK::defaultClient::DefaultClient::getAudioFocusManager ( )

Get a reference to the audio focus manager

Returns: shared_ptr to the audio FocusManagerInterface, callers should perform a nullptr check as the returned pointer may be null

◆ getAVSGateway()

std::string alexaClientSDK::defaultClient::DefaultClient::getAVSGateway ( )

Get the gateway URL for the AVS connection.

Returns: The URL for the current AVS gateway.

◆ getBluetoothLocal()

std::shared_ptr<acsdkBluetoothInterfaces::BluetoothLocalInterface> alexaClientSDK::defaultClient::DefaultClient::getBluetoothLocal ( )

Gets the BluetoothLocalInterface for local applications that wish to invoke Bluetooth functionality.

Returns: A shared_ptr to the BluetoothLocalInterface.

◆ getDefaultEndpointBuilder()

std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface> alexaClientSDK::defaultClient::DefaultClient::getDefaultEndpointBuilder ( )

Retrieves the builder for the default endpoint which contains all capabilities associated with this client.

This builder can be used to add extra capabilities to the default endpoint.

Returns: The default endpoint builder.

Warning: The default endpoint can only be configured before you call connect(). Adding new components after the client has been connected will fail.

◆ getDeviceSetup()

std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface> alexaClientSDK::defaultClient::DefaultClient::getDeviceSetup ( )

Gets the DeviceSetupInterface for when it is time to send the DeviceSetupComplete event to AVS.

This method is required to support legacy applications that have not transitioned to fully integrating the manufactory.

Returns: A shared_ptr to the DeviceSetupInterface.

◆ getEqualizerController()

std::shared_ptr<acsdkEqualizer::EqualizerController> alexaClientSDK::defaultClient::DefaultClient::getEqualizerController ( )

Get a shared_ptr to the EqualizerController.

Note: Be sure to release all references to the returned EqualizerController before releasing the last reference to the DefaultClient.

Returns: shared_ptr to the EqualizerController.

◆ getPlaybackRouter()

std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface> alexaClientSDK::defaultClient::DefaultClient::getPlaybackRouter ( ) const

◆ getRegistrationManager()

std::shared_ptr<registrationManager::RegistrationManagerInterface> alexaClientSDK::defaultClient::DefaultClient::getRegistrationManager ( )

Get a shared_ptr to the RegistrationManager.

Returns: shared_ptr to the RegistrationManager.

◆ getSettingsManager()

std::shared_ptr<settings::DeviceSettingsManager> alexaClientSDK::defaultClient::DefaultClient::getSettingsManager ( )

}

Retrieves the device settings manager which can be used to access device settings.

Returns: Pointer to the device settings manager.

◆ getShutdownManager()

std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> alexaClientSDK::defaultClient::DefaultClient::getShutdownManager ( )

Gets the ShutdownManagerInterface for when it is time to shut down the SDK.

This method is required to support legacy applications that have not transitioned to fully integrating the manufactory.

Returns: A shared_ptr to the ShutdownManagerInterface.

◆ getSpeakerManager()

std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface> alexaClientSDK::defaultClient::DefaultClient::getSpeakerManager ( )

Get a shared_ptr to the SpeakerManager.

Returns: shared_ptr to the SpeakerManager.

◆ isCommsCallMuted()

bool alexaClientSDK::defaultClient::DefaultClient::isCommsCallMuted ( )

Check if the Comms call is muted.

Returns: Whether the comms call is muted.

◆ isCommsEnabled()

bool alexaClientSDK::defaultClient::DefaultClient::isCommsEnabled ( )

Lets the caller know if Comms is enabled.

Returns: True if comms is enabled.

◆ localStopActiveAlert()

void alexaClientSDK::defaultClient::DefaultClient::localStopActiveAlert ( )

This function provides a way for application code to request this object stop any active alert as the result of a user action, such as pressing a physical 'stop' button on the device.

◆ muteCommsCall()

void alexaClientSDK::defaultClient::DefaultClient::muteCommsCall ( )

Mute comms Call.

◆ notifyOfHoldToTalkEnd()

std::future<bool> alexaClientSDK::defaultClient::DefaultClient::notifyOfHoldToTalkEnd ( )

overridevirtual

The directive sequencer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface.

◆ notifyOfHoldToTalkStart()

std::future<bool> alexaClientSDK::defaultClient::DefaultClient::notifyOfHoldToTalkStart	(	capabilityAgents::aip::AudioProvider	holdToTalkAudioProvider,
		std::chrono::steady_clock::time_point	startOfSpeechTimestamp = `std::chrono::steady_clock::now()`,
		avsCommon::avs::AudioInputStream::Index	beginIndex = `capabilityAgents::aip::AudioInputProcessor::INVALID_INDEX`
	)

overridevirtual

The directive sequencer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface.

◆ notifyOfTapToTalk()

std::future<bool> alexaClientSDK::defaultClient::DefaultClient::notifyOfTapToTalk	(	capabilityAgents::aip::AudioProvider	tapToTalkAudioProvider,
		avsCommon::avs::AudioInputStream::Index	beginIndex = `capabilityAgents::aip::AudioInputProcessor::INVALID_INDEX`,
		std::chrono::steady_clock::time_point	startOfSpeechTimestamp = `std::chrono::steady_clock::now()`
	)

overridevirtual

The directive sequencer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface.

◆ notifyOfTapToTalkEnd()

std::future<bool> alexaClientSDK::defaultClient::DefaultClient::notifyOfTapToTalkEnd ( )

overridevirtual

The directive sequencer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface.

◆ notifyOfWakeWord()

std::future<bool> alexaClientSDK::defaultClient::DefaultClient::notifyOfWakeWord	(	capabilityAgents::aip::AudioProvider	wakeWordAudioProvider,
		avsCommon::avs::AudioInputStream::Index	beginIndex,
		avsCommon::avs::AudioInputStream::Index	endIndex,
		std::string	keyword,
		std::chrono::steady_clock::time_point	startOfSpeechTimestamp,
		std::shared_ptr< const std::vector< char >>	KWDMetadata = `nullptr`
	)

overridevirtual

The directive sequencer.

Implements alexaClientSDK::avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface.

◆ onSystemClockSynchronized()

void alexaClientSDK::defaultClient::DefaultClient::onSystemClockSynchronized ( )

The directive sequencer.

◆ registerEndpoint()

std::future<endpoints::EndpointRegistrationManager::RegistrationResult> alexaClientSDK::defaultClient::DefaultClient::registerEndpoint ( std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointInterface > endpoint )

Registers an endpoint with the EndpointRegistrationManagerInterface.

Parameters

endpoint A pointer to the EndpointInterface to be registered.

Returns: A future that will resolve to the RegistrationResult for registering this endpoint.

◆ registerExternalMediaPlayerAdapterHandler()

void alexaClientSDK::defaultClient::DefaultClient::registerExternalMediaPlayerAdapterHandler ( std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface > externalMediaPlayerAdapterHandler )

Register an ExternalMediaPlayerAdapterHandler with the ExternalMediaPlayer CA Multiple adapter handlers can be added to the ExternalMediaPlayer by repeatedly calling this function.

Parameters

externalMediaPlayerAdapterHandler Pointer to the EMPAdapterHandler to register

◆ removeAlertsObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeAlertsObserver ( std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer )

Removes an observer to be notified of alert state changes.

Parameters

observer The observer to remove.

◆ removeAlexaDialogStateObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeAlexaDialogStateObserver ( std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface > observer )

Removes an observer to be notified of Alexa dialog related UX state.

Note: This is a synchronous call which can not be made by an observer callback. Attempting to call removeObserver() from DialogUXStateObserverInterface::onDialogUXStateChanged() will result in a deadlock.

Parameters

observer The observer to remove.

◆ removeAudioInputProcessorObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeAudioInputProcessorObserver ( const std::shared_ptr< avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface > & observer )

Removes an AudioInputProcessorObserver to be alerted on AudioInputProcessor related state changes.

Parameters

observer The observer to be removed as an AudioInputProcessor observer.

◆ removeAudioPlayerObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeAudioPlayerObserver ( std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer )

Removes an observer to be notified of AudioPlayer state changes.

Parameters

observer The observer to remove.

◆ removeBluetoothDeviceObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeBluetoothDeviceObserver ( std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface > observer )

Removes an observer to be notified of bluetooth device changes.

Parameters

observer The BluetoothDeviceObserverInterface to remove.

◆ removeCallStateObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeCallStateObserver ( std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer )

Removes an observer to be notified when the call state has changed.

Parameters

observer The observer to remove.

◆ removeConnectionObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeConnectionObserver ( std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface > observer )

Removes an observer to be notified of connection status changes.

Parameters

observer The observer to remove.

◆ removeContextManagerObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeContextManagerObserver ( std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerObserverInterface > observer )

Removes a ContextManagerObserver to be notified of Context state changes.

Parameters

observer The observer to no longer be notified of Context state changes.

◆ removeEndpointRegistrationManagerObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeEndpointRegistrationManagerObserver ( const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface > & observer )

Removes observer for endpoint registration manager.

Parameters

observer The observer to remove.

◆ removeEqualizerControllerListener()

void alexaClientSDK::defaultClient::DefaultClient::removeEqualizerControllerListener ( std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener )

Removes a EqualizerControllerListener to be notified of Equalizer state changes.

Parameters

listener The listener to no longer be notified of Equalizer state changes.

◆ removeExternalMediaPlayerObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeExternalMediaPlayerObserver ( std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer )

Removes an observer to be notified of ExternalMediaPlayer changes.

Parameters

observer The observer to remove.

◆ removeInternetConnectionObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeInternetConnectionObserver ( std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer )

Removes an observer to be notified of internet connection status changes.

Parameters

observer The observer to remove.

◆ removeMessageObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeMessageObserver ( std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer )

Removes an observer to be notified when a message arrives from AVS.

Parameters

observer The observer to remove.

◆ removeNotificationsObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeNotificationsObserver ( std::shared_ptr< acsdkNotificationsInterfaces::NotificationsObserverInterface > observer )

Removes an observer to be notified of IndicatorState changes.

Parameters

observer The observer to remove.

◆ removeRegistrationObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeRegistrationObserver ( const std::shared_ptr< registrationManager::RegistrationObserverInterface > & observer )

Removes an RegistrationObserverInterface to the RegistrationNotifier.

Parameters

observer - The RegistrationObserverInterfaces to be notified of logout events.

◆ removeSpeakerManagerObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeSpeakerManagerObserver ( std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerObserverInterface > observer )

Removes a SpeakerManagerObserver from being alerted when the volume and mute changes.

Parameters

observer The observer to be notified upon volume and mute changes.

◆ removeSpeechSynthesizerObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeSpeechSynthesizerObserver ( std::shared_ptr< avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface > observer )

Removes a SpeechSynthesizerObserver from being alerted on SpeechSynthesizer state changes

Parameters

observer The observer to be removed

◆ removeTemplateRuntimeObserver()

void alexaClientSDK::defaultClient::DefaultClient::removeTemplateRuntimeObserver ( std::shared_ptr< templateRuntimeInterfaces::TemplateRuntimeObserverInterface > observer )

Removes an observer to be notified when a TemplateRuntime directive is received.

Parameters

observer The observer to remove.

◆ requestEncodingAudioFormats()

capabilityAgents::aip::AudioInputProcessor::EncodingFormatResponse alexaClientSDK::defaultClient::DefaultClient::requestEncodingAudioFormats ( const capabilityAgents::aip::AudioInputProcessor::EncodingFormatRequest & encodings )

Request for multiple audio streams with provided encodings for a single Recognize event. Calling this function will override any previous encoding specified by a call to setEncodingAudioFormat()

Parameters

encodings Encoding formats to use for audio streams.

Returns: Result with encodings confirmed in request.

◆ sendDtmf()

void alexaClientSDK::defaultClient::DefaultClient::sendDtmf ( avsCommon::sdkInterfaces::CallManagerInterface::DTMFTone dtmfTone )

Send dtmf tones during the call.

Parameters

dtmfTone The signal of the dtmf message.

◆ setCaptionMediaPlayers()

void alexaClientSDK::defaultClient::DefaultClient::setCaptionMediaPlayers ( const std::vector< std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> & mediaPlayers )

Sets the media players that can produce or control captioned content.

Deprecated:: Applications should use an ApplicationAudioPipelineFactoryInterface to instantiate media players and register them with the CaptionManager when they transition to the manufactory (e.g. see GstreamerAudioPipelineFactory).

Parameters

mediaPlayers The MediaPlayerInterface instances to add.

◆ setEncodingAudioFormat()

bool alexaClientSDK::defaultClient::DefaultClient::setEncodingAudioFormat ( avsCommon::utils::AudioFormat::Encoding encoding )

Set encoding for the audio format. The new encoding will be used for future utterances. Any audio stream already in progress will not be affected.

Parameters

encoding The encoding format to use.

Returns: on success, false on failure to set the encoding.

◆ setFirmwareVersion()

bool alexaClientSDK::defaultClient::DefaultClient::setFirmwareVersion ( avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion firmwareVersion )

Update the firmware version.

Parameters

firmwareVersion The new firmware version.

Returns: Whether the setting was accepted.

◆ stopAllActivities()

void alexaClientSDK::defaultClient::DefaultClient::stopAllActivities ( )

Stops all active channels/activities if there are any(has acquired focus atleast once). This acts as a "stop" button that can be used to stop all ongoing activities. This call will block until all the activities has stopped. There is a possibility of race condition of some activity about to start when this API is invoked.

◆ stopCommsCall()

void alexaClientSDK::defaultClient::DefaultClient::stopCommsCall ( )

Stops a phone-call.

◆ stopForegroundActivity()

void alexaClientSDK::defaultClient::DefaultClient::stopForegroundActivity ( )

Stops the foreground activity if there is one. This acts as a "stop" button that can be used to stop an ongoing activity. This call will block until the foreground activity has stopped all user-observable activities.

◆ stopInteraction()

void alexaClientSDK::defaultClient::DefaultClient::stopInteraction ( )

Stops any ongoing interaction with the SDK by resetting the state of the AudioInputProcessor.

This method is intended for use when a device needs to stop the current user interaction with alexa, for example when the audio input state needs to be returned to idle as a result of an event such as a back or exit button press. Calling this method has no effect on ongoing Alexa speech, audio playback or visual state.

◆ unmuteCommsCall()

void alexaClientSDK::defaultClient::DefaultClient::unmuteCommsCall ( )

Unmute Comms call.

◆ updateEndpoint()

std::future<endpoints::EndpointRegistrationManager::UpdateResult> alexaClientSDK::defaultClient::DefaultClient::updateEndpoint	(	const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &	endpointId,
		const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointModificationData > &	endpointModificationData
	)

Updates an endpoint with the EndpointRegistrationManagerInterface.

Parameters

endpointId	The `EndpointIdentifier` of the endpoint to update.
endpointModificationData	A pointer to the `endpointModificationData` to be updated.

Returns: A future that will resolve to the UpdateResult for updating this endpoint.

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

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

Public Types

Public Member Functions

Static Public Member Functions

SpeechInteractionHandlerInterface Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DefaultClientManufactory

◆ DefaultClientSubsetManufactory

Constructor & Destructor Documentation

◆ ~DefaultClient()

Member Function Documentation

◆ acceptCommsCall()

◆ addAlertsObserver()

◆ addAlexaDialogStateObserver()

◆ addAudioInputProcessorObserver()

◆ addAudioPlayerObserver()

◆ addBluetoothDeviceObserver()

◆ addCallStateObserver()

◆ addCaptionPresenter()

◆ addConnectionObserver()

◆ addContextManagerObserver()

◆ addEndpointRegistrationManagerObserver()

◆ addEqualizerControllerListener()

◆ addExternalMediaPlayerObserver()

◆ addInternetConnectionObserver()

◆ addMessageObserver()

◆ addNotificationsObserver()

◆ addRegistrationObserver()

◆ addSpeakerManagerObserver()

◆ addSpeechSynthesizerObserver()

◆ addTemplateRuntimeObserver()

◆ audioPlayerLocalStop()

◆ configure()

◆ connect()

◆ create() [1/2]

◆ create() [2/2]

◆ createEndpointBuilder()

◆ deregisterEndpoint()

◆ disableVideo()

◆ disconnect()

◆ doShutdown()

◆ enableVideo()

◆ getAudioFocusManager()

◆ getAVSGateway()

◆ getBluetoothLocal()

◆ getDefaultEndpointBuilder()

◆ getDeviceSetup()

◆ getEqualizerController()

◆ getPlaybackRouter()

◆ getRegistrationManager()

◆ getSettingsManager()

◆ getShutdownManager()

◆ getSpeakerManager()

◆ isCommsCallMuted()

◆ isCommsEnabled()

◆ localStopActiveAlert()

◆ muteCommsCall()

◆ notifyOfHoldToTalkEnd()

◆ notifyOfHoldToTalkStart()

◆ notifyOfTapToTalk()

◆ notifyOfTapToTalkEnd()

◆ notifyOfWakeWord()

◆ onSystemClockSynchronized()

◆ registerEndpoint()

◆ registerExternalMediaPlayerAdapterHandler()

◆ removeAlertsObserver()

◆ removeAlexaDialogStateObserver()

◆ removeAudioInputProcessorObserver()

◆ removeAudioPlayerObserver()

◆ removeBluetoothDeviceObserver()

◆ removeCallStateObserver()

◆ removeConnectionObserver()

◆ removeContextManagerObserver()

◆ removeEndpointRegistrationManagerObserver()

◆ removeEqualizerControllerListener()

◆ removeExternalMediaPlayerObserver()

◆ removeInternetConnectionObserver()

◆ removeMessageObserver()

◆ removeNotificationsObserver()