dpyVoicecall Namespace Reference

Deepsy Voicecall namespace that includes the different enums, structs or method signatures that should be used.

Classes

struct  CallInformation
 Struct to keep information of a call. More...
 
class  ListObserver
 List Observer class. More...
 
struct  VoiceCallSourceInfo
 Defines the structure containing voice call source information. More...
 

Typedefs

typedef boost::function< void(boost::system::error_code, std::list< dpyVoicecall::VoiceCallSourceInfo > sourcesList)> call_sources_list_handler_function
 Prototype of the handler function for getting available call sources. More...
 
typedef boost::function< void(const bool &available)> service_availability_handler
 Prototype of the handler function used to monitor service availability. More...
 
typedef boost::function< void(boost::system::error_code &error_code, std::string &sourceid, std::string &callid, dpyVoicecall::CallStatus status)> call_event_handler_function
 Handler for call event function callback. More...
 
typedef boost::function< void(boost::system::error_code &error_code)> request_handler_function
 Handler for answer function callback. This type of function is called to check the result. More...
 
typedef boost::function< void(boost::system::error_code &error_code, const std::string &callid)> make_call_handler_function
 Callback handler used when making calls. More...
 
typedef boost::function< void(boost::system::error_code error_code, const std::string &callid, dpyVoicecall::CallInformation callinfo)> get_info_handler_function
 Handler for get info function callback. More...
 
typedef boost::function< void(boost::system::error_code error_code, std::map< std::string, dpyVoicecall::CallInformation > callList)> get_all_call_info_handler_function
 Handler for get info function callback. More...
 
typedef boost::function< void(boost::system::error_code, dpyVoicecall::VoiceCallSourceInfo sourceInfo, ListEvent event)> source_list_event_handler_function
 Prototype of the handler function for subscribing to list events. More...
 
typedef boost::function< void(boost::system::error_code, std::string callsourceid, SourceStatus event)> source_status_handler_function
 Prototype of the handler function for subscribing to source status events. More...
 
typedef boost::function< void(boost::system::error_code error_code, std::string sourceid, std::map< dpyVoicecall::CallParameter, std::string > callConfiguration)> get_call_config_handler_function
 Handler for get call configuration. More...
 

Enumerations

enum  CallDirection { DIRECTION_OUTGOING = 0, DIRECTION_INCOMING = 1 }
 Direction. More...
 
enum  CallStatus {
  STATUS_WAITING = 0, STATUS_RINGING = 1, STATUS_DIALING = 2, STATUS_CONVERSATION = 3,
  STATUS_HELD = 4, STATUS_FINISHED = 5, STATUS_ALERTING = 6, STATUS_DROPPED = 7
}
 Defines the possible call status that a sim can report. More...
 
enum  CallType { TYPE_VOICE = 0, TYPE_DATA_VOICE = 1 }
 
enum  ListEvent { ADDED = 0, REMOVED = 1 }
 
enum  SourceStatus { DISABLED = 0, ENABLED = 1, BUSY = 2 }
 Source Status. More...
 
enum  SourceType { SIM_CARD = 0, VoIP = 1 }
 
enum  CallParameter {
  NUM_OF_RINGS =0, AUTOMATIC_ANSWER =1, AUDIO_MODE =2, RINGTONE =3,
  VOLUME_RINGTONE =4, VOLUME_PERCENT =5, MICRO_ADC_GAIN =6, MICRO_MULT_FACTOR =7,
  NUM_OF_RETRIES =8, SIP_ACCOUNT =9, SIP_LOCAL_PORT =10, RTP_LOCAL_PORT_RANGE =11,
  SIP_CODECS =12, AUSRC_SRATE =13, AUPLAY_SRATE =14, OPUS_BITRATE =15,
  JACK_MODULE =16, APP_MODULES =17
}
 Defines the Voice Call Configuration parameters that can be configured. More...
 

Typedef Documentation

typedef boost::function<void(boost::system::error_code& error_code, std::string& sourceid, std::string& callid, dpyVoicecall::CallStatus status)> call_event_handler_function
Parameters
error_codeerror code (if any)
sourceidthe source generating the event
callidthe call identifier
statusstatus of the call
typedef boost::function<void(boost::system::error_code, std::list<dpyVoicecall::VoiceCallSourceInfo> sourcesList)> call_sources_list_handler_function
Parameters
error_codeerror code (if any)
sourceslist of call sources ids
typedef boost::function<void(boost::system::error_code error_code,std::map<std::string,dpyVoicecall::CallInformation> callList)> get_all_call_info_handler_function
Parameters
error_codeerror code (if any)
callidcall identifier
callinfovector to keep information from callsPrototype of the handler function for getModemInfo method
typedef boost::function<void(boost::system::error_code error_code,std::string sourceid, std::map<dpyVoicecall::CallParameter,std::string> callConfiguration )> get_call_config_handler_function
Parameters
error_codeerror code (if any)
callConfigurationmap that associates the call parameters with its valuePrototype of the handler function for GetCallConfiguration method
typedef boost::function<void(boost::system::error_code error_code,const std::string& callid, dpyVoicecall::CallInformation callinfo)> get_info_handler_function
Parameters
error_codeerror code (if any)
callidcall identifier
callinfovector to keep information from callsPrototype of the handler function for getModemInfo method
typedef boost::function<void(boost::system::error_code& error_code, const std::string& callid)> make_call_handler_function
Parameters
error_codeerror code (if any)
callidresultant call identifier
typedef boost::function<void(boost::system::error_code& error_code)> request_handler_function
Parameters
error_codeerror code (if any)
typedef boost::function<void(const bool &available)> service_availability_handler
Parameters
availabletrue if the service is available, false otherwise
typedef boost::function<void(boost::system::error_code, dpyVoicecall::VoiceCallSourceInfo sourceInfo, ListEvent event)> source_list_event_handler_function
Parameters
error_codeerror code (if any)
sourceidvoicecall source id
eventin the list (ADDED,REMOVED)
typedef boost::function<void(boost::system::error_code, std::string callsourceid, SourceStatus event)> source_status_handler_function
Parameters
error_codeerror code (if any)
sourceidvoicecall source id
eventin the list (DISABLED,ENABLED)

Enumeration Type Documentation

Enumerator
DIRECTION_OUTGOING 

0 -> Mobile originated call (MOC)

DIRECTION_INCOMING 

1 -> Mobile terminated call (MTC)

Enumerator
NUM_OF_RINGS 

Number of rings before automatic answer if it is enabled.

AUTOMATIC_ANSWER 

Automatic answer.

AUDIO_MODE 

Audio mode.

RINGTONE 

Type of ring tone.

VOLUME_RINGTONE 

Volume of ring tone,varies from low to high.

VOLUME_PERCENT 

Percentage of volume.

MICRO_ADC_GAIN 

Amplification of the microphone. ADC Gain.

MICRO_MULT_FACTOR 

Amplification of the microphone. Multiplication factor.

NUM_OF_RETRIES 

Maximum retries number.

SIP_ACCOUNT 

SIP Account for baresip.

SIP_LOCAL_PORT 

Local SIP port.

RTP_LOCAL_PORT_RANGE 

Local RTP ports.

SIP_CODECS 

Allowed audio codecs.

AUSRC_SRATE 

Audio src sample rate.

AUPLAY_SRATE 

Audio play sample rate.

OPUS_BITRATE 

Opus bitrate.

JACK_MODULE 

Jack module.

APP_MODULES 

Baresip app modules.

enum CallStatus
Enumerator
STATUS_WAITING 

Waiting (MTC)

STATUS_RINGING 

Incoming (MTC)

STATUS_DIALING 

Dialing (MOC)

STATUS_CONVERSATION 

The call is active.

STATUS_HELD 

The call is held.

STATUS_FINISHED 

The call is not active anymore, but inband information is still available.

STATUS_ALERTING 

Alerting (MOC)

STATUS_DROPPED 

The call has been suspended by the network, but may resumed later.

enum CallType
Enumerator
TYPE_VOICE 

Voice.

TYPE_DATA_VOICE 

Data.

enum ListEvent
Enumerator
ADDED 

ADDED.

REMOVED 

REMOVED.

enum SourceType
Enumerator
SIM_CARD 

Sim card.

VoIP 

Voice IP source type.