/* * Ekiga -- A VoIP and Video-Conferencing application * Copyright (C) 2000-2009 Damien Sandras * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or (at * your option) any later version. This program is distributed in the hope * that it will be useful, but WITHOUT ANY WARRANTY; without even the * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. * * Ekiga is licensed under the GPL license and as a special exception, you * have permission to link or otherwise combine this program with the * programs OPAL, OpenH323 and PWLIB, and distribute the combination, without * applying the requirements of the GNU GPL to the OPAL, OpenH323 and PWLIB * programs, as long as you do follow the requirements of the GNU GPL for all * the rest of the software thus combined. */ /* * call.h - description * ------------------------------------------ * begin : written in 2007 by Damien Sandras * copyright : (c) 2007 by Damien Sandras * description : declaration of the interface of a call handled by * the Ekiga::CallManager. * */ #ifndef __CALL_H__ #define __CALL_H__ #include #include #include "gmref.h" namespace Ekiga { /** * @addtogroup calls * @{ */ /* * Everything is handled asynchronously and signaled through the * Ekiga::CallManager */ class Call : public virtual GmRefCounted { public: Call () { } virtual ~Call () { }; enum StreamType { Audio, Video }; /* * Call Management */ /** Hangup the call */ virtual void hangup () = 0; /** Answer an incoming call */ virtual void answer () = 0; /** Transfer the call to the specified uri * @param uri is the uri where to transfer the call */ virtual void transfer (std::string uri) = 0; /** Put the call on hold or retrieve it */ virtual void toggle_hold () = 0; /** Toggle the stream transmission (if any) * @param the stream type */ virtual void toggle_stream_pause (StreamType type) = 0; /** Send the given DTMF * @param dtmf is the dtmf to send (one char) */ virtual void send_dtmf (const char dtmf) = 0; /** Reject an incoming call after the given delay * @param delay the delay after which reject the call */ virtual void set_reject_delay (unsigned delay) = 0; /* * Call Information */ /** Return the call id * @return: the call id */ virtual const std::string get_id () const = 0; /** Return the local party name * @return: the local party name */ virtual const std::string get_local_party_name () const = 0; /** Return the remote party name * @return: the remote party name */ virtual const std::string get_remote_party_name () const = 0; /** Return the remote application * @return: the remote application */ virtual const std::string get_remote_application () const = 0; /** Return the remote callback uri * @return: the remote uri */ virtual const std::string get_remote_uri () const = 0; /** Return the call duration * @return the current call duration */ virtual const std::string get_duration () const = 0; /** Return the call start date and time * @return the current call start date and time */ virtual time_t get_start_time () const = 0; /** Return information about call type * @return true if it is an outgoing call */ virtual bool is_outgoing () const = 0; /** Return the received audio bandwidth * @return the received audio bandwidth in kbytes/s */ virtual double get_received_audio_bandwidth () const = 0; /** Return the transmitted audio bandwidth * @return the transmitted audio bandwidth in kbytes/s */ virtual double get_transmitted_audio_bandwidth () const = 0; /** Return the received video bandwidth * @return the received video bandwidth in kbytes/s */ virtual double get_received_video_bandwidth () const = 0; /** Return the transmitted video bandwidth * @return the transmitted video bandwidth in kbytes/s */ virtual double get_transmitted_video_bandwidth () const = 0; /** Return the jitter size * @return the jitter size in ms */ virtual unsigned get_jitter_size () const = 0; /** Return the lost packets information * @return the lost packets percentage */ virtual double get_lost_packets () const = 0; /** Return the late packets information * @return the late packets percentage */ virtual double get_late_packets () const = 0; /** Return the out of order packets information * @return the out of order packets percentage */ virtual double get_out_of_order_packets () const = 0; /* * Signals */ /* Signal emitted when the call is established */ sigc::signal0 established; /* Signal emitted when an established call is cleared * @param: a string describing why the call was cleared */ sigc::signal1 cleared; /* Signal emitted when the call is missed, ie cleared * without having been established */ sigc::signal0 missed; /* Signal emitted when the call is forwarded */ sigc::signal0 forwarded; /* Signal emitted when the call is held */ sigc::signal0 held; /* Signal emitted when the call is retrieved */ sigc::signal0 retrieved; /* Signal emitted when the call is being setup */ sigc::signal0 setup; /* Signal emitted when the remote party is ringing */ sigc::signal0 ringing; /* Signal emitted when a stream is opened * @param the stream name * @param the stream type * @param transmission or reception */ sigc::signal3 stream_opened; /* Signal emitted when a stream is closed * @param the stream name * @param the stream type * @param transmission or reception */ sigc::signal3 stream_closed; /* Signal emitted when a transmitted stream is paused * @param the stream name * @param the stream type * @param transmission or reception */ sigc::signal2 stream_paused; /* Signal emitted when a transmitted stream is resumed * @param the stream name * @param the stream type * @param transmission or reception */ sigc::signal2 stream_resumed; /** This signal is emitted when the Call is removed. */ sigc::signal0 removed; }; /** * @} */ }; #endif