![]() |
AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
#include <SpeechInteractionHandlerInterface.h>
Public Member Functions | |
virtual | ~SpeechInteractionHandlerInterface ()=default |
virtual 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)=0 |
virtual std::future< bool > | notifyOfTapToTalk (capabilityAgents::aip::AudioProvider tapToTalkAudioProvider, avsCommon::avs::AudioInputStream::Index beginIndex, std::chrono::steady_clock::time_point startOfSpeechTimestamp=std::chrono::steady_clock::now())=0 |
virtual 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)=0 |
virtual std::future< bool > | notifyOfHoldToTalkEnd ()=0 |
virtual std::future< bool > | notifyOfTapToTalkEnd ()=0 |
A SpeechInteractionHandler
may be any client component who responds to WakeWork and TapToTalk Events This specifies the interface to a SpeechInteractionHandler
.
|
virtualdefault |
|
pure virtual |
Ends a hold to talk interaction by forcing the client to stop streaming audio data to the cloud and ending any currently ongoing recognize interactions.
Implemented in alexaClientSDK::defaultClient::DefaultClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::liveViewController::LiveViewControllerPresentationAdapter.
|
pure virtual |
Begins a hold to talk initiated Alexa interaction.
holdToTalkAudioProvider | The audio provider containing the audio data stream along with its metadata. |
startOfSpeechTimestamp | Moment in time when user started talking to Alexa. This parameter is optional and it is used to measure user perceived latency. |
beginIndex | An optional parameter indicating where in the stream to start reading from. |
Implemented in alexaClientSDK::defaultClient::DefaultClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::liveViewController::LiveViewControllerPresentationAdapter.
|
pure virtual |
Begins a tap to talk initiated Alexa interaction. Note that this can also be used for wake word engines that don't support providing both a begin and end index.
tapToTalkAudioProvider | The audio provider containing the audio data stream along with its metadata. |
beginIndex | An optional parameter indicating where in the stream to start reading from. |
startOfSpeechTimestamp | Moment in time when user started talking to Alexa. This parameter is optional and it is used to measure user perceived latency. INVALID_INDEX may be used to explicitly communicate that there is no wake work. |
Implemented in alexaClientSDK::defaultClient::DefaultClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::liveViewController::LiveViewControllerPresentationAdapter.
|
pure virtual |
Ends a tap to talk interaction by forcing the client to stop streaming audio data to the cloud and ending any currently ongoing recognize interactions.
Implemented in alexaClientSDK::defaultClient::DefaultClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::liveViewController::LiveViewControllerPresentationAdapter.
|
pure virtual |
Begins a wake word initiated Alexa interaction.
wakeWordAudioProvider | The audio provider containing the audio data stream along with its metadata. |
beginIndex | The begin index of the keyword found within the stream. |
endIndex | The end index of the keyword found within the stream. |
keyword | The keyword that was detected. |
KWDMetadata | Wake word engine metadata. |
startOfSpeechTimestamp | Moment in time when user started talking to Alexa. |
Implemented in alexaClientSDK::defaultClient::DefaultClient, and alexaClientSDK::sampleApplications::ipcServerSampleApp::liveViewController::LiveViewControllerPresentationAdapter.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0