c4e.media

Class ToneEmitter

java.lang.Object

c4e.media.ToneEmitter

All Implemented Interfaces:

java.lang.Runnable

public class ToneEmitter
extends java.lang.Object
implements java.lang.Runnable

Encapsulates a tone emitter.

Field Summary

Fields

Modifier and Type	Field and Description
static double	BUFFER_DURATION
static double	NOTE_A
static double	NOTE_ASHARP
static double	NOTE_B
static double	NOTE_C
static double	NOTE_CSHARP
static double	NOTE_D
static double	NOTE_DSHARP
static double	NOTE_E
static double	NOTE_F
static double	NOTE_FSHARP
static double	NOTE_G
static double	NOTE_G_BELOW_C
static double	NOTE_GSHARP
static int	SAMPLE_SIZE
static int	SAMPLING_RATE
static int	SINE_PACKET_SIZE

Constructor Summary

Constructors

Constructor and Description
ToneEmitter() Construct an Emitter.

Method Summary

Modifier and Type	Method and Description
double	getFrequency() Return the frequency of the sound currently being generated.
double	getVolume() Return the current volume of the sound being generated.
static void	main(java.lang.String[] args) A simple test program to illustrate how to play a tune.
void	play(double note) Play a frequency for one second.
void	play(double note, double duration) Play a frequency for a given number of seconds
void	run() This is the thread that services the output channel.
void	setFrequency(double frequency) Set the frequency of the sound to be generated.
void	setVolume(double volume) Set the volume of the sound currently being generated.
void	shutdown() Shutdown the audio generation.

Methods inherited from class java.lang.Object

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

Field Detail

NOTE_G_BELOW_C

public static final double NOTE_G_BELOW_C

See Also:

Constant Field Values

NOTE_A

public static final double NOTE_A

See Also:

Constant Field Values

NOTE_ASHARP

public static final double NOTE_ASHARP

See Also:

Constant Field Values

NOTE_B

public static final double NOTE_B

See Also:

Constant Field Values

NOTE_C

public static final double NOTE_C

See Also:

Constant Field Values

NOTE_CSHARP

public static final double NOTE_CSHARP

See Also:

Constant Field Values

NOTE_D

public static final double NOTE_D

See Also:

Constant Field Values

NOTE_DSHARP

public static final double NOTE_DSHARP

See Also:

Constant Field Values

NOTE_E

public static final double NOTE_E

See Also:

Constant Field Values

NOTE_F

public static final double NOTE_F

See Also:

Constant Field Values

NOTE_FSHARP

public static final double NOTE_FSHARP

See Also:

Constant Field Values

NOTE_G

public static final double NOTE_G

See Also:

Constant Field Values

NOTE_GSHARP

public static final double NOTE_GSHARP

See Also:

Constant Field Values

SAMPLING_RATE

public static final int SAMPLING_RATE

See Also:

Constant Field Values

SAMPLE_SIZE

public static final int SAMPLE_SIZE

See Also:

Constant Field Values

BUFFER_DURATION

public static final double BUFFER_DURATION

See Also:

Constant Field Values

SINE_PACKET_SIZE

public static final int SINE_PACKET_SIZE

See Also:

Constant Field Values

Constructor Detail

ToneEmitter

public ToneEmitter()

Construct an Emitter. This will begin emitting a sine wave (fortunately at zero volume) through the default audio device.

Throws:

java.lang.RuntimeException - if the hardware does not support an appropriate audio output device.

Method Detail

setFrequency

public void setFrequency(double frequency)

Set the frequency of the sound to be generated.

Parameters:

frequency - the frequency (in hertz) of the output sound.

getFrequency

public double getFrequency()

Return the frequency of the sound currently being generated.

Returns:

the frequency (in hertz) of the sound being generated.

setVolume

public void setVolume(double volume)

Set the volume of the sound currently being generated.

Parameters:

volume - the volume of the sound being generated in the range (0..1). 0 is the lowest possible volume. 1 is the maximum. It is not possible to set the output to 11.

getVolume

public double getVolume()

Return the current volume of the sound being generated.

Returns:

the current volume in the range 0..1.

shutdown

public void shutdown()

Shutdown the audio generation. This will first cause the audio channel to play a very quiet note, then terminate audio generation. If you don't do this you will likely hear a buzz or click as the program terminates.

play

public void play(double note)

Play a frequency for one second.

Parameters:

note - the frequency to play.

play

public void play(double note,
                 double duration)

Play a frequency for a given number of seconds

Parameters:

note - the frequency to play.

duration - for how long to play it, in seconds.

run

public void run()

This is the thread that services the output channel.

Specified by:

run in interface java.lang.Runnable

main

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

A simple test program to illustrate how to play a tune.

Parameters:

args - command line arguments (ignored)