AudioInfo Struct Reference

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

#include <CodecOpusOgg.h>

Inheritance diagram for AudioInfo:

Public Member Functions
	AudioInfo ()=default
	Default constructor.
	AudioInfo ()=default
	Default constructor.
	AudioInfo (const AudioInfo &)=default
	Copy 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.
	AudioInfo (sample_rate_t sampleRate, uint16_t channelCount, uint8_t bitsPerSample)
	Constructor which supports all attribures as parameters.
virtual void	clear ()
virtual void	clear ()
void	copyFrom (AudioInfo info)
	Same as set.
void	copyFrom (AudioInfo info)
	Same as set.
bool	equals (AudioInfo alt)
	Returns true if alt values are the same like the current values.
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.
bool	equalsExSampleRate (AudioInfo alt)
	Checks if only the sample rate is different.
virtual void	logInfo (const char *source="")
virtual void	logInfo (const char *source="")
	operator bool ()
	Returns true if all components are defined (no component is 0).
	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 different from the current values.
AudioInfo &	operator= (const AudioInfo &info)
	Same as set.
AudioInfo &	operator= (const AudioInfo &info)
	Same as set.
bool	operator== (AudioInfo alt)
	Returns true if alt values are the same like 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	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.
void	setAudioInfo (AudioInfo info)
	Same as set.

Public Attributes
uint8_t	bits_per_sample = 16
	Number of bits per sample (int16_t = 16 bits).
uint16_t	channels = 2
	Number of channels: 2=stereo, 1=mono.
sample_rate_t	sample_rate = 44100
	Sample Rate: e.g 44100.

Detailed Description

Basic Audio information which drives e.g. I2S.

Constructor & Destructor Documentation

AudioInfo() [1/6]

AudioInfo ( )

default

Default constructor.

AudioInfo() [2/6]

AudioInfo ( sample_rate_t sampleRate, uint16_t channelCount, uint8_t bitsPerSample )

inline

Constructor which supports all attribures as parameters.

AudioInfo() [3/6]

AudioInfo ( const AudioInfo & )

default

Copy constructor.

AudioInfo() [4/6]

AudioInfo ( )

default

Default constructor.

AudioInfo() [5/6]

AudioInfo ( sample_rate_t sampleRate, uint16_t channelCount, uint8_t bitsPerSample )

inline

Constructor which supports all attribures as parameters.

AudioInfo() [6/6]

AudioInfo ( const AudioInfo & )

default

Copy constructor.

Member Function Documentation

clear() [1/2]

virtual void clear ( )

inlinevirtual

clear() [2/2]

virtual void clear ( )

inlinevirtual

copyFrom() [1/2]

void copyFrom ( AudioInfo info )

inline

Same as set.

copyFrom() [2/2]

void copyFrom ( AudioInfo info )

inline

Same as set.

equals() [1/2]

bool equals ( AudioInfo alt )

inline

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

equals() [2/2]

bool equals ( AudioInfo alt )

inline

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

equalsExSampleRate() [1/2]

bool equalsExSampleRate ( AudioInfo alt )

inline

Checks if only the sample rate is different.

equalsExSampleRate() [2/2]

bool equalsExSampleRate ( AudioInfo alt )

inline

Checks if only the sample rate is different.

logInfo() [1/2]

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

inlinevirtual

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

logInfo() [2/2]

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

inlinevirtual

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

operator bool() [1/2]

operator bool ( )

inline

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

operator bool() [2/2]

operator bool ( )

inline

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

operator!=() [1/2]

bool operator!= ( AudioInfo alt )

inline

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

operator!=() [2/2]

bool operator!= ( AudioInfo alt )

inline

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

operator=() [1/2]

AudioInfo & operator= ( const AudioInfo & info )

inline

Same as set.

operator=() [2/2]

AudioInfo & operator= ( const AudioInfo & info )

inline

Same as set.

operator==() [1/2]

bool operator== ( AudioInfo alt )

inline

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

operator==() [2/2]

bool operator== ( AudioInfo alt )

inline

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

set() [1/2]

void set ( AudioInfo info )

inline

Copies the values from info.

set() [2/2]

void set ( AudioInfo info )

inline

Copies the values from info.

setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo info )

inline

Same as set.

setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo info )

inline

Same as set.

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = 16

Number of bits per sample (int16_t = 16 bits).

channels

uint16_t channels = 2

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

sample_rate

sample_rate_t sample_rate = 44100

Sample Rate: e.g 44100.

---

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

• src/AudioTools/AudioCodecs/CodecOpusOgg.h
• src/AudioTools/AudioCodecs/CodecTSDemux.h