Edit

Share via

ITLegacyCallMediaControl2::DetectTones method (tapi3if.h)

  • Article

The DetectTones method enables and disables the detection of inband tones on the call. Each time a specified tone is detected, a message is sent to the application.

This method is intended for C/C++ applications. Visual Basic and scripting applications should use the DetectTonesByCollection method instead.

Syntax

HRESULT DetectTones(
  [in] TAPI_DETECTTONE *pToneList,
  [in] long            lNumTones
);

Parameters

[in] pToneList

Pointer to a TAPI_DETECTTONE array that specifies the tones to detect. Each tone in the array has an application-defined tag field that is used to identify the individual tones in the list when a tone detection event of type TE_TONEEVENT is reported. For more information, see the following Remarks section.

[in] lNumTones

The number of entries in the array specified by the pToneList parameter. This parameter is ignored if pToneList is NULL.

Return value

This method can return one of these values.

Return code Description
S_OK
 Method succeeded.
E_POINTER
 The pToneList parameter is not a valid pointer.
TAPI_E_INVALCALLSTATE
 The call must be in the connected state.

Remarks

This method translates to a TAPI 2.x lineMonitorTones call.

To cancel tone monitoring in progress, call the DetectTones method and specify a NULLpToneList parameter. To change the list of tones to monitor, call this method and specify a new tone list.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h
Library Uuid.lib
DLL Tapi3.dll

See also

ITLegacyCallMediaControl2

TAPI_DETECTTONE