Tpy::CallChannel Class Reference

The CallChannel class provides an object representing a Telepathy channel of type Call. More...

#include <TelepathyQt4Yell/CallChannel>

List of all members.

Signals

• void contentAdded (const Tpy::CallContentPtr &content)
• void contentRemoved (const Tpy::CallContentPtr &content)
• void stateChanged (Tpy::CallState state)
• void localHoldStateChanged (Tp::LocalHoldState state, Tp::LocalHoldStateReason reason)

Public Member Functions

• virtual ~CallChannel ()
• CallState state () const
• CallFlags flags () const
• CallStateReason stateReason () const
• QVariantMap stateDetails () const
• bool handlerStreamingRequired () const
• StreamTransportType initialTransportType () const
• bool hasInitialAudio () const
• bool hasInitialVideo () const
• QString initialAudioName () const
• QString initialVideoName () const
• bool hasMutableContents () const
• Tp::PendingOperation * accept ()
• Tp::PendingOperation * hangup (CallStateChangeReason reason, const QString &detailedReason, const QString &message)
• CallContents contents () const
• CallContents contentsForType (Tp::MediaStreamType type) const
• PendingCallContent * requestContent (const QString &name, Tp::MediaStreamType type)
• Tp::PendingOperation * removeContent (const CallContentPtr &content, ContentRemovalReason reason, const QString &detailedReason, const QString &message)
• Tp::LocalHoldState localHoldState () const
• Tp::LocalHoldStateReason localHoldStateReason () const
• Tp::PendingOperation * requestHold (bool hold)

Static Public Member Functions

• static CallChannelPtr create (const Tp::ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties)

Static Public Attributes

• static const Tp::Feature FeatureContents
• static const Tp::Feature FeatureLocalHoldState

Protected Member Functions

• CallChannel (const Tp::ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties, const Tp::Feature &coreFeature=Tp::Channel::FeatureCore)

---

Detailed Description

The CallChannel class provides an object representing a Telepathy channel of type Call.

---

Constructor & Destructor Documentation

Tpy::CallChannel::~CallChannel

(

)

[virtual]

Class destructor.

Tpy::CallChannel::CallChannel	(	const Tp::ConnectionPtr &	connection,
		const QString &	objectPath,
		const QVariantMap &	immutableProperties,
		const Tp::Feature &	coreFeature = Tp::Channel::FeatureCore
	)			[protected]

Construct a new CallChannel associated with the given object on the same service as the given connection.

Parameters:

	connection	Connection owning this channel, and specifying the service.
	objectPath	The object path of this channel.
	immutableProperties	The immutable properties of this channel.
	coreFeature	The core feature of the channel type. The corresponding introspectable should depend on Channel::FeatureCore.

---

Member Function Documentation

CallChannelPtr Tpy::CallChannel::create	(	const Tp::ConnectionPtr &	connection,
		const QString &	objectPath,
		const QVariantMap &	immutableProperties
	)			[static]

Create a new CallChannel object.

Parameters:

	connection	Connection owning this channel, and specifying the service.
	objectPath	The object path of this channel.
	immutableProperties	The immutable properties of this channel.

Returns:

A CallChannelPtr object pointing to the newly created CallChannel object.

CallState Tpy::CallChannel::state

(

)

const

Return the current state of this call.

Returns:

The current state of this call.

See also:

stateChanged()

CallFlags Tpy::CallChannel::flags

(

)

const

Return the flags representing the status of this call as a whole, providing more specific information than state().

Returns:

The flags representing the status of this call.

See also:

stateChanged()

CallStateReason Tpy::CallChannel::stateReason

(

)

const

Return the reason for the last change to the state() and/or flags().

Returns:

The reason for the last change to the state() and/or flags().

See also:

stateChanged()

QVariantMap Tpy::CallChannel::stateDetails

(

)

const

Return optional extensible details for the state(), flags() and/or stateReason().

Returns:

The optional extensible details for the state(), flags() and/or stateReason().

See also:

stateChanged()

bool Tpy::CallChannel::handlerStreamingRequired

(

)

const

Check whether media streaming by the handler is required for this channel.

If false, all of the media streaming is done by some mechanism outside the scope of Telepathy, otherwise the handler is responsible for doing the actual media streaming.

Returns:

true if required, false otherwise.

StreamTransportType Tpy::CallChannel::initialTransportType

(

)

const

Return the initial transport type used for this call if set on a requested channel.

Where not applicable, this property is defined to be StreamTransportTypeUnknown, in particular, on CMs with hardware streaming.

Returns:

The initial transport type used for this call.

bool Tpy::CallChannel::hasInitialAudio

(

)

const

Return whether an audio content has already been requested.

Returns:

true if an audio content has already been requested, false otherwise.

bool Tpy::CallChannel::hasInitialVideo

(

)

const

Return whether a video content has already been requested.

Returns:

true if an video content has already been requested, false otherwise.

QString Tpy::CallChannel::initialAudioName

(

)

const

Return the name of the initial audio content if hasInitialAudio() returns true.

Returns:

The name of the initial audio content.

QString Tpy::CallChannel::initialVideoName

(

)

const

Return the name of the initial video content if hasInitialVideo() returns true.

Returns:

The name of the initial video content.

bool Tpy::CallChannel::hasMutableContents

(

)

const

Return whether a stream of a different content type can be added after the Channel has been requested.

Returns:

true if a stream of different content type can be added after the Channel has been requested, false otherwise.

Tp::PendingOperation * Tpy::CallChannel::accept

(

)

Accept an incoming call.

Returns:

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

Tp::PendingOperation * Tpy::CallChannel::hangup	(	CallStateChangeReason	reason,
		const QString &	detailedReason,
		const QString &	message
	)

Request that the call is ended.

Deprecated:

Use hangupCall() instead.

Parameters:

	reason	A generic hangup reason.
	detailedReason	A more specific reason for the call hangup, if one is available, or an empty string otherwise.
	message	A human-readable message to be sent to the remote contact(s).

Returns:

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

CallContents Tpy::CallChannel::contents

(

)

const

Return a list of media contents in this channel.

This methods requires CallChannel::FeatureContents to be enabled.

Returns:

The contents in this channel.

See also:

contentAdded(), contentRemoved(), contentsForType(), requestContent()

CallContents Tpy::CallChannel::contentsForType

(

Tp::MediaStreamType

type

)

const

Return a list of media contents in this channel for the given type type.

This methods requires CallChannel::FeatureContents to be enabled.

Parameters:

type

The interested type.

Returns:

A list of media contents in this channel for the given type type.

See also:

contentAdded(), contentRemoved(), contents(), requestContent()

PendingCallContent * Tpy::CallChannel::requestContent	(	const QString &	name,
		Tp::MediaStreamType	type
	)

Request that media content be established to exchange the given type type of media.

This methods requires CallChannel::FeatureContents to be enabled.

Returns:

A PendingCallContent which will emit PendingCallContent::finished when the call has finished.

See also:

contentAdded(), contents(), contentsForType()

Tp::PendingOperation * Tpy::CallChannel::removeContent	(	const CallContentPtr &	content,
		ContentRemovalReason	reason,
		const QString &	detailedReason,
		const QString &	message
	)

Remove the content.

Parameters:

	content	The content to remove.
	reason	A removal reason.
	detailedReason	A more specific reason for the removal, if one is available, or an empty string.
	message	A human-readable message for the reason for the removal, such as "Fatal streaming failure" or "no codec intersection". This property can be left empty if no reason is to be given.

Tp::LocalHoldState Tpy::CallChannel::localHoldState

(

)

const

Return whether the local user has placed this channel on hold.

This method requires CallChannel::FeatureHoldState to be enabled.

Returns:

The channel local hold state.

See also:

requestHold(), localHoldStateChanged()

Tp::LocalHoldStateReason Tpy::CallChannel::localHoldStateReason

(

)

const

Return the reason why localHoldState() changed to its current value.

This method requires CallChannel::FeatureLocalHoldState to be enabled.

Returns:

The channel local hold state reason.

See also:

requestHold(), localHoldStateChanged()

Tp::PendingOperation * Tpy::CallChannel::requestHold

(

bool

hold

)

Request that the channel be put on hold (be instructed not to send any media streams to you) or be taken off hold.

If the connection manager can immediately tell that the requested state change could not possibly succeed, the resulting PendingOperation will fail with error code TP_QT4_YELL_ERROR_NOT_AVAILABLE. If the requested state is the same as the current state, the resulting PendingOperation will finish successfully.

Otherwise, the channel's local hold state will change to Tp::LocalHoldStatePendingHold or Tp::LocalHoldStatePendingUnhold (as appropriate), then the resulting PendingOperation will finish successfully.

The eventual success or failure of the request is indicated by a subsequent localHoldStateChanged() signal, changing the local hold state to Tp::LocalHoldStateHeld or Tp::LocalHoldStateUnheld.

If the channel has multiple streams, and the connection manager succeeds in changing the hold state of one stream but fails to change the hold state of another, it will attempt to revert all streams to their previous hold states.

If the channel does not support the TP_QT4_IFACE_CHANNEL_INTERFACE_HOLD interface, the PendingOperation will fail with error code TP_QT4_YELL_ERROR_NOT_IMPLEMENTED.

Parameters:

hold

A boolean indicating whether or not the channel should be on hold

Returns:

A PendingOperation, which will emit PendingOperation::finished when the request finishes.

See also:

localHoldState(), localHoldStateReason(), localHoldStateChanged()

void Tpy::CallChannel::contentAdded

(

const Tpy::CallContentPtr &

content

)

[signal]

This signal is emitted when a media content is added to this channel.

Parameters:

content

The media content that was added.

See also:

contents(), contentsForType()

void Tpy::CallChannel::contentRemoved

(

const Tpy::CallContentPtr &

content

)

[signal]

This signal is emitted when a media content is removed from this channel.

Parameters:

content

The media content that was removed.

See also:

contents(), contentsForType()

void Tpy::CallChannel::stateChanged

(

Tpy::CallState

state

)

[signal]

void Tpy::CallChannel::localHoldStateChanged	(	Tp::LocalHoldState	state,
		Tp::LocalHoldStateReason	reason
	)			[signal]

This signal is emitted when the local hold state of this channel changes.

Parameters:

	state	The new local hold state of this channel.
	reason	The reason why the change occurred.

See also:

localHoldState(), localHoldStateReason()

---

Member Data Documentation

const Tp::Feature Tpy::CallChannel::FeatureContents [static]

Feature used in order to access content specific methods.

See media content specific methods' documentation for more details.

const Tp::Feature Tpy::CallChannel::FeatureLocalHoldState [static]

Feature used in order to access local hold state info.

See local hold state specific methods' documentation for more details.