speech_recognizer_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_SPEECH_RECOGNIZER_INTERFACE_H__
#define __NUGU_SPEECH_RECOGNIZER_INTERFACE_H__
 
#include <string>
 
#include <nugu.h>
 
namespace NuguClientKit {
 
enum class ListeningState {
    READY, 
    LISTENING, 
    SPEECH_START, 
    SPEECH_END, 
    TIMEOUT, 
    FAILED, 
    DONE 
};
 
typedef struct _EpdAttribute {
    int epd_timeout; 
    int epd_max_duration; 
    long epd_pause_length; 
} EpdAttribute;
 
class NUGU_API ISpeechRecognizerListener {
public:
    virtual ~ISpeechRecognizerListener() = default;
 
    virtual void onListeningState(ListeningState state, const std::string& id) = 0;
 
    virtual void onRecordData(unsigned char* buf, int length, bool is_end) = 0;
};
 
class NUGU_API ISpeechRecognizer {
public:
    virtual ~ISpeechRecognizer() = default;
 
    virtual void setListener(ISpeechRecognizerListener* listener) = 0;
 
    virtual bool startListening(const std::string& id) = 0;
 
    virtual void stopListening() = 0;
 
    virtual void finishListening() = 0;
 
    virtual void setEpdAttribute(const EpdAttribute& attribute) = 0;
 
    virtual EpdAttribute getEpdAttribute() = 0;
 
    virtual bool isMute() = 0;
 
    virtual std::string getCodec() = 0;
 
    virtual std::string getMimeType() = 0;
};
 
} // NuguClientKit
 
#endif /* __NUGU_SPEECH_RECOGNIZER_INTERFACE_H__*/