javax.telephony.phone
Interface PhoneMicrophone

All Superinterfaces:

Component

public interface PhoneMicrophone

extends Component

Phone microphone interface.

Field Summary

static int	FULL The full microhphone gain.
static int	MID The microphone gain is MID.
static int	MUTE The microphone gain is MUTE.

Method Summary

int	getGain() Returns the current microphone gain.
void	setGain(int gain) Sets the microphone gain to a value between MUTE and FULL, inclusive.

Methods inherited from interface javax.telephony.phone.Component

getCapabilities, getName

Field Detail

MUTE

public static final int MUTE

The microphone gain is MUTE.

MID

public static final int MID

The microphone gain is MID.

FULL

public static final int FULL

The full microhphone gain.

Method Detail

getGain

public int getGain()

Returns the current microphone gain.

Returns:

The current microphone gain.

setGain

public void setGain(int gain)
             throws InvalidArgumentException

Sets the microphone gain to a value between MUTE and FULL, inclusive.

Parameters:

gain - A microphone gain between MUTE and FULL, inclusive.

Throws:

InvalidArgumentException - The microphone gain is not valid.