com.SIMRacingApps.Util

Class Sound

java.lang.Object

com.SIMRacingApps.Util.Sound

public class Sound
extends java.lang.Object

This class allows you to load a sound file (WAV) and play it.

Since:

1.0

Author:

Jeffrey Gilliam

Copyright:

Copyright (C) 2015 - 2024 Jeffrey Gilliam

License:

Apache License 2.0

Constructor Summary

Constructors

Constructor and Description
Sound(java.lang.String deviceName, java.lang.String filename) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the sound.
void	drain() Waits for the sound to stop playing, then returns.
void	finalize()
double	getDuration() Returns the duration of the clip in seconds down to the microsecond.
java.lang.String	getErrorMessage() Returns the error message.
long	getLastTimePlayed() Returns the system time of the last time this clip was played.
static double	getMasterVolume() Returns the master volume percentage
double	getVolume() Get the volume for this clip as a percentage of the volume range.
boolean	isPlaying() Returns true if clip is currently playing
static void	loadMixers()
void	loop(int count) Plays the sound, count, times in the background.
static void	main(java.lang.String[] args)
void	play() Starts the sound playing in the background.
void	setBalance(double percentage) Sets the balance position as a percentage of left to right.
static void	setMasterVolume(double percentage) Sets the master volume percentage.
void	setMinTimeBetweenPlays(long milliseconds) Sets the minimum time between plays in milliseconds
void	setVolume(double percentage) Set the volume for this clip as a percentage of the volume range.
void	stop() Stops the currently playing sound.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sound

public Sound(java.lang.String deviceName,
             java.lang.String filename)

Constructor. Creates a Sound object. If the device name is not found, it falls back to the default device. The device name can be the mixer number, but be aware that could change if new sound devices are installed. If the filename is not found, no exception is thrown, it just doesn't play anything.

Parameters:

deviceName - The Sound device name.

filename - The path to the audio file to play. Can be a resource in the classpath.

Method Detail

getErrorMessage

public java.lang.String getErrorMessage()

Returns the error message. Returns blank if no error occured.

Returns:

The error message.

getDuration

public double getDuration()

Returns the duration of the clip in seconds down to the microsecond.

Returns:

The duration of the clip in seconds.

getLastTimePlayed

public long getLastTimePlayed()

Returns the system time of the last time this clip was played. Use to compare with System.currentTimeMillis().

Returns:

The last time played as a long

getMasterVolume

public static double getMasterVolume()

Returns the master volume percentage

Returns:

The master volume as a percentage in the range between 0.0 to 100.0

setMasterVolume

public static void setMasterVolume(double percentage)

Sets the master volume percentage. The current volume is adjusted to compensate.

Parameters:

percentage - The percentage in the range of 0.0 to 1.0 or 0.0 to 100.0

getVolume

public double getVolume()

Get the volume for this clip as a percentage of the volume range.

Returns:

The volume as a percentage in the range between 0.0 to 100.0

setVolume

public void setVolume(double percentage)

Set the volume for this clip as a percentage of the volume range.

Parameters:

percentage - The percentage in the range of 0.0 to 1.0 or 0.0 to 100.0

setBalance

public void setBalance(double percentage)

Sets the balance position as a percentage of left to right. .5 is centered. Note: If the source file is mono, you cannot change the balance. Convert it to stereo.

Parameters:

percentage - The balance position as a percentage between 0.0 to 100.0.

play

public void play()

Starts the sound playing in the background.

isPlaying

public boolean isPlaying()

Returns true if clip is currently playing

Returns:

Returns true if clip is currently playing

setMinTimeBetweenPlays

public void setMinTimeBetweenPlays(long milliseconds)

Sets the minimum time between plays in milliseconds

Parameters:

milliseconds - Number of milliseconds to wait. Defaults to zero.

loop

public void loop(int count)

Plays the sound, count, times in the background. To play it unlimited pass in Integer.MAX_VALUE.

Parameters:

count - The number of times to play the sound.

drain

public void drain()

Waits for the sound to stop playing, then returns.

stop

public void stop()

Stops the currently playing sound.

close

public void close()

Closes the sound. It will not play again after calling this.

finalize

public void finalize()
              throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

loadMixers

public static void loadMixers()

main

public static void main(java.lang.String[] args)