esphome::audio::AudioReadableBuffer Class Reference

Abstract interface for reading audio data from a buffer. More...

#include <audio_transfer_buffer.h>

Inheritance diagram for esphome::audio::AudioReadableBuffer:

Public Member Functions
virtual	~AudioReadableBuffer ()=default
virtual const uint8_t *	data () const =0
	Returns a pointer to the start of readable data.
virtual size_t	available () const =0
	Returns the number of bytes available to read.
virtual size_t	free () const
	Returns the number of free bytes available to write. Defaults to 0 for read-only buffers.
virtual void	consume (size_t bytes)=0
	Advances past consumed data.
virtual bool	has_buffered_data () const =0
	Tests if there is any buffered data.
virtual size_t	fill (TickType_t ticks_to_wait)
	Refills the buffer from its source.
	ESPDEPRECATED ("Use fill(ticks_to_wait) instead. Removed in 2027.5.0.", "2026.11.0") virtual size_t fill(TickType_t ticks_to_wait

Data Fields
bool	pre_shift { return this->fill(ticks_to_wait)

Detailed Description

Abstract interface for reading audio data from a buffer.

Provides a common read interface for both mutable transfer buffers and read-only const buffers.

Definition at line 134 of file audio_transfer_buffer.h.

Constructor & Destructor Documentation

~AudioReadableBuffer()

virtual esphome::audio::AudioReadableBuffer::~AudioReadableBuffer ( )

virtualdefault

Member Function Documentation

available()

virtual size_t esphome::audio::AudioReadableBuffer::available ( ) const

pure virtual

Returns the number of bytes available to read.

Implemented in esphome::audio::ConstAudioSourceBuffer, and esphome::audio::RingBufferAudioSource.

consume()

virtual void esphome::audio::AudioReadableBuffer::consume ( size_t bytes )

pure virtual

Advances past consumed data.

Parameters

bytes

Number of bytes consumed

Implemented in esphome::audio::ConstAudioSourceBuffer, and esphome::audio::RingBufferAudioSource.

data()

virtual const uint8_t * esphome::audio::AudioReadableBuffer::data ( ) const

pure virtual

Returns a pointer to the start of readable data.

Implemented in esphome::audio::ConstAudioSourceBuffer, and esphome::audio::RingBufferAudioSource.

ESPDEPRECATED()

esphome::audio::AudioReadableBuffer::ESPDEPRECATED	(	"Use fill(ticks_to_wait) instead. Removed in 2027.5.0."	,
		"2026.11.0"	)

fill()

virtual size_t esphome::audio::AudioReadableBuffer::fill ( TickType_t ticks_to_wait )

inlinevirtual

Refills the buffer from its source.

No-op by default for read-only buffers.

Parameters

ticks_to_wait

FreeRTOS ticks to block while waiting for data

Returns

Number of bytes read

Reimplemented in esphome::audio::RingBufferAudioSource.

Definition at line 157 of file audio_transfer_buffer.h.

free()

virtual size_t esphome::audio::AudioReadableBuffer::free ( ) const

inlinevirtual

Returns the number of free bytes available to write. Defaults to 0 for read-only buffers.

Definition at line 145 of file audio_transfer_buffer.h.

has_buffered_data()

virtual bool esphome::audio::AudioReadableBuffer::has_buffered_data ( ) const

pure virtual

Tests if there is any buffered data.

Implemented in esphome::audio::ConstAudioSourceBuffer, and esphome::audio::RingBufferAudioSource.

Field Documentation

pre_shift

bool esphome::audio::AudioReadableBuffer::pre_shift { return this->fill(ticks_to_wait)

Definition at line 161 of file audio_transfer_buffer.h.

---

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

• esphome/components/audio/audio_transfer_buffer.h