AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
DefaultClient.h
Go to the documentation of this file.
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  * http://aws.amazon.com/apache2.0/
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 #ifndef ALEXA_CLIENT_SDK_APPLICATIONUTILITIES_DEFAULTCLIENT_INCLUDE_DEFAULTCLIENT_DEFAULTCLIENT_H_
17 #define ALEXA_CLIENT_SDK_APPLICATIONUTILITIES_DEFAULTCLIENT_INCLUDE_DEFAULTCLIENT_DEFAULTCLIENT_H_
18 
24 #include <AIP/AudioProvider.h>
94 
95 #ifdef ENABLE_PCC
96 #include <AVSCommon/SDKInterfaces/Phone/PhoneCallerInterface.h>
97 #include <PhoneCallController/PhoneCallController.h>
98 #endif
99 
100 #ifdef ENABLE_MCC
101 #include <AVSCommon/SDKInterfaces/Calendar/CalendarClientInterface.h>
102 #include <AVSCommon/SDKInterfaces/Meeting/MeetingClientInterface.h>
103 #include <MeetingClientController/MeetingClientController.h>
104 #endif
105 
108 #include <Endpoints/Endpoint.h>
124 
125 #ifdef ENABLE_REVOKE_AUTH
127 #endif
128 
132 
133 namespace alexaClientSDK {
134 namespace defaultClient {
135 
141 public:
143  std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface>,
144  std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface>,
145  std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerInterface>,
146  std::shared_ptr<acsdkBluetoothInterfaces::BluetoothNotifierInterface>,
147  std::shared_ptr<acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface>,
148  std::shared_ptr<acsdkExternalMediaPlayer::ExternalMediaPlayer>,
149  std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface>,
150  std::shared_ptr<acsdkInteractionModelInterfaces::InteractionModelNotifierInterface>,
151  std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface>,
152  std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface>,
153  std::shared_ptr<acsdkStartupManagerInterfaces::StartupManagerInterface>,
154  std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface>,
155  std::shared_ptr<avsCommon::sdkInterfaces::DirectiveSequencerInterface>,
156  std::shared_ptr<afml::interruptModel::InterruptModel>,
157  std::shared_ptr<avsCommon::avs::DialogUXStateAggregator>,
158  std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface>,
159  std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>,
160  std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface>,
161  std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayManagerInterface>,
162  std::shared_ptr<avsCommon::sdkInterfaces::CapabilitiesDelegateInterface>,
163  std::shared_ptr<avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface>,
164  std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>,
165  std::shared_ptr<avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface>,
166  std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>,
167  acsdkManufactory::
168  Annotated<avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>,
169  acsdkManufactory::
170  Annotated<avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>,
171  std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface>,
172  std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface>,
173  std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>,
174  std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface>,
175  std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface>,
176  std::shared_ptr<avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface>,
177  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface>,
178  std::shared_ptr<avsCommon::sdkInterfaces::SystemSoundPlayerInterface>,
179  std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface>,
180  std::shared_ptr<avsCommon::sdkInterfaces::UserInactivityMonitorInterface>,
181  std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>,
185  std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface>,
186  std::shared_ptr<avsCommon::utils::DeviceInfo>,
187  std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>,
188  std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>,
189  std::shared_ptr<capabilityAgents::alexa::AlexaInterfaceMessageSender>,
190  std::shared_ptr<capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent>,
191  std::shared_ptr<captions::CaptionManagerInterface>,
192  std::shared_ptr<certifiedSender::CertifiedSender>,
193  std::shared_ptr<registrationManager::CustomerDataManagerInterface>,
194  std::shared_ptr<registrationManager::RegistrationManagerInterface>,
195  std::shared_ptr<registrationManager::RegistrationNotifierInterface>,
196  std::shared_ptr<settings::DeviceSettingsManager>,
197  std::shared_ptr<settings::storage::DeviceSettingStorageInterface>,
198  std::shared_ptr<speechencoder::SpeechEncoder>,
199  std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface>>;
200 
202  std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface>,
203  std::shared_ptr<acsdkApplicationAudioPipelineFactoryInterfaces::ApplicationAudioPipelineFactoryInterface>,
204  std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerInterface>,
205  std::shared_ptr<acsdkBluetoothInterfaces::BluetoothNotifierInterface>,
206  std::shared_ptr<acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface>,
207  std::shared_ptr<acsdkExternalMediaPlayer::ExternalMediaPlayer>,
208  std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface>,
209  std::shared_ptr<acsdkInteractionModelInterfaces::InteractionModelNotifierInterface>,
210  std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface>,
211  std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface>,
212  std::shared_ptr<acsdkStartupManagerInterfaces::StartupManagerInterface>,
213  std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface>,
214  std::shared_ptr<avsCommon::sdkInterfaces::DirectiveSequencerInterface>,
215  std::shared_ptr<afml::interruptModel::InterruptModel>,
216  std::shared_ptr<avsCommon::avs::DialogUXStateAggregator>,
217  std::shared_ptr<avsCommon::avs::attachment::AttachmentManagerInterface>,
218  std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>,
219  std::shared_ptr<avsCommon::sdkInterfaces::AVSConnectionManagerInterface>,
220  std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayManagerInterface>,
221  std::shared_ptr<avsCommon::sdkInterfaces::CapabilitiesDelegateInterface>,
222  std::shared_ptr<avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface>,
223  std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface>,
224  std::shared_ptr<avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface>,
225  std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface>,
226  acsdkManufactory::
227  Annotated<avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>,
228  acsdkManufactory::
229  Annotated<avsCommon::sdkInterfaces::VisualFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface>,
230  std::shared_ptr<avsCommon::sdkInterfaces::HTTPContentFetcherInterfaceFactoryInterface>,
231  std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface>,
232  std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface>,
233  std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface>,
234  std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface>,
235  std::shared_ptr<avsCommon::sdkInterfaces::RenderPlayerInfoCardsProviderRegistrarInterface>,
236  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface>,
237  std::shared_ptr<avsCommon::sdkInterfaces::SystemSoundPlayerInterface>,
238  std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface>,
239  std::shared_ptr<avsCommon::sdkInterfaces::UserInactivityMonitorInterface>,
240  std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface>,
243  avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface>,
244  std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface>,
245  std::shared_ptr<avsCommon::utils::DeviceInfo>,
246  std::shared_ptr<avsCommon::utils::configuration::ConfigurationNode>,
247  std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>,
248  std::shared_ptr<capabilityAgents::alexa::AlexaInterfaceMessageSender>,
249  std::shared_ptr<capabilityAgents::doNotDisturb::DoNotDisturbCapabilityAgent>,
250  std::shared_ptr<captions::CaptionManagerInterface>,
251  std::shared_ptr<certifiedSender::CertifiedSender>,
252  std::shared_ptr<registrationManager::CustomerDataManagerInterface>,
253  std::shared_ptr<registrationManager::RegistrationManagerInterface>,
254  std::shared_ptr<registrationManager::RegistrationNotifierInterface>,
255  std::shared_ptr<settings::DeviceSettingsManager>,
256  std::shared_ptr<settings::storage::DeviceSettingStorageInterface>,
257  std::shared_ptr<speechencoder::SpeechEncoder>,
258  std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface>>;
259 
295  static std::unique_ptr<DefaultClient> create(
296  const std::shared_ptr<DefaultClientSubsetManufactory>& manufactory,
297  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> ringtoneMediaPlayer,
298  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> ringtoneSpeaker,
299  const std::multimap<
301  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface>> additionalSpeakers,
302 #ifdef ENABLE_PCC
303  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> phoneSpeaker,
304  std::shared_ptr<avsCommon::sdkInterfaces::phone::PhoneCallerInterface> phoneCaller,
305 #endif
306 #ifdef ENABLE_MCC
307  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> meetingSpeaker,
308  std::shared_ptr<avsCommon::sdkInterfaces::meeting::MeetingClientInterface> meetingClient,
309  std::shared_ptr<avsCommon::sdkInterfaces::calendar::CalendarClientInterface> calendarClient,
310 #endif
311 #ifdef ENABLE_COMMS_AUDIO_PROXY
312  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> commsMediaPlayer,
313  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> commsSpeaker,
314  std::shared_ptr<alexaClientSDK::avsCommon::avs::AudioInputStream> sharedDataStream,
315 #endif
316  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::DialogUXStateObserverInterface>>
317  alexaDialogStateObservers,
318  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface>>
319  connectionObservers,
320  bool isGuiSupported,
323  bool sendSoftwareInfoOnConnected = false,
324  std::shared_ptr<avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface> softwareInfoSenderObserver =
325  nullptr,
326  std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface> diagnostics = nullptr,
327  const std::shared_ptr<ExternalCapabilitiesBuilderInterface>& externalCapabilitiesBuilder = nullptr,
328  capabilityAgents::aip::AudioProvider firstInteractionAudioProvider =
330 
407  static std::unique_ptr<DefaultClient> create(
408  std::shared_ptr<avsCommon::utils::DeviceInfo> deviceInfo,
409  std::shared_ptr<registrationManager::CustomerDataManagerInterface> customerDataManager,
410  const std::unordered_map<std::string, std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>>&
411  externalMusicProviderMediaPlayers,
412  const std::unordered_map<std::string, std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface>>&
413  externalMusicProviderSpeakers,
415  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> speakMediaPlayer,
416  std::unique_ptr<avsCommon::utils::mediaPlayer::MediaPlayerFactoryInterface> audioMediaPlayerFactory,
417  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> alertsMediaPlayer,
418  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> notificationsMediaPlayer,
419  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> bluetoothMediaPlayer,
420  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> ringtoneMediaPlayer,
421  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> systemSoundMediaPlayer,
422  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> speakSpeaker,
423  std::vector<std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface>> audioSpeakers,
424  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> alertsSpeaker,
425  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> notificationsSpeaker,
426  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> bluetoothSpeaker,
427  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> ringtoneSpeaker,
428  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> systemSoundSpeaker,
429  const std::multimap<
431  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface>> additionalSpeakers,
432 #ifdef ENABLE_PCC
433  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> phoneSpeaker,
434  std::shared_ptr<avsCommon::sdkInterfaces::phone::PhoneCallerInterface> phoneCaller,
435 #endif
436 #ifdef ENABLE_MCC
437  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> meetingSpeaker,
438  std::shared_ptr<avsCommon::sdkInterfaces::meeting::MeetingClientInterface> meetingClient,
439  std::shared_ptr<avsCommon::sdkInterfaces::calendar::CalendarClientInterface> calendarClient,
440 #endif
441 #ifdef ENABLE_COMMS_AUDIO_PROXY
442  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> commsMediaPlayer,
443  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> commsSpeaker,
444  std::shared_ptr<alexaClientSDK::avsCommon::avs::AudioInputStream> sharedDataStream,
445 #endif
446  std::shared_ptr<EqualizerRuntimeSetup> equalizerRuntimeSetup,
447  std::shared_ptr<avsCommon::sdkInterfaces::audio::AudioFactoryInterface> audioFactory,
448  std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> authDelegate,
449  std::shared_ptr<acsdkAlerts::storage::AlertStorageInterface> alertStorage,
450  std::shared_ptr<certifiedSender::MessageStorageInterface> messageStorage,
451  std::shared_ptr<acsdkNotificationsInterfaces::NotificationsStorageInterface> notificationsStorage,
452  std::unique_ptr<settings::storage::DeviceSettingStorageInterface> deviceSettingStorage,
453  std::shared_ptr<acsdkBluetoothInterfaces::BluetoothStorageInterface> bluetoothStorage,
454  std::shared_ptr<avsCommon::sdkInterfaces::storage::MiscStorageInterface> miscStorage,
455  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::DialogUXStateObserverInterface>>
456  alexaDialogStateObservers,
457  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface>>
458  connectionObservers,
459  std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface> internetConnectionMonitor,
460  bool isGuiSupported,
461  std::shared_ptr<avsCommon::sdkInterfaces::CapabilitiesDelegateInterface> capabilitiesDelegate,
462  std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> contextManager,
463  std::shared_ptr<alexaClientSDK::acl::TransportFactoryInterface> transportFactory,
464  std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayManagerInterface> avsGatewayManager,
465  std::shared_ptr<avsCommon::sdkInterfaces::LocaleAssetsManagerInterface> localeAssetsManager,
466  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface>>
467  enabledConnectionRules = std::unordered_set<
468  std::shared_ptr<avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceConnectionRuleInterface>>(),
469  std::shared_ptr<avsCommon::sdkInterfaces::SystemTimeZoneInterface> systemTimezone = nullptr,
472  bool sendSoftwareInfoOnConnected = false,
473  std::shared_ptr<avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface> softwareInfoSenderObserver =
474  nullptr,
475  std::unique_ptr<avsCommon::sdkInterfaces::bluetooth::BluetoothDeviceManagerInterface> bluetoothDeviceManager =
476  nullptr,
477  std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> metricRecorder = nullptr,
478  std::shared_ptr<avsCommon::sdkInterfaces::PowerResourceManagerInterface> powerResourceManager = nullptr,
479  std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface> diagnostics = nullptr,
480  const std::shared_ptr<ExternalCapabilitiesBuilderInterface>& externalCapabilitiesBuilder = nullptr,
481  std::shared_ptr<avsCommon::sdkInterfaces::ChannelVolumeFactoryInterface> channelVolumeFactory =
482  std::make_shared<alexaClientSDK::capabilityAgents::speakerManager::DefaultChannelVolumeFactory>(),
483  bool startAlertSchedulingOnInitialization = true,
484  std::shared_ptr<alexaClientSDK::acl::MessageRouterFactoryInterface> messageRouterFactory =
485  std::make_shared<alexaClientSDK::acl::MessageRouterFactory>(),
486  const std::shared_ptr<avsCommon::sdkInterfaces::ExpectSpeechTimeoutHandlerInterface>&
487  expectSpeechTimeoutHandler = nullptr,
488  capabilityAgents::aip::AudioProvider firstInteractionAudioProvider =
490 
499  void connect(bool performReset = true);
500 
505  void disconnect();
506 
512  std::string getAVSGateway();
513 
518  void stopForegroundActivity();
519 
525  void stopAllActivities();
526 
531  void localStopActiveAlert();
532 
539  std::shared_ptr<avsCommon::sdkInterfaces::DialogUXStateObserverInterface> observer);
540 
551  std::shared_ptr<avsCommon::sdkInterfaces::DialogUXStateObserverInterface> observer);
552 
558  void addMessageObserver(std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface> observer);
559 
565  void removeMessageObserver(std::shared_ptr<avsCommon::sdkInterfaces::MessageObserverInterface> observer);
566 
572  void addConnectionObserver(std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface> observer);
573 
580  std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface> observer);
581 
588  std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionObserverInterface> observer);
589 
596  std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionObserverInterface> observer);
597 
603  void addAlertsObserver(std::shared_ptr<acsdkAlertsInterfaces::AlertObserverInterface> observer);
604 
610  void removeAlertsObserver(std::shared_ptr<acsdkAlertsInterfaces::AlertObserverInterface> observer);
611 
618  void addAudioPlayerObserver(std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface> observer);
619 
625  void removeAudioPlayerObserver(std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface> observer);
626 
633  std::shared_ptr<avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface> observer);
634 
641  std::shared_ptr<avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface> observer);
642 
647 
654  std::shared_ptr<acsdkNotificationsInterfaces::NotificationsObserverInterface> observer);
655 
662  std::shared_ptr<acsdkNotificationsInterfaces::NotificationsObserverInterface> observer);
663 
670  std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface> observer);
671 
678  std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface> observer);
679 
686  std::shared_ptr<acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface> observer);
687 
694  std::shared_ptr<acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface> observer);
695 
703  void addCaptionPresenter(std::shared_ptr<captions::CaptionPresenterInterface> presenter);
704 
714  const std::vector<std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface>>& mediaPlayers);
715 
716  /*
717  * Get a reference to the PlaybackRouter
718  *
719  * @return shared_ptr to the PlaybackRouter.
720  */
721  std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface> getPlaybackRouter() const;
722 
728  void addSpeakerManagerObserver(std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerObserverInterface> observer);
729 
736  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerObserverInterface> observer);
737 
743  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface> getSpeakerManager();
744 
750  std::shared_ptr<avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface> observer);
751 
757  std::shared_ptr<avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface> observer);
758 
764  std::shared_ptr<registrationManager::RegistrationManagerInterface> getRegistrationManager();
765 
771  void addRegistrationObserver(const std::shared_ptr<registrationManager::RegistrationObserverInterface>& observer);
772 
779  const std::shared_ptr<registrationManager::RegistrationObserverInterface>& observer);
780 
781 #ifdef ENABLE_REVOKE_AUTH
782 
787  void addRevokeAuthorizationObserver(
788  std::shared_ptr<avsCommon::sdkInterfaces::RevokeAuthorizationObserverInterface> observer);
789 
795  void removeRevokeAuthorizationObserver(
796  std::shared_ptr<avsCommon::sdkInterfaces::RevokeAuthorizationObserverInterface> observer);
797 #endif
798 
806  std::shared_ptr<acsdkEqualizer::EqualizerController> getEqualizerController();
807 
814  std::shared_ptr<acsdkEqualizerInterfaces::EqualizerControllerListenerInterface> listener);
815 
822  std::shared_ptr<acsdkEqualizerInterfaces::EqualizerControllerListenerInterface> listener);
823 
829  void addContextManagerObserver(std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerObserverInterface> observer);
830 
837  std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerObserverInterface> observer);
838 
846 
849  std::future<bool> notifyOfWakeWord(
850  capabilityAgents::aip::AudioProvider wakeWordAudioProvider,
853  std::string keyword,
854  std::chrono::steady_clock::time_point startOfSpeechTimestamp,
855  std::shared_ptr<const std::vector<char>> KWDMetadata = nullptr) override;
856 
857  std::future<bool> notifyOfTapToTalk(
858  capabilityAgents::aip::AudioProvider tapToTalkAudioProvider,
860  std::chrono::steady_clock::time_point startOfSpeechTimestamp = std::chrono::steady_clock::now()) override;
861 
862  std::future<bool> notifyOfHoldToTalkStart(
863  capabilityAgents::aip::AudioProvider holdToTalkAudioProvider,
864  std::chrono::steady_clock::time_point startOfSpeechTimestamp = std::chrono::steady_clock::now(),
867 
868  std::future<bool> notifyOfHoldToTalkEnd() override;
869 
870  std::future<bool> notifyOfTapToTalkEnd() override;
872 
878  std::shared_ptr<settings::DeviceSettingsManager> getSettingsManager();
879 
887  std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface> createEndpointBuilder();
888 
895  std::future<endpoints::EndpointRegistrationManager::RegistrationResult> registerEndpoint(
896  std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointInterface> endpoint);
897 
905  std::future<endpoints::EndpointRegistrationManager::UpdateResult> updateEndpoint(
907  const std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointModificationData>& endpointModificationData);
908 
915  std::future<endpoints::EndpointRegistrationManager::DeregistrationResult> deregisterEndpoint(
917 
927  std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface> getDefaultEndpointBuilder();
928 
935  const std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface>& observer);
936 
943  const std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface>& observer);
944 
951  const std::shared_ptr<avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface>& observer);
952 
959  const std::shared_ptr<avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface>& observer);
960 
966  void addCallStateObserver(std::shared_ptr<avsCommon::sdkInterfaces::CallStateObserverInterface> observer);
967 
973  void removeCallStateObserver(std::shared_ptr<avsCommon::sdkInterfaces::CallStateObserverInterface> observer);
974 
980  bool isCommsEnabled();
981 
985  void acceptCommsCall();
986 
993 
997  void stopCommsCall();
998 
1002  void audioPlayerLocalStop();
1003 
1009  bool isCommsCallMuted();
1010 
1014  void muteCommsCall();
1015 
1019  void unmuteCommsCall();
1020 
1024  void enableVideo();
1025 
1029  void disableVideo();
1030 
1031  /*
1032  * To be called when system clock is synchronized.
1033  */
1035 
1043  std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface>
1044  externalMediaPlayerAdapterHandler);
1045 
1053  std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> getShutdownManager();
1054 
1058  ~DefaultClient();
1059 
1068 
1077 
1085  std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface> getDeviceSetup();
1086 
1087 private:
1109  bool initialize(
1110  const std::shared_ptr<DefaultClientManufactory>& manufactory,
1111  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> ringtoneMediaPlayer,
1112  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> ringtoneSpeaker,
1113  const std::multimap<
1115  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface>> additionalSpeakers,
1116 #ifdef ENABLE_PCC
1117  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> phoneSpeaker,
1118  std::shared_ptr<avsCommon::sdkInterfaces::phone::PhoneCallerInterface> phoneCaller,
1119 #endif
1120 #ifdef ENABLE_MCC
1121  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> meetingSpeaker,
1122  std::shared_ptr<avsCommon::sdkInterfaces::meeting::MeetingClientInterface> meetingClient,
1123  std::shared_ptr<avsCommon::sdkInterfaces::calendar::CalendarClientInterface> calendarClient,
1124 #endif
1125 #ifdef ENABLE_COMMS_AUDIO_PROXY
1126  std::shared_ptr<avsCommon::utils::mediaPlayer::MediaPlayerInterface> commsMediaPlayer,
1127  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerInterface> commsSpeaker,
1128  std::shared_ptr<alexaClientSDK::avsCommon::avs::AudioInputStream> sharedDataStream,
1129 #endif
1130  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::DialogUXStateObserverInterface>>
1131  alexaDialogStateObservers,
1132  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::ConnectionStatusObserverInterface>>
1133  connectionObservers,
1134  bool isGuiSupported,
1136  bool sendSoftwareInfoOnConnected,
1137  std::shared_ptr<avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface> softwareInfoSenderObserver,
1138  std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface> diagnostics,
1139  const std::shared_ptr<ExternalCapabilitiesBuilderInterface>& externalCapabilitiesBuilder,
1140  capabilityAgents::aip::AudioProvider firstInteractionAudioProvider);
1141 
1143  std::shared_ptr<avsCommon::sdkInterfaces::DirectiveSequencerInterface> m_directiveSequencer;
1144 
1146  std::shared_ptr<avsCommon::sdkInterfaces::FocusManagerInterface> m_audioFocusManager;
1147 
1149  std::shared_ptr<avsCommon::sdkInterfaces::FocusManagerInterface> m_visualFocusManager;
1150 
1152  std::shared_ptr<acl::AVSConnectionManagerInterface> m_connectionManager;
1153 
1154  std::shared_ptr<avsCommon::sdkInterfaces::InternetConnectionMonitorInterface> m_internetConnectionMonitor;
1155 
1157  std::shared_ptr<captions::CaptionManagerInterface> m_captionManager;
1158 
1160  std::shared_ptr<avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface> m_exceptionSender;
1161 
1163  std::shared_ptr<certifiedSender::CertifiedSender> m_certifiedSender;
1164 
1166  std::shared_ptr<capabilityAgents::aip::AudioInputProcessor> m_audioInputProcessor;
1167 
1169  std::shared_ptr<capabilityAgents::speechSynthesizer::SpeechSynthesizer> m_speechSynthesizer;
1170 
1172  std::shared_ptr<acsdkAudioPlayerInterfaces::AudioPlayerInterface> m_audioPlayer;
1173 
1175  std::shared_ptr<acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerInterface> m_externalMediaPlayer;
1176 
1178  std::shared_ptr<capabilityAgents::alexa::AlexaInterfaceMessageSender> m_alexaMessageSender;
1179 
1181  std::shared_ptr<capabilityAgents::apiGateway::ApiGatewayCapabilityAgent> m_apiGatewayCapabilityAgent;
1182 
1184  std::shared_ptr<acsdkAlertsInterfaces::AlertsCapabilityAgentInterface> m_alertsCapabilityAgent;
1185 
1187  std::shared_ptr<acsdkBluetoothInterfaces::BluetoothNotifierInterface> m_bluetoothNotifier;
1188 
1190  std::shared_ptr<acsdkInteractionModelInterfaces::InteractionModelNotifierInterface> m_interactionModelNotifier;
1191 
1193  std::shared_ptr<acsdkNotificationsInterfaces::NotificationsNotifierInterface> m_notificationsNotifier;
1194 
1195 #ifdef ENABLE_PCC
1196  std::shared_ptr<capabilityAgents::phoneCallController::PhoneCallController> m_phoneCallControllerCapabilityAgent;
1198 #endif
1199 
1200 #ifdef ENABLE_MCC
1201  std::shared_ptr<capabilityAgents::meetingClientController::MeetingClientController>
1203  m_meetingClientControllerCapabilityAgent;
1204 #endif
1205 
1207  std::shared_ptr<avsCommon::sdkInterfaces::CallManagerInterface> m_callManager;
1208 
1210  std::shared_ptr<avsCommon::avs::DialogUXStateAggregator> m_dialogUXStateAggregator;
1211 
1213  std::shared_ptr<avsCommon::sdkInterfaces::PlaybackRouterInterface> m_playbackRouter;
1214 
1216  std::shared_ptr<avsCommon::sdkInterfaces::SpeakerManagerInterface> m_speakerManager;
1217 
1219  std::shared_ptr<capabilityAgents::templateRuntime::TemplateRuntime> m_templateRuntime;
1220 
1222  std::shared_ptr<acsdkEqualizer::EqualizerCapabilityAgent> m_equalizerCapabilityAgent;
1223 
1225  std::shared_ptr<acsdkEqualizer::EqualizerController> m_equalizerController;
1226 
1228  std::shared_ptr<acsdkEqualizerInterfaces::EqualizerRuntimeSetupInterface> m_equalizerRuntimeSetup;
1229 
1231  std::mutex m_softwareInfoSenderMutex;
1232 
1234  std::shared_ptr<capabilityAgents::system::SoftwareInfoSender> m_softwareInfoSender;
1235 
1236 #ifdef ENABLE_REVOKE_AUTH
1237  std::shared_ptr<capabilityAgents::system::RevokeAuthorizationHandler> m_revokeAuthorizationHandler;
1239 #endif
1240 
1242  std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface> m_authDelegate;
1243 
1245  std::shared_ptr<registrationManager::RegistrationManagerInterface> m_registrationManager;
1246 
1248  std::shared_ptr<registrationManager::RegistrationNotifierInterface> m_registrationNotifier;
1249 
1251  std::shared_ptr<settings::DeviceSettingsManager> m_deviceSettingsManager;
1252 
1254  std::shared_ptr<avsCommon::utils::DeviceInfo> m_deviceInfo;
1255 
1257  std::shared_ptr<avsCommon::sdkInterfaces::ContextManagerInterface> m_contextManager;
1258 
1260  std::shared_ptr<endpoints::EndpointRegistrationManager> m_endpointRegistrationManager;
1261 
1263  std::shared_ptr<avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface> m_defaultEndpointBuilder;
1264 
1266  std::shared_ptr<avsCommon::sdkInterfaces::AVSGatewayManagerInterface> m_avsGatewayManager;
1267 
1269  std::shared_ptr<avsCommon::sdkInterfaces::CapabilitiesDelegateInterface> m_capabilitiesDelegate;
1270 
1272  std::shared_ptr<avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface> m_diagnostics;
1273 
1275  std::shared_ptr<acsdkSystemClockMonitorInterfaces::SystemClockMonitorInterface> m_systemClockMonitor;
1276 
1278  std::list<std::shared_ptr<avsCommon::utils::RequiresShutdown>> m_shutdownObjects;
1279 
1281  std::shared_ptr<ConnectionRetryTrigger> m_connectionRetryTrigger;
1282 
1284  std::unordered_set<std::shared_ptr<avsCommon::sdkInterfaces::SoftwareInfoSenderObserverInterface>>
1285  m_softwareInfoSenderObservers;
1286 
1288  std::shared_ptr<capabilityAgents::softwareComponentReporter::SoftwareComponentReporterCapabilityAgent>
1289  m_softwareReporterCapabilityAgent;
1290 
1292  std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownManagerInterface> m_shutdownManager;
1293 
1295  std::shared_ptr<acsdkDeviceSetupInterfaces::DeviceSetupInterface> m_deviceSetup;
1296 };
1297 
1298 } // namespace defaultClient
1299 } // namespace alexaClientSDK
1300 
1301 #endif // ALEXA_CLIENT_SDK_APPLICATIONUTILITIES_DEFAULTCLIENT_INCLUDE_DEFAULTCLIENT_DEFAULTCLIENT_H_
void removeRegistrationObserver(const std::shared_ptr< registrationManager::RegistrationObserverInterface > &observer)
Definition: DefaultClient.cpp:1368
void onSystemClockSynchronized()
Definition: DefaultClient.cpp:1657
std::future< bool > notifyOfHoldToTalkEnd() override
Definition: DefaultClient.cpp:1510
capabilityAgents::aip::AudioInputProcessor::EncodingFormatResponse requestEncodingAudioFormats(const capabilityAgents::aip::AudioInputProcessor::EncodingFormatRequest &encodings)
Definition: DefaultClient.cpp:1766
void removeExternalMediaPlayerObserver(std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer)
Definition: DefaultClient.cpp:1297
void setCaptionMediaPlayers(const std::vector< std::shared_ptr< avsCommon::utils::mediaPlayer::MediaPlayerInterface >> &mediaPlayers)
Definition: DefaultClient.cpp:1308
std::future< bool > notifyOfTapToTalkEnd() override
Definition: DefaultClient.cpp:1514
void addRegistrationObserver(const std::shared_ptr< registrationManager::RegistrationObserverInterface > &observer)
Definition: DefaultClient.cpp:1363
void TemplateRuntimeDisplayCardCleared()
Definition: DefaultClient.cpp:1274
std::map< std::string, std::pair< avsCommon::utils::AudioFormat::Encoding, avsCommon::utils::AudioFormat::Encoding > > EncodingFormatRequest
Definition: AudioInputProcessor.h:100
std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > createEndpointBuilder()
Definition: DefaultClient.cpp:1552
static const auto INVALID_INDEX
A reserved Index value which is considered invalid.
Definition: AudioInputProcessor.h:132
std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownManagerInterface > getShutdownManager()
Definition: DefaultClient.cpp:1669
std::shared_ptr< settings::DeviceSettingsManager > getSettingsManager()
}
Definition: DefaultClient.cpp:1351
void disableVideo()
Definition: DefaultClient.cpp:1651
void addMessageObserver(std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)
Definition: DefaultClient.cpp:1209
void addSpeakerManagerObserver(std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerObserverInterface > observer)
Definition: DefaultClient.cpp:1405
std::shared_ptr< acsdkDeviceSetupInterfaces::DeviceSetupInterface > getDeviceSetup()
Definition: DefaultClient.cpp:1673
void stopAllActivities()
Definition: DefaultClient.cpp:1191
bool isCommsCallMuted()
Definition: DefaultClient.cpp:1626
static const AudioProvider & null()
Definition: AudioProvider.h:104
std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerInterface > getSpeakerManager()
Definition: DefaultClient.cpp:1415
void connect(bool performReset=true)
Definition: DefaultClient.cpp:1145
void addContextManagerObserver(std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerObserverInterface > observer)
Definition: DefaultClient.cpp:1391
void enableVideo()
Definition: DefaultClient.cpp:1645
void stopCommsCall()
Definition: DefaultClient.cpp:1614
void addAudioPlayerObserver(std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer)
Definition: DefaultClient.cpp:1246
void localStopActiveAlert()
Definition: DefaultClient.cpp:1195
void removeMessageObserver(std::shared_ptr< avsCommon::sdkInterfaces::MessageObserverInterface > observer)
Definition: DefaultClient.cpp:1213
void removeEndpointRegistrationManagerObserver(const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface > &observer)
Definition: DefaultClient.cpp:1523
bool isCommsEnabled()
Definition: DefaultClient.cpp:1598
std::future< endpoints::EndpointRegistrationManager::UpdateResult > updateEndpoint(const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointModificationData > &endpointModificationData)
Definition: DefaultClient.cpp:1573
std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface > getDefaultEndpointBuilder()
Definition: DefaultClient.cpp:1557
void addNotificationsObserver(std::shared_ptr< acsdkNotificationsInterfaces::NotificationsObserverInterface > observer)
Definition: DefaultClient.cpp:1282
std::unordered_map< std::string, AdapterCreateFunction > AdapterCreationMap
Definition: ExternalMediaPlayer.h:106
void removeContextManagerObserver(std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerObserverInterface > observer)
Definition: DefaultClient.cpp:1398
std::shared_ptr< acsdkEqualizer::EqualizerController > getEqualizerController()
Definition: DefaultClient.cpp:1373
void addInternetConnectionObserver(std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer)
Definition: DefaultClient.cpp:1228
static const FirmwareVersion INVALID_FIRMWARE_VERSION
The invalid firmware version.
Definition: SoftwareInfoSenderObserverInterface.h:32
void addExternalMediaPlayerObserver(std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaPlayerObserverInterface > observer)
Definition: DefaultClient.cpp:1292
void addEndpointRegistrationManagerObserver(const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface > &observer)
Definition: DefaultClient.cpp:1518
void disconnect()
Definition: DefaultClient.cpp:1179
void muteCommsCall()
Definition: DefaultClient.cpp:1633
void addSpeechSynthesizerObserver(std::shared_ptr< avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface > observer)
Definition: DefaultClient.cpp:1419
void addAlertsObserver(std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer)
Definition: DefaultClient.cpp:1238
std::shared_ptr< registrationManager::RegistrationManagerInterface > getRegistrationManager()
Definition: DefaultClient.cpp:1359
void removeSpeakerManagerObserver(std::shared_ptr< avsCommon::sdkInterfaces::SpeakerManagerObserverInterface > observer)
Definition: DefaultClient.cpp:1410
std::shared_ptr< avsCommon::sdkInterfaces::PlaybackRouterInterface > getPlaybackRouter() const
Definition: DefaultClient.cpp:1355
void addCaptionPresenter(std::shared_ptr< captions::CaptionPresenterInterface > presenter)
Definition: DefaultClient.cpp:1302
void removeAlertsObserver(std::shared_ptr< acsdkAlertsInterfaces::AlertObserverInterface > observer)
Definition: DefaultClient.cpp:1242
void addCallStateObserver(std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer)
Definition: DefaultClient.cpp:1538
avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation DefaultEndpointAnnotation
Definition: PreviewAlexaClientComponent.cpp:87
void removeInternetConnectionObserver(std::shared_ptr< avsCommon::sdkInterfaces::InternetConnectionObserverInterface > observer)
Definition: DefaultClient.cpp:1233
void removeNotificationsObserver(std::shared_ptr< acsdkNotificationsInterfaces::NotificationsObserverInterface > observer)
Definition: DefaultClient.cpp:1287
DTMFTone
An enum used to define the characters that dtmf tone can be.
Definition: CallManagerInterface.h:59
Index
Index used for setting access.
Definition: StateReportGeneratorTest.cpp:41
std::map< std::string, avsCommon::utils::AudioFormat::Encoding > EncodingFormatResponse
Definition: AudioInputProcessor.h:106
void registerExternalMediaPlayerAdapterHandler(std::shared_ptr< acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface > externalMediaPlayerAdapterHandler)
Definition: DefaultClient.cpp:1661
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
Definition: DefaultClient.cpp:1453
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
Definition: DefaultClient.h:140
void removeAudioInputProcessorObserver(const std::shared_ptr< avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface > &observer)
Definition: DefaultClient.cpp:1533
void removeEqualizerControllerListener(std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener)
Definition: DefaultClient.cpp:1384
std::future< endpoints::EndpointRegistrationManager::DeregistrationResult > deregisterEndpoint(avsCommon::sdkInterfaces::endpoints::EndpointIdentifier endpointId)
Definition: DefaultClient.cpp:1587
void addBluetoothDeviceObserver(std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface > observer)
Definition: DefaultClient.cpp:1315
int32_t FirmwareVersion
Type to use to communicate a firmware version.
Definition: SoftwareInfoSenderObserverInterface.h:29
void removeCallStateObserver(std::shared_ptr< avsCommon::sdkInterfaces::CallStateObserverInterface > observer)
Definition: DefaultClient.cpp:1545
void acceptCommsCall()
Definition: DefaultClient.cpp:1602
void unmuteCommsCall()
Definition: DefaultClient.cpp:1639
void addAudioInputProcessorObserver(const std::shared_ptr< avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface > &observer)
Definition: DefaultClient.cpp:1528
~DefaultClient()
Definition: DefaultClient.cpp:1677
void removeConnectionObserver(std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface > observer)
Definition: DefaultClient.cpp:1223
void audioPlayerLocalStop()
Definition: DefaultClient.cpp:1620
void addAlexaDialogStateObserver(std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface > observer)
Definition: DefaultClient.cpp:1199
void removeTemplateRuntimeObserver(std::shared_ptr< avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface > observer)
Definition: DefaultClient.cpp:1265
std::string EndpointIdentifier
Definition: EndpointIdentifier.h:38
void stopForegroundActivity()
Definition: DefaultClient.cpp:1187
std::string getAVSGateway()
Definition: DefaultClient.cpp:1183
void sendDtmf(avsCommon::sdkInterfaces::CallManagerInterface::DTMFTone dtmfTone)
Definition: DefaultClient.cpp:1608
void removeBluetoothDeviceObserver(std::shared_ptr< acsdkBluetoothInterfaces::BluetoothDeviceObserverInterface > observer)
Definition: DefaultClient.cpp:1324
Definition: SpeechInteractionHandlerInterface.h:36
void addEqualizerControllerListener(std::shared_ptr< acsdkEqualizerInterfaces::EqualizerControllerListenerInterface > listener)
Definition: DefaultClient.cpp:1377
bool setFirmwareVersion(avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion firmwareVersion)
Definition: DefaultClient.cpp:1429
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())
Definition: DefaultClient.cpp:79
void addConnectionObserver(std::shared_ptr< avsCommon::sdkInterfaces::ConnectionStatusObserverInterface > observer)
Definition: DefaultClient.cpp:1218
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
Definition: DefaultClient.cpp:1501
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
Definition: DefaultClient.cpp:1492
bool setEncodingAudioFormat(avsCommon::utils::AudioFormat::Encoding encoding)
Definition: DefaultClient.cpp:1762
void removeAlexaDialogStateObserver(std::shared_ptr< avsCommon::sdkInterfaces::DialogUXStateObserverInterface > observer)
Definition: DefaultClient.cpp:1204
void removeSpeechSynthesizerObserver(std::shared_ptr< avsCommon::sdkInterfaces::SpeechSynthesizerObserverInterface > observer)
Definition: DefaultClient.cpp:1424
std::future< endpoints::EndpointRegistrationManager::RegistrationResult > registerEndpoint(std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointInterface > endpoint)
Definition: DefaultClient.cpp:1561
void removeAudioPlayerObserver(std::shared_ptr< acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface > observer)
Definition: DefaultClient.cpp:1251
void addTemplateRuntimeObserver(std::shared_ptr< avsCommon::sdkInterfaces::TemplateRuntimeObserverInterface > observer)
Definition: DefaultClient.cpp:1256

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