Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.DTMF".
Tp::PendingVariant* Tp::Client::ChannelInterfaceDTMFInterface::requestPropertyDeferredTones |
( |
| ) |
const |
|
inline |
Asynchronous getter for the remote object property DeferredTones
of type QString
.
The tones waiting for the user to continue, if any.
When this property is set to a non-empty value,
TonesDeferred() is emitted.
When any tones are played (i.e. whenever
SendingTones() is emitted),
this property is reset to the empty string.
- Returns
- A pending variant which will emit finished when the property has been retrieved.
QDBusPendingReply Tp::Client::ChannelInterfaceDTMFInterface::StartTone |
( |
uint |
streamID, |
|
|
uchar |
event, |
|
|
int |
timeout = -1 |
|
) |
| |
|
inlineslot |
Begins a call to the D-Bus method StartTone
on the remote object.
Start sending a DTMF tone to all eligible streams in the channel. Where possible, the tone will continue until StopTone is called. On certain protocols, it may only be possible to send events with a predetermined length. In this case, the implementation MAY emit a fixed-length tone, and the StopTone method call SHOULD return NotAvailable. The client may wish to control the exact duration and timing of the tones sent as a result of user's interaction with the dialpad, thus starting and stopping the tone sending explicitly. Tone overlaping or queueing is not supported, so this method can only be called if no DTMF tones are already being played.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
- Parameters
-
streamID | A stream ID as defined in the StreamedMedia channel type. This
argument is included for backwards compatibility and MUST be
ignored by the implementations - the tone SHOULD be sent to all
eligible streams in the channel.
|
event | A numeric event code from the DTMF_Event enum.
|
timeout | The timeout in milliseconds. |
QDBusPendingReply Tp::Client::ChannelInterfaceDTMFInterface::StopTone |
( |
uint |
streamID, |
|
|
int |
timeout = -1 |
|
) |
| |
|
inlineslot |
Begins a call to the D-Bus method StopTone
on the remote object.
Stop sending any DTMF tones which have been started using the StartTone or MultipleTones methods. If there is no current tone, this method will do nothing. If MultipleTones was used, the client should not assume the sending has stopped immediately; instead, the client should wait for the StoppedTones signal. On some protocols it might be impossible to cancel queued tones immediately.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
- Parameters
-
streamID | A stream ID as defined in the StreamedMedia channel type. This
argument is included for backwards compatibility and MUST be
ignored by the implementations - the sending SHOULD be stoped in
all eligible streams in the channel.
|
timeout | The timeout in milliseconds. |
QDBusPendingReply Tp::Client::ChannelInterfaceDTMFInterface::MultipleTones |
( |
const QString & |
tones, |
|
|
int |
timeout = -1 |
|
) |
| |
|
inlineslot |
Begins a call to the D-Bus method MultipleTones
on the remote object.
Send multiple DTMF events to all eligible streams in the channel. Each tone will be played for an implementation-defined number of milliseconds (typically 250ms), followed by a gap before the next tone is played (typically 100ms). The duration and gap are defined by the protocol or connection manager. In cases where the client knows in advance the tone sequence it wants to send, it's easier to use this method than manually start and stop each tone in the sequence. The tone and gap lengths may need to vary for interoperability, according to the protocol and other implementations' ability to recognise tones. At the time of writing, GStreamer uses a minimum of 250ms tones and 100ms gaps when playing in-band DTMF in the normal audio stream, or 70ms tones and 50ms gaps when encoding DTMF as audio/telephone-event. Tone overlaping or queueing is not supported, so this method can only be called if no DTMF tones are already being played.
Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
- Parameters
-
tones | \htmlonly
<p>A string representation of one or more DTMF
events. Implementations of this method MUST support all of the
following characters in this string:</p>
<ul>
<li>the digits 0-9, letters A-D and a-d, and symbols '*' and '#'
correspond to the members of <tp:type>DTMF_Event</tp:type></li>
<li>any of 'p', 'P', 'x', 'X' or ',' (comma) results in an
implementation-defined pause, typically for 3 seconds</li>
<li>'w' or 'W' waits for the user to continue, by stopping
interpretation of the string, and if there is more to be played,
emitting the \endhtmlonly TonesDeferred() \htmlonly signal
with the rest of the string as its argument: see that signal
for details</li>
</ul>
\endhtmlonly
|
timeout | The timeout in milliseconds. |
void Tp::Client::ChannelInterfaceDTMFInterface::TonesDeferred |
( |
const QString & |
tones | ) |
|
|
signal |
Represents the signal TonesDeferred
on the remote object.
Emitted when 'w' or 'W', indicating "wait for the user to continue",
is encountered while playing a DTMF string queued by
MultipleTones() or
InitialTones . Any queued DTMF events
after the 'w', which have not yet been played, are placed in the
DeferredTones property and copied
into this signal's argument.
When the channel handler is ready to continue, it MAY pass the
value of DeferredTones to
MultipleTones() , to resume sending.
Alternatively, it MAY ignore the deferred tones, or even play
different tones instead. Any deferred tones are discarded the next
time a tone is played.
This signal SHOULD NOT be emitted if there is nothing left to play,
i.e. if the 'w' was the last character in the DTMF string.
- Parameters
-
tones | The new non-empty value of DeferredTones.
|