Module org.refcodes.audio

Package org.refcodes.audio

Class CurveFunctionSoundSampleBuilderImpl

java.lang.Object

org.refcodes.audio.CurveFunctionSoundSampleBuilderImpl

All Implemented Interfaces:

CurveFunctionSoundSampleBuilder, SamplingRateAccessor, SamplingRateAccessor.SamplingRateBuilder<CurveFunctionSoundSampleBuilder>, SamplingRateAccessor.SamplingRateMutator, SamplingRateAccessor.SamplingRateProperty

public class CurveFunctionSoundSampleBuilderImpl
extends Object
implements CurveFunctionSoundSampleBuilder

The CurveFunctionSoundSampleBuilderImpl implements the CurveFunctionSoundSampleBuilder interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.audio.SamplingRateAccessor

SamplingRateAccessor.SamplingRateBuilder<B extends SamplingRateAccessor.SamplingRateBuilder<B>>, SamplingRateAccessor.SamplingRateMutator, SamplingRateAccessor.SamplingRateProperty

Constructor Summary

Constructors

Constructor	Description
CurveFunctionSoundSampleBuilderImpl()

Method Summary

Modifier and Type	Method	Description
double	getAmplitude()	Returns the amplitude being used when generating MonoSample instances.
double	getFrequency()	Returns the frequency in Hz being used when generating MonoSample instances.
int	getIndex()	Returns the index being used when generating MonoSample instances.
int	getSamplingRate()	Retrieves the sampling rate from the sampling rate property.
Function<Double,Double>	getTrigonometricFunction()	Returns the trigonometric function being used when generating MonoSample instances.
int	getXOffset()	Returns the x-offset being used when generating MonoSample instances.
double	getYOffset()	Returns the yOffset being used when generating MonoSample instances.
MonoSample	next()	Returns the next MonoSample for the current index (as of CurveFunctionSoundSampleBuilder.getIndex()) as well as for the other builder's settings and increases the index by one.
void	setAmplitude(double aAmplitude)	Sets the amplitude to be used when generating MonoSample instances.
void	setFrequency(double aFrequencyInHz)	Sets the frequency in Hz to be used when generating MonoSample instances.
void	setIndex(int aIndex)	Sets the index to be used when generating MonoSample instances.
void	setSamplingRate(int aSamplingRate)	Sets the sampling rate for the sampling rate property.
void	setTrigonometricFunction(Function<Double,Double> aFunction)	Sets the trigonometric function to be used when generating MonoSample.
void	setXOffset(int aXOffset)	Sets the x-offset to be used when generating MonoSample instances.
void	setYOffset(double aYOffset)	Sets the y-offset to be used when generating MonoSample instances.
MonoSample	toMonoSample()	Creates a MonoSample as of the builder's settings.
MonoSample	toMonoSample(int index)	Creates a MonoSample for the given index and the the builder's settings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.audio.CurveFunctionSoundSampleBuilder

setTrigonometricFunction, withAmplitude, withFrequency, withIndex, withSamplingRate, withTrigonometricFunction, withTrigonometricFunction, withXOffset, withYOffset

Methods inherited from interface org.refcodes.audio.SamplingRateAccessor.SamplingRateProperty

letSamplingRate

Constructor Details

CurveFunctionSoundSampleBuilderImpl

public CurveFunctionSoundSampleBuilderImpl()

Method Details

setTrigonometricFunction

public void setTrigonometricFunction(Function<Double,Double> aFunction)

Sets the trigonometric function to be used when generating MonoSample.

Specified by:

setTrigonometricFunction in interface CurveFunctionSoundSampleBuilder

Parameters:

aFunction - The Function to be set.

getTrigonometricFunction

public Function<Double,Double> getTrigonometricFunction()

Returns the trigonometric function being used when generating MonoSample instances.

Specified by:

getTrigonometricFunction in interface CurveFunctionSoundSampleBuilder

Returns:

The Function being set.

setIndex

public void setIndex(int aIndex)

Sets the index to be used when generating MonoSample instances.

Specified by:

setIndex in interface CurveFunctionSoundSampleBuilder

Parameters:

aIndex - The index to be set.

getIndex

public int getIndex()

Returns the index being used when generating MonoSample instances.

Specified by:

getIndex in interface CurveFunctionSoundSampleBuilder

Returns:

The index being set.

setFrequency

public void setFrequency(double aFrequencyInHz)

Sets the frequency in Hz to be used when generating MonoSample instances.

Specified by:

setFrequency in interface CurveFunctionSoundSampleBuilder

Parameters:

aFrequencyInHz - The frequency to be set.

getFrequency

public double getFrequency()

Returns the frequency in Hz being used when generating MonoSample instances.

Specified by:

getFrequency in interface CurveFunctionSoundSampleBuilder

Returns:

The frequency in Hz being set.

setAmplitude

public void setAmplitude(double aAmplitude)

Sets the amplitude to be used when generating MonoSample instances.

Specified by:

setAmplitude in interface CurveFunctionSoundSampleBuilder

Parameters:

aAmplitude - The amplitude to be set.

getAmplitude

public double getAmplitude()

Returns the amplitude being used when generating MonoSample instances.

Specified by:

getAmplitude in interface CurveFunctionSoundSampleBuilder

Returns:

The amplitude being set.

setXOffset

public void setXOffset(int aXOffset)

Sets the x-offset to be used when generating MonoSample instances.

Specified by:

setXOffset in interface CurveFunctionSoundSampleBuilder

Parameters:

aXOffset - The x-offset to be set.

getXOffset

public int getXOffset()

Returns the x-offset being used when generating MonoSample instances.

Specified by:

getXOffset in interface CurveFunctionSoundSampleBuilder

Returns:

The x-offset being set.

setYOffset

public void setYOffset(double aYOffset)

Sets the y-offset to be used when generating MonoSample instances.

Specified by:

setYOffset in interface CurveFunctionSoundSampleBuilder

Parameters:

aYOffset - The y-offset to be set.

getYOffset

public double getYOffset()

Returns the yOffset being used when generating MonoSample instances.

Specified by:

getYOffset in interface CurveFunctionSoundSampleBuilder

Returns:

The yOffset being set.

setSamplingRate

public void setSamplingRate(int aSamplingRate)

Sets the sampling rate for the sampling rate property.

Specified by:

setSamplingRate in interface SamplingRateAccessor.SamplingRateMutator

Parameters:

aSamplingRate - The sampling rate to be stored by the sampling rate property.

getSamplingRate

public int getSamplingRate()

Retrieves the sampling rate from the sampling rate property.

Specified by:

getSamplingRate in interface SamplingRateAccessor

Returns:

The sampling rate stored by the sampling rate property.

next

public MonoSample next()

Returns the next MonoSample for the current index (as of CurveFunctionSoundSampleBuilder.getIndex()) as well as for the other builder's settings and increases the index by one.

Specified by:

next in interface CurveFunctionSoundSampleBuilder

Returns:

The next MonoSample being set up.

toMonoSample

public MonoSample toMonoSample()

Creates a MonoSample as of the builder's settings.

Specified by:

toMonoSample in interface CurveFunctionSoundSampleBuilder

Returns:

The sound sample as of the builder's settings.

toMonoSample

public MonoSample toMonoSample(int index)

Creates a MonoSample for the given index and the the builder's settings.

Specified by:

toMonoSample in interface CurveFunctionSoundSampleBuilder

Parameters:

index - The index for which to create the sound sample.

Returns:

The sound sample as of the index and the builder's settings.