kuusisto.tinysound

Class TinySound

java.lang.Object

kuusisto.tinysound.TinySound

public class TinySound
extends Object

TinySound is the main class of the TinySound system. In order to use the TinySound system, it must be initialized. After that, Music and Sound objects can be loaded and used. When finished with the TinySound system, it must be shutdown.

Author:

Finn Kuusisto

Field Summary

Fields

Modifier and Type	Field and Description
static AudioFormat	FORMAT The internal format used by TinySound.
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
TinySound()

Method Summary

Methods

Modifier and Type	Method and Description
static double	getGlobalVolume() Get the global volume for all audio.
static void	init() Initialize Tinysound.
static void	init(Mixer.Info info) Alternative function to initialize TinySound which should only be used by those very familiar with the Java Sound API.
static boolean	isInitialized() Determine if TinySound is initialized and ready for use.
static Music	loadMusic(File file) Load a Music by a File.
static Music	loadMusic(File file, boolean streamFromFile) Load a Music by a File.
static Music	loadMusic(String name) Load a Music by a resource name.
static Music	loadMusic(String name, boolean streamFromFile) Load a Music by a resource name.
static Music	loadMusic(URL url) Load a Music by a URL.
static Music	loadMusic(URL url, boolean streamFromFile) Load a Music by a URL.
static Sound	loadSound(File file) Load a Sound by a File.
static Sound	loadSound(File file, boolean streamFromFile) Load a Sound by a File.
static Sound	loadSound(String name) Load a Sound by a resource name.
static Sound	loadSound(String name, boolean streamFromFile) Load a Sound by a resource name.
static Sound	loadSound(URL url) Load a Sound by a URL.
static Sound	loadSound(URL url, boolean streamFromFile) Load a Sound by a URL.
static void	setGlobalVolume(double volume) Set the global volume.
static void	shutdown() Shutdown TinySound.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

FORMAT

public static final AudioFormat FORMAT

The internal format used by TinySound.

Constructor Detail

TinySound

public TinySound()

Method Detail

init

public static void init()

Initialize Tinysound. This must be called before loading audio.

init

public static void init(Mixer.Info info)
                 throws LineUnavailableException,
                        SecurityException,
                        IllegalArgumentException

Alternative function to initialize TinySound which should only be used by those very familiar with the Java Sound API. This function allows the line that is used for audio playback to be opened on a specific Mixer.

Parameters:

info - the Mixer.Info representing the desired Mixer

Throws:

LineUnavailableException - if a Line is not available from the specified Mixer

SecurityException - if the specified Mixer or Line are unavailable due to security restrictions

IllegalArgumentException - if the specified Mixer is not installed on the system

shutdown

public static void shutdown()

Shutdown TinySound.

isInitialized

public static boolean isInitialized()

Determine if TinySound is initialized and ready for use.

Returns:

true if TinySound is initialized, false if TinySound has not been initialized or has subsequently been shutdown

getGlobalVolume

public static double getGlobalVolume()

Get the global volume for all audio.

Returns:

the global volume for all audio, -1.0 if TinySound has not been initialized or has subsequently been shutdown

setGlobalVolume

public static void setGlobalVolume(double volume)

Set the global volume. This is an extra multiplier, not a replacement, for all Music and Sound volume settings. It starts at 1.0.

Parameters:

volume - the global volume to set

loadMusic

public static Music loadMusic(String name)

Load a Music by a resource name. The resource must be on the classpath for this to work. This will store audio data in memory.

Parameters:

name - name of the Music resource

Returns:

Music resource as specified, null if not found/loaded

loadMusic

public static Music loadMusic(String name,
              boolean streamFromFile)

Load a Music by a resource name. The resource must be on the classpath for this to work.

Parameters:

name - name of the Music resource

streamFromFile - true if this Music should be streamed from a temporary file to reduce memory overhead

Returns:

Music resource as specified, null if not found/loaded

loadMusic

public static Music loadMusic(File file)

Load a Music by a File. This will store audio data in memory.

Parameters:

file - the Music file to load

Returns:

Music from file as specified, null if not found/loaded

loadMusic

public static Music loadMusic(File file,
              boolean streamFromFile)

Load a Music by a File.

Parameters:

file - the Music file to load

streamFromFile - true if this Music should be streamed from a temporary file to reduce memory overhead

Returns:

Music from file as specified, null if not found/loaded

loadMusic

public static Music loadMusic(URL url)

Load a Music by a URL. This will store audio data in memory.

Parameters:

url - the URL of the Music

Returns:

Music from URL as specified, null if not found/loaded

loadMusic

public static Music loadMusic(URL url,
              boolean streamFromFile)

Load a Music by a URL.

Parameters:

url - the URL of the Music

streamFromFile - true if this Music should be streamed from a temporary file to reduce memory overhead

Returns:

Music from URL as specified, null if not found/loaded

loadSound

public static Sound loadSound(String name)

Load a Sound by a resource name. The resource must be on the classpath for this to work. This will store audio data in memory.

Parameters:

name - name of the Sound resource

Returns:

Sound resource as specified, null if not found/loaded

loadSound

public static Sound loadSound(String name,
              boolean streamFromFile)

Load a Sound by a resource name. The resource must be on the classpath for this to work.

Parameters:

name - name of the Sound resource

streamFromFile - true if this Music should be streamed from a temporary file to reduce memory overhead

Returns:

Sound resource as specified, null if not found/loaded

loadSound

public static Sound loadSound(File file)

Load a Sound by a File. This will store audio data in memory.

Parameters:

file - the Sound file to load

Returns:

Sound from file as specified, null if not found/loaded

loadSound

public static Sound loadSound(File file,
              boolean streamFromFile)

Load a Sound by a File.

Parameters:

file - the Sound file to load

streamFromFile - true if this Music should be streamed from a temporary file to reduce memory overhead

Returns:

Sound from file as specified, null if not found/loaded

loadSound

public static Sound loadSound(URL url)

Load a Sound by a URL. This will store audio data in memory.

Parameters:

url - the URL of the Sound

Returns:

Sound from URL as specified, null if not found/loaded

loadSound

public static Sound loadSound(URL url,
              boolean streamFromFile)

Load a Sound by a URL. This will store audio data in memory.

Parameters:

url - the URL of the Sound

streamFromFile - true if this Music should be streamed from a temporary file to reduce memory overhead

Returns:

Sound from URL as specified, null if not found/loaded