Build 1.0_r1(from source)

android.media
Class ToneGenerator

java.lang.Object
  extended by android.media.ToneGenerator

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.


Field Summary
static int MAX_VOLUME
          Maximum volume, for use with ToneGenerator(int,int)
static int MIN_VOLUME
          Minimum volume setting, for use with ToneGenerator(int,int)
static int TONE_DTMF_0
          DTMF tone for key 0: 1336Hz, 941Hz, continuous
static int TONE_DTMF_1
          DTMF tone for key 1: 1209Hz, 697Hz, continuous
static int TONE_DTMF_2
          DTMF tone for key 2: 1336Hz, 697Hz, continuous
static int TONE_DTMF_3
          DTMF tone for key 3: 1477Hz, 697Hz, continuous
static int TONE_DTMF_4
          DTMF tone for key 4: 1209Hz, 770Hz, continuous
static int TONE_DTMF_5
          DTMF tone for key 5: 1336Hz, 770Hz, continuous
static int TONE_DTMF_6
          DTMF tone for key 6: 1477Hz, 770Hz, continuous
static int TONE_DTMF_7
          DTMF tone for key 7: 1209Hz, 852Hz, continuous
static int TONE_DTMF_8
          DTMF tone for key 8: 1336Hz, 852Hz, continuous
static int TONE_DTMF_9
          DTMF tone for key 9: 1477Hz, 852Hz, continuous
static int TONE_DTMF_A
          DTMF tone for key A: 1633Hz, 697Hz, continuous
static int TONE_DTMF_B
          DTMF tone for key B: 1633Hz, 770Hz, continuous
static int TONE_DTMF_C
          DTMF tone for key C: 1633Hz, 852Hz, continuous
static int TONE_DTMF_D
          DTMF tone for key D: 1633Hz, 941Hz, continuous
static int TONE_DTMF_P
          DTMF tone for key #: 1477Hz, 941Hz, continuous
static int TONE_DTMF_S
          DTMF tone for key *: 1209Hz, 941Hz, continuous
static int TONE_PROP_ACK
          Proprietary tone, positive acknowlegement: 1200Hz, 100ms ON, 100ms OFF 2 bursts
static int TONE_PROP_BEEP
          Proprietary tone, general beep: 400Hz+1200Hz, 35ms ON
static int TONE_PROP_BEEP2
          Proprietary tone, general double beep: twice 400Hz+1200Hz, 35ms ON, 200ms OFF, 35ms ON
static int TONE_PROP_NACK
          Proprietary tone, negative acknowlegement: 300Hz+400Hz+500Hz, 400ms ON
static int TONE_PROP_PROMPT
          Proprietary tone, prompt tone: 400Hz+1200Hz, 200ms ON
static int TONE_SUP_BUSY
          Call supervisory tone, Busy: 425Hz, 500ms ON, 500ms OFF...
static int TONE_SUP_CALL_WAITING
          Call supervisory tone, Call Waiting: 425Hz, 200ms ON, 600ms OFF, 200ms ON, 3s OFF...
static int TONE_SUP_CONGESTION
          Call supervisory tone, Congestion: 425Hz, 200ms ON, 200ms OFF...
static int TONE_SUP_DIAL
          Call supervisory tone, Dial tone: 425Hz, continuous
static int TONE_SUP_ERROR
          Call supervisory tone, Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF...
static int TONE_SUP_RADIO_ACK
          Call supervisory tone, Radio path acknowlegment : 425Hz, 200ms ON
static int TONE_SUP_RADIO_NOTAVAIL
          Call supervisory tone, Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts
static int TONE_SUP_RINGTONE
          Call supervisory tone, Ring Tone: 425Hz, 1s ON, 4s OFF...
 
Constructor Summary
ToneGenerator(int streamType, int volume)
          ToneGenerator class contructor specifying output stream type and volume.
 
Method Summary
protected  void finalize()
          Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
 void release()
          Releases resources associated with this ToneGenerator object.
 boolean startTone(int toneType)
          This method starts the playback of a tone of the specified type.
 void stopTone()
          This method stops the tone currently playing playback.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TONE_DTMF_0

public static final int TONE_DTMF_0
DTMF tone for key 0: 1336Hz, 941Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_1

public static final int TONE_DTMF_1
DTMF tone for key 1: 1209Hz, 697Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_2

public static final int TONE_DTMF_2
DTMF tone for key 2: 1336Hz, 697Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_3

public static final int TONE_DTMF_3
DTMF tone for key 3: 1477Hz, 697Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_4

public static final int TONE_DTMF_4
DTMF tone for key 4: 1209Hz, 770Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_5

public static final int TONE_DTMF_5
DTMF tone for key 5: 1336Hz, 770Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_6

public static final int TONE_DTMF_6
DTMF tone for key 6: 1477Hz, 770Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_7

public static final int TONE_DTMF_7
DTMF tone for key 7: 1209Hz, 852Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_8

public static final int TONE_DTMF_8
DTMF tone for key 8: 1336Hz, 852Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_9

public static final int TONE_DTMF_9
DTMF tone for key 9: 1477Hz, 852Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_S

public static final int TONE_DTMF_S
DTMF tone for key *: 1209Hz, 941Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_P

public static final int TONE_DTMF_P
DTMF tone for key #: 1477Hz, 941Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_A

public static final int TONE_DTMF_A
DTMF tone for key A: 1633Hz, 697Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_B

public static final int TONE_DTMF_B
DTMF tone for key B: 1633Hz, 770Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_C

public static final int TONE_DTMF_C
DTMF tone for key C: 1633Hz, 852Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_DTMF_D

public static final int TONE_DTMF_D
DTMF tone for key D: 1633Hz, 941Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_DIAL

public static final int TONE_SUP_DIAL
Call supervisory tone, Dial tone: 425Hz, continuous

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_BUSY

public static final int TONE_SUP_BUSY
Call supervisory tone, Busy: 425Hz, 500ms ON, 500ms OFF...

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_CONGESTION

public static final int TONE_SUP_CONGESTION
Call supervisory tone, Congestion: 425Hz, 200ms ON, 200ms OFF...

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_RADIO_ACK

public static final int TONE_SUP_RADIO_ACK
Call supervisory tone, Radio path acknowlegment : 425Hz, 200ms ON

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_RADIO_NOTAVAIL

public static final int TONE_SUP_RADIO_NOTAVAIL
Call supervisory tone, Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_ERROR

public static final int TONE_SUP_ERROR
Call supervisory tone, Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF...

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_CALL_WAITING

public static final int TONE_SUP_CALL_WAITING
Call supervisory tone, Call Waiting: 425Hz, 200ms ON, 600ms OFF, 200ms ON, 3s OFF...

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_SUP_RINGTONE

public static final int TONE_SUP_RINGTONE
Call supervisory tone, Ring Tone: 425Hz, 1s ON, 4s OFF...

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_PROP_BEEP

public static final int TONE_PROP_BEEP
Proprietary tone, general beep: 400Hz+1200Hz, 35ms ON

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_PROP_ACK

public static final int TONE_PROP_ACK
Proprietary tone, positive acknowlegement: 1200Hz, 100ms ON, 100ms OFF 2 bursts

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_PROP_NACK

public static final int TONE_PROP_NACK
Proprietary tone, negative acknowlegement: 300Hz+400Hz+500Hz, 400ms ON

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_PROP_PROMPT

public static final int TONE_PROP_PROMPT
Proprietary tone, prompt tone: 400Hz+1200Hz, 200ms ON

See Also:
ToneGenerator(int, int), Constant Field Values

TONE_PROP_BEEP2

public static final int TONE_PROP_BEEP2
Proprietary tone, general double beep: twice 400Hz+1200Hz, 35ms ON, 200ms OFF, 35ms ON

See Also:
ToneGenerator(int, int), Constant Field Values

MAX_VOLUME

public static final int MAX_VOLUME
Maximum volume, for use with ToneGenerator(int,int)

See Also:
Constant Field Values

MIN_VOLUME

public static final int MIN_VOLUME
Minimum volume setting, for use with ToneGenerator(int,int)

See Also:
Constant Field Values
Constructor Detail

ToneGenerator

public ToneGenerator(int streamType,
                     int volume)
ToneGenerator class contructor specifying output stream type and volume.

Parameters:
streamType - The streame type used for tone playback (e.g. STREAM_MUSIC).
volume - The volume of the tone, given in percentage of maximum volume (from 0-100).
Method Detail

startTone

public 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.

Parameters:
toneType - The type of tone generate chosen from the following list:
See Also:
ToneGenerator(int, int)

stopTone

public void stopTone()
This method stops the tone currently playing playback.

See Also:
ToneGenerator(int, int)

release

public void release()
Releases resources associated with this ToneGenerator object. It is good practice to call this method when you're done using the ToneGenerator.


finalize

protected void finalize()
Description copied from class: Object
Called by the virtual machine when there are no longer any (non-weak) references to the receiver. Subclasses can use this facility to guarantee that any associated resources are cleaned up before the receiver is garbage collected. Uncaught exceptions which are thrown during the running of the method cause it to terminate immediately, but are otherwise ignored.

Note: The virtual machine assumes that the implementation in class Object is empty.

Overrides:
finalize in class Object

Build 1.0_r1(from source)

Please submit a feedback, bug or feature