|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--net.rim.device.api.system.Alert
Provides access to the device's audio system.
Applications can use the device's audio system to notify the device's operator of interesting events (for example, new messages or phone calls).
This class provides a number of alert type query methods you can use to
determine whether the host device supports a particular kind of alert (for
example isAudioSupported()). If the device does support a particular
kind of alert, then you can use the associated start and
stop control methods to use that type of alert (for example,
startAudio(short[], int) and stopAudio()).
AlertListener| Field Summary | ||
static int |
ALERT_ERROR_BAD_DATA
Invalid data was provided |
|
static int |
ALERT_ERROR_BAD_STATE
Playback is already in progress |
|
static int |
ALERT_ERROR_FILESYSTEM_FULL
Filesystem is full |
|
static int |
ALERT_ERROR_UNKNOWN
Unknown error |
|
static int |
ALERT_OK
Playback has begun |
|
| Method Summary | ||
static void |
enablePWMSync(boolean enable)
Deprecated. This is no longer supported. |
|
static int |
getVolume()
Retrieves the master volume. |
|
static boolean |
isADPCMSupported()
Deprecated. ADPCM is no longer supported. |
|
static boolean |
isAudioSupported()
Determines if this device provides support for playing audio alerts via startAudio(short[], int). |
|
static boolean |
isBuzzerSupported()
Determines if this device provides buzzer support. |
|
static boolean |
isMIDISupported()
Determines if this device provides MIDI support. |
|
static boolean |
isVibrateSupported()
Determines if this device provides vibration support. |
|
static void |
mute(boolean newMuteState)
Toggles the device between mute (volume 0) and loud state, and persists the current volume level. |
|
static void |
playBuzzer(short[] tune,
int volume)
Deprecated. Replaced by startBuzzer(short[],int,boolean) |
|
static void |
setADPCMVolume(int volume)
Deprecated. ADPCM is no longer supported. |
|
static void |
setBuzzerVolume(int volume)
Sets the volume for the buzzer. |
|
static void |
setVolume(int volume)
Sets the master volume. |
|
static int |
startADPCM(byte[] tune,
boolean interruptable)
Deprecated. ADPCM is no longer supported. |
|
static void |
startAudio(short[] tune,
int volume)
Starts an audio alert. |
|
static void |
startBuzzer(short[] tune,
int volume)
Starts a buzzer alert. |
|
static void |
startBuzzer(short[] tune,
int volume,
boolean interruptable)
Starts a buzzer alert. |
|
static int |
startMIDI(byte[] tune,
boolean interruptable)
Starts a MIDI alert. |
|
static void |
startVibrate(int duration)
Starts a vibrate alert. |
|
static void |
stopADPCM()
Deprecated. ADPCM is no longer supported. |
|
static void |
stopAudio()
Cancels an audio alert in progress. |
|
static void |
stopBuzzer()
Cancels a buzzer alert in progress. |
|
static void |
stopMIDI()
Cancels a MIDI alert in progress. |
|
static void |
stopVibrate()
Cancels a vibrate alert in progress. |
|
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int ALERT_ERROR_BAD_DATA
public static final int ALERT_ERROR_BAD_STATE
public static final int ALERT_ERROR_FILESYSTEM_FULL
| Method Detail |
public static void enablePWMSync(boolean enable)
UnsupportedOperationException - if the device does not support ADPCM.public static int getVolume()
public static boolean isADPCMSupported()
public static boolean isAudioSupported()
startAudio(short[], int).public static boolean isBuzzerSupported()
public static boolean isMIDISupported()
public static boolean isVibrateSupported()
public static void mute(boolean newMuteState)
setVolume() overrides the current mute state. Any later call to
mute(false) returns the volume to the cached value.
If newMuteState is equal to the current mute state, this method does nothing.
newMuteState - If true, mutes the device; otherwise, returns the volume to the value previous to muting.
public static void playBuzzer(short[] tune,
int volume)
startBuzzer(short[],int,boolean)
The specified tune is played using the piezoelectric buzzer at the
specified volume. When the alert is complete,
AlertListener.buzzerDone(int) is invoked on the event thread.
The tune is not interrupted by keypad or trackwheel activity.
If the device does not support the buzzer, then invoking this method has no effect.
| Notes: |
|
tune - Two-element array containing tune data (elements are the
note frequency in hertz and the duration of the note in milliseconds).volume - Percentage of capable volume level, from 0 to 100.IllegalArgumentException - if the specified volume is outside the range 0 to 100.AlertListener.buzzerDone(int)public static void setADPCMVolume(int volume)
Note: This value is multiplied with the master volume.
If the device does not support an ADPCM alert, invoking this method throws an UnsupportedOperationException.
volume - Percentage of total capable volume, from 0 to 100.UnsupportedOperationException - if the device does not support ADPCM.IllegalArgumentException - if the specified volume is outside the range 0 to 100.public static void setBuzzerVolume(int volume)
Sets the volume for the buzzer.
If the device does not support the buzzer, then invoking this method has no effect.
Note: This value is multiplied with the master volume.
volume - Percentage of total capable volume, from 0 to 100.IllegalArgumentException - if the specified volume is outside the range 0 to 100.public static void setVolume(int volume)
volume - Percentage of total capable volume, from 0 to 100.IllegalArgumentException - if the specified volume is outside the range 0 to 100.
public static int startADPCM(byte[] tune,
boolean interruptable)
The specified tune is played using the polyphonic device. When the
alert is complete, AlertListener2#adpcmDone is invoked on the event thread.
If the device does not support an ADPCM alert, invoking this method throws an UnsupportedOperationException.
tune - Tune to play.interruptable - If true, the tune might be interrupted by keypad or
trackwheel activity; otherwise, the tune will not be interrupted.UnsupportedOperationException - if the device does not support ADPCM.AlertListener2#adpcmDone
public static void startAudio(short[] tune,
int volume)
The specified tune is played using the currently selected audio channel at the specified volume. (Typically using the headset if the device is so equipped.)
When the alert is complete, AlertListener.audioDone(int)
is invoked on the event thread.
| Notes: |
|
tune - Two-element array containing tune data. The elements of the array
are the note frequency in hertz and the duration of the note in milliseconds.volume - Percentage of capable volume level, from 0 to 100.IllegalArgumentException - if the specified volume is outside the range 0 to 100.AlertListener.audioDone(int)
public static void startBuzzer(short[] tune,
int volume)
The specified tune is played using the piezoelectric buzzer at the
specified volume. When the alert is complete,
AlertListener.buzzerDone(int) is invoked on the event thread.
The tune is interrupted by any keypad or trackwheel activity.
If the device does not support the buzzer, then invoking this method has no effect.
| Notes: |
|
tune - Two-element array containing tune data. The array elements are
the note frequency in hertz and the duration of the note in milliseconds.volume - Percentage of capable volume level, from 0 to 100.IllegalArgumentException - if the specified volume is outside the range 0 to 100.AlertListener.buzzerDone(int)
public static void startBuzzer(short[] tune,
int volume,
boolean interruptable)
The specified tune is played using the piezoelectric buzzer at the
specified volume. When the alert is complete,
AlertListener.buzzerDone(int) is invoked on the event thread.
The tune is interrupted by any keypad or trackwheel activity.
If the device does not support the buzzer, then invoking this method has no effect.
| Notes: |
|
tune - Two-element array containing tune data. The array elements
are the note frequency in hertz and the duration of the note in milliseconds.volume - Percentage of capable volume level, from 0 to 100.interruptable - If true, the tune might be interrupted by keypad or
trackwheel activity; otherwise, the tune will not be interrupted.IllegalArgumentException - if the specified volume is outside the range 0 to 100.AlertListener.buzzerDone(int)
public static int startMIDI(byte[] tune,
boolean interruptable)
The specified tune is played using the polyphonic device. When the
alert is complete, AlertListener2.midiDone(int) is invoked on the event thread.
If the device does not support a MIDI alert, invoking this method throws an UnsupportedOperationException.
tune - Tune to play.interruptable - If true, the tune might be interrupted by keypad or
trackwheel activity; otherwise, the tune will not be interrupted.UnsupportedOperationException - if the device does not support MIDI.AlertListener2.midiDone(int)public static void startVibrate(int duration)
The device vibrates for the specified amount of time. When the
alert is complete, AlertListener.vibrateDone(int) is
invoked on the event thread.
duration - Vibration time in milliseconds, from 0 to 25500.IllegalArgumentException - if the specified duration is outside the range 0 to 25500.AlertListener.vibrateDone(int)public static void stopADPCM()
If the device does not support an ADPCM alert, invoking this method throws an UnsupportedOperationException.
UnsupportedOperationException - if the device does not support ADPCM.public static void stopBuzzer()
If the device does not support the buzzer, then invoking this method has no effect.
public static void stopMIDI()
If the device does not support a MIDI alert, invoking this method throws an UnsupportedOperationException.
UnsupportedOperationException - if the device does not support MIDI.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2007 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.