Configuration for SPIAudioSlave. More...
#include <SPIAudioSlave.h>
Public Member Functions | |
| virtual void | clear () |
| void | copyFrom (AudioInfo info) |
| Same as set. | |
| bool | equals (AudioInfo alt) |
| Returns true if alt values are the same like the current values. | |
| bool | equalsExSampleRate (AudioInfo alt) |
| Checks if only the sample rate is different. | |
| void | log () const |
| virtual void | logInfo (const char *source="") |
| operator bool () | |
| Returns true if all components are defined (no component is 0) | |
| bool | operator!= (AudioInfo alt) |
| Returns true if alt values are the different from the current values. | |
| bool | operator== (AudioInfo alt) |
| Returns true if alt values are the same like the current values. | |
| void | set (AudioInfo info) |
| Copies the values from info. | |
| void | setAudioInfo (AudioInfo info) |
| Same as set. | |
Public Attributes | |
| uint8_t | bits_per_sample = DEFAULT_BITS_PER_SAMPLE |
| Number of bits per sample (int16_t = 16 bits) | |
| uint16_t | channels = DEFAULT_CHANNELS |
| Number of channels: 2=stereo, 1=mono. | |
| int | dma_chan = 1 |
| spi_host_device_t | host = SPI2_HOST |
| size_t | max_command_payload = 1024 |
| size_t | max_mime_len = 20 |
| size_t | max_response_payload = 32 |
| int | pin_cs = 5 |
| int | pin_miso = 19 |
| int | pin_mosi = 23 |
| int | pin_sclk = 18 |
| int | queue_size = 4 |
| sample_rate_t | sample_rate = DEFAULT_SAMPLE_RATE |
| Sample Rate: e.g 44100. | |
| bool | use_hw_slave = true |
Detailed Description
Configuration for SPIAudioSlave.
Performance Tuning (ESP32)
For optimal performance with ESP32 SPI slave hardware:
- queue_size: Increase from default 4 to 8+ if experiencing buffer overflow or if audio data arrives in large bursts. Each queue entry consumes ~256 bytes of DMA-capable RAM. Start with 4 and increase as needed.
- dma_chan: DMA channel (1 or 2). Usually doesn't affect performance.
- use_hw_slave: Set to true (default) to use hardware SPI slave driver instead of bit-banging, significantly improving throughput.
Member Function Documentation
◆ clear()
|
inlinevirtualinherited |
◆ copyFrom()
|
inlineinherited |
Same as set.
◆ equals()
Returns true if alt values are the same like the current values.
◆ equalsExSampleRate()
Checks if only the sample rate is different.
◆ log()
|
inline |
◆ logInfo()
|
inlinevirtualinherited |
Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.
◆ operator bool()
|
inlineinherited |
Returns true if all components are defined (no component is 0)
◆ operator!=()
Returns true if alt values are the different from the current values.
◆ operator==()
Returns true if alt values are the same like the current values.
◆ set()
|
inlineinherited |
Copies the values from info.
◆ setAudioInfo()
|
inlineinherited |
Same as set.
Member Data Documentation
◆ bits_per_sample
|
inherited |
Number of bits per sample (int16_t = 16 bits)
◆ channels
|
inherited |
Number of channels: 2=stereo, 1=mono.
◆ dma_chan
| int dma_chan = 1 |
◆ host
| spi_host_device_t host = SPI2_HOST |
◆ max_command_payload
| size_t max_command_payload = 1024 |
◆ max_mime_len
| size_t max_mime_len = 20 |
◆ max_response_payload
| size_t max_response_payload = 32 |
◆ pin_cs
| int pin_cs = 5 |
◆ pin_miso
| int pin_miso = 19 |
◆ pin_mosi
| int pin_mosi = 23 |
◆ pin_sclk
| int pin_sclk = 18 |
◆ queue_size
| int queue_size = 4 |
Queue size for SPI slave transactions. Higher values improve throughput at the cost of DMA RAM. Default 4 balances performance and memory usage.
◆ sample_rate
|
inherited |
Sample Rate: e.g 44100.
◆ use_hw_slave
| bool use_hw_slave = true |
The documentation for this struct was generated from the following file:
- src/AudioTools/Communication/SPI/SPIAudioSlave.h
