Media

Class Sound

java.lang.Object

Media.Sound

All Implemented Interfaces:

java.lang.Iterable<Sample>

public class Sound
extends java.lang.Object
implements java.lang.Iterable<Sample>

This class represents a sound that can be played. A sound is a collection of Samples, being the height of the sound wave at the sampling intervals. A sound can be saved as a WAV file.

Version:

1.0 July 2008, 2.0 (08/07/09), 3.0 (09/05/04), 4.0 (09/05/04), 5.0 (10/09/02), 6.0 (12/06/12)

Author:

A. Cheesman, D. Hughes, D. Hughes, D. Hughes, D. Hughes, D. Hughes

Constructor Summary

Constructors

Constructor and Description
Sound() Create a sound opening a WAV file selected from a dialog.
Sound(java.io.File file) Create a sound from a specified WAV file.
Sound(int length) Create a new empty (all samples 0) sound with specified length
Sound(int length, int sampSize, int sampRate) Create a new empty (silent, all samples 0) sound with specified length (number of samples), sample size (frame size) and sample rate (frame rate)
Sound(int length, Sound like) Create a new empty (silent, all samples 0) sound with specified length (number of samples) and same sound parameters as another sound
Sound(java.lang.String filePath) Create a sound from a specified WAV file.

Method Summary

Modifier and Type	Method and Description
void	close() Frees resources associated with the Sound.
java.io.File	getFile() Returns the file that is associated with this sound or null if there is no such file.
int	getNumSamples() Returns the number of samples in the sound.
Sample	getSample(int pos) Returns the Sample at a particular position in the Sound.
int	getSampleRate() Returns the sampling (frame) rate for the sound.
int	getSampleSize() Returns the sample (frame) size for the sound.
boolean	hasNext() This method returns true if there is at least one more sample that hasn't been accessed via the default iterator.
java.util.Iterator<Sample>	iterator()
Sample	next() This method returns the next sample in the sound.
void	play() This method plays the sound.
void	save() This method saves the sound to a file chosen from a dialog.
void	save(java.io.File to) This method saves the sound to a specified file.
void	save(java.lang.String to) This method saves the sound to a specified file

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Sound

public Sound()

Create a sound opening a WAV file selected from a dialog.

Sound

public Sound(java.io.File file)

Create a sound from a specified WAV file.

Parameters:

file - the file descriptor for the WAV file.

Sound

public Sound(java.lang.String filePath)

Create a sound from a specified WAV file.

Parameters:

filePath - the directory and the file name of the file.

Sound

public Sound(int length,
             int sampSize,
             int sampRate)

Create a new empty (silent, all samples 0) sound with specified length (number of samples), sample size (frame size) and sample rate (frame rate)

Parameters:

length - int number of samples

sampSize - int sample size (in bytes 1-4)

sampRate - int sample rate (in samples/second)

Sound

public Sound(int length,
             Sound like)

Create a new empty (silent, all samples 0) sound with specified length (number of samples) and same sound parameters as another sound

Parameters:

length - int number of samples

like - Sound sound parameters to mimic

Sound

public Sound(int length)

Create a new empty (all samples 0) sound with specified length

Parameters:

length - number of samples

Method Detail

play

public void play()

This method plays the sound.

save

public void save(java.io.File to)

This method saves the sound to a specified file.

Parameters:

to - the file (descriptor) to write to

save

public void save(java.lang.String to)

This method saves the sound to a specified file

Parameters:

to - the file name of the file to write to

save

public void save()

This method saves the sound to a file chosen from a dialog.

close

public void close()

Frees resources associated with the Sound. The sound shoud no longer be used.

getFile

public java.io.File getFile()

Returns the file that is associated with this sound or null if there is no such file.

Returns:

File file associated with sound or null.

getSample

public Sample getSample(int pos)

Returns the Sample at a particular position in the Sound.

Parameters:

pos - position (sample number)

Returns:

Sample the sample at the position.

getSampleSize

public int getSampleSize()

Returns the sample (frame) size for the sound.

Returns:

int the sample size.

getNumSamples

public int getNumSamples()

Returns the number of samples in the sound.

Returns:

int the number of samples.

getSampleRate

public int getSampleRate()

Returns the sampling (frame) rate for the sound.

Returns:

int the sample rate.

iterator

public java.util.Iterator<Sample> iterator()

Specified by:

iterator in interface java.lang.Iterable<Sample>

hasNext

public boolean hasNext()

This method returns true if there is at least one more sample that hasn't been accessed via the default iterator.

Returns:

boolean true if there is another sample

next

public Sample next()

This method returns the next sample in the sound.

Returns:

Sample the next sample