Package ev3dev.actuators

Class Sound

java.lang.Object

ev3dev.hardware.EV3DevFileSystem

ev3dev.hardware.EV3DevPlatforms

ev3dev.hardware.EV3DevDevice

ev3dev.actuators.Sound

public class Sound
extends EV3DevDevice

Class that provides access methods for the local audio device The class is implemented as Singleton. Note: Only tested with EV3Brick

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CMD_APLAY
private static java.lang.String	CMD_BEEP
private static java.lang.String	DISABLED_FEATURE_MESSAGE
private static Sound	Instance
private static Logger	log
private static java.lang.String	SOUND_PATH
private static java.lang.String	VOLUME
private static java.lang.String	VOLUME_PATH

Fields inherited from class ev3dev.hardware.EV3DevDevice

ADDRESS, DEVICE, LEGO_PORT, LEGO_SENSOR, MODE, PATH_DEVICE

Fields inherited from class ev3dev.hardware.EV3DevFileSystem

EV3DEV_ROOT_PATH, EV3DEV_TESTING_KEY, ROOT_PATH

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Sound()

Method Summary

Modifier and Type	Method and Description
void	beep() Beeps once.
static Sound	getInstance() Return a Instance of Sound.
int	getVolume() Get the current master volume level
void	playSample(java.io.File file) Play a wav file.
void	playSample(java.io.File file, int volume) 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 volume) Set the master volume level
void	twoBeeps() Beeps twice.

Methods inherited from class ev3dev.hardware.EV3DevDevice

detect, getIntegerAttribute, getStringAttribute, setIntegerAttribute, setStringAttribute

Methods inherited from class ev3dev.hardware.EV3DevPlatforms

getMotorPort, getPlatform, getSensorPort

Methods inherited from class ev3dev.hardware.EV3DevFileSystem

getROOT_PATH

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final Logger log

SOUND_PATH

private static final java.lang.String SOUND_PATH

See Also:

Constant Field Values

CMD_BEEP

private static final java.lang.String CMD_BEEP

See Also:

Constant Field Values

CMD_APLAY

private static final java.lang.String CMD_APLAY

See Also:

Constant Field Values

VOLUME

private static final java.lang.String VOLUME

See Also:

Constant Field Values

VOLUME_PATH

private static final java.lang.String VOLUME_PATH

See Also:

Constant Field Values

DISABLED_FEATURE_MESSAGE

private static final java.lang.String DISABLED_FEATURE_MESSAGE

See Also:

Constant Field Values

Instance

private static Sound Instance

Constructor Detail

Sound

private Sound()

Method Detail

getInstance

public static Sound getInstance()

Return a Instance of Sound.

Returns:

A Sound instance

beep

public void beep()

Beeps once.

twoBeeps

public void twoBeeps()

Beeps twice.

playTone

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

Plays a tone, given its frequency and duration.

Parameters:

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

duration - The duration of the tone, in milliseconds.

volume - 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:

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

duration - The duration of the tone, in milliseconds.

playSample

public void playSample(java.io.File file,
                       int volume)

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

volume - the volume percentage 0 - 100

playSample

public void 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

setVolume

public void setVolume(int volume)

Set the master volume level

Parameters:

volume - 0-100

getVolume

public int getVolume()

Get the current master volume level

Returns:

the current master volume 0-100