Tpy::Client::CallStreamInterfaceMediaInterface Class Reference

#include <TelepathyQt4Yell/Channel>

List of all members.

Public Slots

QDBusPendingReply SetCredentials (const QString &username, const QString &password, int timeout=-1)
QDBusPendingReply AddCandidates (const Tpy::CandidateList &candidates, int timeout=-1)
QDBusPendingReply CandidatesPrepared (int timeout=-1)

Signals

void LocalCandidatesAdded (const Tpy::CandidateList &candidates)
void LocalCredentialsChanged (const QString &username, const QString &password)
void RelayInfoChanged (const Tpy::StringVariantMapList &relayInfo)
void STUNServersChanged (const Tpy::SocketAddressIPList &servers)
void ServerInfoRetrieved ()
void EndpointsChanged (const Tpy::ObjectPathList &endpointsAdded, const Tpy::ObjectPathList &endpointsRemoved)
void PleaseRestartICE ()

Public Member Functions

CallStreamInterfaceMediaInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
CallStreamInterfaceMediaInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
CallStreamInterfaceMediaInterface (Tp::DBusProxy *proxy)
CallStreamInterfaceMediaInterface (const Tp::Client::ChannelInterface &mainInterface)
CallStreamInterfaceMediaInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
Tp::PendingVariant * requestPropertyTransport () const
Tp::PendingVariant * requestPropertyLocalCandidates () const
Tp::PendingVariant * requestPropertyLocalCredentials () const
Tp::PendingVariant * requestPropertySTUNServers () const
Tp::PendingVariant * requestPropertyRelayInfo () const
Tp::PendingVariant * requestPropertyHasServerInfo () const
Tp::PendingVariant * requestPropertyEndpoints () 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.Interface.Media.DRAFT."

Constructor & Destructor Documentation

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

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

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

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

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

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

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

Returns:: The D-Bus interface name.

Tp::PendingVariant* Tpy::Client::CallStreamInterfaceMediaInterface::requestPropertyTransport ( ) const [inline]

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

The transport for this stream.

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

Tp::PendingVariant* Tpy::Client::CallStreamInterfaceMediaInterface::requestPropertyLocalCandidates ( ) const [inline]

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

[FIXME]. Change notification is via the LocalCandidatesAdded signal.

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

Tp::PendingVariant* Tpy::Client::CallStreamInterfaceMediaInterface::requestPropertyLocalCredentials ( ) const [inline]

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

[FIXME]. Change notification is via the LocalCredentialsChanged signal.

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

Tp::PendingVariant* Tpy::Client::CallStreamInterfaceMediaInterface::requestPropertySTUNServers ( ) const [inline]

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

The IP addresses of possible STUN servers to use for NAT traversal, as dotted-quad IPv4 address literals or RFC2373 IPv6 address literals. Change notification is via the <tp:member-ref>STUNServersChanged</tp:member-ref> signal. The IP addresses MUST NOT be given as DNS hostnames.

<tp:rationale> High-quality connection managers already need an asynchronous DNS resolver, so they might as well resolve this name to an IP to make life easier for streaming implementations. </tp:rationale>

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

Tp::PendingVariant* Tpy::Client::CallStreamInterfaceMediaInterface::requestPropertyRelayInfo ( ) const [inline]

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

A list of mappings describing TURN or Google relay servers available for the client to use in its candidate gathering, as determined from the protocol. Map keys are:

ip - s

The IP address of the relay server as a dotted-quad IPv4 address literal or an RFC2373 IPv6 address literal. This MUST NOT be a DNS hostname.

<tp:rationale> High-quality connection managers already need an asynchronous DNS resolver, so they might as well resolve this name to an IP and make life easier for streaming implementations. </tp:rationale>

type - s

Either udp for UDP (UDP MUST be assumed if this key is omitted), tcp for TCP, or tls.

The precise meaning of this key depends on the <tp:member-ref>Transport</tp:member-ref> property: if Transport is ICE, tls means TLS over TCP as referenced by ICE draft 19, and if Transport is GTalk_P2P, tls means a fake SSL session over TCP as implemented by libjingle.

port - q

The UDP or TCP port of the relay server as an ASCII unsigned integer

username - s

The username to use

password - s

The password to use

component - u

The component number to use this relay server for, as an ASCII unsigned integer; if not included, this relay server may be used for any or all components.

<tp:rationale> In ICE draft 6, as used by Google Talk, credentials are only valid once, so each component needs relaying separately. </tp:rationale>

<tp:rationale>

An equivalent of the gtalk-p2p-relay-token property on MediaSignalling channels is not included here. The connection manager should be responsible for making the necessary HTTP requests to turn the token into a username and password. </tp:rationale>

The type of relay server that this represents depends on the value of the <tp:member-ref>Transport</tp:member-ref> property. If Transport is ICE, this is a TURN server; if Transport is GTalk_P2P, this is a Google relay server; otherwise, the meaning of RelayInfo is undefined.

If relaying is not possible for this stream, the list is empty.

Change notification is given via the <tp:member-ref>RelayInfoChanged</tp:member-ref> signal.

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

Tp::PendingVariant* Tpy::Client::CallStreamInterfaceMediaInterface::requestPropertyHasServerInfo ( ) const [inline]

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

True if all the initial information about STUN servers and Relay servers has been retrieved. Change notification is via the <tp:member-ref>ServerInfoRetrieved</tp:member-ref> signal.

<tp:rationale> Streaming implementations that can't cope with STUN and relay servers being added later SHOULD wait for this property to become true before proceeding. </tp:rationale>

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

Tp::PendingVariant* Tpy::Client::CallStreamInterfaceMediaInterface::requestPropertyEndpoints ( ) const [inline]

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

The list of Endpoint.DRAFT objects that exist for this stream. Change notification is via the EndpointsChanged signal.

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

Tp::PendingVariantMap* Tpy::Client::CallStreamInterfaceMediaInterface::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::CallStreamInterfaceMediaInterface::SetCredentials	(	const QString &	username,
		const QString &	password,
		int	timeout = `-1`
	)			`[inline, slot]`

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

Used to set the username fragment and password for streams that have global credentials.

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

Parameters:

	username	The username to use when authenticating on the stream.
	password	The password to use when authenticating on the stream.
	timeout	The timeout in milliseconds.

QDBusPendingReply Tpy::Client::CallStreamInterfaceMediaInterface::AddCandidates	(	const Tpy::CandidateList &	candidates,
		int	timeout = `-1`
	)			`[inline, slot]`

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

Add candidates to the LocalCandidates property and signal them to the remote contact(s).

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

Parameters:

	candidates	The candidates to be added.
	timeout	The timeout in milliseconds.

QDBusPendingReply Tpy::Client::CallStreamInterfaceMediaInterface::CandidatesPrepared ( int timeout = -1 ) [inline, slot]

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

This indicates to the CM that the initial batch of candidates has been added.

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

Parameters:

timeout

The timeout in milliseconds.

void Tpy::Client::CallStreamInterfaceMediaInterface::LocalCandidatesAdded ( const Tpy::CandidateList & candidates ) [signal]

Represents the signal "LocalCandidatesAdded" on the remote object.

Emitted when local candidates are added to the LocalCandidates property.

Parameters:

candidates

Candidates that have been added.

void Tpy::Client::CallStreamInterfaceMediaInterface::LocalCredentialsChanged	(	const QString &	username,
		const QString &	password
	)			`[signal]`

Represents the signal "LocalCredentialsChanged" on the remote object.

Emitted when the value of LocalCredentials changes.

void Tpy::Client::CallStreamInterfaceMediaInterface::RelayInfoChanged ( const Tpy::StringVariantMapList & relayInfo ) [signal]

Represents the signal "RelayInfoChanged" on the remote object.

Emitted when the value of RelayInfo changes.

void Tpy::Client::CallStreamInterfaceMediaInterface::STUNServersChanged ( const Tpy::SocketAddressIPList & servers ) [signal]

Represents the signal "STUNServersChanged" on the remote object.

Emitted when the value of STUNServers changes.

void Tpy::Client::CallStreamInterfaceMediaInterface::ServerInfoRetrieved ( ) [signal]

Represents the signal "ServerInfoRetrieved" on the remote object.

Signals that the initial information about STUN and Relay servers has been retrieved, i.e. the <tp:member-ref>HasServerInfo</tp:member-ref> property is now true.

void Tpy::Client::CallStreamInterfaceMediaInterface::EndpointsChanged	(	const Tpy::ObjectPathList &	endpointsAdded,
		const Tpy::ObjectPathList &	endpointsRemoved
	)			`[signal]`

Represents the signal "EndpointsChanged" on the remote object.

Emitted when the Endpoints property changes.

Parameters:

	endpointsAdded	Endpoints that were added.
	endpointsRemoved	Endpoints that no longer exist.

void Tpy::Client::CallStreamInterfaceMediaInterface::PleaseRestartICE ( ) [signal]

Represents the signal "PleaseRestartICE" on the remote object.

Emitted when the CM does an ICE restart to notify the streaming implementation that it should call SetCredentials again.

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