Home · All Classes · All Namespaces · Modules · Functions · Files

Tp::MediaStream Class Reference

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

Inherits Tp::ReadyObject, and Tp::RefCounted.

List of all members.

Public Types

Signals

Public Member Functions


Member Enumeration Documentation

Enumerator:
SendingStateNone 
SendingStatePendingSend 
SendingStateSending 

Constructor & Destructor Documentation

Tp::MediaStream::~MediaStream (  ) 

Member Function Documentation

MediaContentPtr Tp::MediaStream::content (  )  const
StreamedMediaChannelPtr Tp::MediaStream::channel (  )  const
uint Tp::MediaStream::id (  )  const

Return the stream id.

Returns:
An integer representing the stream id.
Contacts Tp::MediaStream::members (  )  const

Return the contacts whose the stream is with.

Returns:
The contacts whose the stream is with.
ContactPtr Tp::MediaStream::contact (  )  const

Return the contact who the stream is with.

Returns:
The contact who the stream is with.
MediaStreamState Tp::MediaStream::state (  )  const

Return the stream state.

Returns:
The stream state.
MediaStreamType Tp::MediaStream::type (  )  const

Return the stream type.

Returns:
The stream type.
MediaStream::SendingState Tp::MediaStream::localSendingState (  )  const

Return the stream local sending state.

Returns:
The stream local sending state.
MediaStream::SendingState Tp::MediaStream::remoteSendingState ( const ContactPtr contact  )  const

Return the stream remote sending state for a given contact.

Returns:
The stream remote sending state for a contact.
bool Tp::MediaStream::sending (  )  const

Return whether media is being sent on this stream.

Returns:
A boolean indicating whether media is being sent on this stream.
bool Tp::MediaStream::receiving (  )  const

Return whether media is being received on this stream.

Returns:
A boolean indicating whether media is being received on this stream.
bool Tp::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.
bool Tp::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.
MediaStreamDirection Tp::MediaStream::direction (  )  const

Return the stream direction.

Returns:
The stream direction.
MediaStreamPendingSend Tp::MediaStream::pendingSend (  )  const

Return the stream pending send flags.

Returns:
The stream pending send flags.
PendingOperation * Tp::MediaStream::requestSending ( bool  send  ) 

Request that media starts or stops being sent on this stream.

Returns:
A PendingOperation which will emit PendingOperation::finished when the call has finished.
PendingOperation * Tp::MediaStream::requestReceiving ( const ContactPtr contact,
bool  receive 
)

Request that a remote contact stops or starts sending on this stream.

Returns:
A PendingOperation which will emit PendingOperation::finished when the call has finished.
PendingOperation * Tp::MediaStream::requestDirection ( 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.
PendingOperation * Tp::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(Tp::MediaStreamDirection direction)
PendingOperation * Tp::MediaStream::startDTMFTone ( DTMFEvent  event  ) 

Start sending a DTMF tone on this stream. Where possible, the tone will continue until stopDTMFTone() is called. On certain protocols, it may only be possible to send events with a predetermined length. In this case, the implementation may emit a fixed-length tone, and the stopDTMFTone() method call should return TELEPATHY_ERROR_NOT_AVAILABLE.

If the channel() does not support the TELEPATHY_INTERFACE_CHANNEL_INTERFACE_DTMF interface, the resulting PendingOperation will fail with error code TELEPATHY_ERROR_NOT_IMPLEMENTED.

Parameters:
event A numeric event code from the DTMFEvent enum.
Returns:
A PendingOperation which will emit PendingOperation::finished when the request finishes.
See also:
stopDTMFTone()
PendingOperation * Tp::MediaStream::stopDTMFTone (  ) 

Stop sending any DTMF tone which has been started using the startDTMFTone() method. If there is no current tone, the resulting PendingOperation will finish successfully.

If continuous tones are not supported by this stream, the resulting PendingOperation will fail with error code TELEPATHY_ERROR_NOT_AVAILABLE.

If the channel() does not support the TELEPATHY_INTERFACE_CHANNEL_INTERFACE_DTMF interface, the resulting PendingOperation will fail with error code TELEPATHY_ERROR_NOT_IMPLEMENTED.

Returns:
A PendingOperation which will emit PendingOperation::finished when the request finishes.
See also:
startDTMFTone()
void Tp::MediaStream::localSendingStateChanged ( Tp::MediaStream::SendingState  localSendingState  )  [signal]
void Tp::MediaStream::remoteSendingStateChanged ( const QHash< Tp::ContactPtr, Tp::MediaStream::SendingState > &  remoteSendingStates  )  [signal]
void Tp::MediaStream::membersRemoved ( const Tp::Contacts members  )  [signal]


Copyright © 2009 Collabora Ltd. and Nokia Corporation
Telepathy-Qt4 0.3.0