AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
KeywordObserver.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_SAMPLEAPP_INCLUDE_SAMPLEAPP_KEYWORDOBSERVER_H_
17 #define ALEXA_CLIENT_SDK_SAMPLEAPP_INCLUDE_SAMPLEAPP_KEYWORDOBSERVER_H_
18 
19 #include <memory>
20 #include <string>
21 
26 
27 namespace alexaClientSDK {
28 namespace sampleApp {
29 
34 public:
44  static std::shared_ptr<KeywordObserver> create(
45  std::shared_ptr<defaultClient::DefaultClient> client,
47  std::shared_ptr<acsdkKWDImplementations::AbstractKeywordDetector> keywordDetector);
48 
56  std::shared_ptr<defaultClient::DefaultClient> client,
58 
61  void onKeyWordDetected(
62  std::shared_ptr<avsCommon::avs::AudioInputStream> stream,
63  std::string keyword,
66  std::shared_ptr<const std::vector<char>> KWDMetadata = nullptr) override;
68 
69 private:
71  std::shared_ptr<defaultClient::DefaultClient> m_client;
72 
75 };
76 
77 } // namespace sampleApp
78 } // namespace alexaClientSDK
79 
80 #endif // ALEXA_CLIENT_SDK_SAMPLEAPP_INCLUDE_SAMPLEAPP_KEYWORDOBSERVER_H_
alexaClientSDK::sampleApp::KeywordObserver
Definition: KeywordObserver.h:33
AbstractKeywordDetector.h
alexaClientSDK::avsCommon::sdkInterfaces::KeyWordObserverInterface
Definition: KeyWordObserverInterface.h:32
alexaClientSDK::avsCommon::sdkInterfaces::KeyWordObserverInterface::UNSPECIFIED_INDEX
static constexpr avs::AudioInputStream::Index UNSPECIFIED_INDEX
This represents when an index passed into the onKeyWordDetected() call should be ignored.
Definition: KeyWordObserverInterface.h:35
alexaClientSDK::capabilityAgents::system::Index
Index
Index used for setting access.
Definition: StateReportGeneratorTest.cpp:41
alexaClientSDK::capabilityAgents::aip::AudioProvider
Definition: AudioProvider.h:31
alexaClientSDK::sampleApp::KeywordObserver::onKeyWordDetected
void onKeyWordDetected(std::shared_ptr< avsCommon::avs::AudioInputStream > stream, std::string keyword, avsCommon::avs::AudioInputStream::Index beginIndex=UNSPECIFIED_INDEX, avsCommon::avs::AudioInputStream::Index endIndex=UNSPECIFIED_INDEX, std::shared_ptr< const std::vector< char >> KWDMetadata=nullptr) override
Definition: KeywordObserver.cpp:104
DefaultClient.h
alexaClientSDK
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.h:36
alexaClientSDK::sampleApp::KeywordObserver::create
static std::shared_ptr< KeywordObserver > create(std::shared_ptr< defaultClient::DefaultClient > client, capabilityAgents::aip::AudioProvider audioProvider, std::shared_ptr< acsdkKWDImplementations::AbstractKeywordDetector > keywordDetector)
Definition: KeywordObserver.cpp:34
KeyWordObserverInterface.h
AudioInputStream.h
alexaClientSDK::sampleApp::KeywordObserver::KeywordObserver
KeywordObserver(std::shared_ptr< defaultClient::DefaultClient > client, capabilityAgents::aip::AudioProvider audioProvider)
Definition: KeywordObserver.cpp:46

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