net.sf.mmm.client.ui.api.attribute

Interface AttributeReadVolume

All Known Subinterfaces:

AttributeWriteVolume, UiWidgetMedia, UiWidgetMediaAudio, UiWidgetMediaVideo

public interface AttributeReadVolume

This interface gives read access to the volume attribute of an object.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
double	getVolume() This method gets the volume of this object.

Method Detail

getVolume

double getVolume()

This method gets the volume of this object. Please note that the actual volume might be influenced by the mixer of the operating system. This is just a relative scale to the system volume.

Returns:

the volume in the range from 0.0 (mute) to 1.0 (maximum).