PitchShiftInfo Struct Reference

Configuration for PitchShiftOutput. More...

#include <PitchShift.h>

Inheritance diagram for PitchShiftInfo:

Public Member Functions
	PitchShiftInfo ()
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_size = 1000
	Size of the internal buffer used for pitch shifting (affects quality and latency)
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
float	pitch_shift = 1.4f
	Pitch shift factor: 1.0 = no change, >1.0 = higher pitch, <1.0 = lower pitch.
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.

Detailed Description

Configuration for PitchShiftOutput.

This structure contains all the parameters needed to configure pitch shifting. The pitch_shift parameter determines the amount of frequency shift applied to the audio. Values > 1.0 increase pitch (higher frequency), values < 1.0 decrease pitch (lower frequency). A value of 1.0 means no pitch change.

Note

The buffer_size affects the quality and latency of the pitch shifting. Larger buffers provide better quality but increase latency.

Constructor & Destructor Documentation

PitchShiftInfo()

PitchShiftInfo ( )

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, 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

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

buffer_size

int buffer_size = 1000

Size of the internal buffer used for pitch shifting (affects quality and latency)

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

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

pitch_shift

float pitch_shift = 1.4f

Pitch shift factor: 1.0 = no change, >1.0 = higher pitch, <1.0 = lower pitch.

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/CoreAudio/AudioEffects/PitchShift.h