ShefRobot

Class Speaker

java.lang.Object

ShefRobot.Speaker

public class Speaker
extends Object

Objects of this class represent the audio interface to the Robot which it was created from

See Also:

Robot.getSpeaker()

Field Summary

Fields

Modifier and Type	Field and Description
static int	VOLUME_MAX The maximum integer that can be passed to setVolume or returned from getVolume
static int	VOLUME_MIN The minimum integer that can be passed to setVolume or returned from getVolume

Method Summary

Modifier and Type	Method and Description
int	getVolume() Returns the current volume of the robots speaker
void	playTone(int freq, int duration) Synchronously plays a tone of the specified frequency and duration through the robots speaker (The current thread will be stalled whilst tone is playing)
void	setVolume(int volume) Sets the volume of the robots speaker

Methods inherited from class java.lang.Object

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

Field Detail

VOLUME_MAX

public static final int VOLUME_MAX

The maximum integer that can be passed to setVolume or returned from getVolume

See Also:

Constant Field Values

VOLUME_MIN

public static final int VOLUME_MIN

The minimum integer that can be passed to setVolume or returned from getVolume

See Also:

Constant Field Values

Method Detail

getVolume

public int getVolume()

Returns the current volume of the robots speaker

Returns:

The current volume of the robots speaker, the value will be in the range of VOLUME_MIN-VOLUME_MAX.

setVolume

public void setVolume(int volume)

Sets the volume of the robots speaker

Parameters:

volume - The volume the robot should play sounds at, value must be in the range VOLUME_MIN-VOLUME_MAX.

Throws:

IllegalArgumentException - When volume argument is outside of the range VOLUME_MIN-VOLUME_MAX.

playTone

public void playTone(int freq,
                     int duration)

Synchronously plays a tone of the specified frequency and duration through the robots speaker (The current thread will be stalled whilst tone is playing)

Parameters:

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

duration - The duration of the tone, in milliseconds (ms).

Throws:

IllegalArgumentException - When freq or duration arguments are below 1.