From 93adc6aec9ba4671884d9692308b239d3064e553 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Sat, 21 Aug 2010 19:15:30 +0000 Subject: add doc html --- doc/html/classQXmppCall.html | 352 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 352 insertions(+) create mode 100644 doc/html/classQXmppCall.html (limited to 'doc/html/classQXmppCall.html') diff --git a/doc/html/classQXmppCall.html b/doc/html/classQXmppCall.html new file mode 100644 index 00000000..4c508871 --- /dev/null +++ b/doc/html/classQXmppCall.html @@ -0,0 +1,352 @@ + + + + + +QXmpp: QXmppCall Class Reference + + + + + + + + + +
+

QXmppCall Class Reference

+

The QXmppCall class represents a Voice-Over-IP call to a remote party. +More...

+ +

#include <QXmppCallManager.h>

+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types

enum  Direction { IncomingDirection, +OutgoingDirection + }
 

This enum is used to describe the direction of a call.

+ More...
enum  State {
+  OfferState = 0, +ConnectingState = 1, +ActiveState = 2, +DisconnectingState = 3, +
+  FinishedState = 4 +
+ }
 

This enum is used to describe the state of a call.

+ More...

Public Slots

void accept ()
void hangup ()

Signals

void connected ()
void finished ()
+void ringing ()
 This signal is emitted when the remote party is ringing.
+void logMessage (QXmppLogger::MessageType type, const QString &msg)
 This signal is emitted to send logging messages.
+void stateChanged (QXmppCall::State state)
 This signal is emitted when the call state changes.

Public Member Functions

QXmppCall::Direction direction () const
QString jid () const
QString sid () const
QXmppCall::State state () const
QXmppJinglePayloadType payloadType () const

Friends

+class QXmppCallManager
+

Detailed Description

+

The QXmppCall class represents a Voice-Over-IP call to a remote party.

+

It acts as a QIODevice so that you can read / write audio samples, for instance using a QAudioOutput and a QAudioInput.

+
Note:
THIS API IS NOT FINALIZED YET
+

Member Enumeration Documentation

+ +
+
+ + + + +
enum QXmppCall::Direction
+
+
+ +

This enum is used to describe the direction of a call.

+
Enumerator:
+ + +
IncomingDirection  +

The call is incoming.

+
OutgoingDirection  +

The call is outgoing.

+
+
+
+ +
+
+ +
+
+ + + + +
enum QXmppCall::State
+
+
+ +

This enum is used to describe the state of a call.

+
Enumerator:
+ + + + + +
OfferState  +

The remote part is being called.

+
ConnectingState  +

The call is being connected.

+
ActiveState  +

The call is active.

+
DisconnectingState  +

The call is being disconnected.

+
FinishedState  +

The call is finished.

+
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
void QXmppCall::accept ( )  [slot]
+
+
+

Call this method if you wish to accept an incoming call.

+ +
+
+ +
+
+ + + + + + + + +
void QXmppCall::connected ( )  [signal]
+
+
+

This signal is emitted when a call is connected.

+

Once this signal is emitted, you can connect a QAudioOutput and QAudioInput to the call. You can determine the appropriate clockrate and the number of channels by calling payloadType().

+ +
+
+ +
+
+ + + + + + + + +
QXmppCall::Direction QXmppCall::direction ( )  const
+
+
+

Returns the call's direction.

+ +
+
+ +
+
+ + + + + + + + +
void QXmppCall::finished ( )  [signal]
+
+
+

This signal is emitted when a call is finished.

+

Note: Do not delete the call in the slot connected to this signal, instead use deleteLater().

+ +
+
+ +
+
+ + + + + + + + +
void QXmppCall::hangup ( )  [slot]
+
+
+

Hangs up the call.

+ +
+
+ +
+
+ + + + + + + + +
QString QXmppCall::jid ( )  const
+
+
+

Returns the remote party's JID.

+ +
+
+ +
+
+ + + + + + + + +
QXmppJinglePayloadType QXmppCall::payloadType ( )  const
+
+
+

Returns the negociated payload type.

+

You can use this to determine the QAudioFormat to use with your QAudioInput/QAudioOutput.

+ +
+
+ +
+
+ + + + + + + + +
QString QXmppCall::sid ( )  const
+
+
+

Returns the call's session identifier.

+ +
+
+ +
+
+ + + + + + + + +
QXmppCall::State QXmppCall::state ( )  const
+
+
+

Returns the call's state.

+
See also:
stateChanged()
+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Classes Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on Sun Aug 22 00:44:23 2010 for QXmpp by  + +doxygen 1.6.1
+ + -- cgit v1.2.3