tts_interface.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. 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.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 __NUGU_TTS_INTERFACE_H__
#define __NUGU_TTS_INTERFACE_H__
 
#include <clientkit/capability_interface.hh>
#include <nugu.h>
 
namespace NuguCapability {
 
using namespace NuguClientKit;
 
#define NUGU_TTS_ENGINE "skt" 
enum class TTSState {
    TTS_SPEECH_START, 
    TTS_SPEECH_STOP, 
    TTS_SPEECH_FINISH 
};
 
typedef struct _TTSAttribute {
    std::string tts_engine; 
} TTSAttribute;
 
class NUGU_API ITTSListener : virtual public ICapabilityListener {
public:
    virtual ~ITTSListener() = default;
 
    virtual void onTTSState(TTSState state, const std::string& dialog_id) = 0;
 
    virtual void onTTSText(const std::string& text, const std::string& dialog_id) = 0;
 
    virtual void onTTSCancel(const std::string& dialog_id) = 0;
};
 
class NUGU_API ITTSHandler : virtual public ICapabilityInterface {
public:
    virtual ~ITTSHandler() = default;
 
    virtual void addListener(ITTSListener* listener) = 0;
 
    virtual void removeListener(ITTSListener* listener) = 0;
 
    virtual void stopTTS() = 0;
 
    virtual std::string requestTTS(const std::string& text, const std::string& play_service_id, const std::string& referrer_id = "") = 0;
 
    virtual bool setVolume(int volume) = 0;
 
    virtual bool setMute(bool mute) = 0;
 
    virtual void setAttribute(TTSAttribute&& attribute) = 0;
 
    virtual std::string getPlayServiceId() = 0;
};
 
} // NuguCapability
 
#endif /* __NUGU_TTS_INTERFACE_H__ */