QXmpp  Version:1.3.0
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 <QXmppCall.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 addVideo ()
 Starts 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 streamCreated (QXmppCallStream *stream)
 This signal is emitted when a stream is created.
 
- 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
 
GstElement * pipeline () const
 
QXmppCallStreamaudioStream () const
 
QXmppCallStreamvideoStream () const
 
- Public Member Functions inherited from QXmppLoggable
 QXmppLoggable (QObject *parent=nullptr)
 

Properties

Direction direction
 
QString jid
 
State state
 

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.

Note
THIS API IS NOT FINALIZED YET

Member Enumeration Documentation

◆ Direction

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

Enumerator
IncomingDirection 

The call is incoming.

OutgoingDirection 

The call is outgoing.

◆ State

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

◆ accept

void QXmppCall::accept ( )
slot

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

◆ audioStream()

QXmppCallStream * QXmppCall::audioStream ( ) const

Returns the RTP stream for the audio data.

Since
QXmpp 1.3

◆ connected

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

◆ finished

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

◆ hangup

void QXmppCall::hangup ( )
slot

Hangs up the call.

◆ pipeline()

GstElement * QXmppCall::pipeline ( ) const

Returns the GStreamer pipeline.

Since
QXmpp 1.3

◆ sid()

QString QXmppCall::sid ( ) const

Returns the call's session identifier.

◆ videoStream()

QXmppCallStream * QXmppCall::videoStream ( ) const

Returns the RTP stream for the video data.

Since
QXmpp 1.3

Property Documentation

◆ direction

QXmppCall::Direction QXmppCall::direction
read

Returns the call's direction.

◆ jid

QString QXmppCall::jid
read

Returns the remote party's JID.

◆ state

QXmppCall::State QXmppCall::state
read

Returns the call's state.

See also
stateChanged()

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