Tpy::Client::CallStreamInterface Class Reference

#include <TelepathyQt4Yell/Channel>

List of all members.

Public Slots

• QDBusPendingReply SetSending (bool send, int timeout=-1)
• QDBusPendingReply RequestReceiving (uint contact, bool receive, int timeout=-1)

Signals

• void RemoteMembersChanged (const Tpy::ContactSendingStateMap &updates, const Tpy::UIntList &removed)
• void LocalSendingStateChanged (uint state)

Public Member Functions

• CallStreamInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
• CallStreamInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
• CallStreamInterface (Tp::DBusProxy *proxy)
• CallStreamInterface (const Tp::Client::ChannelInterface &mainInterface)
• CallStreamInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
• Tp::PendingVariant * requestPropertyInterfaces () const
• Tp::PendingVariant * requestPropertyRemoteMembers () const
• Tp::PendingVariant * requestPropertyLocalSendingState () const
• Tp::PendingVariant * requestPropertyCanRequestReceiving () const
• Tp::PendingVariantMap * requestAllProperties () const

Static Public Member Functions

• static QLatin1String staticInterfaceName ()

Protected Member Functions

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

---

Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Call.Stream.DRAFT."

---

Constructor & Destructor Documentation

Tpy::Client::CallStreamInterface::CallStreamInterface	(	const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a CallStreamInterface 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.

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

Creates a CallStreamInterface 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.

Tpy::Client::CallStreamInterface::CallStreamInterface

(

Tp::DBusProxy *

proxy

)

Creates a CallStreamInterface 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.

Tpy::Client::CallStreamInterface::CallStreamInterface

(

const Tp::Client::ChannelInterface &

mainInterface

)

[explicit]

Creates a CallStreamInterface 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.

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

Creates a CallStreamInterface 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 QLatin1String Tpy::Client::CallStreamInterface::staticInterfaceName

(

)

[inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.Call.Stream.DRAFT", which this class represents.

Returns:

The D-Bus interface name.

Tp::PendingVariant* Tpy::Client::CallStreamInterface::requestPropertyInterfaces

(

)

const [inline]

Asynchronous getter for the remote object property "Interfaces" of type QStringList.

Extra interfaces provided by this stream, such as <tp:dbus-ref namespace="ofdT.Call">Stream.Interface.Media.DRAFT</tp:dbus-ref>. This SHOULD NOT include the Stream interface itself, and cannot change once the stream has been created.

Returns:

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

Tp::PendingVariant* Tpy::Client::CallStreamInterface::requestPropertyRemoteMembers

(

)

const [inline]

Asynchronous getter for the remote object property "RemoteMembers" of type Tpy::ContactSendingStateMap.

A map from remote contacts to their sending state. The local user's sending state is shown in <tp:member-ref>LocalSendingState</tp:member-ref>.

<tp:type>Sending_State</tp:type>_Pending_Send indicates that another contact has asked the local user to send media.

Other contacts' handles in this map indicate whether they are sending media to the contacts in this stream. Sending_State_Pending_Send indicates contacts who are not sending but have been asked to do so.

Returns:

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

Tp::PendingVariant* Tpy::Client::CallStreamInterface::requestPropertyLocalSendingState

(

)

const [inline]

Asynchronous getter for the remote object property "LocalSendingState" of type uint.

The local user's sending state. Media sent on this stream should be assumed to be received, directly or indirectly, by every other contact in the <tp:member-ref>RemoteMembers</tp:member-ref> mapping. Change notification is given via the <tp:member-ref>LocalSendingStateChanged</tp:member-ref> signal.

<tp:rationale> Implementations of the first Call draft had the self handle in the <tp:member-ref>RemoteMembers</tp:member-ref> (then called Members) map and this showed that it's annoying having to keep track of the self handle so that it can be special-cased. </tp:rationale>

A value of <tp:type>Sending_State</tp:type>_Pending_Send for this property indicates that the other side requested the local user start sending media, which can be done by calling <tp:member-ref>SetSending</tp:member-ref>. When a call is accepted, all initial contents with streams that have a local sending state of <tp:type>Sending_State</tp:type>_Pending_Send are automatically set to sending. For example, on an incoming call it means you need to <tp:dbus-ref namespace="ofdT.Channel.Type.Call.DRAFT">Accept</tp:dbus-ref> to start the actual call, on an outgoing call it might mean you need to call <tp:dbus-ref namespace="ofdT.Channel.Type.Call.DRAFT">Accept</tp:dbus-ref> before actually starting the call.

Returns:

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

Tp::PendingVariant* Tpy::Client::CallStreamInterface::requestPropertyCanRequestReceiving

(

)

const [inline]

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

If true, the user can request that a remote contact starts sending on this stream.

<tp:rationale>Not all protocols allow the user to ask the other side to start sending media.</tp:rationale>

Returns:

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

Tp::PendingVariantMap* Tpy::Client::CallStreamInterface::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 Tpy::Client::CallStreamInterface::SetSending	(	bool	send,
		int	timeout = -1
	)			[inline, slot]

Begins a call to the D-Bus method "SetSending" on the remote object.

Set the stream to start or stop sending media from the local user to other contacts.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:

send

If True, the <tp:member-ref>LocalSendingState</tp:member-ref> should change to <tp:type>Sending_State</tp:type>_Sending, if it isn't already.

If False, the <tp:member-ref>LocalSendingState</tp:member-ref> should change to <tp:type>Sending_State</tp:type>_None, if it isn't already.

Parameters:

timeout

The timeout in milliseconds.

QDBusPendingReply Tpy::Client::CallStreamInterface::RequestReceiving	(	uint	contact,
		bool	receive,
		int	timeout = -1
	)			[inline, slot]

Begins a call to the D-Bus method "RequestReceiving" on the remote object.

Request that a remote contact stops or starts sending on this stream. The CanRequestReceiving property defines whether the protocol allows the local user to request the other side start sending on this stream.

Note that timeout is ignored as of now. It will be used once http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.

Parameters:

contact

Contact from which sending is requested

Parameters:

receive

If true, request that the given contact starts to send media. If false, request that the given contact stops sending media.

Parameters:

timeout

The timeout in milliseconds.

void Tpy::Client::CallStreamInterface::RemoteMembersChanged	(	const Tpy::ContactSendingStateMap &	updates,
		const Tpy::UIntList &	removed
	)			[signal]

Represents the signal "RemoteMembersChanged" on the remote object.

Emitted when <tp:member-ref>RemoteMembers</tp:member-ref> changes.

Parameters:

	updates	A mapping from channel-specific handles to their updated sending state, whose keys include at least the members who were added, and the members whose states changed.
	removed	The channel-specific handles that were removed from the keys of the RemoteMembers property, as a result of the contact leaving this stream

void Tpy::Client::CallStreamInterface::LocalSendingStateChanged

(

uint

state

)

[signal]

Represents the signal "LocalSendingStateChanged" on the remote object.

Emitted when <tp:member-ref>LocalSendingState</tp:member-ref> changes.

Parameters:

state

The new value of LocalSendingState.

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