AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
SpeechInteractionHandlerInterface.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 #ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEECHINTERACTIONHANDLERINTERFACE_H_
16 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEECHINTERACTIONHANDLERINTERFACE_H_
17 
18 #include <stdlib.h>
19 #include <chrono>
20 #include <future>
21 #include <memory>
22 #include <string>
23 
24 #include <AIP/AudioProvider.h>
26 
27 namespace alexaClientSDK {
28 namespace avsCommon {
29 namespace sdkInterfaces {
30 
37 public:
38  virtual ~SpeechInteractionHandlerInterface() = default;
39 
51  virtual std::future<bool> notifyOfWakeWord(
52  capabilityAgents::aip::AudioProvider wakeWordAudioProvider,
55  std::string keyword,
56  std::chrono::steady_clock::time_point startOfSpeechTimestamp,
57  std::shared_ptr<const std::vector<char>> KWDMetadata = nullptr) = 0;
58 
70  virtual std::future<bool> notifyOfTapToTalk(
71  capabilityAgents::aip::AudioProvider tapToTalkAudioProvider,
73  std::chrono::steady_clock::time_point startOfSpeechTimestamp = std::chrono::steady_clock::now()) = 0;
74 
84  virtual std::future<bool> notifyOfHoldToTalkStart(
85  capabilityAgents::aip::AudioProvider holdToTalkAudioProvider,
86  std::chrono::steady_clock::time_point startOfSpeechTimestamp = std::chrono::steady_clock::now(),
89 
97  virtual std::future<bool> notifyOfHoldToTalkEnd() = 0;
98 
106  virtual std::future<bool> notifyOfTapToTalkEnd() = 0;
107 };
108 
109 } // namespace sdkInterfaces
110 } // namespace avsCommon
111 } // namespace alexaClientSDK
112 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEECHINTERACTIONHANDLERINTERFACE_H_
static const auto INVALID_INDEX
A reserved Index value which is considered invalid.
Definition: AudioInputProcessor.h:132
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 > 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
Index
Index used for setting access.
Definition: StateReportGeneratorTest.cpp:41
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
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
Definition: SpeechInteractionHandlerInterface.h:36

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