Telepathy::Client::MediaStream Class Reference

#include <TelepathyQt4/Client/streamed-media-channel.h>

Inheritance diagram for Telepathy::Client::MediaStream:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ~MediaStream ()
StreamedMediaChannelchannel () const
uint id () const
ContactPtr contact () const
Telepathy::MediaStreamState state () const
Telepathy::MediaStreamType type () const
bool sending () const
bool receiving () const
bool localSendingRequested () const
bool remoteSendingRequested () const
Telepathy::MediaStreamDirection direction () const
Telepathy::MediaStreamPendingSend pendingSend () const
PendingOperationrequestDirection (Telepathy::MediaStreamDirection direction)
PendingOperationrequestDirection (bool send, bool receive)

Friends

class PendingMediaStreams
class StreamedMediaChannel
struct Private


Constructor & Destructor Documentation

Telepathy::Client::MediaStream::~MediaStream (  ) 


Member Function Documentation

StreamedMediaChannel * Telepathy::Client::MediaStream::channel (  )  const

ContactPtr Telepathy::Client::MediaStream::contact (  )  const

Return the contact who the stream is with.

Returns:
The contact who the stream is with.

Telepathy::MediaStreamDirection Telepathy::Client::MediaStream::direction (  )  const

Return the stream direction.

Returns:
The stream direction.

uint Telepathy::Client::MediaStream::id (  )  const

Return the stream id.

Returns:
An integer representing the stream id.

bool Telepathy::Client::MediaStream::localSendingRequested (  )  const

Return whether the local user has been asked to send media by the remote user.

Returns:
A boolean indicating whether the local user has been asked to send media by the remote user.

References Telepathy::MediaStreamPendingLocalSend.

Telepathy::MediaStreamPendingSend Telepathy::Client::MediaStream::pendingSend (  )  const

Return the stream pending send flags.

Returns:
The stream pending send flags.

bool Telepathy::Client::MediaStream::receiving (  )  const

Return whether media is being received on this stream.

Returns:
A boolean indicating whether media is being received on this stream.

References Telepathy::MediaStreamDirectionReceive.

bool Telepathy::Client::MediaStream::remoteSendingRequested (  )  const

Return whether the remote user has been asked to send media by the local user.

Returns:
A boolean indicating whether the remote user has been asked to send media by the local user.

References Telepathy::MediaStreamPendingRemoteSend.

PendingOperation * Telepathy::Client::MediaStream::requestDirection ( bool  send,
bool  receive 
)

Request a change in the direction of this 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.

Returns:
A PendingOperation which will emit PendingOperation::finished when the call has finished.
See also:
requestDirection(Telepathy::MediaStreamDirection direction)

References Telepathy::MediaStreamDirectionNone, Telepathy::MediaStreamDirectionReceive, Telepathy::MediaStreamDirectionSend, and requestDirection().

PendingOperation * Telepathy::Client::MediaStream::requestDirection ( Telepathy::MediaStreamDirection  direction  ) 

Request a change in the direction of this 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.

Returns:
A PendingOperation which will emit PendingOperation::finished when the call has finished.

Referenced by requestDirection().

bool Telepathy::Client::MediaStream::sending (  )  const

Return whether media is being sent on this stream.

Returns:
A boolean indicating whether media is being sent on this stream.

References Telepathy::MediaStreamDirectionSend.

Telepathy::MediaStreamState Telepathy::Client::MediaStream::state (  )  const

Return the stream state.

Returns:
The stream state.

Telepathy::MediaStreamType Telepathy::Client::MediaStream::type (  )  const

Return the stream type.

Returns:
The stream type.


Friends And Related Function Documentation

friend class PendingMediaStreams [friend]

friend struct Private [friend]

Reimplemented from Telepathy::Client::ReadyObject.

friend class StreamedMediaChannel [friend]


Generated on Mon Mar 23 18:02:37 2009 for TelepathyQt4-0.1.2 by  doxygen 1.5.8