ホーム › Devices.Tapi › ITLegacyCallMediaControl2

ITLegacyCallMediaControl2

COMIDispatch (デュアル)

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID57ca332d-7bc2-44f1-a60c-936fe8d7ce73継承元ITLegacyCallMediaControl呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl12

公式ドキュメント

ITLegacyCallMediaControl2 インターフェイスは、ITLegacyCallMediaControl インターフェイスを拡張したものです。ITLegacyCallMediaControl2 は、主にトーンの検出と生成のための追加メソッドを提供します。

メソッド 10

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

vtbl 12 HRESULT GenerateDigits2(LPWSTR pDigits, INT DigitMode, INT lDuration)

GenerateDigits2 メソッドは、現在のコールにダイヤル数字を出力させます。このメソッドは、ITLegacyCallMediaControl::GenerateDigits メソッドに duration(継続時間)パラメーターを追加して拡張したものです。

pDigits	LPWSTR	in	生成するダイヤル数字の BSTR 表現へのポインター。
DigitMode	INT	in	ダイヤル数字のモードを示します。有効な値は、TAPI 2.x の LINEDIGITMODE_constants の値です。
lDuration	INT	in	DTMF ダイヤル数字およびパルスの継続時間(ミリ秒単位)と、DTMF のダイヤル数字間の間隔の両方を指定します。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pDigits パラメーターが有効なポインターではありません。
TAPI_E_INVALCALLSTATE	コールは接続済み状態でなければなりません。

解説(Remarks)

このメソッドは、TAPI 2.x の lineGenerateDigits 関数の呼び出しに変換されます。

ダイヤル数字の生成が完了すると、TE_GENERATEEVENT 型のイベントが生成されます。

vtbl 13 HRESULT GatherDigits(INT DigitMode, INT lNumDigits, LPWSTR pTerminationDigits, INT lFirstDigitTimeout, INT lInterDigitTimeout)

GatherDigits メソッドは、指定したコールでのダイヤル数字の収集を開始します。アプリケーションは、収集するダイヤル数字の最大数を指定します。

DigitMode	INT	in	監視するダイヤル数字モード。このパラメーターには、 LINEDIGITMODE 定数のうち 1 つ以上を指定します。
lNumDigits	INT	in	収集するダイヤル数字の数。このパラメーターが 0 の場合、このメソッドは進行中のダイヤル数字収集を新たに開始せずにキャンセルします。詳細については、次の「解説」セクションを参照してください。
pTerminationDigits	LPWSTR	in	終了ダイヤル数字の BSTR 表現へのポインター。文字列内の終了ダイヤル数字のいずれかが検出されると、そのダイヤル数字がバッファーに追加され、ダイヤル数字の収集が終了して、TE_GATHERDIGITS イベントがアプリケーションに送信されます。
lFirstDigitTimeout	INT	in	最初のダイヤル数字を待機する時間の長さ(ミリ秒単位)。この時間内に最初のダイヤル数字が受信されない場合、ダイヤル数字の収集は中止され、TE_GATHERDIGITS イベントがアプリケーションに送信されます。バッファーには NULL 文字のみが格納され、ダイヤル数字が受信されず、最初のダイヤル数字のタイムアウトによってダイヤル数字収集が終了したことを示します。指定できる最小および最大のタイムアウトは、AC_GATHERDIGITSMINTIMEOUT および AC_GATHERDIGITSMAXTIMEOUT 機能で確認できます。
lInterDigitTimeout	INT	in	連続するダイヤル数字間の最大時間(ミリ秒単位)。この時間内に次のダイヤル数字が受信されない場合、ダイヤル数字の収集は中止され、TE_GATHERDIGITS イベントがアプリケーションに送信されます。バッファーにはその時点までに収集されたダイヤル数字のみが格納され、その後に NULL 文字が続き、ダイヤル数字間のタイムアウトによってダイヤル数字収集が終了したことを示します。指定できる最小および最大のタイムアウトは、AC_GATHERDIGITSMINTIMEOUT および AC_GATHERDIGITSMAXTIMEOUT 機能で確認できます。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pTerminationDigits パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	ダイヤル数字収集バッファーを割り当てるのに十分なメモリがありません。
TAPI_E_INVALCALLSTATE	コールは接続済み状態でなければなりません。

解説(Remarks)

GatherDigits メソッドは、TAPI 2.x の lineGatherDigits 関数の呼び出しに変換されます。

1 つのコールに対して未処理にできる GatherDigits 呼び出しは 1 つだけです。TE_GATHERDIGITS イベントが発生する前に GatherDigits を再度呼び出すと、2 回目の呼び出しによって前回のダイヤル数字収集がキャンセルされます。キャンセルされたダイヤル数字収集は、それまでに収集されたダイヤル数字を含む TE_GATHERDIGITS イベントを送信します。

vtbl 14 HRESULT DetectTones(TAPI_DETECTTONE* pToneList, INT lNumTones)

DetectTones メソッドは、コール上のインバンドトーンの検出を有効または無効にします。指定したトーンが検出されるたびに、メッセージがアプリケーションに送信されます。

pToneList	TAPI_DETECTTONE*	in	検出するトーンを指定する TAPI_DETECTTONE 配列へのポインター。配列内の各トーンには、アプリケーション定義のタグフィールドがあり、TE_TONEEVENT 型のトーン検出イベントが報告されるときにリスト内の個々のトーンを識別するために使用されます。詳細については、次の「解説」セクションを参照してください。
lNumTones	INT	in	pToneList パラメーターで指定された配列内のエントリ数。pToneList が NULL の場合、このパラメーターは無視されます。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pToneList パラメーターが有効なポインターではありません。
TAPI_E_INVALCALLSTATE	コールは接続済み状態でなければなりません。

解説(Remarks)

このメソッドは、TAPI 2.x の lineMonitorTones 呼び出しに変換されます。

進行中のトーン監視をキャンセルするには、 DetectTones メソッドを呼び出し、pToneList パラメーターに NULL を指定します。監視するトーンのリストを変更するには、このメソッドを呼び出し、新しいトーンリストを指定します。

vtbl 15 HRESULT DetectTonesByCollection(ITCollection2* pDetectToneCollection)

DetectTonesByCollection メソッドは、コール上のインバンドトーンの検出を有効または無効にします。指定したトーンが検出されるたびに、メッセージがアプリケーションに送信されます。

pDetectToneCollection

ITCollection2*

監視するトーンを表す ITDetectTone インターフェイスポインターのコレクションを含む ITCollection2 インターフェイスへのポインター。リスト内の各トーンには、アプリケーション定義のタグフィールドがあり、TE_TONEEVENT イベントによってトーン検出が報告されるときに個々のトーンを識別するために使用されます。詳細については、次の「解説」セクションを参照してください。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pDetectToneCollection パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	トーンバッファーを割り当てるのに十分なメモリがありません。
TAPI_E_INVALCALLSTATE	コールは接続済み状態でなければなりません。

解説(Remarks)

このメソッドは、TAPI 2.x の lineMonitorTones 呼び出しに変換されます。

進行中のトーン監視をキャンセルするには、 DetectTonesByCollection メソッドを呼び出し、空のコレクションを指定します。監視するトーンのリストを変更するには、このメソッドを呼び出し、新しいトーンコレクションを指定します。

vtbl 16 HRESULT GenerateTone(TAPI_TONEMODE ToneMode, INT lDuration)

GenerateTone メソッドは、指定したトーンを生成します。

ToneMode	TAPI_TONEMODE	in	トーンモードを示します。使用される値は、 TAPI_TONEMODE 列挙型の値です。
lDuration	INT	in	DTMF ダイヤル数字およびパルスの継続時間(ミリ秒単位)と、DTMF のダイヤル数字間の間隔の両方を指定します。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	いずれかのパラメーターが無効です。
TAPI_E_INVALCALLSTATE	コールは接続済み状態でなければなりません。

解説(Remarks)

このメソッドは、TAPI 2.x の lineGenerateTone 関数の呼び出しに変換されます。

トーンの生成が完了すると、TE_GENERATEEVENT 型のイベントが生成されます。

vtbl 17 HRESULT GenerateCustomTones(TAPI_CUSTOMTONE* pToneList, INT lNumTones, INT lDuration)

GenerateCustomTones メソッドは、指定したカスタムトーンを生成します。

pToneList	TAPI_CUSTOMTONE*	in	生成するトーンを指定する TAPI_CUSTOMTONE 配列へのポインター。
lNumTones	INT	in	pToneList パラメーターで指定された配列内のエントリ数。
lDuration	INT	in	トーンを持続させる継続時間(ミリ秒単位)。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは、TAPI 2.x の lineGenerateTone 関数の呼び出しに変換されます。

vtbl 18 HRESULT GenerateCustomTonesByCollection(ITCollection2* pCustomToneCollection, INT lDuration)

GenerateCustomTonesByCollection メソッドは、指定したカスタムトーンを生成します。

pCustomToneCollection	ITCollection2*	in	トーンの構成要素を表す ITCustomTone インターフェイスポインターのコレクションを含む ITCollection2 インターフェイスへのポインター。コレクションが多重周波数トーンの場合、各トーンは同時に再生されます。
lDuration	INT	in	トーンを持続させる継続時間(ミリ秒単位)。値が 0 の場合は既定の継続時間が使用されます。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_POINTER	pCustomToneCollection パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	トーンバッファーを割り当てるのに十分なメモリがありません。
TAPI_E_INVALCALLSTATE	コールは接続済み状態でなければなりません。

解説(Remarks)

このメソッドは、TAPI 2.x の lineGenerateTone 関数の呼び出しに変換されます。

トーンの生成が完了すると、TE_GENERATEEVENT 型のイベントが生成されます。

vtbl 19 HRESULT CreateDetectToneObject(ITDetectTone** ppDetectTone)

CreateDetectToneObject メソッドは、DetectTonesByCollection メソッドで使用する検出トーンオブジェクトを作成します。

ppDetectTone

ITDetectTone**

out

ITDetectTone インターフェイスへのポインター。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	ppDetectTone パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	オブジェクトを割り当てるのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITLegacyCallMediaControl2::CreateDetectToneObject が返す ITDetectTone インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、それに関連付けられたリソースを解放するために、 ITDetectTone インターフェイスに対して Release メソッドを呼び出す必要があります。

vtbl 20 HRESULT CreateCustomToneObject(ITCustomTone** ppCustomTone)

CreateCustomToneObject メソッドは、GenerateCustomTonesByCollection メソッドで使用するカスタムトーンオブジェクトを作成します。

ppCustomTone

ITCustomTone**

out

ITCustomTone インターフェイスへのポインター。

戻り値

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

値	意味
S_OK	メソッドは成功しました。
E_POINTER	ppCustomTone パラメーターが有効なポインターではありません。
E_OUTOFMEMORY	オブジェクトを割り当てるのに十分なメモリがありません。

解説(Remarks)

TAPI は、ITLegacyCallMediaControl2::CreateCustomToneObject が返す ITCustomTone インターフェイスに対して AddRef メソッドを呼び出します。アプリケーションは、それに関連付けられたリソースを解放するために、 ITCustomTone インターフェイスに対して Release メソッドを呼び出す必要があります。

vtbl 21 HRESULT GetIDAsVariant(LPWSTR bstrDeviceClass, VARIANT* pVarDeviceID)

GetIDAsVariant メソッドは、現在のコールに関連付けられたデバイスの識別子を取得します。

bstrDeviceClass	LPWSTR	in	TAPI デバイスクラスを表す BSTR。
pVarDeviceID	VARIANT*	out	bstrDeviceClass で指定されたデバイスの識別子を含む、VT_ARRAY \| VT_UI1 型のバイトの variant 配列へのポインター。

戻り値

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

戻り値コード	説明
S_OK	メソッドは成功しました。
E_OUTOFMEMORY	操作を実行するのに十分なメモリがありません。
E_POINTER	pVarDeviceID パラメーターが有効なポインターではありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITLegacyCallMediaControl2 "{57CA332D-7BC2-44F1-A60C-936FE8D7CE73}"
#usecom global ITLegacyCallMediaControl2 IID_ITLegacyCallMediaControl2 "{}"
#comfunc global ITLegacyCallMediaControl2_GenerateDigits2                  12 wstr,int,int
#comfunc global ITLegacyCallMediaControl2_GatherDigits                     13 int,int,wstr,int,int
#comfunc global ITLegacyCallMediaControl2_DetectTones                      14 var,int
#comfunc global ITLegacyCallMediaControl2_DetectTonesByCollection          15 sptr
#comfunc global ITLegacyCallMediaControl2_GenerateTone                     16 int,int
#comfunc global ITLegacyCallMediaControl2_GenerateCustomTones              17 var,int,int
#comfunc global ITLegacyCallMediaControl2_GenerateCustomTonesByCollection  18 sptr,int
#comfunc global ITLegacyCallMediaControl2_CreateDetectToneObject           19 sptr
#comfunc global ITLegacyCallMediaControl2_CreateCustomToneObject           20 sptr
#comfunc global ITLegacyCallMediaControl2_GetIDAsVariant                   21 wstr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITLegacyCallMediaControl2 "{57CA332D-7BC2-44F1-A60C-936FE8D7CE73}"
#usecom global ITLegacyCallMediaControl2 IID_ITLegacyCallMediaControl2 "{}"
#comfunc global ITLegacyCallMediaControl2_GenerateDigits2                  12 wstr,int,int
#comfunc global ITLegacyCallMediaControl2_GatherDigits                     13 int,int,wstr,int,int
#comfunc global ITLegacyCallMediaControl2_DetectTones                      14 sptr,int
#comfunc global ITLegacyCallMediaControl2_DetectTonesByCollection          15 sptr
#comfunc global ITLegacyCallMediaControl2_GenerateTone                     16 int,int
#comfunc global ITLegacyCallMediaControl2_GenerateCustomTones              17 sptr,int,int
#comfunc global ITLegacyCallMediaControl2_GenerateCustomTonesByCollection  18 sptr,int
#comfunc global ITLegacyCallMediaControl2_CreateDetectToneObject           19 sptr
#comfunc global ITLegacyCallMediaControl2_CreateCustomToneObject           20 sptr
#comfunc global ITLegacyCallMediaControl2_GetIDAsVariant                   21 wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。