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

MediaStream Class Reference

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

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

List of all members.

Public Member Functions


Constructor & Destructor Documentation

~MediaStream (  ) 


Member Function Documentation

StreamedMediaChannelPtr channel (  )  const

uint id (  )  const

Return the stream id.

Returns:
An integer representing the stream id.

ContactPtr contact (  )  const

Return the contact who the stream is with.

Returns:
The contact who the stream is with.

MediaStreamState state (  )  const

Return the stream state.

Returns:
The stream state.

MediaStreamType type (  )  const

Return the stream type.

Returns:
The stream type.

bool sending (  )  const

Return whether media is being sent on this stream.

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

bool receiving (  )  const

Return whether media is being received on this stream.

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

bool 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 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 direction (  )  const

Return the stream direction.

Returns:
The stream direction.

MediaStreamPendingSend pendingSend (  )  const

Return the stream pending send flags.

Returns:
The stream pending send flags.

PendingOperation * 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 * 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 * 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 * 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()


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