city.cs.engine

Class SoundClip

java.lang.Object

city.cs.engine.SoundClip

public class SoundClip
extends Object

Sound clips loaded from audio files. If exceptions are thrown when loading mp3 or other compressed audio file formats, check that you have appropriate support libraries on your classpath. Libraries can be obtained from http://www.javazoom.net/mp3spi/sources.html.

 Contributors:
  seb  (soi.city.ac.uk) - initial API and implementation
  Matthias Pfisterer - code for converting compressed formats, adapted from
  AudioPlayer (http://jsresources.org/); code adapted from AudioPlayer is
  covered by the following notices:

 Copyright (c) 1999, 2000 by Matthias Pfisterer
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 - Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 - Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 OF THE POSSIBILITY OF SUCH DAMAGE.
 

Constructor Summary

Constructors

Constructor and Description
SoundClip(String fileName) Initialise a new sound clip from the named audio file.
SoundClip(URL url) Initialise a new sound clip from the audio file located at the given url.

Method Summary

Modifier and Type	Method and Description
void	close() Permanently close the clip.
protected void	finalize() Close the clip if still open when garbage collected.
void	loop() Start playing the clip in a continuous loop.
void	pause() Pause the playing of the clip.
void	play() Play the clip from the start.
void	resume() Resume playing a paused clip.
void	setVolume(double volume) Adjust the volume of the sound.
void	stop() Stop playing the clip.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundClip

public SoundClip(String fileName)
          throws UnsupportedAudioFileException,
                 IOException,
                 LineUnavailableException

Initialise a new sound clip from the named audio file.

Parameters:

fileName - audio file name

Throws:

UnsupportedAudioFileException

IOException

LineUnavailableException

SoundClip

public SoundClip(URL url)
          throws UnsupportedAudioFileException,
                 IOException,
                 LineUnavailableException

Initialise a new sound clip from the audio file located at the given url.

Parameters:

url - the location of the audio file

Throws:

UnsupportedAudioFileException

IOException

LineUnavailableException

Method Detail

setVolume

public void setVolume(double volume)

Adjust the volume of the sound. A value of 1.0 (the default) means the sound will play at its normal level, 0.5 at half normal level, 2.0 at twice normal level, and so on.

Parameters:

volume - The multiplier to apply to the clip's default volume level.

play

public void play()

Play the clip from the start.

loop

public void loop()

Start playing the clip in a continuous loop.

stop

public void stop()

Stop playing the clip. Does nothing if the clip is not playing.

resume

public void resume()

Resume playing a paused clip.

pause

public void pause()

Pause the playing of the clip.

close

public void close()

Permanently close the clip. The clip will no longer play.

finalize

protected void finalize()
                 throws Throwable

Close the clip if still open when garbage collected.

Overrides:

finalize in class Object

Throws:

Throwable