esphome::microphone::Microphone Class Reference

#include <microphone.h>

Inheritance diagram for esphome::microphone::Microphone:

Public Member Functions
virtual void	start ()=0
virtual void	stop ()=0
void	add_data_callback (std::function< void(const std::vector< uint8_t > &)> &&data_callback)
bool	is_running () const
bool	is_stopped () const
void	set_mute_state (bool is_muted)
bool	get_mute_state ()
audio::AudioStreamInfo	get_audio_stream_info ()

Protected Member Functions
std::vector< uint8_t >	silence_audio_ (std::vector< uint8_t > data)

Protected Attributes
State	state_ {STATE_STOPPED}
bool	mute_state_ {false}
audio::AudioStreamInfo	audio_stream_info_
CallbackManager< void(const std::vector< uint8_t > &)>	data_callbacks_ {}

Detailed Description

Definition at line 21 of file microphone.h.

Member Function Documentation

add_data_callback()

void esphome::microphone::Microphone::add_data_callback

(

std::function< void(const std::vector< uint8_t > &)> &&

data_callback

)

Definition at line 6 of file microphone.cpp.

get_audio_stream_info()

audio::AudioStreamInfo esphome::microphone::Microphone::get_audio_stream_info ( )

inline

Definition at line 33 of file microphone.h.

get_mute_state()

bool esphome::microphone::Microphone::get_mute_state ( )

inline

Definition at line 31 of file microphone.h.

is_running()

bool esphome::microphone::Microphone::is_running ( ) const

inline

Definition at line 27 of file microphone.h.

is_stopped()

bool esphome::microphone::Microphone::is_stopped ( ) const

inline

Definition at line 28 of file microphone.h.

set_mute_state()

void esphome::microphone::Microphone::set_mute_state ( bool is_muted )

inline

Definition at line 30 of file microphone.h.

silence_audio_()

std::vector< uint8_t > esphome::microphone::Microphone::silence_audio_ ( std::vector< uint8_t > data )

protected

Definition at line 12 of file microphone.cpp.

start()

virtual void esphome::microphone::Microphone::start ( )

pure virtual

Implemented in esphome::i2s_audio::I2SAudioMicrophone.

stop()

virtual void esphome::microphone::Microphone::stop ( )

pure virtual

Implemented in esphome::i2s_audio::I2SAudioMicrophone.

Field Documentation

audio_stream_info_

audio::AudioStreamInfo esphome::microphone::Microphone::audio_stream_info_

protected

Definition at line 41 of file microphone.h.

data_callbacks_

CallbackManager<void(const std::vector<uint8_t> &)> esphome::microphone::Microphone::data_callbacks_ {}

protected

Definition at line 43 of file microphone.h.

mute_state_

bool esphome::microphone::Microphone::mute_state_ {false}

protected

Definition at line 39 of file microphone.h.

state_

State esphome::microphone::Microphone::state_ {STATE_STOPPED}

protected

Definition at line 38 of file microphone.h.

---

The documentation for this class was generated from the following files:

• esphome/components/microphone/microphone.h
• esphome/components/microphone/microphone.cpp