Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QTelephonyTones Class Reference
[QtTelephonyModule]

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

    #include <QTelephonyTones>

Inherits QCommInterface.

List of all members, including inherited members

Public Types

enum Tone { Dtmf0, Dtmf1, Dtmf2, Dtmf3, ..., User }

Public Functions

QTelephonyTones ( const QString & service = QString(), QObject * parent = 0, QCommInterface::Mode mode = Client )
~QTelephonyTones ()
QString startTone ( QTelephonyTones::Tone tone, int duration = -1 )

1 public function inherited from QCommInterface
4 public functions inherited from QAbstractIpcInterface
29 public functions inherited from QObject

Public Slots

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

1 public slot inherited from QObject

Signals

void toneStopped ( const QString & id )

1 signal inherited from QAbstractIpcInterface
1 signal inherited from QObject

Additional Inherited Members

1 property inherited from QObject
1 public type inherited from QObject
4 static public members inherited from QObject
14 protected functions inherited from QAbstractIpcInterface
7 protected functions inherited from QObject
2 protected variables inherited from QObject

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().

Constant	Value	Description
`QTelephonyTones::Dtmf0`	`0`	Tone for DTMF digit 0
`QTelephonyTones::Dtmf1`	`1`	Tone for DTMF digit 1
`QTelephonyTones::Dtmf2`	`2`	Tone for DTMF digit 2
`QTelephonyTones::Dtmf3`	`3`	Tone for DTMF digit 3
`QTelephonyTones::Dtmf4`	`4`	Tone for DTMF digit 4
`QTelephonyTones::Dtmf5`	`5`	Tone for DTMF digit 5
`QTelephonyTones::Dtmf6`	`6`	Tone for DTMF digit 6
`QTelephonyTones::Dtmf7`	`7`	Tone for DTMF digit 7
`QTelephonyTones::Dtmf8`	`8`	Tone for DTMF digit 8
`QTelephonyTones::Dtmf9`	`9`	Tone for DTMF digit 9
`QTelephonyTones::DtmfStar`	`10`	Tone for DTMF digit *
`QTelephonyTones::DtmfHash`	`11`	Tone for DTMF digit #
`QTelephonyTones::DtmfA`	`12`	Tone for DTMF digit A
`QTelephonyTones::DtmfB`	`13`	Tone for DTMF digit B
`QTelephonyTones::DtmfC`	`14`	Tone for DTMF digit C
`QTelephonyTones::DtmfD`	`15`	Tone for DTMF digit D
`QTelephonyTones::Busy`	`16`	Busy signal when the other party cannot be reached
`QTelephonyTones::Dial`	`17`	Dial tone
`QTelephonyTones::Dial2`	`18`	Secondary dial tone, for outside lines
`QTelephonyTones::Alerting`	`19`	Tone indicating that the called party is alerting (ringing).
`QTelephonyTones::CallWaiting`	`20`	Tone indicating that there is another call waiting.
`QTelephonyTones::MessageWaiting`	`21`	Tone indicating that this is a message waiting.
`QTelephonyTones::NoService`	`22`	Tone indicating that there is no network service. This may be played instead of Dial to audibly indicate to the user that the current call attempt will probably not succeed. The tone provider could choose to play no tone at all for this case.
`QTelephonyTones::User`	`100`	First user-defined tone.

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.

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.

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

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

Stops playing the tone associated with id.

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

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

QTelephonyTones Class Reference[QtTelephonyModule]