QXmpp  Version:0.9.1
Public Types | Public Slots | Signals | Public Member Functions | Properties | Friends | List of all members
QXmppCall Class Reference

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

#include <QXmppCallManager.h>

Inheritance diagram for QXmppCall:
Inheritance graph
[legend]
Collaboration diagram for QXmppCall:
Collaboration graph
[legend]

Public Types

enum  Direction { IncomingDirection, OutgoingDirection }
 This enum is used to describe the direction of a call. More...
 
enum  State { ConnectingState = 0, ActiveState = 1, DisconnectingState = 2, FinishedState = 3 }
 This enum is used to describe the state of a call. More...
 

Public Slots

void accept ()
 
void hangup ()
 
void startVideo ()
 Starts sending video to the remote party.
 
void stopVideo ()
 Stops sending video to the remote party.
 

Signals

void connected ()
 This signal is emitted when a call is connected. More...
 
void finished ()
 This signal is emitted when a call is finished. More...
 
void ringing ()
 This signal is emitted when the remote party is ringing.
 
void stateChanged (QXmppCall::State state)
 This signal is emitted when the call state changes.
 
void audioModeChanged (QIODevice::OpenMode mode)
 This signal is emitted when the audio channel changes.
 
void videoModeChanged (QIODevice::OpenMode mode)
 This signal is emitted when the video channel changes.
 
- Signals inherited from QXmppLoggable
void setGauge (const QString &gauge, double value)
 Sets the given gauge to value.
 
void logMessage (QXmppLogger::MessageType type, const QString &msg)
 This signal is emitted to send logging messages.
 
void updateCounter (const QString &counter, qint64 amount=1)
 Updates the given counter by amount.
 

Public Member Functions

QXmppCall::Direction direction () const
 
QString jid () const
 
QString sid () const
 
QXmppCall::State state () const
 
QXmppRtpAudioChannelaudioChannel () const
 
QIODevice::OpenMode audioMode () const
 
QXmppRtpVideoChannelvideoChannel () const
 
QIODevice::OpenMode videoMode () const
 
- Public Member Functions inherited from QXmppLoggable
 QXmppLoggable (QObject *parent=0)
 

Properties

Direction direction
 
QString jid
 
State state
 
QIODevice::OpenMode audioMode
 Returns the audio mode.
 
QIODevice::OpenMode videoMode
 Returns the video mode.
 

Friends

class QXmppCallManager
 
class QXmppCallManagerPrivate
 
class QXmppCallPrivate
 

Additional Inherited Members

- Protected Member Functions inherited from QXmppLoggable
void debug (const QString &message)
 
void info (const QString &message)
 
void warning (const QString &message)
 
void logReceived (const QString &message)
 
void logSent (const QString &message)
 

Detailed Description

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

To get the QIODevice from which you can read / write audio samples, call audioChannel().

Note
THIS API IS NOT FINALIZED YET

Member Enumeration Documentation

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

Enumerator
IncomingDirection 

The call is incoming.

OutgoingDirection 

The call is outgoing.

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

Enumerator
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.

QXmppRtpAudioChannel * QXmppCall::audioChannel ( ) const

Returns the RTP channel for the audio data.

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

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().

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::sid ( ) const

Returns the call's session identifier.

QXmppRtpVideoChannel * QXmppCall::videoChannel ( ) const

Returns the RTP channel for the video data.

Property Documentation

QXmppCall::Direction QXmppCall::direction
read

Returns the call's direction.

QString QXmppCall::jid
read

Returns the remote party's JID.

QXmppCall::State QXmppCall::state
read

Returns the call's state.

See also
stateChanged()

The documentation for this class was generated from the following files: