Package org.jitsi.service.neomedia
Interface VolumeControl
-
- All Known Implementing Classes:
BasicVolumeControl,HardwareVolumeControl
public interface VolumeControlControl for volume level in (neo)media service.- Author:
- Damian Minkov
-
-
Field Summary
Fields Modifier and Type Field Description static StringCAPTURE_VOLUME_LEVEL_PROPERTY_NAMEThe name of the configuration property which specifies the volume level of audio input.static StringPLAYBACK_VOLUME_LEVEL_PROPERTY_NAMEThe name of the configuration property which specifies the volume level of audio output.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddVolumeChangeListener(VolumeChangeListener listener)Adds a VolumeChangeListener to be informed about changes in the volume level of this instance.floatgetMaxValue()Returns the maximum allowed volume value/level.floatgetMinValue()Returns the minimum allowed volume value/level.booleangetMute()Get mute state of sound playback.floatgetVolume()Gets the current volume value/level.voidremoveVolumeChangeListener(VolumeChangeListener listener)Removes a VolumeChangeListener to no longer be notified about changes in the volume level of this instance.voidsetMute(boolean mute)Mutes current sound playback.floatsetVolume(float value)Sets the current volume value/level.
-
-
-
Field Detail
-
CAPTURE_VOLUME_LEVEL_PROPERTY_NAME
static final String CAPTURE_VOLUME_LEVEL_PROPERTY_NAME
The name of the configuration property which specifies the volume level of audio input.- See Also:
- Constant Field Values
-
PLAYBACK_VOLUME_LEVEL_PROPERTY_NAME
static final String PLAYBACK_VOLUME_LEVEL_PROPERTY_NAME
The name of the configuration property which specifies the volume level of audio output.- See Also:
- Constant Field Values
-
-
Method Detail
-
addVolumeChangeListener
void addVolumeChangeListener(VolumeChangeListener listener)
Adds a VolumeChangeListener to be informed about changes in the volume level of this instance.- Parameters:
listener- the VolumeChangeListener to be informed about changes in the volume level of this instance
-
getMaxValue
float getMaxValue()
Returns the maximum allowed volume value/level.- Returns:
- the maximum allowed volume value/level
-
getMinValue
float getMinValue()
Returns the minimum allowed volume value/level.- Returns:
- the minimum allowed volume value/level
-
getMute
boolean getMute()
Get mute state of sound playback.- Returns:
- mute state of sound playback.
-
getVolume
float getVolume()
Gets the current volume value/level.- Returns:
- the current volume value/level
-
removeVolumeChangeListener
void removeVolumeChangeListener(VolumeChangeListener listener)
Removes a VolumeChangeListener to no longer be notified about changes in the volume level of this instance.- Parameters:
listener- the VolumeChangeListener to no longer be notified about changes in the volume level of this instance
-
setMute
void setMute(boolean mute)
Mutes current sound playback.- Parameters:
mute- mutes/unmutes playback.
-
setVolume
float setVolume(float value)
Sets the current volume value/level.- Parameters:
value- the volume value/level to set on this instance- Returns:
- the actual/current volume value/level set on this instance
-
-