sk.upjs.jpaz2

Class AudioClip

java.lang.Object

sk.upjs.jpaz2.AudioClip

public class AudioClip
extends Object

Audio clip for playing an uncompressed sampled audio (AIFF, AU and WAV) or a midi file (MID).

Constructor Summary

Constructors

Constructor and Description
AudioClip(File file) Constructs a new audio clip from an audio file.
AudioClip(File file, boolean storeInMemory) Constructs a new audio clip from an audio file.
AudioClip(String audioLocation) Constructs a new audio clip from an audio file at a specified location.
AudioClip(String audioLocation, boolean storeInMemory) Constructs a new audio clip from an audio file at a specified location.
AudioClip(String packageName, String fileName) Constructs a new audio clip from an audio resource located in specified package and a given filename.
AudioClip(String packageName, String fileName, boolean storeInMemory) Constructs a new audio clip from an audio resource located in specified package and a given filename.
AudioClip(URL url) Constructs a new audio clip from a resource specified by an URL.
AudioClip(URL url, boolean storeInMemory) Constructs a new audio clip from a resource specified by an URL.

Method Summary

Modifier and Type	Method and Description
double	getVolume() Returns volume of audio clip.
boolean	isPlaying() Returns whether this audio clip is playing.
void	play() Plays this audio clip.
void	playAsActionSound() Plays this audio clip as an action sound.
void	playInLoop() Plays this audio clip in the infinite loop.
void	setVolume(double volume) Sets volume of audio clip.
void	stop() Stops this audio clip.
void	stopAllActionSounds() Stops all action sounds of this audio clip.

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioClip

public AudioClip(URL url,
                 boolean storeInMemory)

Constructs a new audio clip from a resource specified by an URL.

Parameters:

url - the URL of the audio file

storeInMemory - true, if the audio file data should be loaded to memory, false otherwise.

AudioClip

public AudioClip(URL url)

Constructs a new audio clip from a resource specified by an URL. The resource is loaded into memory.

Parameters:

url - the URL of the audio file

AudioClip

public AudioClip(File file,
                 boolean storeInMemory)

Constructs a new audio clip from an audio file.

Parameters:

file - the audio file.

storeInMemory - true, if the audio file data should be loaded to memory, false otherwise.

AudioClip

public AudioClip(File file)

Constructs a new audio clip from an audio file. The file is loaded into memory.

Parameters:

file - the audio file.

AudioClip

public AudioClip(String audioLocation,
                 boolean storeInMemory)

Constructs a new audio clip from an audio file at a specified location. If location string starts with /, it is first considered to be a resource location. If resource localization failed, location string is considered as a file name.

Parameters:

audioLocation - the string with location of an audio file (file or resource).

storeInMemory - true, if the audio file data should be loaded to memory, false otherwise.

AudioClip

public AudioClip(String audioLocation)

Constructs a new audio clip from an audio file at a specified location. If location string starts with /, it is first considered to be a resource location. If resource localization failed, location string is considered as a file name. The audio file is loaded into memory.

Parameters:

audioLocation - the string with location of an audio file (file or resource).

AudioClip

public AudioClip(String packageName,
                 String fileName,
                 boolean storeInMemory)

Constructs a new audio clip from an audio resource located in specified package and a given filename.

Parameters:

packageName - the package where resource file is searched

fileName - the filename (in the package given by parameter packageName)

storeInMemory - true, if the audio file data should be loaded to memory, false otherwise.

AudioClip

public AudioClip(String packageName,
                 String fileName)

Constructs a new audio clip from an audio resource located in specified package and a given filename. The audio resource is loaded into memory.

Parameters:

packageName - the package where resource file is searched

fileName - the filename (in the package given by parameter packageName)

Method Detail

play

public void play()

Plays this audio clip. If it is played, it will be started again.

stop

public void stop()

Stops this audio clip.

playInLoop

public void playInLoop()

Plays this audio clip in the infinite loop.

isPlaying

public boolean isPlaying()

Returns whether this audio clip is playing.

Returns:

true, if this audio clip is playing, false otherwise.

playAsActionSound

public void playAsActionSound()

Plays this audio clip as an action sound. Action sounds are played simultaneously with all other action sounds.

stopAllActionSounds

public void stopAllActionSounds()

Stops all action sounds of this audio clip.

getVolume

public double getVolume()

Returns volume of audio clip. Volume is a number between 0 and 1 (loudest).

Returns:

the volume of audio clip.

setVolume

public void setVolume(double volume)

Sets volume of audio clip. Volume is a number between 0 and 1 (loudest).

Parameters:

volume - the desired volume of audio clip.