fr.liglab.adele.icasa.device.sound

Interface Speaker

All Superinterfaces:

GenericDevice

public interface Speaker
extends GenericDevice

Service definition of a simple speaker device.

Author:

jander, bourretp

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPEAKER_NOISE_LEVEL TODO comments.
static String	SPEAKER_VOLUME Service property indicating the current volume of the speaker.

Fields inherited from interface fr.liglab.adele.icasa.device.GenericDevice

DEFAULT_HEIGHT, DEFAULT_WIDTH, DEVICE_SERIAL_NUMBER, FAULT_NO, FAULT_PROPERTY_NAME, FAULT_UNKNOWN, FAULT_YES, LOCATION_PROPERTY_NAME, LOCATION_UNKNOWN, STATE_ACTIVATED, STATE_DEACTIVATED, STATE_PROPERTY_NAME, STATE_UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
double	getNoiseLevel() TODO comments.
double	getVolume() Return the current volume of this speaker.
void	setAudioSource(AudioSource source) Set the audio stream that this speaker must play.
double	setVolume(double volume) Change the volume of this speaker.

Methods inherited from interface fr.liglab.adele.icasa.device.GenericDevice

addListener, constainsProperty, enterInZones, getFault, getProperties, getPropertyValue, getSerialNumber, getState, hasPropertyValue, leavingZones, removeListener, removeProperty, setFault, setPropertyValue, setState

Field Detail

SPEAKER_VOLUME

static final String SPEAKER_VOLUME

Service property indicating the current volume of the speaker.

• This property is mandatory
• Type of values : java.lang.Double, between 0.0d and 1.0d
• Description : value is 0.0d when the speaker is completely muted, 1.0d when volume is set to the maximum.

See Also:

getVolume(), setVolume(double), Constant Field Values

SPEAKER_NOISE_LEVEL

static final String SPEAKER_NOISE_LEVEL

TODO comments.

See Also:

Constant Field Values

Method Detail

getVolume

double getVolume()

Return the current volume of this speaker.

Returns:

the current volume of this speaker.

See Also:

setVolume(double), SPEAKER_VOLUME

setVolume

double setVolume(double volume)

Change the volume of this speaker.

Parameters:

volume - the new volume of this speaker.

Returns:

the previous volume of this speaker.

See Also:

getVolume(), SPEAKER_VOLUME

getNoiseLevel

double getNoiseLevel()

TODO comments.

Returns:

setAudioSource

void setAudioSource(AudioSource source)

Set the audio stream that this speaker must play.

Parameters:

source - the audio source to play, or null to stop playing.