SpeechSynthesizerObserverInterface.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_SPEECHSYNTHESIZEROBSERVERINTERFACE_H_
#define ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEECHSYNTHESIZEROBSERVERINTERFACE_H_

#include <iostream>
#include <vector>

#include <AVSCommon/Utils/MediaPlayer/MediaPlayerInterface.h>
#include <AVSCommon/Utils/AudioAnalyzer/AudioAnalyzerState.h>

namespace alexaClientSDK {
namespace avsCommon {
namespace sdkInterfaces {

class SpeechSynthesizerObserverInterface {
public:
    enum class SpeechSynthesizerState {
        PLAYING,

        FINISHED,

        INTERRUPTED,

        GAINING_FOCUS,

        LOSING_FOCUS
    };

    virtual ~SpeechSynthesizerObserverInterface() = default;

    virtual void onStateChanged(
        SpeechSynthesizerState state,
        const avsCommon::utils::mediaPlayer::MediaPlayerInterface::SourceId mediaSourceId,
        const avsCommon::utils::Optional<avsCommon::utils::mediaPlayer::MediaPlayerState>& mediaPlayerState,
        const std::vector<avsCommon::utils::audioAnalyzer::AudioAnalyzerState>& audioAnalyzerState) = 0;
};

inline std::ostream& operator<<(
    std::ostream& stream,
    const SpeechSynthesizerObserverInterface::SpeechSynthesizerState state) {
    switch (state) {
        case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::PLAYING:
            stream << "PLAYING";
            break;
        case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::FINISHED:
            stream << "FINISHED";
            break;
        case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::INTERRUPTED:
            stream << "INTERRUPTED";
            break;
        case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::GAINING_FOCUS:
            stream << "GAINING_FOCUS";
            break;
        case SpeechSynthesizerObserverInterface::SpeechSynthesizerState::LOSING_FOCUS:
            stream << "LOSING_FOCUS";
            break;
    }
    return stream;
}

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

#endif  // ALEXA_CLIENT_SDK_AVSCOMMON_SDKINTERFACES_INCLUDE_AVSCOMMON_SDKINTERFACES_SPEECHSYNTHESIZEROBSERVERINTERFACE_H_