Class espos_voice::WakeEngine

ClassList > espos_voice > WakeEngine

• #include <espos_voice/wake_engine.h>

Public Types

Type	Name
typedef std::function< void()>	DetectFn
typedef std::function< bool()>	MutedFn

Public Functions

Type	Name
	WakeEngine (espos_audio::AudioDriver * audio)
void	clear_probe ()
uint32_t	detections () const
bool	listening () const
void	pause ()
uint32_t	pcm_age_ms () const
size_t	pcm_snapshot (int16_t * out, size_t max_samples)
void	resume ()
bool	running () const
void	set_input_gain (int g)
void	set_muted_fn (MutedFn fn)
void	set_on_detect (DetectFn fn)
void	set_threshold (float t)
bool	start ()
void	stop ()
const char *	word () const
	~WakeEngine ()

Public Types Documentation

typedef DetectFn

using espos_voice::WakeEngine::DetectFn =  std::function<void()>;

---

typedef MutedFn

using espos_voice::WakeEngine::MutedFn =  std::function<bool()>;

---

Public Functions Documentation

function WakeEngine

inline explicit espos_voice::WakeEngine::WakeEngine (
    espos_audio::AudioDriver * audio
) 

---

function clear_probe

void espos_voice::WakeEngine::clear_probe () 

---

function detections

inline uint32_t espos_voice::WakeEngine::detections () const

---

function listening

inline bool espos_voice::WakeEngine::listening () const

---

function pause

void espos_voice::WakeEngine::pause () 

---

function pcm_age_ms

uint32_t espos_voice::WakeEngine::pcm_age_ms () const

---

function pcm_snapshot

size_t espos_voice::WakeEngine::pcm_snapshot (
    int16_t * out,
    size_t max_samples
) 

---

function resume

void espos_voice::WakeEngine::resume () 

---

function running

inline bool espos_voice::WakeEngine::running () const

---

function set_input_gain

inline void espos_voice::WakeEngine::set_input_gain (
    int g
) 

---

function set_muted_fn

inline void espos_voice::WakeEngine::set_muted_fn (
    MutedFn fn
) 

---

function set_on_detect

inline void espos_voice::WakeEngine::set_on_detect (
    DetectFn fn
) 

---

function set_threshold

inline void espos_voice::WakeEngine::set_threshold (
    float t
) 

---

function start

bool espos_voice::WakeEngine::start () 

---

function stop

void espos_voice::WakeEngine::stop () 

---

function word

inline const char * espos_voice::WakeEngine::word () const

---

function ~WakeEngine

espos_voice::WakeEngine::~WakeEngine () 

---

---

The documentation for this class was generated from the following file espos_voice/include/espos_voice/wake_engine.h