arduino-audio-tools
Public Member Functions | Public Attributes | List of all members
WM8960Config Class Reference

Configuration for WM8960. More...

#include <WM8960Stream.h>

Inheritance diagram for WM8960Config:
I2SConfigESP32 AudioInfo

Public Member Functions

 WM8960Config (RxTxMode mode)
 
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 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

bool auto_clear = I2S_AUTO_CLEAR
 
uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE
 Number of bits per sample (int16_t = 16 bits)

 
int buffer_count = I2S_BUFFER_COUNT
 
int buffer_size = I2S_BUFFER_SIZE
 
uint16_t channels = DEFAULT_CHANNELS
 Number of channels: 2=stereo, 1=mono.
 
float default_volume = 0.6
 Volume that is used on start (range 0.0 to 1.0)
 
int8_t features = -1
 
uint32_t fixed_mclk = 0
 
uint32_t i2c_retry_count = 0
 Number of i2c write retry on fail: 0 = endless until success.
 
I2SFormat i2s_format = I2S_STD_FORMAT
 
bool is_master = true
 
int pin_bck = PIN_I2S_BCK
 
int pin_data = -1
 
int pin_data_rx = -1
 
int pin_mck = -1
 
int pin_ws = PIN_I2S_WS
 
int port_no = 0
 
RxTxMode rx_tx_mode = RXTX_MODE
 public settings
 
sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE
 Sample Rate: e.g 44100.
 
I2SSignalType signal_type = Digital
 
bool use_apll = I2S_USE_APLL
 
bool vs1053_dump = false
 Dump registers.
 
bool vs1053_enable_pll = true
 enalbel pll for wm8960 - default is true
 
uint32_t vs1053_mclk_hz = 0
 masterclock rate for wm8960 - default is 0
 
TwoWire * wire =nullptr
 Define wire if we do not use the default Wire object.
 

Detailed Description

Configuration for WM8960.

Author
Phil Schatzmann

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