javax.microedition.media.control
Interface VolumeControl

All Superinterfaces:
Control

public interface VolumeControl
extends Control

VolumeControl is an interface for manipulating the audio volume of a Player.

Volume Settings

This interface allows the output volume to be specified using an integer value that varies between 0 and 100.

Specifying Volume in the Level Scale

The level scale specifies volume in a linear scale. It ranges from 0 to 100, where 0 represents silence and 100 represents the highest volume. The mapping for producing a linear multiplicative value is implementation dependent.

Mute

Setting mute on or off doesn't change the volume level returned by getLevel. If mute is true, no audio signal is produced by this Player; if mute is false an audio signal is produced and the volume is restored.

Volume Change Events

When the state of the VolumeControl changes, a VOLUME_CHANGED event is delivered through the PlayerListener.

Since:
JDE 4.0.0
See Also:
Control, Player, PlayerListener

Method Summary
 int getLevel()
          Get the current volume level set.
 boolean isMuted()
          Get the mute state of the signal associated with this VolumeControl.
 int setLevel(int level)
          Set the volume using a linear point scale with values between 0 and 100.
 void setMute(boolean mute)
          Mute or unmute the Player associated with this VolumeControl.
 

Method Detail

getLevel

public int getLevel()
Get the current volume level set.

getLevel may return -1 if and only if the Player is in the REALIZED state (the audio device has not been initialized) and setLevel has not yet been called.

Returns:
The current volume level or -1.
Since:
JDE 4.0.0
See Also:
setLevel(int)

isMuted

public boolean isMuted()
Get the mute state of the signal associated with this VolumeControl.
Returns:
The mute state.
Since:
JDE 4.0.0
See Also:
setMute(boolean)

setLevel

public int setLevel(int level)
Set the volume using a linear point scale with values between 0 and 100.
0 is silence; 100 is the loudest useful level that this VolumeControl supports. If the given level is less than 0 or greater than 100, the level will be set to 0 or 100 respectively.
When setLevel results in a change in the volume level, a VOLUME_CHANGED event will be delivered through the PlayerListener.
Parameters:
level - The new volume specified in the level scale.
Returns:
The level that was actually set.
Since:
JDE 4.0.0
See Also:
getLevel()

setMute

public void setMute(boolean mute)
Mute or unmute the Player associated with this VolumeControl.

Calling setMute(true) on the Player that is already muted is ignored, as is calling setMute(false) on the Player that is not currently muted. Setting mute on or off doesn't change the volume level returned by getLevel.

When setMute results in a change in the muted state, a VOLUME_CHANGED event will be delivered through the PlayerListener.

Parameters:
mute - Specify true to mute the signal, false to unmute the signal.
Since:
JDE 4.0.0
See Also:
isMuted()



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.