WAVAudioInfo Struct Reference

Sound information which is available in the WAV header. More...

#include <CodecWAV.h>

Inheritance diagram for WAVAudioInfo:

Collaboration diagram for WAVAudioInfo:

Public Member Functions
	WAVAudioInfo ()=default
	WAVAudioInfo (const AudioInfo &from)
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.
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)
int	block_align = 0
int	byte_rate = 0
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
uint32_t	data_length = 0
bool	ext_adpcm_header = false
	write the extended 'fmt ' chunk + 'fact' chunk for ADPCM formats
uint32_t	file_size = 0
AudioFormat	format = AudioFormat::PCM
bool	is_streamed = true
bool	is_valid = false
int	offset = 0
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.

Detailed Description

Sound information which is available in the WAV header.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

WAVAudioInfo() [1/2]

WAVAudioInfo ( )

default

WAVAudioInfo() [2/2]

WAVAudioInfo ( const AudioInfo &  from )

inline

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtualinherited

copyFrom()

void copyFrom ( AudioInfo  info )

inlineinherited

Same as set.

equals()

bool equals ( AudioInfo  alt )

inlineinherited

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

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inlineinherited

Checks if only the sample rate is different.

logInfo()

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

inlinevirtualinherited

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

operator bool()

operator bool ( )

inlineinherited

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

operator!=()

bool operator!= ( AudioInfo  alt )

inlineinherited

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

operator==()

bool operator== ( AudioInfo  alt )

inlineinherited

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

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

block_align

int block_align = 0

byte_rate

int byte_rate = 0

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

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

data_length

uint32_t data_length = 0

ext_adpcm_header

bool ext_adpcm_header = false

write the extended 'fmt ' chunk + 'fact' chunk for ADPCM formats

file_size

uint32_t file_size = 0

format

AudioFormat format = AudioFormat::PCM

is_streamed

bool is_streamed = true

is_valid

bool is_valid = false

offset

int offset = 0

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

---

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

• src/AudioTools/AudioCodecs/CodecWAV.h