OPAL Version 3.10.4

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Protected Attributes
OpalIVREndPoint Class Reference

`#include <ivr.h>`

Inheritance diagram for OpalIVREndPoint:

## Public Member Functions

Construction
| OpalIVREndPoint (OpalManager &manager, const char *prefix="ivr")
| ~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
Public Member Functions inherited from OpalLocalEndPoint
| OpalLocalEndPoint (OpalManager &manager, const char *prefix="local")
| ~OpalLocalEndPoint ()
PSafePtr< OpalLocalConnection > | GetLocalConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
virtual OpalLocalConnection * | CreateConnection (OpalCall &call, void *userData, unsigned options, OpalConnection::StringOptions *stringOptions)
virtual bool | OnOutgoingCall (const OpalLocalConnection &connection)
virtual bool | OnIncomingCall (OpalLocalConnection &connection)
virtual bool | AlertingIncomingCall (const PString &token, OpalConnection::StringOptions *options=NULL)
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)
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 | IsSynchronous () const
bool | IsDeferredAlerting () const
void | SetDeferredAlerting (bool defer)
bool | IsDeferredAnswer () const
void | SetDeferredAnswer (bool defer)
Public Member Functions inherited from OpalEndPoint
| OpalEndPoint (OpalManager &manager, const PCaselessString &prefix, unsigned attributes)
| ~OpalEndPoint ()
virtual void | ShutDown ()
void | PrintOn (ostream &strm) const
PBoolean | StartListeners (const PStringArray &interfaces)
PBoolean | StartListener (const OpalTransportAddress &iface)
PBoolean | StartListener (OpalListener *listener)
virtual PStringArray | GetDefaultListeners () const
virtual PString | GetDefaultTransport () const
OpalListener * | FindListener (const OpalTransportAddress &iface)
bool | FindListenerForProtocol (const char *proto, OpalTransportAddress &addr)
PBoolean | StopListener (const OpalTransportAddress &iface)
PBoolean | RemoveListener (OpalListener *listener)
OpalTransportAddressArray | GetInterfaceAddresses (PBoolean excludeLocalHost=true, const OpalTransport *associatedTransport=NULL)
| PDECLARE_NOTIFIER (PThread, OpalEndPoint, ListenerCallback)
virtual PBoolean | NewIncomingConnection (OpalTransport *transport)
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)
template<class ConnClass >
PSafePtr< ConnClass > | GetConnectionWithLockAs (const PString &token, PSafetyMode mode=PSafeReadWrite)
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 PBoolean | OnOpenMediaStream (OpalConnection &connection, OpalMediaStream &stream)
virtual void | OnClosedMediaStream (const OpalMediaStream &stream)
virtual PBoolean | CreateVideoInputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PVideoInputDevice *&device, PBoolean &autoDelete)
virtual PBoolean | CreateVideoOutputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PBoolean preview, PVideoOutputDevice *&device, PBoolean &autoDelete)
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 PBoolean | GarbageCollection ()
OpalManager & | GetManager () const
const PString & | GetPrefixName () const
PBoolean | HasAttribute (Attributes opt) const
WORD | GetDefaultSignalPort () 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)
unsigned | GetInitialBandwidth () const
void | SetInitialBandwidth (unsigned bandwidth)
const OpalListenerList & | GetListeners () const
const OpalConnection::StringOptions & | GetDefaultStringOptions () const
void | SetDefaultStringOptions (const OpalConnection::StringOptions &opts)
void | SetDefaultStringOption (const PCaselessString &key, const PString &data)
OpalConnection::SendUserInputModes | GetSendUserInputMode () const
void | SetSendUserInputMode (OpalConnection::SendUserInputModes mode)

## Protected Attributes

PString | defaultVXML
OpalMediaFormatList | defaultMediaFormats
PString | defaultTts
Protected Attributes inherited from OpalLocalEndPoint
bool | m_deferredAlerting
bool | m_deferredAnswer
Protected Attributes inherited from OpalEndPoint
OpalManager & | manager
PCaselessString | prefixName
unsigned | attributeBits
WORD | defaultSignalPort
PINDEX | m_maxSizeUDP
OpalProductInfo | productInfo
PString | defaultLocalPartyName
PString | defaultDisplayName
unsigned | initialBandwidth
OpalConnection::StringOptions | m_defaultStringOptions
OpalConnection::SendUserInputModes | defaultSendUserInputMode
OpalListenerList | listeners
OpalEndPoint::ConnectionDict | connectionsActive
PMutex | inUseFlag

## Detailed Description

Interactive Voice Response endpoint.

## Constructor & Destructor Documentation

OpalIVREndPoint::OpalIVREndPoint | ( | OpalManager & | manager,
|  | const char * | prefix = `"ivr"`
| ) |  |

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

PString OpalIVREndPoint::GetDefaultTextToSpeech | ( |  | ) | const

inline

References defaultTts.

const PString& OpalIVREndPoint::GetDefaultVXML | ( |  | ) | const

inline

Get the default VXML to use.

References 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 is pure.

Reimplemented from OpalLocalEndPoint.

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 is pure.

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::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 defaultTts.

void OpalIVREndPoint::SetDefaultVXML | ( | const PString & | vxml | ) |

Set the default VXML to use.

## Field Documentation

OpalMediaFormatList OpalIVREndPoint::defaultMediaFormats

protected

PString OpalIVREndPoint::defaultTts

protected

Referenced by GetDefaultTextToSpeech(), and SetDefaultTextToSpeech().

PString OpalIVREndPoint::defaultVXML

protected

Referenced by GetDefaultVXML().

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

- ivr.h