PortAudioConfig Class Reference

PortAudio information. More...

#include <PortAudioStream.h>

Inheritance diagram for PortAudioConfig:

Public Member Functions
	PortAudioConfig ()
	PortAudioConfig (const AudioInfo &in)
	PortAudioConfig (const PortAudioConfig &)=default
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	buffer_count = 1
int	buffer_size = 0
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
bool	is_input = false
bool	is_output = true
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.

Detailed Description

PortAudio information.

Constructor & Destructor Documentation

PortAudioConfig() [1/3]

PortAudioConfig ( )

inline

PortAudioConfig() [2/3]

PortAudioConfig ( const PortAudioConfig &  )

default

PortAudioConfig() [3/3]

PortAudioConfig ( const AudioInfo &  in )

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)

buffer_count

int buffer_count = 1

buffer_size

int buffer_size = 0

Size of a single buffer in bytes and the number of buffers - same buffer_size/buffer_count pattern used by I2SConfig/MiniAudioConfig. Together they define PortAudio's total internal buffering (buffer_size * buffer_count bytes, converted to frames per buffer internally) - a larger total adds latency but absorbs more jitter from a slow/bursty producer (e.g. this project's synchronous demux+decode+write loops), reducing "output underflowed" warnings. buffer_size 0 (default) leaves it to PortAudio's own default (paFramesPerBufferUnspecified).

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

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

is_input

bool is_input = false

is_output

bool is_output = true

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

---

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

• src/AudioTools/AudioLibs/PortAudioStream.h