org.cell2d

Class Sound

java.lang.Object

org.cell2d.Sound

All Implemented Interfaces:

Loadable

public class Sound
extends java.lang.Object
implements Loadable

A Sound is a sound effect. Like other Loadables, Sounds can be manually loaded and unloaded into and out of memory. Loading may take a moment, but while a Sound is not loaded, it cannot play.

Sounds can be played at different speeds from 0 up, with a speed of 0 making the Sound inaudible and a speed of 1 causing no speed change. They can also be played at different volumes between 0 and 1, with a volume of 0 making the Sound inaudible and a volume of 1 causing no volume change. Finally, the Sound class has a global volume between 0 and 1, by which the effective volumes of all newly played Sounds are scaled. The global volume is 1 by default.

Constructor Summary

Constructors

Constructor and Description
Sound(java.lang.String path, boolean load) Constructs a Sound from an audio file.

Method Summary

Modifier and Type	Method and Description
static double	getGlobalVolume() Returns the global sound volume.
boolean	isLoaded() Returns whether this Loadable is loaded.
boolean	isPlaying() Returns whether this Sound is currently playing.
boolean	load() Loads this Loadable if it is not already loaded.
void	play() Plays this Sound once.
void	play(boolean loop) Plays this Sound.
void	play(double speed, double volume) Plays this Sound once at the specified speed and volume.
void	play(double speed, double volume, boolean loop) Plays this Sound at the specified speed and volume.
static void	setGlobalVolume(double volume) Sets the global sound volume to the specified value.
void	stop() Stops this Sound.
boolean	unload() Unloads this Loadable if it is currently loaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sound

public Sound(java.lang.String path,
             boolean load)

Constructs a Sound from an audio file. Files of WAV and OGG formats are supported.

Parameters:

path - The relative path to the audio file

load - Whether this Sound should load upon creation

Method Detail

getGlobalVolume

public static double getGlobalVolume()

Returns the global sound volume.

Returns:

The global sound volume

setGlobalVolume

public static void setGlobalVolume(double volume)

Sets the global sound volume to the specified value.

Parameters:

volume - The new global sound volume

isLoaded

public final boolean isLoaded()

Description copied from interface: Loadable

Returns whether this Loadable is loaded.

Specified by:

isLoaded in interface Loadable

Returns:

Whether this Loadable is loaded

load

public final boolean load()

Description copied from interface: Loadable

Loads this Loadable if it is not already loaded.

Specified by:

load in interface Loadable

Returns:

Whether the loading occurred

unload

public final boolean unload()

Description copied from interface: Loadable

Unloads this Loadable if it is currently loaded.

Specified by:

unload in interface Loadable

Returns:

Whether the unloading occurred

isPlaying

public final boolean isPlaying()

Returns whether this Sound is currently playing.

Returns:

Whether this Sound is currently playing

play

public final void play(boolean loop)

Plays this Sound.

Parameters:

loop - If true, this Sound will loop indefinitely until stopped; otherwise, it will play once

play

public final void play(double speed,
                       double volume,
                       boolean loop)

Plays this Sound at the specified speed and volume.

Parameters:

speed - The speed at which to play this Sound

volume - The volume at which to play this Sound

loop - If true, this Sound will loop indefinitely until stopped; otherwise, it will play once

play

public final void play()

Plays this Sound once.

play

public final void play(double speed,
                       double volume)

Plays this Sound once at the specified speed and volume.

Parameters:

speed - The speed at which to play this Sound

volume - The volume at which to play this Sound

stop

public final void stop()

Stops this Sound.