QTelephonyTones Class Reference
[QtTelephonyModule]

Detailed Description

The QTelephonyTones class provides access to a tone generator for DTMF tones and other special telephony sounds.

This class is intended for use by dialer user interfaces to generate DTMF tones for the user when digits are typed in prior to call setup. It can also be used to generate supervisory tones such as dial tones, busy signals, etc.

When on a call, DTMF tones should be generated with QPhoneCall::tone() so that the DTMF information can be properly transmitted to the remote party. The QTelephonyTones class should only be used for DTMF tones that occur during call setup.

Some tones, such as dial tone and busy signals, may be country-specific. The server implementation of QTelephonyTones is responsible for generating the correct country-specific tone if it can determine the country. This allows dialer user interfaces to request a specific type of supervisory tone without being aware of the country-specific details.

See also QCommInterface and QPhoneCall::tone().

Member Type Documentation

enum QTelephonyTones::Tone

This enum defines a telephony-related tone to be played using QTelephonyTones::startTone().

Member Function Documentation

QTelephonyTones::QTelephonyTones ( const QString & service = QString(), QObject * parent = 0, QCommInterface::Mode mode = Client )

Construct a new tone generation object for service and attach it to parent. The object will be created in client mode if mode is Client, or server mode otherwise.

If service is empty, this class will use the first available service that supports tone generation. If there is more than one service that supports tone generation, the caller should enumerate them with QCommServiceManager::supports() and create separate QTelephonyTones objects for each.

See also QCommServiceManager::supports().

QTelephonyTones::~QTelephonyTones ()

Destroys this tone generation object.

QString QTelephonyTones::startTone ( QTelephonyTones::Tone tone, int duration = -1 )

Starts playing tone and returns an identifier for it. If duration is -1, the tone should play indefinitely until stopTone() is called. If duration is not -1, it indicates the number of milliseconds to play the tone before automatically stopping.

DTMF tones during a call should be played with QPhoneCall::tone() rather than this function so that the DTMF information can be properly transmitted to the remote party. DTMF tones should only be played with this function when they occur outside a call during the dialing step.

See also stopTone(), toneStopped(), and QPhoneCall::tone().

void QTelephonyTones::startTone ( const QString & id, QTelephonyTones::Tone tone, int duration = -1 )   [virtual slot]

This is an overloaded member function, provided for convenience.

Starts playing tone and associates it with id. If duration is -1, the tone should play indefinitely until stopTone() is called. If duration is not -1, it indicates the number of milliseconds to play the tone before automatically stopping.

DTMF tones during a call should be played with QPhoneCall::tone() rather than this function so that the DTMF information can be properly transmitted to the remote party. DTMF tones should only be played with this function when they occur outside a call during the dialing step.

See also stopTone(), toneStopped(), and QPhoneCall::tone().

void QTelephonyTones::stopTone ( const QString & id )   [virtual slot]

Stops playing the tone associated with id.

See also startTone() and toneStopped().

void QTelephonyTones::toneStopped ( const QString & id )   [signal]

Signal that is emitted when the tone associated with id stops playing.

See also startTone() and stopTone().