KeyWordObserverInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_KEYWORDOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_KEYWORDOBSERVERINTERFACE_H_

#include <limits>
#include <memory>
#include <vector>

#include "AVSCommon/AVS/AudioInputStream.h"

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class KeyWordObserverInterface {
public:
    static constexpr avs::AudioInputStream::Index UNSPECIFIED_INDEX =
        std::numeric_limits<avs::AudioInputStream::Index>::max();

    virtual ~KeyWordObserverInterface() = default;

    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;
};

}  // namespace sdkInterfaces
}  // namespace avsCommon
}  // namespace alexaClientSDK

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_KEYWORDOBSERVERINTERFACE_H_