arduino-audio-tools
Public Member Functions | Public Attributes | List of all members
AudioInfo Struct Reference

Basic Audio information which drives e.g. I2S. More...

#include <AudioTypes.h>

Inheritance diagram for AudioInfo:
AnalogConfigESP32 AnalogConfigESP32V1 AnalogConfigStd AudioFFTConfig AudioLoRaConfig AudioMP34DT05Config AudioServerExConfig ConfigEquilizer3Bands DACInfo I2SConfigESP32 I2SConfigESP32V1 I2SConfigStd MiniAudioConfig MozziConfig OpusSettings PWMConfig PitchShiftInfo PortAudioConfig ProgressStreamInfo R2RConfig ResampleConfig SPDIFConfig ThrottleConfig TimerCallbackAudioStreamInfo VBANConfig VS1053Config VolumeStreamConfig WAVAudioInfo WavIMAAudioInfo

Public Member Functions

 AudioInfo ()=default
 Default constructor.
 
 AudioInfo (const AudioInfo &)=default
 Copy constructor.
 
 AudioInfo (sample_rate_t sampleRate, uint16_t channelCount, uint8_t bitsPerSample)
 Constructor which supports all attribures as parameters.
 
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.
 
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.
 
AudioInfooperator= (const AudioInfo &info)
 Same as set.
 
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.
 
sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE
 Sample Rate: e.g 44100.
 

Detailed Description

Basic Audio information which drives e.g. I2S.


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