Class AudioLevelEffect
- java.lang.Object
-
- org.jitsi.impl.neomedia.control.AbstractControls
-
- org.jitsi.impl.neomedia.control.ControlsAdapter
-
- org.jitsi.impl.neomedia.audiolevel.AudioLevelEffect
-
- All Implemented Interfaces:
javax.media.Codec,javax.media.Controls,javax.media.Effect,javax.media.PlugIn
public class AudioLevelEffect extends ControlsAdapter implements javax.media.Effect
An effect that would pass data to the AudioLevelEventDispatcher so that it would calculate levels and dispatch changes to interested parties.- Author:
- Damian Minkov, Emil Ivov, Lyubomir Marinov
-
-
Field Summary
-
Fields inherited from class org.jitsi.impl.neomedia.control.ControlsAdapter
EMPTY_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description AudioLevelEffect()The minimum and maximum values of the scale
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Closes this effect.SimpleAudioLevelListenergetAudioLevelListener()Returns the audio level listener.StringgetName()Gets the name of this plug-in as a human-readable string.javax.media.Format[]getSupportedInputFormats()Lists all of the input formats that this codec accepts.javax.media.Format[]getSupportedOutputFormats(javax.media.Format input)Lists the output formats that this codec can generate.voidopen()Opens this effect.intprocess(javax.media.Buffer inputBuffer, javax.media.Buffer outputBuffer)Performs the media processing defined by this codec.voidreset()Resets its state.voidsetAudioLevelListener(SimpleAudioLevelListener listener)Sets (or unsets if listener is null), the listener that is going to be notified of audio level changes detected by this effect.javax.media.FormatsetInputFormat(javax.media.Format format)Sets the format of the data to be input to this codec.javax.media.FormatsetOutputFormat(javax.media.Format format)Sets the format for the data this codec outputs.-
Methods inherited from class org.jitsi.impl.neomedia.control.ControlsAdapter
getControls
-
Methods inherited from class org.jitsi.impl.neomedia.control.AbstractControls
getControl, getControl, queryInterface, queryInterface
-
-
-
-
Method Detail
-
setAudioLevelListener
public void setAudioLevelListener(SimpleAudioLevelListener listener)
Sets (or unsets if listener is null), the listener that is going to be notified of audio level changes detected by this effect. Given the semantics of theAudioLevelEventDispatcherthis effect would do no real work if no listener is set or if it is set to null.- Parameters:
listener- the SimpleAudioLevelListener that we'd like to receive level changes or null if we'd like level measurements to stop.
-
getAudioLevelListener
public SimpleAudioLevelListener getAudioLevelListener()
Returns the audio level listener.- Returns:
- the audio level listener or null if it does not exist.
-
getSupportedInputFormats
public javax.media.Format[] getSupportedInputFormats()
Lists all of the input formats that this codec accepts.- Specified by:
getSupportedInputFormatsin interfacejavax.media.Codec- Returns:
- An array that contains the supported input Formats.
-
getSupportedOutputFormats
public javax.media.Format[] getSupportedOutputFormats(javax.media.Format input)
Lists the output formats that this codec can generate.- Specified by:
getSupportedOutputFormatsin interfacejavax.media.Codec- Parameters:
input- The Format of the data to be used as input to the plug-in.- Returns:
- An array that contains the supported output Formats.
-
setInputFormat
public javax.media.Format setInputFormat(javax.media.Format format)
Sets the format of the data to be input to this codec.- Specified by:
setInputFormatin interfacejavax.media.Codec- Parameters:
format- The Format to be set.- Returns:
- The Format that was set.
-
setOutputFormat
public javax.media.Format setOutputFormat(javax.media.Format format)
Sets the format for the data this codec outputs.- Specified by:
setOutputFormatin interfacejavax.media.Codec- Parameters:
format- The Format to be set.- Returns:
- The Format that was set.
-
process
public int process(javax.media.Buffer inputBuffer, javax.media.Buffer outputBuffer)Performs the media processing defined by this codec.- Specified by:
processin interfacejavax.media.Codec- Parameters:
inputBuffer- The Buffer that contains the media data to be processed.outputBuffer- The Buffer in which to store the processed media data.- Returns:
- BUFFER_PROCESSED_OK if the processing is successful.
- See Also:
PlugIn
-
getName
public String getName()
Gets the name of this plug-in as a human-readable string.- Specified by:
getNamein interfacejavax.media.PlugIn- Returns:
- A String that contains the descriptive name of the plug-in.
-
open
public void open() throws javax.media.ResourceUnavailableExceptionOpens this effect.- Specified by:
openin interfacejavax.media.PlugIn- Throws:
javax.media.ResourceUnavailableException- If all of the required resources cannot be acquired.
-
close
public void close()
Closes this effect.- Specified by:
closein interfacejavax.media.PlugIn
-
reset
public void reset()
Resets its state.- Specified by:
resetin interfacejavax.media.PlugIn
-
-