arduino-audio-tools
All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Modules Pages
Public Member Functions | Public Attributes | Protected Attributes | List of all members
PWMConfig Struct Reference

Configuration data for PWM audio output. More...

#include <PWMAudioBase.h>

Inheritance diagram for PWMConfig:
AudioInfo

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 logConfig ()
 
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 buffer_size = PWM_BUFFER_SIZE
 size of an inidividual buffer
 
uint8_t buffers = PWM_BUFFER_COUNT
 number of buffers
 
uint16_t channels = DEFAULT_CHANNELS
 Number of channels: 2=stereo, 1=mono.
 
uint32_t max_sample_rate = PWM_MAX_SAMPLE_RATE
 max sample sample rate that still produces good audio
 
uint32_t pwm_frequency = 0
 additinal info which might not be used by all processors
 
uint8_t resolution = 8
 Only used by ESP32: must be between 8 and 11 -> drives pwm frequency // 20,000Hz (not used by ESP32)
 
sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE
 Sample Rate: e.g 44100.
 
uint8_t timer_id = 0
 Timer used: Only used by ESP32 must be between 0 and 3

 

Protected Attributes

Pins pins_data
 

Detailed Description

Configuration data for PWM audio output.

Author
Phil Schatzmann

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