DialogUXStateObserverInterface.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_DIALOGUXSTATEOBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIALOGUXSTATEOBSERVERINTERFACE_H_

#include <ostream>
#include <string>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class DialogUXStateObserverInterface {
public:
    enum class DialogUXState {
        IDLE,

        LISTENING,

        EXPECTING,

        THINKING,

        SPEAKING,

        FINISHED
    };

    virtual ~DialogUXStateObserverInterface() = default;

    virtual void onDialogUXStateChanged(DialogUXState newState) = 0;

    static std::string stateToString(DialogUXState state);
};

inline std::string DialogUXStateObserverInterface::stateToString(DialogUXState state) {
    switch (state) {
        case DialogUXState::IDLE:
            return "IDLE";
        case DialogUXState::LISTENING:
            return "LISTENING";
        case DialogUXState::EXPECTING:
            return "EXPECTING";
        case DialogUXState::THINKING:
            return "THINKING";
        case DialogUXState::SPEAKING:
            return "SPEAKING";
        case DialogUXState::FINISHED:
            return "FINISHED";
    }
    return "Unknown State";
}

inline std::ostream& operator<<(std::ostream& stream, const DialogUXStateObserverInterface::DialogUXState& state) {
    return stream << DialogUXStateObserverInterface::stateToString(state);
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_DIALOGUXSTATEOBSERVERINTERFACE_H_