 |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
|
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <DefaultClientBuilder.h>
Public Member Functions | |
| std::shared_ptr< DefaultClient > | construct (const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry) |
| std::string | name () override |
 Public Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface | |
| virtual | ~FeatureClientBuilderInterface ()=default |
Additional Inherited Members | |
| Protected Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface | |
| template<typename ComponentType > | |
| ACSDK_INLINE_VISIBILITY void | addRequiredType () |
The DefaultClientBuilder is used to construct DefaultClient when used with the ClientBuilder
| std::shared_ptr<DefaultClient> alexaClientSDK::defaultClient::DefaultClientBuilder::construct | ( | const std::shared_ptr< sdkClient::SDKClientRegistry > & | sdkClientRegistry | ) |
Function used by SDKClientBuilder to construct an instance of DefaultClient
| sdkClientRegistry | The SDKClientRegistry object |
DefaultClient, or nullptr if creation failed Creates and initializes a default AVS SDK client. To connect the client to AVS, users should make a call to connect() after creation.
| 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. |
std::unique_ptr to a DefaultClient if all went well or nullptr otherwise.
|
overridevirtual |
FeatureClientBuilderInterface functions
Implements alexaClientSDK::sdkClient::FeatureClientBuilderInterface.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0