Tpy::Client::CallContentInterface Class Reference

#include <TelepathyQt4Yell/Channel>

List of all members.

Public Slots

QDBusPendingReply Remove (uint reason, const QString &detailedRemovalReason, const QString &message, int timeout=-1)

Signals

void Removed ()
void StreamsAdded (const Tpy::ObjectPathList &streams)
void StreamsRemoved (const Tpy::ObjectPathList &streams)

Public Member Functions

CallContentInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
CallContentInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
CallContentInterface (Tp::DBusProxy *proxy)
CallContentInterface (const Tp::Client::ChannelInterface &mainInterface)
CallContentInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
Tp::PendingVariant * requestPropertyInterfaces () const
Tp::PendingVariant * requestPropertyName () const
Tp::PendingVariant * requestPropertyType () const
Tp::PendingVariant * requestPropertyDisposition () const
Tp::PendingVariant * requestPropertyStreams () const
Tp::PendingVariant * requestPropertyPacketization () 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.DRAFT."

Constructor & Destructor Documentation

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

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

Creates a CallContentInterface 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::CallContentInterface::CallContentInterface ( Tp::DBusProxy * proxy )

Creates a CallContentInterface 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::CallContentInterface::CallContentInterface ( const Tp::Client::ChannelInterface & mainInterface ) [explicit]

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

Creates a CallContentInterface 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::CallContentInterface::staticInterfaceName ( ) [inline, static]

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

Returns:: The D-Bus interface name.

Tp::PendingVariant* Tpy::Client::CallContentInterface::requestPropertyInterfaces ( ) const [inline]

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

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

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

Tp::PendingVariant* Tpy::Client::CallContentInterface::requestPropertyName ( ) const [inline]

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

The name of the content.

<tp:rationale> The content name property should be meaningful, so should be given a name which is significant to the user. The name could be the "audio" or "video" string localized, or perhaps include some string identifying the source, such as a webcam identifier. </tp:rationale>

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

Tp::PendingVariant* Tpy::Client::CallContentInterface::requestPropertyType ( ) const [inline]

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

The media type of this content.

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

Tp::PendingVariant* Tpy::Client::CallContentInterface::requestPropertyDisposition ( ) const [inline]

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

The disposition of this content.

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

Tp::PendingVariant* Tpy::Client::CallContentInterface::requestPropertyStreams ( ) const [inline]

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

The list of <tp:dbus-ref namespace="ofdT.Call">Stream.DRAFT</tp:dbus-ref> objects that exist in this content.

<tp:rationale> In a conference call multiple parties can share one media content (say, audio), but the streaming of that media can either be shared or separate. For example, in a multicast conference all contacts would share one stream, while in a Muji conference there would be a stream for each participant. </tp:rationale>

Change notification is through the <tp:member-ref>StreamsAdded</tp:member-ref> and <tp:member-ref>StreamsRemoved</tp:member-ref> signals.

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

Tp::PendingVariant* Tpy::Client::CallContentInterface::requestPropertyPacketization ( ) const [inline]

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

The packetization method in use for this content.

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

Tp::PendingVariantMap* Tpy::Client::CallContentInterface::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::CallContentInterface::Remove	(	uint	reason,
		const QString &	detailedRemovalReason,
		const QString &	message,
		int	timeout = `-1`
	)			`[inline, slot]`

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

Remove the content from the call.

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

Parameters:

	reason	A generic hangup reason.
	detailedRemovalReason	A more specific reason for the content removal, if one is available, or an empty string.
	message	A human-readable message for the reason of removing the content, such as "Fatal streaming failure" or "no codec intersection". This property can be left empty if no reason is to be given.
	timeout	The timeout in milliseconds.

void Tpy::Client::CallContentInterface::Removed ( ) [signal]

Represents the signal "Removed" on the remote object.

Emitted when the content is removed from the call. This is the same as the <tp:dbus-ref namespace="ofdT.Channel.Type">Call.DRAFT.ContentRemoved</tp:dbus-ref> signal.

void Tpy::Client::CallContentInterface::StreamsAdded ( const Tpy::ObjectPathList & streams ) [signal]

Represents the signal "StreamsAdded" on the remote object.

Emitted when streams are added to a call.

Parameters:

streams

The Stream.DRAFTs which were added.

void Tpy::Client::CallContentInterface::StreamsRemoved ( const Tpy::ObjectPathList & streams ) [signal]

Represents the signal "StreamsRemoved" on the remote object.

Emitted when streams are removed from a call

Parameters:

streams

The Stream.DRAFTs which were removed.

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