Win32 API 日本語リファレンス
ホームDevices.Tapi › ITDetectTone

ITDetectTone

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID961f79bd-3097-49df-a1d6-909b77e89ca0継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITDetectTone インターフェースは、TAPI Server がトーンイベントを生成する契機となるトーンおよびトーンの特性をアプリケーションが指定できるようにするメソッドを公開します。

メソッド 6

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 7 HRESULT get_AppSpecific(INT* plAppSpecific)

get_AppSpecific メソッドは、検出するトーンを識別するためのアプリケーション定義のタグを取得します。

plAppSpecificINT*outトーンのアプリケーション固有の識別子を受け取る値へのポインター。TAPI Server がトーンを検出すると、このパラメーターの値は TE_TONEEVENT イベントでアプリケーションに返されます。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

リターンコード 説明
S_OK
メソッドが成功しました。
E_POINTER
plAppSpecific パラメーターが有効なポインターではありません。
vtbl 8 HRESULT put_AppSpecific(INT lAppSpecific)

put_AppSpecific メソッドは、検出するトーンを識別するためのアプリケーション定義のタグを設定します。

lAppSpecificINTin検出するトーンを識別するアプリケーション固有のタグを指定します。TAPI Server がトーンを検出すると、このパラメーターの値は TE_TONEEVENT イベントでアプリケーションに返されます。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

リターンコード 説明
S_OK
メソッドが成功しました。
vtbl 9 HRESULT get_Duration(INT* plDuration)

get_Duration メソッドは、TAPI Server がトーンイベントを生成する前にトーンが存在している必要がある時間の長さを取得します。

plDurationINT*out指定したトーンが存在している必要があるトーンの継続時間(ミリ秒単位)を受け取る値へのポインター。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

リターンコード 説明
S_OK
メソッドが成功しました。
E_POINTER
plDuration パラメーターが有効なポインターではありません。
vtbl 10 HRESULT put_Duration(INT lDuration)

put_Duration メソッドは、TAPI Server がトーンイベントを生成する前にトーンが存在している必要がある時間の長さを設定します。

lDurationINTin指定したトーンが存在している必要があるトーンの継続時間(ミリ秒単位)を指定します。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

リターンコード 説明
S_OK
メソッドが成功しました。
vtbl 11 HRESULT get_Frequency(INT Index, INT* plFrequency)

get_Frequency メソッドは、TAPI Server がトーンイベントを生成する対象となるトーンの周波数を取得します。

IndexINTinトーンのインデックスを指定します。
plFrequencyINT*outトーンの周波数(ヘルツ単位)を受け取る値へのポインター。詳細については、次の「解説」セクションを参照してください。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

リターンコード 説明
S_OK
メソッドが成功しました。
E_POINTER
plFrequency パラメーターが有効なポインターではありません。

解説(Remarks)

トーンを構成する成分として、最大 3 つの周波数を設定できます。必要な周波数が 3 つ未満の場合は、使用しない周波数に値 0 を指定します。3 つの周波数がすべて 0 に設定されたトーンは無音として解釈され、無音の検出に使用できます。

vtbl 12 HRESULT put_Frequency(INT Index, INT lFrequency)

put_Frequency メソッドは、TAPI Server がトーンイベントを生成する対象となるトーンの周波数を設定します。

IndexINTin設定するトーンのインデックスを指定します。
lFrequencyINTinトーンの周波数(ヘルツ単位)を指定します。詳細については、次の「解説」セクションを参照してください。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

リターンコード 説明
S_OK
メソッドが成功しました。

解説(Remarks)

トーンを構成する成分として、最大 3 つの周波数を設定できます。必要な周波数が 3 つ未満の場合は、使用しない周波数に値 0 を指定します。3 つの周波数がすべて 0 に設定されたトーンは無音として解釈され、無音の検出に使用できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_ITDetectTone "{961F79BD-3097-49DF-A1D6-909B77E89CA0}"
#usecom global ITDetectTone IID_ITDetectTone "{}"
#comfunc global ITDetectTone_get_AppSpecific  7 var
#comfunc global ITDetectTone_put_AppSpecific  8 int
#comfunc global ITDetectTone_get_Duration     9 var
#comfunc global ITDetectTone_put_Duration     10 int
#comfunc global ITDetectTone_get_Frequency    11 int,var
#comfunc global ITDetectTone_put_Frequency    12 int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。