![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <ExternalCapabilitiesBuilderInterface.h>
Classes | |
struct | Capability |
This interface provides a facility to add external capabilities to default client.
Default client will provide its core components in the build call.
RequiresShutdown
objects returned by buildCapabilities(). This will ensure that these objects are shutdown during DefaultClient
shutdown and before any core component is shutdown.
|
virtualdefault |
Destructor.
Build the capabilities with the given core components.
externalMediaPlayer | Object used to manage external media playback. |
connectionManager | Object responsible for managing the SDK connection with AVS. |
messageSender | Object that can be used to send events to AVS. |
exceptionSender | Object that can be used to send exceptions to AVS. |
certifiedSender | Object that can be used to send events to AVS that require stronger guarantee. |
audioFocusManager | The focus manager for audio channels. |
dataManager | Object used to manage objects that store customer data. |
stateReportHandler | Object used to report the device state and its settings. |
audioInputProcessor | Object used to recognize voice interactions. |
speakerManager | Object used to manage all speaker instances that can be controlled by Alexa. |
directiveSequencer | Object used to sequence and handle a stream of AVSDirective instances. |
userInactivityMonitor | Object used to notify an implementation of the user activity. |
contextManager | Object used to provide the context for various components. |
avsGatewayManager | Object used to get the AVS gateway URL data. |
ringtoneMediaPlayer | The media player to play Comms ringtones. |
audioFactory | The audioFactory is a component the provides unique audio streams. |
ringtoneChannelVolumeInterface | The ChannelVolumeInterface used for ringtone channel volume attenuation. #ifdef ENABLE_COMMS_AUDIO_PROXY |
commsMediaPlayer | The media player to play Comms calling audio. |
commsSpeaker | The speaker to control volume of Comms calling audio. |
sharedDataStream | The stream to use which has the audio from microphone. #endif |
powerResourceManager | Object to manage power resource. |
softwareComponentReporter | Object to report adapters' versions. |
playbackRouter | Object to route local playback control command. |
endpointRegistrationManager | Object to manage endpoints. |
metricRecorder | Object to manage AVS SDK metric reporting. |
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.
|
pure virtual |
Get the CallManager reference.
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder, and alexaClientSDK::sampleApp::ExternalCapabilitiesBuilder.
|
pure virtual |
This method sets the Alexa Interface Message Sender to send Alexa Interface response events.
alexaMessageSender | The AlexaInterfaceMessageSenderInterface object. |
Implemented in alexaClientSDK::sampleApp::ExternalCapabilitiesBuilder, and alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.
|
pure virtual |
This method sets the DialogUXStateAggregator for CallManager.
dialogUXStateAggregator | The DialogUXStateAggregator object. |
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.
|
pure virtual |
This method sets the InternetConnectionMonitor for CallManager.
internetConnectionMonitor | The InternetConnectionMonitor object. |
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder.
|
pure virtual |
This method sets the storage using for setting.
|
pure virtual |
This method sets the TemplateRuntime Capability Agent for visual interactions.
This method will only get called if GUI supports has been enabled.
templateRuntime | The TemplateRuntime object. |
Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::ExternalCapabilitiesBuilder, and alexaClientSDK::sampleApp::ExternalCapabilitiesBuilder.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0