ev3dev.hardware

Class Sound

java.lang.Object

ev3dev.hardware.Device

ev3dev.hardware.EV3DevSysfs

ev3dev.hardware.Sound

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class Sound
extends EV3DevSysfs

Class that provides access methods for the local audio device

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CMD_APLAY
static java.lang.String	CMD_BEEP
private static Sound	Instance
static java.lang.String	SOUND_PATH
static java.lang.String	TONE_PATH
static java.lang.String	VOLUME_PATH

Fields inherited from class ev3dev.hardware.Device

closeList

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Sound()

Method Summary

Modifier and Type	Method and Description
void	beep() Beeps once.
static Sound	getInstance()
int	getVolume() Get the current master volume level
void	pause(int t)
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) Plays a tone, given its frequency and duration.
void	playTone(int frequency, int duration, int volume) Plays a tone, given its frequency and duration.
void	setVolume(int vol) Set the master volume level
void	twoBeeps() Beeps twice.

Methods inherited from class ev3dev.hardware.EV3DevSysfs

getElements, readFloat, readInteger, readString, writeInteger, writeString

Methods inherited from class ev3dev.hardware.Device

close, releaseOnClose

Methods inherited from class java.lang.Object

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

Field Detail

SOUND_PATH

public static final java.lang.String SOUND_PATH

See Also:

Constant Field Values

TONE_PATH

public static final java.lang.String TONE_PATH

See Also:

Constant Field Values

VOLUME_PATH

public static final java.lang.String VOLUME_PATH

See Also:

Constant Field Values

CMD_BEEP

public static final java.lang.String CMD_BEEP

See Also:

Constant Field Values

CMD_APLAY

public static final java.lang.String CMD_APLAY

See Also:

Constant Field Values

Instance

private static Sound Instance

Constructor Detail

Sound

private Sound()

Method Detail

getInstance

public static Sound getInstance()

beep

public void beep()

Beeps once.

twoBeeps

public void twoBeeps()

Beeps twice.

pause

public void pause(int t)

playTone

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

Plays a tone, given its frequency and duration.

Parameters:

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

aDuration - 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)

Plays a tone, given its frequency and duration.

Parameters:

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

duration - The duration of the tone, in milliseconds.

playSample

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

Play a wav file. Must be mono, from 8kHz to 48kHz, and 8-bit or 16-bit.

Parameters:

file - the 8-bit or 16-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.

Throws:

java.io.FileNotFoundException

playSample

public int playSample(java.io.File file)

Play a wav file. Must be mono, from 8kHz to 48kHz, and 8-bit or 16-bit.

Parameters:

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

Returns:

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

Throws:

java.io.FileNotFoundException

setVolume

public void setVolume(int vol)

Set the master volume level

Parameters:

vol - 0-100

getVolume

public int getVolume()

Get the current master volume level

Returns:

the current master volume 0-100