Package adams.data.video

Class AbstractSoundRecorder

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.video.AbstractRecorder

adams.data.video.AbstractFileBaseRecorder

adams.data.video.AbstractSoundRecorder

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

Direct Known Subclasses:

SampledSoundRecorder

public abstract class AbstractSoundRecorder
extends AbstractFileBaseRecorder

Ancestor for sound recorders.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected float	m_Frequency	the frequency to use.

Fields inherited from class adams.data.video.AbstractFileBaseRecorder

m_Output

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractSoundRecorder()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	frequencyTipText()	Returns the tip text for this property.
float	getFrequency()	Returns the frequency.
void	setFrequency(float value)	Sets the frequency.

Methods inherited from class adams.data.video.AbstractFileBaseRecorder

getDefaultOutput, getOutput, outputTipText, setOutput

Methods inherited from class adams.data.video.AbstractRecorder

configure, doConfigure

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Frequency

protected float m_Frequency

the frequency to use.

Constructor Detail

AbstractSoundRecorder

public AbstractSoundRecorder()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractFileBaseRecorder

setFrequency

public void setFrequency(float value)

Sets the frequency.

Parameters:

value - the frequency

getFrequency

public float getFrequency()

Returns the frequency.

Returns:

the frequency

frequencyTipText

public String frequencyTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.