Voice Call Source interface.

#include <iVoiceCallSource.h>

Public Member Functions
	IVoiceCallSource (const std::string &id)
	Constructor. More...

virtual	~IVoiceCallSource ()
	Destructor.

virtual void	start ()=0
	Start Source operations.

virtual void	stop ()=0
	Stop Source operations.

std::string	getId () const
	Retrieve the voice call source ID. More...

virtual dpyVoicecall::SourceType	getVoiceCallSourceType ()=0
	Get source type. More...

dpyVoicecall::SourceStatus	getSourceStatus ()
	Retrieve source status from the voice call source. More...

virtual boost::system::error_code	getCallStatus (dpyVoicecall::CallStatus &status)=0
	Retrieve call status from the voice call source. More...

virtual std::list< boost::shared_ptr< ICall > >	getCallList ()=0
	Retrieve call list from the voice call source. More...

virtual boost::system::error_code	getCallInfo (const std::string &callid, dpyVoicecall::CallInformation &info)=0
	Retrieve call related information. More...

virtual boost::system::error_code	makeCall (const std::string &destination, std::string &callid)=0
	Performs a call to a specified phone number. More...

virtual boost::system::error_code	answerCall (const std::string &callid)=0
	Answer a incoming call. More...

virtual boost::system::error_code	finishCall (const std::string &callid)=0
	Finish an active call. More...

virtual boost::system::error_code	muteCall (const std::string &callid, const bool &mute)=0
	Mute or unmute an active call. More...

virtual boost::system::error_code	redialLastNumber ()=0
	Redial the number that is associated with the last voice call. More...

virtual boost::system::error_code	setCallConfigParameter (const dpyVoicecall::CallParameter &param, const std::string &value)=0
	Set call configuration for a specific parameter. More...

virtual std::map< dpyVoicecall::CallParameter, std::string >	getCallConfigParameters ()=0
	Get call configuration parameters. More...

boost::system::error_code	subscribe (VoiceCallSourceObserver *observer)
	Subscribe to the different voice call source events. More...

boost::system::error_code	unsubscribe (VoiceCallSourceObserver *observer)
	Unsubscribe from the different voice call source events. More...

Protected Member Functions
void	setSourceStatus (dpyVoicecall::SourceStatus status)
	set source status of the voice call source More...

void	notifySourceStatusUpdate (const std::string &sourceid, const dpyVoicecall::SourceStatus &status)

void	notifyCallStatusEvent (const std::string &sourceid, const std::string &callid, const dpyVoicecall::CallStatus &status)

Constructor & Destructor Documentation

IVoiceCallSource ( const std::string & id )

explicit

Parameters

id	voice call source identifier

Member Function Documentation

virtual boost::system::error_code answerCall ( const std::string & callid )

pure virtual

Returns: error code

virtual boost::system::error_code finishCall ( const std::string & callid )

pure virtual

Returns: error code

virtual std::map<dpyVoicecall::CallParameter,std::string> getCallConfigParameters ( )

pure virtual

Returns: callParameters map with call configuration

virtual boost::system::error_code getCallInfo	(	const std::string &	callid,
		dpyVoicecall::CallInformation &	info
	)

pure virtual

Parameters

callid	id to be retrieved
info	call information

Returns: error code

virtual std::list<boost::shared_ptr<ICall> > getCallList ( )

pure virtual

Returns: list of calls

virtual boost::system::error_code getCallStatus ( dpyVoicecall::CallStatus & status )

pure virtual

Parameters

status status of the voice call system

Returns: error code

std::string getId ( ) const

Returns: voice call source ID

dpyVoicecall::SourceStatus getSourceStatus ( )

Returns: status of the source

virtual dpyVoicecall::SourceType getVoiceCallSourceType ( )

pure virtual

Returns: SourceType

virtual boost::system::error_code makeCall	(	const std::string &	destination,
		std::string &	callid
	)

pure virtual

Parameters

destination	is the destination number or element to call
callid	resultant call identifier

Returns: error code

virtual boost::system::error_code muteCall	(	const std::string &	callid,
		const bool &	mute
	)

pure virtual

Parameters

mute option

Returns: error code

virtual boost::system::error_code redialLastNumber ( )

pure virtual

Returns: error code

virtual boost::system::error_code setCallConfigParameter	(	const dpyVoicecall::CallParameter &	param,
		const std::string &	value
	)

pure virtual

Parameters

param	parameter to be set
value	value of the parameter

Returns: error code

void setSourceStatus ( dpyVoicecall::SourceStatus status )

protected

Parameters

status status of the source

boost::system::error_code subscribe ( VoiceCallSourceObserver * observer )

Parameters

observer object to subscribe

Returns: error code

boost::system::error_code unsubscribe ( VoiceCallSourceObserver * observer )

Parameters

observer object to unsubscribe

Returns: error code

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation