AudioInfo Struct Reference

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

#include <AudioTypes.h>

Inheritance diagram for AudioInfo:

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.
AudioInfo &	operator= (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.

Constructor & Destructor Documentation

AudioInfo() [1/3]

AudioInfo ( )

default

Default constructor.

AudioInfo() [2/3]

AudioInfo ( sample_rate_t  sampleRate, uint16_t  channelCount, uint8_t  bitsPerSample  )

inline

Constructor which supports all attribures as parameters.

AudioInfo() [3/3]

AudioInfo ( const AudioInfo &  )

default

Copy constructor.

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtual

copyFrom()

void copyFrom ( AudioInfo  info )

inline

Same as set.

equals()

bool equals ( AudioInfo  alt )

inline

Returns true if alt values are the same like the current values.

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inline

Checks if only the sample rate is different.

logInfo()

virtual void logInfo ( const char *  source = "" )

inlinevirtual

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, and I2SConfigStd.

operator bool()

operator bool ( )

inline

Returns true if all components are defined (no component is 0)

operator!=()

bool operator!= ( AudioInfo  alt )

inline

Returns true if alt values are the different from the current values.

operator=()

AudioInfo & operator= ( const AudioInfo &  info )

inline

Same as set.

operator==()

bool operator== ( AudioInfo  alt )

inline

Returns true if alt values are the same like the current values.

set()

void set ( AudioInfo  info )

inline

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inline

Same as set.

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

Number of bits per sample (int16_t = 16 bits)

channels

uint16_t channels = DEFAULT_CHANNELS

Number of channels: 2=stereo, 1=mono.

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

Sample Rate: e.g 44100.

---

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

• src/AudioTools/CoreAudio/AudioTypes.h