#include <ivr.h>

Inheritance diagram for OpalIVREndPoint:

Collaboration diagram for OpalIVREndPoint:

Public Member Functions
virtual PVXMLCache &	GetTextToSpeechCache ()

Construction
	OpalIVREndPoint (OpalManager &manager, const char *prefix=OPAL_IVR_PREFIX)

	~OpalIVREndPoint ()

Overrides from OpalEndPoint
virtual PSafePtr< OpalConnection >	MakeConnection (OpalCall &call, const PString &party, void userData=NULL, unsigned int options=0, OpalConnection::StringOptions stringOptions=NULL)

virtual OpalMediaFormatList	GetMediaFormats () const

Customisation call backs
virtual OpalIVRConnection *	CreateConnection (OpalCall &call, void userData, const PString &vxml, unsigned int options, OpalConnection::StringOptions stringOptions=NULL)

Options and configuration
PSafePtr< OpalIVRConnection >	GetIVRConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)

const PString &	GetDefaultVXML () const

void	SetDefaultVXML (const PString &vxml)

void	SetDefaultMediaFormats (const OpalMediaFormatList &formats)

virtual void	OnEndDialog (OpalIVRConnection &connection)

void	SetDefaultTextToSpeech (const PString &tts)

PString	GetDefaultTextToSpeech () const

const PDirectory &	GetCacheDir () const

void	SetCacheDir (const PDirectory &dir)

void	SetRecordDirectory (const PDirectory &dir)

const PDirectory &	GetRecordDirectory () const

Public Member Functions inherited from OpalLocalEndPoint
	OpalLocalEndPoint (OpalManager &manager, const char *prefix=OPAL_LOCAL_PREFIX, bool useCallbacks=true)

	~OpalLocalEndPoint ()

PSafePtr< OpalLocalConnection >	GetLocalConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)

virtual OpalLocalConnection *	CreateConnection (OpalCall &call, void userData, unsigned options, OpalConnection::StringOptions stringOptions)

virtual bool	OnOutgoingSetUp (const OpalLocalConnection &connection)

virtual bool	OnOutgoingCall (const OpalLocalConnection &connection)

virtual bool	OnIncomingCall (OpalLocalConnection &connection)

virtual bool	AlertingIncomingCall (const PString &token, OpalConnection::StringOptions *options=NULL, bool withMedia=false)

virtual bool	AcceptIncomingCall (const PString &token, OpalConnection::StringOptions *options=NULL)

virtual bool	RejectIncomingCall (const PString &token, const OpalConnection::CallEndReason &reason=OpalConnection::EndedByAnswerDenied)

virtual bool	OnUserInput (const OpalLocalConnection &connection, const PString &indication)

Synchronicity	GetDefaultAudioSynchronicity () const

void	SetDefaultAudioSynchronicity (Synchronicity sync)

Synchronicity	GetDefaultVideoSourceSynchronicity () const

void	SetDefaultVideoSourceSynchronicity (Synchronicity sync)

bool	IsDeferredAlerting () const

void	SetDeferredAlerting (bool defer)

bool	IsDeferredAnswer () const

void	SetDeferredAnswer (bool defer)

bool	WillPauseTransmitMediaOnHold () const

void	SetPauseTransmitMediaOnHold (bool pause)

void	SetFarEndCameraCapabilityChangedNotifier (const PNotifier &notifier)
	Set a callback for when the far end camera control capabilities change. More...

const PNotifier &	GetFarEndCameraCapabilityChangedNotifier () const
	Get a callback for when the far end camera control capabilities change. More...

void	SetFarEndCameraActionNotifier (const PNotifier &notifier)
	Set a callback for when a far end camera control action comes from remote. More...

const PNotifier &	GetFarEndCameraActionNotifier () const
	Get a callback for when a far end camera control action comes from remote. More...

	P_DECLARE_BITWISE_ENUM (CallbackUsage, 2,(NoCallbacks, UseSourceCallback, UseSinkCallback))
	Enumeration for usage of media callback direction in CallbackMap. More...

bool	UseCallback (const OpalMediaFormat &mediaFormat, bool isSource) const
	Indicate media type and direction is to use virtual callback functions. More...

bool	SetCallbackUsage (const OpalMediaType &mediaType, CallbackUsage usage)
	Set callback usage for media type. More...

virtual bool	OnReadMediaFrame (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, RTP_DataFrame &frame)

virtual bool	OnWriteMediaFrame (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, RTP_DataFrame &frame)

virtual bool	OnReadMediaData (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, void *data, PINDEX size, PINDEX &length)

virtual bool	OnWriteMediaData (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, const void *data, PINDEX length, PINDEX &written)

virtual bool	CreateVideoInputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PVideoInputDevice *&device, bool &autoDelete)

virtual bool	CreateVideoOutputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, bool preview, PVideoOutputDevice *&device, bool &autoDelete)

virtual Synchronicity	GetSynchronicity (const OpalMediaFormat &mediaFormat, bool isSource) const

Public Member Functions inherited from OpalEndPoint
	P_DECLARE_BITWISE_ENUM (Attributes, 2,(NoAttributes, IsNetworkEndPoint, SupportsE164))

	OpalEndPoint (OpalManager &manager, const PCaselessString &prefix, Attributes attributes)

	~OpalEndPoint ()

virtual void	ShutDown ()

void	PrintOn (ostream &strm) const

bool	StartListeners (const PStringArray &interfaces, bool add=true)

PBoolean	StartListener (const OpalTransportAddress &iface)

PBoolean	StartListener (OpalListener *listener)

virtual PStringArray	GetDefaultListeners () const

virtual PString	GetDefaultTransport () const

virtual WORD	GetDefaultSignalPort () const

OpalListener *	FindListener (const OpalTransportAddress &iface)

bool	FindListenerForProtocol (const char *proto, OpalTransportAddress &addr)

PBoolean	StopListener (const OpalTransportAddress &iface)

PBoolean	RemoveListener (OpalListener *listener)

OpalTransportAddressArray	GetInterfaceAddresses (const OpalTransport *associatedTransport=NULL) const

	PDECLARE_AcceptHandlerNotifier (OpalEndPoint, NewIncomingConnection)

virtual void	OnNewConnection (OpalCall &call, OpalConnection &connection)

virtual PBoolean	OnSetUpConnection (OpalConnection &connection)

virtual PBoolean	OnIncomingConnection (OpalConnection &connection, unsigned options, OpalConnection::StringOptions *stringOptions)

virtual void	OnProceeding (OpalConnection &connection)

virtual void	OnAlerting (OpalConnection &connection)

virtual OpalConnection::AnswerCallResponse	OnAnswerCall (OpalConnection &connection, const PString &caller)

virtual void	OnConnected (OpalConnection &connection)

virtual void	OnEstablished (OpalConnection &connection)

virtual void	OnReleased (OpalConnection &connection)

virtual void	OnHold (OpalConnection &connection, bool fromRemote, bool onHold)

virtual void	OnHold (OpalConnection &connection)

virtual PBoolean	OnForwarded (OpalConnection &connection, const PString &remoteParty)

virtual bool	OnTransferNotify (OpalConnection &connection, const PStringToString &info)

virtual PBoolean	ClearCall (const PString &token, OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PSyncPoint *sync=NULL)

virtual PBoolean	ClearCallSynchronous (const PString &token, OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PSyncPoint *sync=NULL)

virtual void	ClearAllCalls (OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PBoolean wait=true)

PSafePtr< OpalConnection >	GetConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite) const

template<class ConnClass >
PSafePtr< ConnClass >	GetConnectionWithLockAs (const PString &token, PSafetyMode mode=PSafeReadWrite) const

PStringList	GetAllConnections ()

PINDEX	GetConnectionCount () const

virtual PBoolean	HasConnection (const PString &token)

virtual void	DestroyConnection (OpalConnection *connection)

virtual void	AdjustMediaFormats (bool local, const OpalConnection &connection, OpalMediaFormatList &mediaFormats) const

virtual bool	GetMediaTransportAddresses (const OpalConnection &source, const OpalConnection &destination, const OpalMediaType &mediaType, OpalTransportAddressArray &transports) const

virtual PBoolean	OnOpenMediaStream (OpalConnection &connection, OpalMediaStream &stream)

virtual void	OnClosedMediaStream (const OpalMediaStream &stream)

virtual void	OnFailedMediaStream (OpalConnection &connection, bool fromRemote, const PString &reason)

void	SetMediaCryptoSuites (const PStringArray &security)

PStringArray	GetMediaCryptoSuites () const

virtual PStringArray	GetAllMediaCryptoSuites () const

virtual void	OnUserInputString (OpalConnection &connection, const PString &value)

virtual void	OnUserInputTone (OpalConnection &connection, char tone, int duration)

virtual PString	ReadUserInput (OpalConnection &connection, const char *terminators="#\r\n", unsigned lastDigitTimeout=4, unsigned firstDigitTimeout=30)

virtual PBoolean	Message (const PString &to, const PString &body)

virtual PBoolean	Message (const PURL &to, const PString &type, const PString &body, PURL &from, PString &conversationId)

virtual PBoolean	Message (OpalIM &Message)

virtual void	OnMessageReceived (const OpalIM &message)

virtual void	OnMWIReceived (const PString &party, OpalManager::MessageWaitingType type, const PString &extraInfo)

virtual bool	GetConferenceStates (OpalConferenceStates &states, const PString &name=PString::Empty()) const

virtual void	OnConferenceStatusChanged (OpalEndPoint &endpoint, const PString &uri, OpalConferenceState::ChangeType change)

virtual PStringList	GetNetworkURIs (const PString &name) const

virtual PBoolean	GarbageCollection ()

OpalManager &	GetManager () const

const PString &	GetPrefixName () const

bool	HasAttribute (Attributes opt) const

const OpalProductInfo &	GetProductInfo () const

void	SetProductInfo (const OpalProductInfo &info)

const PString &	GetDefaultLocalPartyName () const

virtual void	SetDefaultLocalPartyName (const PString &name)

const PString &	GetDefaultDisplayName () const

void	SetDefaultDisplayName (const PString &name)

OpalBandwidth	GetInitialBandwidth (OpalBandwidth::Direction dir) const

void	SetInitialBandwidth (OpalBandwidth::Direction dir, OpalBandwidth bandwidth)

const OpalListenerList &	GetListeners () const

const OpalConnection::StringOptions &	GetDefaultStringOptions () const

void	SetDefaultStringOptions (const OpalConnection::StringOptions &opts)

void	SetDefaultStringOption (const PCaselessString &key, const PString &data)

void	RemoveDefaultStringOption (const PCaselessString &key)

virtual PStringList	GetAvailableStringOptions () const

OpalConnection::SendUserInputModes	GetSendUserInputMode () const

void	SetSendUserInputMode (OpalConnection::SendUserInputModes mode)

Protected Attributes
PString	m_defaultVXML

OpalMediaFormatList	m_defaultMediaFormats

PString	m_defaultTTS

PMutex	m_defaultsMutex

PVXMLCache	m_ttsCache

PDirectory	m_recordDirectory

Protected Attributes inherited from OpalLocalEndPoint
bool	m_deferredAlerting

bool	m_deferredAnswer

bool	m_pauseTransmitMediaOnHold

CallbackMap	m_useCallback

Synchronicity	m_defaultAudioSynchronicity

Synchronicity	m_defaultVideoSourceSynchronicity

PNotifier	m_farEndCameraCapabilityChangedNotifier

PNotifier	m_farEndCameraActionNotifier

Protected Attributes inherited from OpalEndPoint
OpalManager &	manager

PCaselessString	prefixName

Attributes	m_attributes

PINDEX	m_maxSizeUDP

OpalProductInfo	productInfo

PString	defaultLocalPartyName

PString	defaultDisplayName

PStringArray	m_mediaCryptoSuites

OpalBandwidth	m_initialRxBandwidth

OpalBandwidth	m_initialTxBandwidth

OpalConnection::StringOptions	m_defaultStringOptions

OpalConnection::SendUserInputModes	defaultSendUserInputMode

OpalListenerList	listeners

OpalEndPoint::ConnectionDict	connectionsActive

Additional Inherited Members
Public Types inherited from OpalLocalEndPoint
enum	Synchronicity { e_Synchronous, e_Asynchronous, e_SimulateSyncronous }

typedef map< OpalMediaType, CallbackUsage >	CallbackMap
	Map for indicating if a media type is to use callback virtual functions. More...

Protected Member Functions inherited from OpalEndPoint
OpalConnection *	AddConnection (OpalConnection *connection)

Detailed Description

Interactive Voice Response endpoint.

Constructor & Destructor Documentation

OpalIVREndPoint::OpalIVREndPoint	(	OpalManager &	manager,
		const char *	prefix = `OPAL_IVR_PREFIX`
	)

Create a new endpoint.

Parameters

manager	Manager of all endpoints.
prefix	Prefix for URL style address strings

OpalIVREndPoint::~OpalIVREndPoint ( )

Destroy endpoint.

Member Function Documentation

virtual OpalIVRConnection* OpalIVREndPoint::CreateConnection	(	OpalCall &	call,
		void *	userData,
		const PString &	vxml,
		unsigned int	options,
		OpalConnection::StringOptions *	stringOptions = `NULL`
	)

virtual

Create a connection for the PCSS endpoint. The default implementation is to create a OpalPCSSConnection.

Parameters

call	Owner of connection
userData	Arbitrary data to pass to connection
vxml	vxml to execute

const PDirectory& OpalIVREndPoint::GetCacheDir ( ) const

inline

Get the text to speach cache directory to use.

References m_ttsCache.

PString OpalIVREndPoint::GetDefaultTextToSpeech ( ) const

inline

References m_defaultTTS.

const PString& OpalIVREndPoint::GetDefaultVXML ( ) const

inline

Get the default VXML to use.

References m_defaultVXML.

PSafePtr<OpalIVRConnection> OpalIVREndPoint::GetIVRConnectionWithLock	(	const PString &	token,
		PSafetyMode	mode = `PSafeReadWrite`
	)

inline

Find a connection that uses the specified token. This searches the endpoint for the connection that contains the token as provided by functions such as MakeConnection().

Parameters

token Token to identify connection

References OpalEndPoint::GetConnectionWithLock().

virtual OpalMediaFormatList OpalIVREndPoint::GetMediaFormats ( ) const

virtual

Get the data formats this endpoint is capable of operating. This provides a list of media data format names that may be used by an OpalMediaStream may be created by a connection from this endpoint.

Note that a specific connection may not actually support all of the media formats returned here, but should return no more.

The default behaviour returns the basic media formats for PCM/YUV.

Reimplemented from OpalLocalEndPoint.

const PDirectory& OpalIVREndPoint::GetRecordDirectory ( ) const

inline

References m_recordDirectory.

virtual PVXMLCache& OpalIVREndPoint::GetTextToSpeechCache ( )

inlinevirtual

References m_ttsCache.

virtual PSafePtr<OpalConnection> OpalIVREndPoint::MakeConnection	(	OpalCall &	call,
		const PString &	party,
		void *	userData = `NULL`,
		unsigned int	options = `0`,
		OpalConnection::StringOptions *	stringOptions = `NULL`
	)

virtual

Set up a connection to a remote party. This is called from the OpalManager::MakeConnection() function once it has determined that this is the endpoint for the protocol.

The general form for this party parameter is:

 [proto:][alias@][transport$]address[:port]

where the various fields will have meanings specific to the endpoint type. For example, with H.323 it could be "h323:Fred@site.com" which indicates a user Fred at gatekeeper size.com. Whereas for the PSTN endpoint it could be "pstn:5551234" which is to call 5551234 on the first available PSTN line.

The proto field is optional when passed to a specific endpoint. If it is present, however, it must agree with the endpoints protocol name or false is returned.

This function usually returns almost immediately with the connection continuing to occur in a new background thread.

If false is returned then the connection could not be established. For example if a PSTN endpoint is used and the assiciated line is engaged then it may return immediately. Returning a non-NULL value does not mean that the connection will succeed, only that an attempt is being made.

The default behaviour sets up an IVR connection.

Parameters

call	Owner of connection
party	Remote party to call
userData	Arbitrary data to pass to connection
options	options to pass to conneciton

Reimplemented from OpalLocalEndPoint.

virtual void OpalIVREndPoint::OnEndDialog ( OpalIVRConnection & connection )

virtual

Called when VXML ends. Gives an opputunity for an application to do somthing when script ends, start a new script for instance.

Default action does nothing, session will end and connection will be released.

Parameters

connection Connection with ending dialog

void OpalIVREndPoint::SetCacheDir ( const PDirectory & dir )

inline

Set the text to speach cache directory to use.

References m_ttsCache.

void OpalIVREndPoint::SetDefaultMediaFormats ( const OpalMediaFormatList & formats )

Set the default media formats for all connections using VXML.

void OpalIVREndPoint::SetDefaultTextToSpeech ( const PString & tts )

inline

Set/get the default text to speech engine used by the IVR

References m_defaultTTS.

void OpalIVREndPoint::SetDefaultVXML ( const PString & vxml )

Set the default VXML to use.

void OpalIVREndPoint::SetRecordDirectory ( const PDirectory & dir )

inline

References m_recordDirectory.

Field Documentation

OpalMediaFormatList OpalIVREndPoint::m_defaultMediaFormats

protected

PMutex OpalIVREndPoint::m_defaultsMutex

protected

PString OpalIVREndPoint::m_defaultTTS

protected

Referenced by GetDefaultTextToSpeech(), and SetDefaultTextToSpeech().

PString OpalIVREndPoint::m_defaultVXML

protected

Referenced by GetDefaultVXML().

PDirectory OpalIVREndPoint::m_recordDirectory

protected

Referenced by GetRecordDirectory(), and SetRecordDirectory().

PVXMLCache OpalIVREndPoint::m_ttsCache

protected

Referenced by GetCacheDir(), GetTextToSpeechCache(), and SetCacheDir().

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

ivr.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation