ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::microphone::Microphone Class Referenceabstract

#include <microphone.h>

Inheritance diagram for esphome::microphone::Microphone:
esphome::i2s_audio::I2SAudioMicrophone esphome::resampler::ResamplerMicrophone esphome::usb_audio::USBAudioMicrophone

Public Member Functions

virtual void start ()=0
 
virtual void stop ()=0
 
template<typename F >
void add_data_callback (F &&data_callback)
 Callbacks take (const AudioCapture &) and run on the microphone's task.
 
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

void publish_audio_ (std::span< uint8_t > data, const audio::AudioStreamInfo &stream_info, int64_t capture_time_us=0)
 While muted, data is zeroed first, so it must be a buffer the platform owns.
 
bool has_data_callbacks_ () const
 

Protected Attributes

State state_ {STATE_STOPPED}
 
bool mute_state_ {false}
 
audio::AudioStreamInfo audio_stream_info_
 
DataCallbackManager data_callbacks_ {&this->audio_stream_info_, &this->mute_state_}
 

Detailed Description

Definition at line 78 of file microphone.h.

Member Function Documentation

◆ add_data_callback()

template<typename F >
void esphome::microphone::Microphone::add_data_callback ( F && data_callback)
inline

Callbacks take (const AudioCapture &) and run on the microphone's task.

Definition at line 84 of file microphone.h.

◆ get_audio_stream_info()

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

Definition at line 94 of file microphone.h.

◆ get_mute_state()

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

Definition at line 92 of file microphone.h.

◆ has_data_callbacks_()

bool esphome::microphone::Microphone::has_data_callbacks_ ( ) const
inlineprotected

Definition at line 105 of file microphone.h.

◆ is_running()

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

Definition at line 88 of file microphone.h.

◆ is_stopped()

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

Definition at line 89 of file microphone.h.

◆ publish_audio_()

void esphome::microphone::Microphone::publish_audio_ ( std::span< uint8_t > data,
const audio::AudioStreamInfo & stream_info,
int64_t capture_time_us = 0 )
inlineprotected

While muted, data is zeroed first, so it must be a buffer the platform owns.

Definition at line 98 of file microphone.h.

◆ set_mute_state()

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

Definition at line 91 of file microphone.h.

◆ start()

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

◆ stop()

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

Field Documentation

◆ audio_stream_info_

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

Definition at line 110 of file microphone.h.

◆ data_callbacks_

DataCallbackManager esphome::microphone::Microphone::data_callbacks_ {&this->audio_stream_info_, &this->mute_state_}
protected

Definition at line 113 of file microphone.h.

◆ mute_state_

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

Definition at line 108 of file microphone.h.

◆ state_

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

Definition at line 107 of file microphone.h.


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