lejos.remote.nxt

Class RemoteNXTAudio

java.lang.Object

lejos.remote.nxt.RemoteNXTAudio

All Implemented Interfaces:

Audio, Sounds

public class RemoteNXTAudio
extends java.lang.Object
implements Audio

Field Summary

Fields

Modifier and Type	Field and Description
static int	C2

Fields inherited from interface lejos.hardware.Sounds

ASCENDING, BEEP, BUZZ, DESCENDING, DOUBLE_BEEP, FLUTE, PIANO, VOL_MAX, XYLOPHONE

Constructor Summary

Constructors

Constructor and Description
RemoteNXTAudio(NXTCommand nxtCommand)

Method Summary

Modifier and Type	Method and Description
int	getVolume() Get the current master volume level
void	loadSettings() Load the current system settings associated with this class.
void	playNote(int[] inst, int freq, int len) Play a note with attack, decay, sustain and release shape.
int	playSample(byte[] data, int offset, int len, int freq, int vol) Queue a series of PCM samples to play at the specified volume and sample rate.
int	playSample(java.io.File file) Play a wav file
int	playSample(java.io.File file, int vol) Play a wav file
void	playTone(int frequency, int duration)
void	playTone(int frequency, int duration, int aVolume) Plays a tone, given its frequency and duration.
void	setVolume(int vol) Set the master volume level
void	systemSound(int aCode) Play a system sound.

Methods inherited from class java.lang.Object

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

Field Detail

C2

public static int C2

Constructor Detail

RemoteNXTAudio

public RemoteNXTAudio(NXTCommand nxtCommand)

Method Detail

systemSound

public void systemSound(int aCode)

Description copied from interface: Audio

Play a system sound.

aCode	Resulting Sound
0	short beep
1	double beep
2	descending arpeggio
3	ascending arpeggio
4	long, low buzz

Specified by:

systemSound in interface Audio

playTone

public void playTone(int frequency,
                     int duration,
                     int aVolume)

Description copied from interface: Audio

Plays a tone, given its frequency and duration.

Specified by:

playTone in interface Audio

Parameters:

frequency - The frequency of the tone in Hertz (Hz).

duration - The duration of the tone, in milliseconds.

aVolume - The volume of the playback 100 corresponds to 100%

playTone

public void playTone(int frequency,
                     int duration)

Specified by:

playTone in interface Audio

playSample

public int playSample(java.io.File file,
                      int vol)

Description copied from interface: Audio

Play a wav file

Specified by:

playSample in interface Audio

Parameters:

file - the 8-bit PWM (WAV) sample file

vol - the volume percentage 0 - 100

Returns:

The number of milliseconds the sample will play for or < 0 if there is an error.

playSample

public int playSample(java.io.File file)

Description copied from interface: Audio

Play a wav file

Specified by:

playSample in interface Audio

Parameters:

file - the 8-bit PWM (WAV) sample file

Returns:

The number of milliseconds the sample will play for or < 0 if there is an error.

playSample

public int playSample(byte[] data,
                      int offset,
                      int len,
                      int freq,
                      int vol)

Description copied from interface: Audio

Queue a series of PCM samples to play at the specified volume and sample rate.

Specified by:

playSample in interface Audio

Parameters:

data - Buffer containing the samples

offset - Offset of the first sample in the buffer

len - Number of samples to queue

freq - Sample rate

vol - playback volume

Returns:

Number of samples actually queued

playNote

public void playNote(int[] inst,
                     int freq,
                     int len)

Description copied from interface: Audio

Play a note with attack, decay, sustain and release shape. This function allows the playing of a more musical sounding note. It uses a set of supplied "instrument" parameters to define the shape of the notes envelope.

Specified by:

playNote in interface Audio

Parameters:

inst - Instrument definition

freq - The note to play (in Hz)

len - The duration of the note (in ms)

setVolume

public void setVolume(int vol)

Description copied from interface: Audio

Set the master volume level

Specified by:

setVolume in interface Audio

Parameters:

vol - 0-100

getVolume

public int getVolume()

Description copied from interface: Audio

Get the current master volume level

Specified by:

getVolume in interface Audio

Returns:

the current master volume 0-100

loadSettings

public void loadSettings()

Description copied from interface: Audio

Load the current system settings associated with this class. Called automatically to initialize the class. May be called if it is required to reload any settings.

Specified by:

loadSettings in interface Audio