com.siemens.mp.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

Muting is independent of the volume. 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.

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

setMute

public void setMute(boolean mute)

Mute or unmute the Player associated with this VolumeControl.

Note: Only available after the Player has been restarted by calling the start method. Noneffective during runtime.

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. Going from a muted to an unmuted state doesn't affect the volume.
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.

See Also:

isMuted()

isMuted

public boolean isMuted()

Get the mute state of the signal associated with this VolumeControl.

Note: Only available after the Player has been restarted by calling the start method. Noneffective during runtime.

Returns:

The mute state.

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.

Note: Only available after the Player has been restarted by calling the start method. Noneffective during runtime.

Parameters:

level - The new volume specified in the level scale.

Returns:

The level that was actually set.

See Also:

getLevel()

getLevel

public int getLevel()

Get the current volume level set.
If the current volume level is not known because the audio device has not been initialized (e.g. the Player has not been prefetched), getLevel may return -1.

Returns:

The current volume level or -1 if the current volume level is unknown.

See Also:

setLevel(int)