Edit

Share via

ITDetectTone::get_Frequency method (tapi3if.h)

  • Article

The get_Frequency method retrieves the frequency of the tone for which the TAPI Server generates a tone event.

Syntax

HRESULT get_Frequency(
  [in]  long Index,
  [out] long *plFrequency
);

Parameters

[in] Index

Specifies the index of the tone.

[out] plFrequency

Pointer to a value to receive the frequency, in hertz, of the tone. For more information, see the following Remarks section.

Return value

This method can return one of these values.

Return code Description
S_OK
 Method succeeded.
E_POINTER
 The plFrequency parameter is not a valid pointer.

Remarks

You can set up to three frequencies that make up the components of a tone. If fewer than three frequencies are required, specify a value of zero for the unused frequencies. A tone with all three frequencies set to zero is interpreted as silence and can be used for silence detection.

Requirements

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

See also

ITDetectTone

put_Frequency