esphome::audio::ConstAudioSourceBuffer Class Reference

A lightweight read-only audio buffer for const data sources (e.g., flash memory). More...

#include <audio_transfer_buffer.h>

Inheritance diagram for esphome::audio::ConstAudioSourceBuffer:

Public Member Functions
void	set_data (const uint8_t *data, size_t length)
	Sets the data pointer and length for the buffer.
const uint8_t *	data () const override
size_t	available () const override
void	consume (size_t bytes) override
bool	has_buffered_data () const override
Public Member Functions inherited from esphome::audio::AudioReadableBuffer
virtual	~AudioReadableBuffer ()=default
virtual size_t	free () const
	Returns the number of free bytes available to write. Defaults to 0 for read-only buffers.
virtual size_t	fill (TickType_t ticks_to_wait, bool pre_shift)
	Refills the buffer from its source.
size_t	fill (TickType_t ticks_to_wait)

Protected Attributes
const uint8_t *	data_start_ {nullptr}
size_t	length_ {0}

Detailed Description

A lightweight read-only audio buffer for const data sources (e.g., flash memory).

Does not allocate memory or transfer data from external sources.

Definition at line 198 of file audio_transfer_buffer.h.

Member Function Documentation

available()

size_t esphome::audio::ConstAudioSourceBuffer::available ( ) const

inlineoverridevirtual

Implements esphome::audio::AudioReadableBuffer.

Definition at line 207 of file audio_transfer_buffer.h.

consume()

void esphome::audio::ConstAudioSourceBuffer::consume ( size_t bytes )

overridevirtual

Implements esphome::audio::AudioReadableBuffer.

Definition at line 205 of file audio_transfer_buffer.cpp.

data()

const uint8_t * esphome::audio::ConstAudioSourceBuffer::data ( ) const

inlineoverridevirtual

Implements esphome::audio::AudioReadableBuffer.

Definition at line 206 of file audio_transfer_buffer.h.

has_buffered_data()

bool esphome::audio::ConstAudioSourceBuffer::has_buffered_data ( ) const

inlineoverridevirtual

Implements esphome::audio::AudioReadableBuffer.

Definition at line 209 of file audio_transfer_buffer.h.

set_data()

void esphome::audio::ConstAudioSourceBuffer::set_data	(	const uint8_t *	data,
		size_t	length )

Sets the data pointer and length for the buffer.

Parameters

data	Pointer to the const audio data
length	Size of the data in bytes

Definition at line 200 of file audio_transfer_buffer.cpp.

Field Documentation

data_start_

const uint8_t* esphome::audio::ConstAudioSourceBuffer::data_start_ {nullptr}

protected

Definition at line 212 of file audio_transfer_buffer.h.

length_

size_t esphome::audio::ConstAudioSourceBuffer::length_ {0}

protected

Definition at line 213 of file audio_transfer_buffer.h.

---

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

• esphome/components/audio/audio_transfer_buffer.h
• esphome/components/audio/audio_transfer_buffer.cpp