Tp::Client::ChannelInterfaceDTMFInterface Class Reference [Channel proxies]

#include <TelepathyQt4/Channel>

Inherits Tp::AbstractInterface.

List of all members.

Public Slots

• QDBusPendingReply StartTone (uint streamID, uchar event)
• QDBusPendingReply StopTone (uint streamID)
• QDBusPendingReply MultipleTones (const QString &tones)

Signals

• void SendingTones (const QString &tones)
• void StoppedTones (bool cancelled)

Public Member Functions

• ChannelInterfaceDTMFInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
• ChannelInterfaceDTMFInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
• ChannelInterfaceDTMFInterface (Tp::DBusProxy *proxy)
• ChannelInterfaceDTMFInterface (const Tp::Client::ChannelInterface &mainInterface)
• ChannelInterfaceDTMFInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
• TELEPATHY_QT4_DEPRECATED bool CurrentlySendingTones () const
• Tp::PendingVariant * requestPropertyCurrentlySendingTones () const
• TELEPATHY_QT4_DEPRECATED QString InitialTones () const
• Tp::PendingVariant * requestPropertyInitialTones () const
• Tp::PendingVariantMap * requestAllProperties () const

Static Public Member Functions

• static const char * staticInterfaceName ()

Protected Member Functions

• virtual void invalidate (Tp::DBusProxy *, const QString &, const QString &)

Properties

• bool CurrentlySendingTones
• QString InitialTones

---

Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.DTMF."

---

Constructor & Destructor Documentation

Tp::Client::ChannelInterfaceDTMFInterface::ChannelInterfaceDTMFInterface	(	const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a ChannelInterfaceDTMFInterface associated with the given object on the session bus.

Parameters:

	busName	Name of the service the object is on.
	objectPath	Path to the object on the service.
	parent	Passed to the parent class constructor.

Tp::Client::ChannelInterfaceDTMFInterface::ChannelInterfaceDTMFInterface	(	const QDBusConnection &	connection,
		const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a ChannelInterfaceDTMFInterface associated with the given object on the given bus.

Parameters:

	connection	The bus via which the object can be reached.
	busName	Name of the service the object is on.
	objectPath	Path to the object on the service.
	parent	Passed to the parent class constructor.

Tp::Client::ChannelInterfaceDTMFInterface::ChannelInterfaceDTMFInterface

(

Tp::DBusProxy *

proxy

)

Creates a ChannelInterfaceDTMFInterface associated with the same object as the given proxy.

Parameters:

proxy

The proxy to use. It will also be the QObject::parent() for this object.

Tp::Client::ChannelInterfaceDTMFInterface::ChannelInterfaceDTMFInterface

(

const Tp::Client::ChannelInterface &

mainInterface

)

[explicit]

Creates a ChannelInterfaceDTMFInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.

Parameters:

mainInterface

The proxy to use.

Tp::Client::ChannelInterfaceDTMFInterface::ChannelInterfaceDTMFInterface	(	const Tp::Client::ChannelInterface &	mainInterface,
		QObject *	parent
	)

Creates a ChannelInterfaceDTMFInterface associated with the same object as the given proxy. However, a different parent object can be specified.

Parameters:

	mainInterface	The proxy to use.
	parent	Passed to the parent class constructor.

---

Member Function Documentation

static const char* Tp::Client::ChannelInterfaceDTMFInterface::staticInterfaceName

(

)

[inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.DTMF", which this class represents.

Returns:

The D-Bus interface name.

TELEPATHY_QT4_DEPRECATED bool Tp::Client::ChannelInterfaceDTMFInterface::CurrentlySendingTones

(

)

const [inline]

Getter for the remote object property "CurrentlySendingTones".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertyCurrentlySendingTones() instead.

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ChannelInterfaceDTMFInterface::requestPropertyCurrentlySendingTones

(

)

const [inline]

Asynchronous getter for the remote object property "CurrentlySendingTones" of type bool.

Indicates whether there are DTMF tones currently being sent in the channel. If so, the client should wait for StoppedTones signal before trying to send more tones.

Returns:

A pending variant which will emit finished when the property has been retrieved.

TELEPATHY_QT4_DEPRECATED QString Tp::Client::ChannelInterfaceDTMFInterface::InitialTones

(

)

const [inline]

Getter for the remote object property "InitialTones".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertyInitialTones() instead.

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ChannelInterfaceDTMFInterface::requestPropertyInitialTones

(

)

const [inline]

Asynchronous getter for the remote object property "InitialTones" of type QString.

If non-empty in a channel request that will create a new channel, the connection manager should send the tones immediately after at least one eligible audio stream has been created in the channel. This property is immutable (cannot change).

Returns:

A pending variant which will emit finished when the property has been retrieved.

Tp::PendingVariantMap* Tp::Client::ChannelInterfaceDTMFInterface::requestAllProperties

(

)

const [inline]

Request all of the DBus properties on the interface.

Returns:

A pending variant map which will emit finished when the properties have been retrieved.

QDBusPendingReply Tp::Client::ChannelInterfaceDTMFInterface::StartTone	(	uint	streamID,
		uchar	event
	)			[inline, slot]

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.

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.

QDBusPendingReply Tp::Client::ChannelInterfaceDTMFInterface::StopTone

(

uint

streamID

)

[inline, slot]

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.

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.

QDBusPendingReply Tp::Client::ChannelInterfaceDTMFInterface::MultipleTones

(

const QString &

tones

)

[inline, slot]

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 character in the Tones string must be a valid DTMF event (as defined by RFC4733). Each tone will be played for a pre-defined number of milliseconds, followed by a pause before the next tone is played. The duration/pause is 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. Tone overlaping or queueing is not supported, so this method can only be called if no DTMF tones are already being played.

Parameters:

tones

A string representation of one or more DTMF events.

void Tp::Client::ChannelInterfaceDTMFInterface::SendingTones

(

const QString &

tones

)

[signal]

Represents the signal "SendingTones" on the remote object.

DTMF tone(s)are being sent to all eligible streams in the channel. The signal is provided to indicating the fact that the streams are currently being used to send one or more DTMF tones, so any other media input is not getting through to the audio stream. It also serves as a cue for the <tp:member-ref>StopTone</tp:member-ref> method.

Parameters:

tones

DTMF string (one or more events) that is to be played.

void Tp::Client::ChannelInterfaceDTMFInterface::StoppedTones

(

bool

cancelled

)

[signal]

Represents the signal "StoppedTones" on the remote object.

DTMF tones have finished playing on streams in this channel.

Parameters:

cancelled

True if the DTMF tones were actively cancelled via StopTone.

void Tp::Client::ChannelInterfaceDTMFInterface::invalidate	(	Tp::DBusProxy *	proxy,
		const QString &	error,
		const QString &	message
	)			[protected, virtual]

Reimplemented from Tp::AbstractInterface.

---

Property Documentation

bool Tp::Client::ChannelInterfaceDTMFInterface::CurrentlySendingTones [read]

Represents property "CurrentlySendingTones" on the remote object.

Indicates whether there are DTMF tones currently being sent in the channel. If so, the client should wait for StoppedTones signal before trying to send more tones.

QString Tp::Client::ChannelInterfaceDTMFInterface::InitialTones [read]

Represents property "InitialTones" on the remote object.

If non-empty in a channel request that will create a new channel, the connection manager should send the tones immediately after at least one eligible audio stream has been created in the channel. This property is immutable (cannot change).