LeechCraft Azoth  0.6.70-15082-g543737046d
Modular multiprotocol IM plugin for LeechCraft
LC::Azoth::ISupportMediaCalls Class Referenceabstract

Interface for accounts supporting audio/video calls. More...

#include "isupportmediacalls.h"

Public Types

enum  MediaCallFeature { MCFNoFeatures, MCFSupportsAudioCalls = 0x01, MCFSupportsVideoCalls = 0x02 }
 Describes supported media call features. More...
 

Public Member Functions

virtual ~ISupportMediaCalls ()
 
virtual MediaCallFeatures GetMediaCallFeatures () const =0
 Returns the media features supported by this account. More...
 
virtual QObject * Call (const QString &id, const QString &variant)=0
 Tries to call a contact list entry. More...
 

Protected Member Functions

virtual void called (QObject *callObj)=0
 Emitted when a new call is established. More...
 

Detailed Description

Interface for accounts supporting audio/video calls.

This interface should be implemented by IAccount instances wishing to advertise the support for audio or video calls to the rest of Azoth.

See also
IAccount
IMediaCall

Definition at line 38 of file isupportmediacalls.h.

Member Enumeration Documentation

◆ MediaCallFeature

Describes supported media call features.

Enumerator
MCFNoFeatures 

No particular features.

MCFSupportsAudioCalls 

The account supports audio calls.

MCFSupportsVideoCalls 

The accounts supports video calls.

Definition at line 51 of file isupportmediacalls.h.

Constructor & Destructor Documentation

◆ ~ISupportMediaCalls()

virtual LC::Azoth::ISupportMediaCalls::~ISupportMediaCalls ( )
inlinevirtual

Definition at line 47 of file isupportmediacalls.h.

Member Function Documentation

◆ Call()

virtual QObject* LC::Azoth::ISupportMediaCalls::Call ( const QString &  id,
const QString &  variant 
)
pure virtual

Tries to call a contact list entry.

The entry is identified by its id, which is the ID returned by ICLEntry::GetEntryID().

If the corresponding protocol supports multiple variants per entry, the variant parameter specifies which variant (from the ones returned from ICLEntry::Variants()) of the entry should be called.

Returns either a IMediaCall object or a nullptr if the call initialization failed.

Note
If this method returns a valid IMediaCall object, it should also be advertised via the called() signal.
Parameters
[in]idThe ID of the entry to call (as in ICLEntry::GetEntryID()).
[in]variantThe variant of the entry to call to.
Returns
The call object implementing IMediaCall, or a nullptr if it is impossible to make the call.

◆ called()

virtual void LC::Azoth::ISupportMediaCalls::called ( QObject *  callObj)
protectedpure virtual

Emitted when a new call is established.

This signal should be emitted whenever a new call is established, either an incoming call or an outgoing call initiated via the Call() method.

Note
This function is expected to be a signal.
Parameters
[out]callObjThe object representing the call and implementing IMediaCall.

◆ GetMediaCallFeatures()

virtual MediaCallFeatures LC::Azoth::ISupportMediaCalls::GetMediaCallFeatures ( ) const
pure virtual

Returns the media features supported by this account.

Returns
The account media call features.

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