AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
KeyWordObserverInterface.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_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_KEYWORDOBSERVERINTERFACE_H_
17 #define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_KEYWORDOBSERVERINTERFACE_H_
18 
19 #include <limits>
20 #include <memory>
21 #include <vector>
22 
24 
25 namespace alexaClientSDK {
26 namespace avsCommon {
27 namespace sdkInterfaces {
28 
33 public:
36  std::numeric_limits<avs::AudioInputStream::Index>::max();
37 
41  virtual ~KeyWordObserverInterface() = default;
42 
57  virtual void onKeyWordDetected(
58  std::shared_ptr<avs::AudioInputStream> stream,
59  std::string keyword,
60  avs::AudioInputStream::Index beginIndex = UNSPECIFIED_INDEX,
61  avs::AudioInputStream::Index endIndex = UNSPECIFIED_INDEX,
62  std::shared_ptr<const std::vector<char>> KWDMetadata = nullptr) = 0;
63 };
64 
65 } // namespace sdkInterfaces
66 } // namespace avsCommon
67 } // namespace alexaClientSDK
68 
69 #endif // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_KEYWORDOBSERVERINTERFACE_H_
virtual void onKeyWordDetected(std::shared_ptr< avs::AudioInputStream > stream, std::string keyword, avs::AudioInputStream::Index beginIndex=UNSPECIFIED_INDEX, avs::AudioInputStream::Index endIndex=UNSPECIFIED_INDEX, std::shared_ptr< const std::vector< char >> KWDMetadata=nullptr)=0
static constexpr avs::AudioInputStream::Index UNSPECIFIED_INDEX
This represents when an index passed into the onKeyWordDetected() call should be ignored.
Definition: KeyWordObserverInterface.h:35
Index
Index used for setting access.
Definition: StateReportGeneratorTest.cpp:41
Whether or not curl logs should be emitted.
Definition: AVSConnectionManager.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