Tpy::CallStream Class Reference

The CallStream class provides an object representing a Telepathy Call.Stream. More...

#include <TelepathyQt4Yell/CallStream>

List of all members.

Signals

void localSendingStateChanged (Tpy::SendingState localSendingState)
void remoteSendingStateChanged (const QHash< Tp::ContactPtr, Tpy::SendingState > &remoteSendingStates)
void remoteMembersRemoved (const Tp::Contacts &remoteMembers)

Public Member Functions

~CallStream ()
CallContentPtr content () const
Tp::Contacts members () const
SendingState localSendingState () const
SendingState remoteSendingState (const Tp::ContactPtr &contact) const
Tp::PendingOperation * requestSending (bool send)
Tp::PendingOperation * requestReceiving (const Tp::ContactPtr &contact, bool receive)

Detailed Description

The CallStream class provides an object representing a Telepathy Call.Stream.

Instances of this class cannot be constructed directly; the only way to get one is via CallContent.

See async_model

Constructor & Destructor Documentation

Tpy::CallStream::~CallStream ( )

Class destructor.

Member Function Documentation

CallContentPtr Tpy::CallStream::content ( ) const

Return the channel owning this media stream.

Returns:: The channel owning this media stream.

Tp::Contacts Tpy::CallStream::members ( ) const

Return the contacts whose the media stream is with.

Deprecated:: Use contact() instead.

Returns:: The contacts whose the media stream is with.

See also:: membersRemoved()

SendingState Tpy::CallStream::localSendingState ( ) const

Return the media stream local sending state.

Returns:: The media stream local sending state.

See also:: localSendingStateChanged()

SendingState Tpy::CallStream::remoteSendingState ( const Tp::ContactPtr & contact ) const

Return the media stream remote sending state for a given contact.

Deprecated:: Use remoteSendingState() instead.

Returns:: The media stream remote sending state for a contact.

See also:: remoteSendingStateChanged()

Tp::PendingOperation * Tpy::CallStream::requestSending ( bool send )

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

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

See also:: localSendingStateChanged()

Tp::PendingOperation * Tpy::CallStream::requestReceiving	(	const Tp::ContactPtr &	contact,
		bool	receive
	)

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

Deprecated:: Use requestReceiving(bool receive) instead.

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

See also:: remoteSendingStateChanged()

void Tpy::CallStream::localSendingStateChanged ( Tpy::SendingState localSendingState ) [signal]

This signal is emitted when the local sending state of this media stream changes.

Parameters:

localSendingState

The new local sending state of this media stream.

See also:: localSendingState()

void Tpy::CallStream::remoteSendingStateChanged ( const QHash< Tp::ContactPtr, Tpy::SendingState > & remoteSendingStates ) [signal]

This signal is emitted when any remote sending state of this media stream changes.

Parameters:

remoteSendingStates

The new remote sending states of this media stream.

See also:: remoteSendingState()

void Tpy::CallStream::remoteMembersRemoved ( const Tp::Contacts & members ) [signal]

This signal is emitted when one or more members of this stream are removed.

Parameters:

members

The members that were removed from this media stream.

See also:: members()