HephAudio::EchoInfo Struct Reference

container for echo effect parameters. More...

#include <EchoInfo.h>

Public Member Functions
	EchoInfo ()
	EchoInfo (uint32_t reflectionCount, double reflectionDelay_s, double decayFactor, double echoStartPosition, double echoEndPosition)
size_t	CalculateAudioBufferFrameCount (const AudioBuffer &buffer) const

Public Attributes
uint32_t	reflectionCount
double	reflectionDelay_s
double	decayFactor
double	echoStartPosition
double	echoEndPosition

Detailed Description

container for echo effect parameters.

Constructor & Destructor Documentation

EchoInfo() [1/2]

HephAudio::EchoInfo::EchoInfo

(

)

creates a new instance and initializes it with default values.

EchoInfo() [2/2]

HephAudio::EchoInfo::EchoInfo	(	uint32_t	reflectionCount,
		double	reflectionDelay_s,
		double	decayFactor,
		double	echoStartPosition,
		double	echoEndPosition )

creates a new instance and initializes it with the provided values.

Parameters

reflectionCount	number of times the audio data will be reflected (repeated).
reflectionDelay_s	elapsed time, in seconds, between the start of each reflection.
decayFactor	multiplication factor of the reflected data. Reflected data will be multiplied by this between each reflection.
echoStartPosition	start position of the audio data that will be reflected. Should be between 0 and 1.
echoEndPosition	end position of the audio data that will be reflected. Should be between 0 and 1.

Note

the echoStartPosition must be less than or equal to echoEndPosition.

Member Function Documentation

CalculateAudioBufferFrameCount()

size_t HephAudio::EchoInfo::CalculateAudioBufferFrameCount

(

const AudioBuffer &

buffer

)

const

calculates the number of frames the buffer will have after applying the echo effect.

Member Data Documentation

reflectionCount

uint32_t HephAudio::EchoInfo::reflectionCount

number of times the audio data will be reflected (repeated).

reflectionDelay_s

double HephAudio::EchoInfo::reflectionDelay_s

elapsed time, in seconds, between the start of each reflection.

decayFactor

double HephAudio::EchoInfo::decayFactor

multiplication factor of the reflected data. Reflected data will be multiplied by this between each reflection.

echoStartPosition

double HephAudio::EchoInfo::echoStartPosition

start position of the audio data that will be reflected. Should be between 0 and 1.

echoEndPosition

double HephAudio::EchoInfo::echoEndPosition

end position of the audio data that will be reflected. Should be between 0 and 1.

Note

the echoStartPosition must be less than or equal to echoEndPosition.