org.apache.tools.ant.taskdefs.optional.sound

Class AntSoundPlayer

Implemented Interfaces:
EventListener, LineListener, BuildListener

public class AntSoundPlayer
extends java.lang.Object
implements LineListener, BuildListener

This class is designed to be used by any AntTask that requires audio output. It implements the BuildListener interface to listen for BuildEvents and could be easily extended to provide audio output upon any specific build events occuring. I have only tested this with .WAV and .AIFF sound file formats. Both seem to work fine.

Constructor Summary

AntSoundPlayer()

Method Summary

void
addBuildFailedSound(File fileFail, int loopsFail, Long durationFail)
void
addBuildSuccessfulSound(File file, int loops, Long duration)
void
buildFinished(BuildEvent event)
Fired after the last target has finished.
void
buildStarted(BuildEvent event)
Fired before any targets are started.
void
messageLogged(BuildEvent event)
Fired whenever a message is logged.
void
targetFinished(BuildEvent event)
Fired when a target has finished.
void
targetStarted(BuildEvent event)
Fired when a target is started.
void
taskFinished(BuildEvent event)
Fired when a task has finished.
void
taskStarted(BuildEvent event)
Fired when a task is started.
void
update(LineEvent event)
This is implemented to listen for any line events and closes the clip if required.

Constructor Details

AntSoundPlayer

public AntSoundPlayer()

Method Details

addBuildFailedSound

public void addBuildFailedSound(File fileFail,
                                int loopsFail,
                                Long durationFail)
Parameters:
fileFail - the location of the audio file to be played when the build fails
loopsFail - the number of times the file should be played when the build is fails
durationFail - the number of milliseconds the file should be played when the build fails

addBuildSuccessfulSound

public void addBuildSuccessfulSound(File file,
                                    int loops,
                                    Long duration)
Parameters:
file - the location of the audio file to be played when the build is successful
loops - the number of times the file should be played when the build is successful
duration - the number of milliseconds the file should be played when the build is successful

buildFinished

public void buildFinished(BuildEvent event)
Fired after the last target has finished. This event will still be thrown if an error occurred during the build.
Specified by:
buildFinished in interface BuildListener

buildStarted

public void buildStarted(BuildEvent event)
Fired before any targets are started.
Specified by:
buildStarted in interface BuildListener

messageLogged

public void messageLogged(BuildEvent event)
Fired whenever a message is logged.
Specified by:
messageLogged in interface BuildListener

targetFinished

public void targetFinished(BuildEvent event)
Fired when a target has finished. This event will still be thrown if an error occurred during the build.
Specified by:
targetFinished in interface BuildListener

targetStarted

public void targetStarted(BuildEvent event)
Fired when a target is started.
Specified by:
targetStarted in interface BuildListener

taskFinished

public void taskFinished(BuildEvent event)
Fired when a task has finished. This event will still be throw if an error occurred during the build.
Specified by:
taskFinished in interface BuildListener

taskStarted

public void taskStarted(BuildEvent event)
Fired when a task is started.
Specified by:
taskStarted in interface BuildListener

update

public void update(LineEvent event)
This is implemented to listen for any line events and closes the clip if required.

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.