Home · Modules · All Classes · All Namespaces |
The StreamedMediaStream class represents a Telepathy streamed media stream. More...
#include <TelepathyQt/StreamedMediaStream>
Inherits Tp::Object, and Tp::ReadyObject.
Public Types | |
enum | SendingState { SendingStateNone, SendingStatePendingSend, SendingStateSending } |
Signals | |
void | localSendingStateChanged (Tp::StreamedMediaStream::SendingState localSendingState) |
void | remoteSendingStateChanged (Tp::StreamedMediaStream::SendingState remoteSendingState) |
Signals inherited from Tp::Object | |
void | propertyChanged (const QString &propertyName) |
Public Member Functions | |
~StreamedMediaStream () | |
StreamedMediaChannelPtr | channel () const |
uint | id () const |
ContactPtr | contact () const |
MediaStreamState | state () const |
MediaStreamType | type () const |
SendingState | localSendingState () const |
SendingState | remoteSendingState () const |
bool | sending () const |
bool | receiving () const |
bool | localSendingRequested () const |
bool | remoteSendingRequested () const |
MediaStreamDirection | direction () const |
MediaStreamPendingSend | pendingSend () const |
PendingOperation * | requestSending (bool send) |
PendingOperation * | requestReceiving (bool receive) |
PendingOperation * | requestDirection (MediaStreamDirection direction) |
PendingOperation * | requestDirection (bool send, bool receive) |
PendingOperation * | startDTMFTone (DTMFEvent event) |
PendingOperation * | stopDTMFTone () |
Public Member Functions inherited from Tp::Object | |
virtual | ~Object () |
Public Member Functions inherited from Tp::RefCounted | |
RefCounted () | |
virtual | ~RefCounted () |
Additional Inherited Members | |
Protected Member Functions inherited from Tp::Object | |
Object () | |
void | notify (const char *propertyName) |
The StreamedMediaStream class represents a Telepathy streamed media stream.
Instances of this class cannot be constructed directly; the only way to get one is via StreamedMediaChannel.
Tp::StreamedMediaStream::~StreamedMediaStream | ( | ) |
Class destructor.
StreamedMediaChannelPtr Tp::StreamedMediaStream::channel | ( | ) | const |
Return the channel owning this media stream.
uint Tp::StreamedMediaStream::id | ( | ) | const |
Return the id of this media stream.
ContactPtr Tp::StreamedMediaStream::contact | ( | ) | const |
Return the contact who this media stream is with.
MediaStreamState Tp::StreamedMediaStream::state | ( | ) | const |
Return the state of this media stream.
MediaStreamType Tp::StreamedMediaStream::type | ( | ) | const |
Return the type of this media stream.
StreamedMediaStream::SendingState Tp::StreamedMediaStream::localSendingState | ( | ) | const |
Return the media stream local sending state.
StreamedMediaStream::SendingState Tp::StreamedMediaStream::remoteSendingState | ( | ) | const |
Return the media stream remote sending state.
bool Tp::StreamedMediaStream::sending | ( | ) | const |
Return whether media is being sent on this media stream.
true
if media is being sent, false
otherwise. bool Tp::StreamedMediaStream::receiving | ( | ) | const |
Return whether media is being received on this media stream.
true
if media is being received, false
otherwise. bool Tp::StreamedMediaStream::localSendingRequested | ( | ) | const |
Return whether the local user has been asked to send media by the remote user on this media stream.
true
if the local user has been asked to send media by the remote user, false
otherwise. bool Tp::StreamedMediaStream::remoteSendingRequested | ( | ) | const |
Return whether the remote user has been asked to send media by the local user on this media stream.
true
if the remote user has been asked to send media by the local user, false
otherwise. MediaStreamDirection Tp::StreamedMediaStream::direction | ( | ) | const |
Return the direction of this media stream.
MediaStreamPendingSend Tp::StreamedMediaStream::pendingSend | ( | ) | const |
Return the pending send flags of this media stream.
PendingOperation * Tp::StreamedMediaStream::requestSending | ( | bool | send | ) |
Request that media starts or stops being sent on this media stream.
PendingOperation * Tp::StreamedMediaStream::requestReceiving | ( | bool | receive | ) |
Request that the remote contact stops or starts sending on this media stream.
PendingOperation * Tp::StreamedMediaStream::requestDirection | ( | MediaStreamDirection | direction | ) |
Request a change in the direction of this media 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.
direction | The new direction. |
PendingOperation * Tp::StreamedMediaStream::requestDirection | ( | bool | send, |
bool | receive | ||
) |
Request a change in the direction of this media 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.
PendingOperation * Tp::StreamedMediaStream::startDTMFTone | ( | DTMFEvent | event | ) |
Start sending a DTMF tone on this media 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 TP_QT_ERROR_NOT_AVAILABLE.
If the channel() does not support the TP_QT_IFACE_CHANNEL_INTERFACE_DTMF interface, the resulting PendingOperation will fail with error code TP_QT_ERROR_NOT_IMPLEMENTED.
event | A numeric event code from the DTMFEvent enum. |
PendingOperation * Tp::StreamedMediaStream::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 media stream, the resulting PendingOperation will fail with error code TP_QT_ERROR_NOT_AVAILABLE.
If the channel() does not support the TP_QT_IFACE_CHANNEL_INTERFACE_DTMF interface, the resulting PendingOperation will fail with error code TP_QT_ERROR_NOT_IMPLEMENTED.
|
signal |
Emitted when the local sending state of this media stream changes.
localSendingState | The new local sending state of this media stream. |
|
signal |
TelepathyQt 0.9.8 | Generated by 1.8.15 |