tspi.h header

This header is used by TAPI 2.2. For more information, see:

  • TAPI 2.2 tspi.h contains the following programming interfaces:

Functions

Title Description
TSPI_lineAccept The TSPI_lineAccept function accepts the specified offered call. It can optionally send the specified user-user information to the calling party.
TSPI_lineAddToConference The TSPI_lineAddToConference function adds the call specified by hdConsultCall to the conference call specified by hdConfCall.
TSPI_lineAnswer The TSPI_lineAnswer function answers the specified offering call.
TSPI_lineBlindTransfer The TSPI_lineBlindTransfer function performs a blind or single-step transfer of the specified call to the specified destination address.
TSPI_lineClose The TSPI_lineClose function closes the specified open line device after completing or aborting all outstanding calls and asynchronous operations on the device.
TSPI_lineCloseCall The TSPI_lineCloseCall function deallocates the call after completing or aborting all outstanding asynchronous operations on the call.
TSPI_lineCloseMSPInstance The TSPI_lineCloseMSPInstance function directs the TAPI 3 DLL to close a media service provider (MSP) call instance. This function requires TAPI 3.0 version negotiation.
TSPI_lineCompleteCall The TSPI_lineCompleteCall function is used to specify how a call that cannot be connected normally is to be completed instead.
TSPI_lineCompleteTransfer The TSPI_lineCompleteTransfer function completes the transfer of the specified call to the party connected in the consultation call.
TSPI_lineConditionalMediaDetection The TSPI_lineConditionalMediaDetection function is invoked by TAPI whenever a client application uses LINEMAPPER as the dwDeviceID in a lineOpen function call.
TSPI_lineConfigDialog The TSPI_lineConfigDialog function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_lineConfigDialog.
TSPI_lineConfigDialogEdit The TSPI_lineConfigDialogEdit function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_lineConfigDialogEdit.
TSPI_lineCreateMSPInstance The TSPI_lineCreateMSPInstance function directs the TAPI 3 DLL to create a media service provider (MSP) instance for a specific line device. This function returns a TSP handle for the MSP call. This function requires TAPI 3.0 version negotiation.
TSPI_lineDevSpecific The TSPI_lineDevSpecific function is used as a general extension mechanism to enable service providers to provide access to features not described in other operations.
TSPI_lineDevSpecificFeature The TSPI_lineDevSpecificFeature function is used as an extension mechanism to enable service providers to provide access to features not described in other operations.
TSPI_lineDial The TSPI_lineDial function dials the specified dialable number on the specified call.
TSPI_lineDrop The TSPI_lineDrop function drops or disconnects the specified call.
TSPI_lineForward The TSPI_lineForward function forwards calls destined for the specified address on the specified line, according to the specified forwarding instructions.
TSPI_lineGatherDigits The TSPI_lineGatherDigits function initiates the buffered gathering of digits on the specified call. TAPI specifies a buffer in which to place the digits and the maximum number of digits to be collected.
TSPI_lineGenerateDigits The TSPI_lineGenerateDigits function initiates the generation of the specified digits on the specified call as in-band tones using the specified signaling mode.
TSPI_lineGenerateTone The TSPI_lineGenerateTone function generates the specified tone inband over the specified call.
TSPI_lineGetAddressCaps The TSPI_lineGetAddressCaps function queries the specified address on the specified line device to determine its telephony capabilities.
TSPI_lineGetAddressID The TSPI_lineGetAddressID function returns the address identifier associated with address in a different format on the specified line.
TSPI_lineGetAddressStatus The TSPI_lineGetAddressStatus function queries the specified address for its current status.
TSPI_lineGetCallAddressID The TSPI_lineGetCallAddressID function retrieves the address identifier for the indicated call.
TSPI_lineGetCallHubTracking The TSPI_lineGetCallHubTracking function returns the current state of CallHub tracking for the service provider. This function requires TAPI 3.0 version negotiation.
TSPI_lineGetCallIDs The TSPI_lineGetCallIDs function returns the call identifiers for the service provider. This function requires TAPI 3.0 version negotiation.
TSPI_lineGetCallInfo The TSPI_lineGetCallInfo function returns detailed information about the specified call.
TSPI_lineGetCallStatus The TSPI_lineGetCallStatus function returns the current status of the specified call.
TSPI_lineGetDevCaps The TSPI_lineGetDevCaps function queries a specified line device to determine its telephony capabilities. The returned information is valid for all addresses on the line device.
TSPI_lineGetDevConfig The TSPI_lineGetDevConfig function returns a data structure object, the contents of which are specific to the line (service provider) and device class, giving the current configuration of a device associated one-to-one with the line device.
TSPI_lineGetExtensionID The TSPI_lineGetExtensionID function returns the extension identifier that the service provider supports for the indicated line device.
TSPI_lineGetIcon The TSPI_lineGetIcon function retrieves a service line device-specific icon to display to the user.
TSPI_lineGetID The TSPI_lineGetID function returns a device identifier for the specified device class associated with the selected line, address, or call.
TSPI_lineGetLineDevStatus The TSPI_lineGetLineDevStatus function queries the specified open line device for its current status. The information returned is global to all addresses on the line.
TSPI_lineGetNumAddressIDs The TSPI_lineGetNumAddressIDs function retrieves the number of address identifiers supported on the indicated line.
TSPI_lineHold The TSPI_lineHold function places the specified call on hold.
TSPI_lineMakeCall The TSPI_lineMakeCall function places a call on the specified line to the specified destination address. Optionally, call parameters can be specified if anything but default call setup parameters are requested.
TSPI_lineMonitorDigits The TSPI_lineMonitorDigits function enables and disables the unbuffered detection of digits received on the call.
TSPI_lineMonitorMedia The TSPI_lineMonitorMedia function enables and disables the detection of media types on the specified call. When a media type is detected, a LINE_MONITORMEDIA message is sent to TAPI.
TSPI_lineMonitorTones The TSPI_lineMonitorTones function enables and disables the detection of inband tones on the call. Each time a specified tone is detected, a message is sent to the client application through TAPI.
TSPI_lineMSPIdentify The TSPI_lineMSPIdentify function determines the associated MSP CLSID for every line. This function requires TAPI 3.0 version negotiation.
TSPI_lineNegotiateExtVersion The TSPI_lineNegotiateExtVersion function returns the highest extension version number the service provider can operate under for this device, given the range of possible extension versions.
TSPI_lineNegotiateTSPIVersion The TSPI_lineNegotiateTSPIVersion function returns the highest SPI version the service provider can operate under for this device, given the range of possible SPI versions.
TSPI_lineOpen The TSPI_lineOpen function opens the line device whose device identifier is given, returning the service provider's handle for the device.
TSPI_linePark The TSPI_linePark function parks the specified call according to the specified park mode.
TSPI_linePickup The TSPI_linePickup function picks up a call alerting at the specified destination address and returns a call handle for the picked-up call.
TSPI_linePrepareAddToConference The TSPI_linePrepareAddToConference function prepares an existing conference call for the addition of another party. It creates a new, temporary consultation call. The new consultation call can be subsequently added to the conference call.
TSPI_lineReceiveMSPData The TSPI_lineReceiveMSPData function service provider receives data sent by the media service provider (MSP). This function requires TAPI 3.0 version negotiation.
TSPI_lineRedirect The TSPI_lineRedirect function redirects the specified offering call to the specified destination address.
TSPI_lineReleaseUserUserInfo The TSPI_lineReleaseUserUserInfo function informs the service provider that the user-user information contained in the LINECALLINFO structure has been processed, and that subsequently received user-user information can now be written into that structure.
TSPI_lineRemoveFromConference The TSPI_lineRemoveFromConference function removes the specified call from the conference call to which it currently belongs. The remaining calls in the conference call are unaffected.
TSPI_lineSecureCall The TSPI_lineSecureCall function secures the call from any interruptions or interference that can affect the call's media stream.
TSPI_lineSelectExtVersion The TSPI_lineSelectExtVersion function selects the indicated extension version for the indicated line device. Subsequent requests operate according to that extension version.
TSPI_lineSendUserUserInfo The TSPI_lineSendUserUserInfo function sends user-user information to the remote party on the specified call.
TSPI_lineSetAppSpecific The TSPI_lineSetAppSpecific function sets the application-specific field of the specified call's LINECALLINFO structure.
TSPI_lineSetCallData The TSPI_lineSetCallData function service provider stores the indicated call data with its information related to the call, and subsequently delivers it whenever TSPI_lineGetCallInfo is called.
TSPI_lineSetCallHubTracking The TSPI_lineSetCallHubTracking function sets the CallHub tracking mode. This function requires TAPI 3.0 version negotiation.
TSPI_lineSetCallParams The TSPI_lineSetCallParams function sets certain parameters for an existing call.
TSPI_lineSetCallQualityOfService The TSPI_lineSetCallQualityOfService function service provider attempts to renegotiate the QOS on the call with the switch If the desired QOS is not available, then the function fails, but the call continues with the previous QOS.
TSPI_lineSetCallTreatment The TSPI_lineSetCallTreatment function service provider stores the indicated dwCallTreatment in LINECALLINFO, and sends a LINE_CALLINFO message to indicate the updated information.
TSPI_lineSetDefaultMediaDetection The TSPI_lineSetDefaultMediaDetection procedure tells the service provider the new set of media types to detect for the indicated line (replacing any previous set).
TSPI_lineSetDevConfig The TSPI_lineSetDevConfig function restores the configuration of a device associated one-to-one with the line device from a data structure previously obtained using TSPI_lineGetDevConfig.
TSPI_lineSetLineDevStatus The TSPI_lineSetLineDevStatus service provider sets the device status as indicated, sending appropriate LINE_LINEDEVSTATE messages to indicate the new status.
TSPI_lineSetMediaControl The TSPI_lineSetMediaControl function enables and disables control actions on the media stream associated with the specified line, address, or call.
TSPI_lineSetMediaMode The TSPI_lineSetMediaMode function changes the call's media as stored in the call's LINECALLINFO structure.
TSPI_lineSetStatusMessages The TSPI_lineSetStatusMessages function enables TAPI to specify which notification messages the service provider should generate for events related to status changes for the specified line or any of its addresses.
TSPI_lineSetTerminal The TSPI_lineSetTerminal function enables TAPI to specify to which terminal information related to the specified line, address, or call is to be routed.
TSPI_lineSetupConference The TSPI_lineSetupConference function sets up a conference call for the addition of the third party.
TSPI_lineSetupTransfer The TSPI_lineSetupTransfer function initiates a transfer of the call specified by hdCall. It establishes a consultation call, lphdConsultCall, on which the party can be dialed that can become the destination of the transfer.
TSPI_lineSwapHold The TSPI_lineSwapHold function swaps the specified active call with the specified call on consultation hold.
TSPI_lineUncompleteCall The TSPI_lineUncompleteCall function is used to cancel the specified call completion request on the specified line.
TSPI_lineUnhold The TSPI_lineUnhold function retrieves the specified held call.
TSPI_lineUnpark The TSPI_lineUnpark function retrieves the call parked at the specified address and returns a call handle for it.
TSPI_phoneClose The TSPI_phoneClose function closes the specified open phone device after completing or aborting all outstanding asynchronous operations on the device.
TSPI_phoneConfigDialog The TSPI_phoneConfigDialog function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_phoneConfigDialog.
TSPI_phoneDevSpecific The TSPI_phoneDevSpecific function is used as a general extension mechanism to enable a Telephony API implementation to provide features not described in the other operations. The meanings of these extensions are device specific.
TSPI_phoneGetButtonInfo The TSPI_phoneGetButtonInfo function returns information about a specified button.
TSPI_phoneGetData The TSPI_phoneGetData function uploads the information from the specified location in the open phone device to the specified buffer.
TSPI_phoneGetDevCaps The TSPI_phoneGetDevCaps function queries a specified phone device to determine its telephony capabilities.
TSPI_phoneGetDisplay The TSPI_phoneGetDisplay function returns the current contents of the specified phone display.
TSPI_phoneGetExtensionID The TSPI_phoneGetExtensionID function retrieves the extension identifier that the service provider supports for the indicated phone device.
TSPI_phoneGetGain The TSPI_phoneGetGain function returns the gain setting of the microphone of the specified phone's hookswitch device.
TSPI_phoneGetHookSwitch The TSPI_phoneGetHookSwitch function returns the current hookswitch mode of the specified open phone device.
TSPI_phoneGetIcon The TSPI_phoneGetIcon function retrieves a service phone device-specific (or provider-specific) icon to display to the user.
TSPI_phoneGetID The TSPI_phoneGetID function returns a device identifier for the given device class associated with the specified phone device.
TSPI_phoneGetLamp The TSPI_phoneGetLamp function returns the current lamp mode of the specified lamp.
TSPI_phoneGetRing The TSPI_phoneGetRing function enables an application to query the specified open phone device as to its current ring mode.
TSPI_phoneGetStatus The TSPI_phoneGetStatus function queries the specified open phone device for its overall status.
TSPI_phoneGetVolume The TSPI_phoneGetVolume function returns the volume setting of the specified phone's hookswitch device.
TSPI_phoneNegotiateExtVersion The TSPI_phoneNegotiateExtVersion function returns the highest extension version number the service provider can operate under for this device, given the range of possible extension versions.
TSPI_phoneNegotiateTSPIVersion The TSPI_phoneNegotiateTSPIVersion function returns the highest SPI version the service provider can operate under for this device, given the range of possible SPI versions.
TSPI_phoneOpen The TSPI_phoneOpen function opens the phone device whose device identifier is given, returning the service provider's opaque handle for the device and retaining TAPI's opaque handle for the device for use in subsequent calls to the PHONEEVENT procedure.
TSPI_phoneSelectExtVersion The TSPI_phoneSelectExtVersion function selects the indicated extension version for the indicated phone device. Subsequent requests operate according to that extension version.
TSPI_phoneSetButtonInfo The TSPI_phoneSetButtonInfo function sets information about the specified button on the specified phone.
TSPI_phoneSetData The TSPI_phoneSetData function downloads the information in the specified buffer to the opened phone device at the selected data identifier.
TSPI_phoneSetDisplay The TSPI_phoneSetDisplay function causes the specified string to be displayed on the specified open phone device.
TSPI_phoneSetGain The TSPI_phoneSetGain function sets the gain of the microphone of the specified hookswitch device to the specified gain level.
TSPI_phoneSetHookSwitch The TSPI_phoneSetHookSwitch function sets the hook state of the specified open phone's hookswitch devices to the specified mode. Only the hookswitch state of the hookswitch devices listed is affected.
TSPI_phoneSetLamp The TSPI_phoneSetLamp function causes the specified lamp to be set on the specified open phone device in the specified lamp mode.
TSPI_phoneSetRing The TSPI_phoneSetRing function rings the specified open phone device using the specified ring mode and volume.
TSPI_phoneSetStatusMessages The TSPI_phoneSetStatusMessages function causes the service provider to filter status messages that are not currently of interest to any application.
TSPI_phoneSetVolume The TSPI_phoneSetVolume function sets the volume of the speaker component of the specified hookswitch device to the specified level.
TSPI_providerConfig The TSPI_providerConfig function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_providerConfig.
TSPI_providerCreateLineDevice The TSPI_providerCreateLineDevice function is called by TAPI in response to receipt of a LINE_CREATE message from the service provider, which allows the dynamic creation of a new line device.
TSPI_providerCreatePhoneDevice The TSPI_providerCreatePhoneDevice function is called by TAPI in response to receipt of a PHONE_CREATE message from the service provider, which allows the dynamic creation of a new phone device.
TSPI_providerEnumDevices TAPI calls the TSPI_providerEnumDevices function before TSPI_providerInit to determine the number of line and phone devices supported by the service provider.
TSPI_providerFreeDialogInstance The TSPI_providerFreeDialogInstance function informs the service provider that the dialog box associated with hdDlgInst has exited.
TSPI_providerGenericDialogData The TSPI_providerGenericDialogData function delivers to the service provider data that was sent from the UI DLL running in an application context through the TUISPIDLLCALLBACK function.
TSPI_providerInit The TSPI_providerInit function initializes the service provider and gives it parameters required for subsequent operations.
TSPI_providerInstall The TSPI_providerInstall function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_providerInstall.
TSPI_providerRemove The TSPI_providerRemove function is obsolete. TAPI version 1.4 or earlier service providers can implement this TSPI function. TAPI version 2.0 or later TSPs implement TUISPI_providerRemove.
TSPI_providerShutdown The TSPI_providerShutdown function shuts down the service provider. The service provider terminates any activities it has in progress and releases any resources it has allocated.
TSPI_providerUIIdentify The TSPI_providerUIIdentify function extracts from the service provider the fully qualified path to load the service provider's UI DLL component.
TUISPI_lineConfigDialog The TUISPI_lineConfigDialog function causes the provider of the specified line device to display a modal dialog box as a child window of hwndOwner to allow the user to configure parameters related to the line device.
TUISPI_lineConfigDialogEdit The TUISPI_lineConfigDialogEdit function causes the provider of the specified line device to display a modal dialog box as a child window of hwndOwner to allow the user to configure parameters related to the line device.
TUISPI_phoneConfigDialog The TUISPI_phoneConfigDialog function causes the provider of the specified phone device to display a modal dialog box as a child window of hwndOwner to allow the user to configure parameters related to the phone device.
TUISPI_providerConfig The TUISPI_providerConfig function implements the UI elements that must execute in the context of the calling application. This function makes the TSPI_providerConfig function obsolete in version 2.0 and later (supported in version 1.4 and earlier).
TUISPI_providerGenericDialog The TUISPI_providerGenericDialog function in the UI DLL is called when the service provider sends a LINE_CREATEDIALOGINSTANCE message.
TUISPI_providerGenericDialogData The TUISPI_providerGenericDialogData function in the UI DLL is called when the service provider sends a LINE_SENDDIALOGINSTANCEDATA message.
TUISPI_providerInstall Implementation of the TUISPI_providerInstall function is the service provider's opportunity to install any additional "pieces" of the provider into the right directories and set up registry entries the provider needs.
TUISPI_providerRemove The TUISPI_providerRemove function asks the user to confirm elimination of the service provider. This function makes the TSPI_providerRemove function obsolete in version 2.0 and later (supported in version 1.4 and earlier).

Callback functions

Title Description
ASYNC_COMPLETION Completion_Proc is a callback function implemented by TAPI and supplied to the service provider as a parameter to TSPI_providerInit.
LINEEVENT Line_Event is a callback function implemented by TAPI and supplied to the service provider as a parameter to TSPI_lineOpen. The service provider calls this function to report events that occur on the line or on calls on the line.
PHONEEVENT Phone_Event a callback function implemented by TAPI and supplied to the service provider as a parameter to TSPI_phoneOpen. The service provider calls this function to report events that occur on the phone.
TUISPIDLLCALLBACK The DllCallbackProc function is called by the UI DLL to send a private parameter block to the service provider.

Structures

Title Description
TUISPICREATEDIALOGINSTANCEPARAMS The TUISPI data structure is defined below.