Interface java.telephony.phone.PhoneRinger
All Packages Class Hierarchy This Package Previous Next Index
Interface java.telephony.phone.PhoneRinger
- public interface PhoneRinger
- extends Object
- extends Component
-
FULL
- Ringer volume definition for the ringer at maximum volume.
-
MIDDLE
- Ringer volume definition for the middle volume.
-
OFF
- Ringer volume definition for the ringer off.
-
getNumberOfRingPatterns()
- Returns the number of available ringing patterns.
-
getNumberOfRings()
- Returns the number of complete ring cycles that the ringer has been
ringing.
-
getRingerPattern()
- Returns the current ringer pattern.
-
getRingerVolume()
- Returns the current ringer volume.
-
isRingerOn()
- Returns true if the ringer is on, false otherwise.
-
setRingerPattern(int)
- Set the ringer pattern given an valid index number returned by
getNumberOfRingPatterns().
-
setRingerVolume(int)
- Sets the ringer volume between ZERO or FULL, inclusive.
OFF
public final static int OFF
- Ringer volume definition for the ringer off.
MIDDLE
public final static int MIDDLE
- Ringer volume definition for the middle volume.
FULL
public final static int FULL
- Ringer volume definition for the ringer at maximum volume.
isRingerOn
public abstract int isRingerOn() throws PlatformException
- Returns true if the ringer is on, false otherwise.
- Returns:
- True if the ringer is on, false otherwise
- Throws: PlatformException
- A platform-specific exception occurred.
getRingerVolume
public abstract int getRingerVolume() throws PlatformException
- Returns the current ringer volume.
- Returns:
- The current ringer volume
- Throws: PlatformException
- A platform-specific exception occurred.
setRingerVolume
public abstract void setRingerVolume(int volume) throws InvalidArgumentException, PlatformException
- Sets the ringer volume between ZERO or FULL, inclusive.
- Parameters:
- volume - The ringer volume, between ZERO and FULL, inclusive.
- Throws: InvalidArgumentException
- The volume provided was not valid.
- Throws: PlatformException
- A platform-specific exception occurred.
getRingerPattern
public abstract int getRingerPattern() throws PlatformException
- Returns the current ringer pattern. Applications may also turn the ringer
off using this method as well.
- Returns:
- The current ringer pattern.
- Throws: PlatformException
- A platform-specific exception occurred.
getNumberOfRingPatterns
public abstract int getNumberOfRingPatterns() throws PlatformException
- Returns the number of available ringing patterns. An index between zero
and the returns value minus one may be used for the setRingerPattern()
method.
- Returns:
- The number of available ringer patterns.
- Throws: PlatformException
- A platform-specific exception occurred.
setRingerPattern
public abstract void setRingerPattern(int ringerPattern) throws InvalidArgumentException, PlatformException
- Set the ringer pattern given an valid index number returned by
getNumberOfRingPatterns().
- Parameters:
- ringerPattern - The desired ringer pattern.
- Throws: InvalidArgumentException
- The ring pattern provided was not
valid.
- Throws: PlatformException
- A platform-specific exception occurred.
getNumberOfRings
public abstract int getNumberOfRings() throws PlatformException
- Returns the number of complete ring cycles that the ringer has been
ringing. A value of 0 indicates that the ringer is not being rung.
- Returns:
- The current ringer count.
- Throws: PlatformException
- A platform-specific exception occurred.
All Packages Class Hierarchy This Package Previous Next Index