HephAudio::LinearFadeOut Class Reference

applies linear fade-out. More...

#include <LinearFadeOut.h>

Inheritance diagram for HephAudio::LinearFadeOut:

Public Member Functions
	LinearFadeOut ()
	LinearFadeOut (double duration)
	LinearFadeOut (double duration, double startTime)
virtual	~LinearFadeOut ()=default
virtual std::string	Name () const override
virtual void	ResetInternalState () override
virtual void	Process (AudioBuffer &buffer, size_t startIndex, size_t frameCount) override
virtual double	GetStartTime () const
virtual void	SetStartTime (double startTime)
virtual double	GetDuration () const
virtual void	SetDuration (double duration)
virtual void	Process (AudioBuffer &buffer)
virtual void	Process (AudioBuffer &buffer, size_t startIndex)
Public Member Functions inherited from HephAudio::AudioEffect
virtual	~AudioEffect ()=default
virtual bool	HasMTSupport () const
virtual bool	HasRTSupport () const
virtual size_t	GetThreadCount () const
virtual void	SetThreadCount (size_t threadCount)
virtual size_t	CalculateRequiredFrameCount (size_t outputFrameCount, const AudioFormatInfo &formatInfo) const
virtual size_t	CalculateOutputFrameCount (size_t inputFrameCount, const AudioFormatInfo &formatInfo) const
virtual size_t	CalculateAdvanceSize (size_t renderFrameCount, const AudioFormatInfo &formatInfo) const

Protected Member Functions
virtual void	ProcessST (const AudioBuffer &inputBuffer, AudioBuffer &outputBuffer, size_t startIndex, size_t frameCount) override
Protected Member Functions inherited from HephAudio::AudioEffect
	AudioEffect ()
virtual void	ProcessMT (const AudioBuffer &inputBuffer, AudioBuffer &outputBuffer, size_t startIndex, size_t frameCount)

Protected Attributes
double	startTime
double	duration
size_t	currentIndex
Protected Attributes inherited from HephAudio::AudioEffect
size_t	threadCount

Detailed Description

applies linear fade-out.

Constructor & Destructor Documentation

LinearFadeOut() [1/3]

HephAudio::LinearFadeOut::LinearFadeOut

(

)

creates a new instance and initializes it with default values.

LinearFadeOut() [2/3]

HephAudio::LinearFadeOut::LinearFadeOut ( double duration )

explicit

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

Parameters

duration

duration of the fade-out in seconds.

LinearFadeOut() [3/3]

HephAudio::LinearFadeOut::LinearFadeOut	(	double	duration,
		double	startTime )

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

Parameters

duration	duration of the fade-out in seconds.
startTime	time, in seconds, of the first audio frame the effect will be applied to.

~LinearFadeOut()

virtual HephAudio::LinearFadeOut::~LinearFadeOut ( )

virtualdefault

releases the resources and destroys the instance.

Member Function Documentation

Name()

virtual std::string HephAudio::LinearFadeOut::Name ( ) const

overridevirtual

gets the name of the audio effect.

Implements HephAudio::AudioEffect.

ResetInternalState()

virtual void HephAudio::LinearFadeOut::ResetInternalState ( )

overridevirtual

resets the variables internally used for processing.

Reimplemented from HephAudio::AudioEffect.

Process() [1/3]

virtual void HephAudio::LinearFadeOut::Process ( AudioBuffer & buffer, size_t startIndex, size_t frameCount )

overridevirtual

Applies the effect.

Parameters

buffer	contains the audio data which will be processed.
startIndex	index of the first audio frame to process.
frameCount	number of frames to process.

Reimplemented from HephAudio::AudioEffect.

GetStartTime()

virtual double HephAudio::LinearFadeOut::GetStartTime ( ) const

virtual

gets the start time in seconds.

SetStartTime()

virtual void HephAudio::LinearFadeOut::SetStartTime ( double startTime )

virtual

sets the start index.

Parameters

startTime

time, in seconds, of the first audio frame the effect will be applied to.

GetDuration()

virtual double HephAudio::LinearFadeOut::GetDuration ( ) const

virtual

gets the duration in seconds.

SetDuration()

virtual void HephAudio::LinearFadeOut::SetDuration ( double duration )

virtual

sets the duration.

Parameters

duration

duration of the fade-out in seconds.

ProcessST()

virtual void HephAudio::LinearFadeOut::ProcessST ( const AudioBuffer & inputBuffer, AudioBuffer & outputBuffer, size_t startIndex, size_t frameCount )

overrideprotectedvirtual

applies the effect using single thread.

Parameters

inputBuffer	contains the audio data which will be processed.
outputBuffer	contains the processed audio data.
startIndex	index of the first sample to process.
frameCount	number of frames to process.

Implements HephAudio::AudioEffect.

Process() [2/3]

virtual void HephAudio::AudioEffect::Process ( AudioBuffer & buffer )

virtual

Applies the effect.

Parameters

buffer

contains the audio data which will be processed.

Reimplemented from HephAudio::AudioEffect.

Process() [3/3]

virtual void HephAudio::AudioEffect::Process ( AudioBuffer & buffer, size_t startIndex )

virtual

Applies the effect.

Parameters

buffer	contains the audio data which will be processed.
startIndex	index of the first audio frame to process.

Reimplemented from HephAudio::AudioEffect.

Member Data Documentation

startTime

double HephAudio::LinearFadeOut::startTime

protected

time, in seconds, of the first audio frame the effect will be applied to.

duration

double HephAudio::LinearFadeOut::duration

protected

duration of the fade-out in seconds.

currentIndex

size_t HephAudio::LinearFadeOut::currentIndex

protected

for real-time processing.