Telepathy::Client::ChannelTypeStreamedMediaInterface Class Reference
[Channel proxies]

#include <TelepathyQt4/Client/Channel>

Inheritance diagram for Telepathy::Client::ChannelTypeStreamedMediaInterface:

Inheritance graph
[legend]
Collaboration diagram for Telepathy::Client::ChannelTypeStreamedMediaInterface:

Collaboration graph
[legend]

List of all members.

Public Slots

QDBusPendingReply
< Telepathy::MediaStreamInfoList
ListStreams ()
QDBusPendingReply RemoveStreams (const Telepathy::UIntList &streams)
QDBusPendingReply RequestStreamDirection (uint streamID, uint streamDirection)
QDBusPendingReply
< Telepathy::MediaStreamInfoList
RequestStreams (uint contactHandle, const Telepathy::UIntList &types)

Signals

void StreamAdded (uint streamID, uint contactHandle, uint streamType)
void StreamDirectionChanged (uint streamID, uint streamDirection, uint pendingFlags)
void StreamError (uint streamID, uint errorCode, const QString &message)
void StreamRemoved (uint streamID)
void StreamStateChanged (uint streamID, uint streamState)

Public Member Functions

 ChannelTypeStreamedMediaInterface (const QString &serviceName, const QString &objectPath, QObject *parent=0)
 ChannelTypeStreamedMediaInterface (const QDBusConnection &connection, const QString &serviceName, const QString &objectPath, QObject *parent=0)
 ChannelTypeStreamedMediaInterface (Telepathy::Client::DBusProxy *proxy)
 ChannelTypeStreamedMediaInterface (const Telepathy::Client::ChannelInterface &mainInterface)
 ChannelTypeStreamedMediaInterface (const Telepathy::Client::ChannelInterface &mainInterface, QObject *parent)

Static Public Member Functions

static const char * staticInterfaceName ()

Protected Member Functions

virtual void invalidate (Telepathy::Client::DBusProxy *, const QString &, const QString &)


Detailed Description

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

Constructor & Destructor Documentation

Telepathy::Client::ChannelTypeStreamedMediaInterface::ChannelTypeStreamedMediaInterface ( const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

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

Parameters:
serviceName Name of the service the object is on.
objectPath Path to the object on the service.
parent Passed to the parent class constructor.

Telepathy::Client::ChannelTypeStreamedMediaInterface::ChannelTypeStreamedMediaInterface ( const QDBusConnection &  connection,
const QString &  serviceName,
const QString &  objectPath,
QObject *  parent = 0 
)

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

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

Telepathy::Client::ChannelTypeStreamedMediaInterface::ChannelTypeStreamedMediaInterface ( Telepathy::Client::DBusProxy proxy  ) 

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

Telepathy::Client::ChannelTypeStreamedMediaInterface::ChannelTypeStreamedMediaInterface ( const Telepathy::Client::ChannelInterface mainInterface  )  [explicit]

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

Telepathy::Client::ChannelTypeStreamedMediaInterface::ChannelTypeStreamedMediaInterface ( const Telepathy::Client::ChannelInterface mainInterface,
QObject *  parent 
)

Creates a ChannelTypeStreamedMediaInterface 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

virtual void Telepathy::Client::ChannelTypeStreamedMediaInterface::invalidate ( Telepathy::Client::DBusProxy ,
const QString &  ,
const QString &   
) [protected, virtual]

QDBusPendingReply<Telepathy::MediaStreamInfoList> Telepathy::Client::ChannelTypeStreamedMediaInterface::ListStreams (  )  [inline, slot]

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

Returns an array of structs representing the streams currently active within this channel. Each stream is identified by an unsigned integer which is unique for each stream within the channel.

Returns:
An array of structs containing:
  • the stream identifier
  • the contact handle who the stream is with (or 0 if the stream represents more than a single member)
  • the type of the stream
  • the current stream state
  • the current direction of the stream
  • the current pending send flags

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

QDBusPendingReply Telepathy::Client::ChannelTypeStreamedMediaInterface::RemoveStreams ( const Telepathy::UIntList streams  )  [inline, slot]

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

Request that the given streams are removed.

Parameters:
streams An array of stream identifiers (as defined in ListStreams)

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

QDBusPendingReply Telepathy::Client::ChannelTypeStreamedMediaInterface::RequestStreamDirection ( uint  streamID,
uint  streamDirection 
) [inline, slot]

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

Request a change in the direction of an existing stream. In particular, this might be useful to stop sending media of a particular type, or inform the peer that you are no longer using media that is being sent to you.

Depending on the protocol, streams which are no longer sending in either direction should be removed and a <tp:member-ref>StreamRemoved</tp:member-ref> signal emitted. Some direction changes can be enforced locally (for example, BIDIRECTIONAL -> RECEIVE can be achieved by merely stopping sending), others may not be possible on some protocols, and some need agreement from the remote end. In this case, the MEDIA_STREAM_PENDING_REMOTE_SEND flag will be set in the <tp:member-ref>StreamDirectionChanged</tp:member-ref> signal, and the signal emitted again without the flag to indicate the resulting direction when the remote end has accepted or rejected the change.

Parameters:
streamID The stream identifier (as defined in ListStreams)
streamDirection The desired stream direction (a value of MediaStreamDirection)

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

QDBusPendingReply<Telepathy::MediaStreamInfoList> Telepathy::Client::ChannelTypeStreamedMediaInterface::RequestStreams ( uint  contactHandle,
const Telepathy::UIntList types 
) [inline, slot]

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

Request that streams be established to exchange the given types of media with the given member. In general this will try and establish a bidirectional stream, but on some protocols it may not be possible to indicate to the peer that you would like to receive media, so a send-only stream will be created initially. In the cases where the stream requires remote agreement (eg you wish to receive media from them), the <tp:member-ref>StreamDirectionChanged</tp:member-ref> signal will be emitted with the MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again with the flag cleared when the remote end has replied.

If streams of the requested types have already been requested via this method or <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.Type.StreamedMedia">FUTURE.InitialAudio</tp:dbus-ref>/<tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.Type.StreamedMedia">FUTURE.InitialVideo</tp:dbus-ref>, this method SHOULD return successfully.

Parameters:
contactHandle A contact handle with whom to establish the streams
types An array of stream types (values of MediaStreamType)
Returns:
An array of structs (in the same order as the given stream types) containing:
  • the stream identifier
  • the contact handle who the stream is with (or 0 if the stream represents more than a single member)
  • the type of the stream
  • the current stream state
  • the current direction of the stream
  • the current pending send flags

References Telepathy::Client::AbstractInterface::invalidationMessage(), and Telepathy::Client::AbstractInterface::invalidationReason().

static const char* Telepathy::Client::ChannelTypeStreamedMediaInterface::staticInterfaceName (  )  [inline, static]

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

Returns:
The D-Bus interface name.

Referenced by TpPrototype::StreamedMediaChannel::requestChannel().

void Telepathy::Client::ChannelTypeStreamedMediaInterface::StreamAdded ( uint  streamID,
uint  contactHandle,
uint  streamType 
) [signal]

Represents the signal "StreamAdded" on the remote object.

Emitted when a new stream has been added to this channel.

Parameters:
streamID The stream identifier (as defined in ListStreams)
contactHandle The contact handle who the stream is with (or 0 if it represents more than a single member)
streamType The stream type (a value from MediaStreamType)

void Telepathy::Client::ChannelTypeStreamedMediaInterface::StreamDirectionChanged ( uint  streamID,
uint  streamDirection,
uint  pendingFlags 
) [signal]

Represents the signal "StreamDirectionChanged" on the remote object.

Emitted when the direction or pending flags of a stream are changed. If the MEDIA_STREAM_PENDING_LOCAL_SEND flag is set, the remote user has requested that we begin sending on this stream. RequestStreamDirection should be called to indicate whether or not this change is acceptable.

Parameters:
streamID The stream identifier (as defined in ListStreams)
streamDirection The new stream direction (as defined in ListStreams)
pendingFlags The new pending send flags (as defined in ListStreams)

void Telepathy::Client::ChannelTypeStreamedMediaInterface::StreamError ( uint  streamID,
uint  errorCode,
const QString &  message 
) [signal]

Represents the signal "StreamError" on the remote object.

Emitted when a stream encounters an error.

Parameters:
streamID The stream identifier (as defined in ListStreams)
errorCode A stream error number, one of the values of MediaStreamError
message A string describing the error (for debugging purposes only)

void Telepathy::Client::ChannelTypeStreamedMediaInterface::StreamRemoved ( uint  streamID  )  [signal]

Represents the signal "StreamRemoved" on the remote object.

Emitted when a stream has been removed from this channel.

Parameters:
streamID stream_id - the stream identifier (as defined in ListStreams)

void Telepathy::Client::ChannelTypeStreamedMediaInterface::StreamStateChanged ( uint  streamID,
uint  streamState 
) [signal]

Represents the signal "StreamStateChanged" on the remote object.

Emitted when a member's stream's state changes.

Parameters:
streamID The stream identifier (as defined in ListStreams)
streamState The new stream state (as defined in ListStreams)


Generated on Thu Mar 5 18:52:01 2009 for TelepathyQt4-0.1.1 by  doxygen 1.5.8