OpenSpeech Browser

Getting Started
Architecture Description
Integration Guide

Copyright (c) 1998-2001 SpeechWorks International, Inc. All Rights Reserved.



VXIsessionControl

Session Control Interface
o VXIscResult
Result codes for interface methods
o VXIscTransferType
Types of transfers that can be performed
o SC_ANI_CALLER_NUMBER
Keys identifying standard read-only properties returned by GetNthPropertyPair( ), support for these is optional but is highly encouraged.
o SC_XFER_CONNECT_TIMEOUT
Keys identifying standard read/write properties that are set using SetProperty( ).
o SC_ANI_CALLER_NUMBER_DEFAULT
Defaults for standard properties
o SC_EVENT_ERROR
Events returned from the Session Control as detailed in the Session Control interface description.
o VXIscEventData
Event structure for returning detailed status information
o VXIscEventListener
Signature for the event handler called to report Session Control events, as registered via RegisterEventListener( ).
o VXIscInterface
Session Control interface for call control and DTMF input
Abstract interface for call control and obtaining DTMF input from the caller via a telephony interface. The call control functionality includes detecting incoming calls, accepting incoming calls, near-end disconnects (hang-up), detecting far-end disconnects, and performing call transfers.

The Session Control interface must be implemented for each new underlying telephony interface, where this is frequently done by a third party integrator.

There is one Session Control interface per telephony channel.

The following table summarizes the events delivered by Session Control implementations.

SC_EVENT_ERROR Reports the Session Control encountered an error on the line during a call, typically due to an underlying telephony error. The error must have occurred after a call to VXIscAcceptSession( ) returned with a VXIsc_RESULT_SUCCESS result code, never within that function or after that function returned with an error. If the error terminated the call, a SC_EVENT_END event must be delivered after this event.

The event includes a result code that indicates the cause of the error.

SC_EVENT_BEGIN Reports a call has started, as initiated by a successful call to AcceptSession( ).
SC_EVENT_END Reports a disconnect (hang-up, call terminated) due to either a near-end disconnect (from a call to TerminateSession( )), a far-end disconnect, or an error (in which case a SC_EVENT_ERROR will be delivered prior to this event).

SC_EVENT_TRANSFER_BEGIN Reports that a transfer has successfully started, as initiated by a successful call to Transfer( ). For a bridge (supervised) transfer this event should be reported when the far-end has answered the call and the near-end party and far-end party are able to hear each other. For a blind transfer this should be reported when the blind transfer has been successfully initiated in the network. For a blind transfer, a SC_EVENT_END event should immediately follow this event.
SC_EVENT_TRANSFER_COMPLETE Reports that a bridge (supervised) transfer has completed with the far-end party disconnected and the near-end party still connected. This can occur either on a maxtime exceeded or far-end party or network disconnect.
SC_EVENT_INVITE Reports an incoming call request on the telephony channel. For analog connections, should be generated on each ring.
SC_EVENT_DTMF_RECEIVED Reports a DTMF key press, with a separate event for each DTMF received. If no event listeners are registered, these events should be buffered and delivered as soon as a listener is registered.

Version:
1.0

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.