File Doc Category Size Date Package
ToneGenerator.java API Doc Android 1.5 API 8939 Wed May 06 22:42:00 BST 2009 android.media

ToneGenerator

java.lang.Object

public class ToneGenerator extends Object

This class provides methods to play DTMF tones (ITU-T Recommendation Q.23), call supervisory tones (3GPP TS 22.001, CEPT) and proprietary tones (3GPP TS 31.111). Depending on call state and routing options, tones are mixed to the downlink audio or output to the speaker phone or headset. This API is not for generating tones over the uplink audio path.

Fields Summary
public static final int
TONE_DTMF_0
DTMF tone for key 0: 1336Hz, 941Hz, continuous
public static final int
TONE_DTMF_1
DTMF tone for key 1: 1209Hz, 697Hz, continuous
public static final int
TONE_DTMF_2
DTMF tone for key 2: 1336Hz, 697Hz, continuous
public static final int
TONE_DTMF_3
DTMF tone for key 3: 1477Hz, 697Hz, continuous
public static final int
TONE_DTMF_4
DTMF tone for key 4: 1209Hz, 770Hz, continuous
public static final int
TONE_DTMF_5
DTMF tone for key 5: 1336Hz, 770Hz, continuous
public static final int
TONE_DTMF_6
DTMF tone for key 6: 1477Hz, 770Hz, continuous
public static final int
TONE_DTMF_7
DTMF tone for key 7: 1209Hz, 852Hz, continuous
public static final int
TONE_DTMF_8
DTMF tone for key 8: 1336Hz, 852Hz, continuous
public static final int
TONE_DTMF_9
DTMF tone for key 9: 1477Hz, 852Hz, continuous
public static final int
TONE_DTMF_S
DTMF tone for key *: 1209Hz, 941Hz, continuous
public static final int
TONE_DTMF_P
DTMF tone for key #: 1477Hz, 941Hz, continuous
public static final int
TONE_DTMF_A
DTMF tone for key A: 1633Hz, 697Hz, continuous
public static final int
TONE_DTMF_B
DTMF tone for key B: 1633Hz, 770Hz, continuous
public static final int
TONE_DTMF_C
DTMF tone for key C: 1633Hz, 852Hz, continuous
public static final int
TONE_DTMF_D
DTMF tone for key D: 1633Hz, 941Hz, continuous
public static final int
TONE_SUP_DIAL
Call supervisory tone, Dial tone: 425Hz, continuous
public static final int
TONE_SUP_BUSY
Call supervisory tone, Busy: 425Hz, 500ms ON, 500ms OFF...
public static final int
TONE_SUP_CONGESTION
Call supervisory tone, Congestion: 425Hz, 200ms ON, 200ms OFF...
public static final int
TONE_SUP_RADIO_ACK
Call supervisory tone, Radio path acknowlegment : 425Hz, 200ms ON
public static final int
TONE_SUP_RADIO_NOTAVAIL
Call supervisory tone, Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts
public static final int
TONE_SUP_ERROR
Call supervisory tone, Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF...
public static final int
TONE_SUP_CALL_WAITING
Call supervisory tone, Call Waiting: 425Hz, 200ms ON, 600ms OFF, 200ms ON, 3s OFF...
public static final int
TONE_SUP_RINGTONE
Call supervisory tone, Ring Tone: 425Hz, 1s ON, 4s OFF...
public static final int
TONE_PROP_BEEP
Proprietary tone, general beep: 400Hz+1200Hz, 35ms ON
public static final int
TONE_PROP_ACK
Proprietary tone, positive acknowlegement: 1200Hz, 100ms ON, 100ms OFF 2 bursts
public static final int
TONE_PROP_NACK
Proprietary tone, negative acknowlegement: 300Hz+400Hz+500Hz, 400ms ON
public static final int
TONE_PROP_PROMPT
Proprietary tone, prompt tone: 400Hz+1200Hz, 200ms ON
public static final int
TONE_PROP_BEEP2
Proprietary tone, general double beep: twice 400Hz+1200Hz, 35ms ON, 200ms OFF, 35ms ON
public static final int
MAX_VOLUME
Maximum volume, for use with {@link #ToneGenerator(int,int)}
public static final int
MIN_VOLUME
Minimum volume setting, for use with {@link #ToneGenerator(int,int)}
private int
mNativeContext
Constructors Summary
public ToneGenerator(int streamType, int volume)
ToneGenerator class contructor specifying output stream type and volume.
param
streamType The streame type used for tone playback (e.g. STREAM_MUSIC).
param
volume The volume of the tone, given in percentage of maximum volume (from 0-100).
native_setup(streamType, volume);
Methods Summary
protected void finalize()
native_finalize();
private final native void native_finalize()
private final native void native_setup(int streamType, int volume)
public native void release()
Releases resources associated with this ToneGenerator object. It is good practice to call this method when you're done using the ToneGenerator.
public native boolean startTone(int toneType)
This method starts the playback of a tone of the specified type. only one tone can play at a time: if a tone is playing while this method is called, this tone is stopped and replaced by the one requested.
param
toneType The type of tone generate chosen from the following list:

{@link #TONE_DTMF_0}
{@link #TONE_DTMF_1}
{@link #TONE_DTMF_2}
{@link #TONE_DTMF_3}
{@link #TONE_DTMF_4}
{@link #TONE_DTMF_5}
{@link #TONE_DTMF_6}
{@link #TONE_DTMF_7}
{@link #TONE_DTMF_8}
{@link #TONE_DTMF_9}
{@link #TONE_DTMF_A}
{@link #TONE_DTMF_B}
{@link #TONE_DTMF_C}
{@link #TONE_DTMF_D}
{@link #TONE_SUP_DIAL}
{@link #TONE_SUP_BUSY}
{@link #TONE_SUP_CONGESTION}
{@link #TONE_SUP_RADIO_ACK}
{@link #TONE_SUP_RADIO_NOTAVAIL}
{@link #TONE_SUP_ERROR}
{@link #TONE_SUP_CALL_WAITING}
{@link #TONE_SUP_RINGTONE}
{@link #TONE_PROP_BEEP}
{@link #TONE_PROP_ACK}
{@link #TONE_PROP_NACK}
{@link #TONE_PROP_PROMPT}
{@link #TONE_PROP_BEEP2}
see
#ToneGenerator(int, int)
public native void stopTone()
This method stops the tone currently playing playback.
see
#ToneGenerator(int, int)