Package adams.flow.sink.ffmpeg

Class ConvertAudio

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.sink.ffmpeg.AbstractFFmpegPlugin

adams.flow.sink.ffmpeg.AbstractFFmpegPluginWithOptions

adams.flow.sink.ffmpeg.ConvertAudio

All Implemented Interfaces:

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

public class ConvertAudio
extends AbstractFFmpegPluginWithOptions

Converts audio files.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_BitRate	the bitrate to use.
protected String	m_Encoder	the output encoder to use.

Fields inherited from class adams.flow.sink.ffmpeg.AbstractFFmpegPluginWithOptions

m_AdditionalInputOptions, m_AdditionalOutputOptions

Fields inherited from class adams.flow.sink.ffmpeg.AbstractFFmpegPlugin

m_Input, m_Owner

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
ConvertAudio()

Method Summary

Modifier and Type	Method	Description
protected String	assembleActualInputOptions()	Assembles the actual input command-line options, not including the additional options or the input file.
protected String	assembleActualOutputOptions()	Assembles the actual output command-line options, not including the additional options.
String	bitRateTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	encoderTipText()	Returns the tip text for this property.
int	getBitRate()	Returns the bit rate to use.
String	getEncoder()	Returns the encoder to use.
String	getQuickInfo()	Returns a quick info about the plugin, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setBitRate(int value)	Sets the bit rate to use.
void	setEncoder(String value)	Sets the encoder to use.

Methods inherited from class adams.flow.sink.ffmpeg.AbstractFFmpegPluginWithOptions

additionalInputOptionsTipText, additionalOutputOptionsTipText, assembleInputOptions, assembleOutputOptions, getAdditionalInputOptions, getAdditionalOutputOptions, getDefaultAdditionalInputOptions, getDefaultAdditionalOutputOptions, setAdditionalInputOptions, setAdditionalOutputOptions

Methods inherited from class adams.flow.sink.ffmpeg.AbstractFFmpegPlugin

execute, getExecutable, getInput, getOwner, handleException, initialize, reset, setInput, setOwner, setUp

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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_Encoder

protected String m_Encoder

the output encoder to use.

m_BitRate

protected int m_BitRate

the bitrate to use.

Constructor Detail

ConvertAudio

public ConvertAudio()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

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 AbstractFFmpegPluginWithOptions

setEncoder

public void setEncoder(String value)

Sets the encoder to use.

Parameters:

value - the encoder

getEncoder

public String getEncoder()

Returns the encoder to use.

Returns:

the encoder

encoderTipText

public String encoderTipText()

Returns the tip text for this property.

Returns:

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

setBitRate

public void setBitRate(int value)

Sets the bit rate to use.

Parameters:

value - the bit rate

getBitRate

public int getBitRate()

Returns the bit rate to use.

Returns:

the bit rate

bitRateTipText

public String bitRateTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the plugin, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractFFmpegPluginWithOptions

Returns:

null if no info available, otherwise short string

assembleActualInputOptions

protected String assembleActualInputOptions()

Assembles the actual input command-line options, not including the additional options or the input file.

Specified by:

assembleActualInputOptions in class AbstractFFmpegPluginWithOptions

Returns:

the command-line

assembleActualOutputOptions

protected String assembleActualOutputOptions()

Assembles the actual output command-line options, not including the additional options.

Specified by:

assembleActualOutputOptions in class AbstractFFmpegPluginWithOptions

Returns:

the command-line