Tpy::Client::CallContentInterfaceMediaInterface Class Reference

#include <TelepathyQt4Yell/Channel>

List of all members.

Public Slots

• QDBusPendingReply UpdateCodecs (const Tpy::CodecList &codecs, int timeout=-1)

Signals

• void CodecsChanged (const Tpy::ContactCodecMap &updatedCodecs, const Tpy::UIntList &removedContacts)
• void NewCodecOffer (uint contact, const QDBusObjectPath &offer, const Tpy::CodecList &codecs)

Public Member Functions

• CallContentInterfaceMediaInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
• CallContentInterfaceMediaInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
• CallContentInterfaceMediaInterface (Tp::DBusProxy *proxy)
• CallContentInterfaceMediaInterface (const Tp::Client::ChannelInterface &mainInterface)
• CallContentInterfaceMediaInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
• Tp::PendingVariant * requestPropertyContactCodecMap () const
• Tp::PendingVariant * requestPropertyCodecOffer () 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.Content.Interface.Media.DRAFT."

---

Constructor & Destructor Documentation

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

Creates a CallContentInterfaceMediaInterface 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::CallContentInterfaceMediaInterface::CallContentInterfaceMediaInterface	(	const QDBusConnection &	connection,
		const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a CallContentInterfaceMediaInterface 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::CallContentInterfaceMediaInterface::CallContentInterfaceMediaInterface

(

Tp::DBusProxy *

proxy

)

Creates a CallContentInterfaceMediaInterface 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::CallContentInterfaceMediaInterface::CallContentInterfaceMediaInterface

(

const Tp::Client::ChannelInterface &

mainInterface

)

[explicit]

Creates a CallContentInterfaceMediaInterface 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::CallContentInterfaceMediaInterface::CallContentInterfaceMediaInterface	(	const Tp::Client::ChannelInterface &	mainInterface,
		QObject *	parent
	)

Creates a CallContentInterfaceMediaInterface 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::CallContentInterfaceMediaInterface::staticInterfaceName

(

)

[inline, static]

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

Returns:

The D-Bus interface name.

Tp::PendingVariant* Tpy::Client::CallContentInterfaceMediaInterface::requestPropertyContactCodecMap

(

)

const [inline]

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

A map from contact handles (including the local user's own handle) to the codecs supported by that contact. Change notification is via the CodecsChanged signal.

Returns:

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

Tp::PendingVariant* Tpy::Client::CallContentInterfaceMediaInterface::requestPropertyCodecOffer

(

)

const [inline]

Asynchronous getter for the remote object property "CodecOffer" of type Tpy::CodecOffering.

The object path to the current <tp:dbus-ref namespace="ofdT.Call.Content">CodecOffer.DRAFT</tp:dbus-ref> object, its <tp:dbus-ref namespace="ofdT.Call.Content">CodecOffer.DRAFT.RemoteContact</tp:dbus-ref> and <tp:dbus-ref namespace="ofdT.Call.Content">CodecOffer.DRAFT.RemoteContactCodecs</tp:dbus-ref> properties. If the object path is "/" then there isn't an outstanding codec offer, and the mapping MUST be empty.

<tp:rationale> Having the <tp:dbus-ref namespace="ofdT.Call.Content.CodecOffer.DRAFT">RemoteContact</tp:dbus-ref> and <tp:dbus-ref namespace="ofdT.Call.Content.CodecOffer.DRAFT">RemoteContactCodecs</tp:dbus-ref> properties here saves a D-Bus round-trip - it shouldn't be necessary to get these properties from the CodecOffer object, in practice. </tp:rationale>

Change notification is via the <tp:member-ref>NewCodecOffer</tp:member-ref> (which replaces the value of this property with a new codec offer), and <tp:member-ref>CodecsChanged</tp:member-ref> (which implies that there is no longer any active codec offer) signals.

Returns:

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

Tp::PendingVariantMap* Tpy::Client::CallContentInterfaceMediaInterface::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::CallContentInterfaceMediaInterface::UpdateCodecs	(	const Tpy::CodecList &	codecs,
		int	timeout = -1
	)			[inline, slot]

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

Update the local codec mapping. This method should only be used during an existing call to update the codec mapping.

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

Parameters:

	codecs	The codecs now supported by the local user.
	timeout	The timeout in milliseconds.

void Tpy::Client::CallContentInterfaceMediaInterface::CodecsChanged	(	const Tpy::ContactCodecMap &	updatedCodecs,
		const Tpy::UIntList &	removedContacts
	)			[signal]

Represents the signal "CodecsChanged" on the remote object.

Emitted when the codecs in use change.

As well as acting as change notification for the <tp:member-ref>ContactCodecMap</tp:member-ref>, emission of this signal implies that the <tp:member-ref>CodecOffer</tp:member-ref> property has changed to ('/', {}).

Parameters:

	updatedCodecs	A map from contact to his or her codecs. Each pair in this map is added to the ContactCodecMap property, replacing any previous pair with that key.
	removedContacts	A list of keys which were removed from the ContactCodecMap, probably because those contacts left the call.

void Tpy::Client::CallContentInterfaceMediaInterface::NewCodecOffer	(	uint	contact,
		const QDBusObjectPath &	offer,
		const Tpy::CodecList &	codecs
	)			[signal]

Represents the signal "NewCodecOffer" on the remote object.

Emitted when a new <tp:dbus-ref namespace="ofdT.Call.Content">CodecOffer.DRAFT</tp:dbus-ref> appears. The streaming implementation MUST respond by calling the <tp:dbus-ref namespace="ofdT.Call.Content.CodecOffer.DRAFT">Accept</tp:dbus-ref> or <tp:dbus-ref namespace="ofdT.Call.Content.CodecOffer.DRAFT">Reject</tp:dbus-ref> method on the codec offer object.

Emission of this signal indicates that the <tp:member-ref>CodecOffer</tp:member-ref> property has changed to (Contact, Offer, Codecs).

Parameters:

	contact	The contact the codec offer belongs to.
	offer	The object path of the new codec offer. This replaces any previous codec offer.
	codecs

The <tp:dbus-ref namespace="ofdT.Call.Content">CodecOffer.DRAFT.RemoteContactCodecs</tp:dbus-ref> property of the codec offer.

<tp:rationale> Having the <tp:dbus-ref namespace="ofdT.Call.Content.CodecOffer.DRAFT">RemoteContactCodecs</tp:dbus-ref> property here saves a D-Bus round-trip - it shouldn't be necessary to get the property from the CodecOffer object, in practice. </tp:rationale>

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