TimerCallbackAudioStreamInfo Struct Reference

TimerCallbackAudioStream Configuration. More...

#include <AudioStreams.h>

Inheritance diagram for TimerCallbackAudioStreamInfo:

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.
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
bool	adapt_sample_rate = false
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
uint16_t	buffer_size = DEFAULT_BUFFER_SIZE
uint16_t(*	callback )(uint8_t *data, uint16_t len) = nullptr
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
RxTxMode	rx_tx_mode = RX_MODE
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
TimerFunction	timer_function = DirectTimerCallback
int	timer_id = -1
bool	use_timer = true

Detailed Description

TimerCallbackAudioStream Configuration.

Author

Phil Schatzmann

Copyright

GPLv3

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, and I2SConfigStd.

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

adapt_sample_rate

bool adapt_sample_rate = false

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

buffer_size

uint16_t buffer_size = DEFAULT_BUFFER_SIZE

callback

uint16_t(* callback) (uint8_t *data, uint16_t len) = nullptr

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

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

rx_tx_mode

RxTxMode rx_tx_mode = RX_MODE

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

timer_function

TimerFunction timer_function = DirectTimerCallback

timer_id

int timer_id = -1

use_timer

bool use_timer = true

---

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

• src/AudioTools/CoreAudio/AudioStreams.h