ホーム › Devices.Tapi › ITCustomTone

ITCustomTone

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID357ad764-b3c6-4b2a-8fa5-0722827a9254継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ITCustomTone インターフェースは、一部の電話機で利用できるカスタムトーンを詳細に制御するためのメソッドを公開します。

メソッド 8

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

vtbl 7 HRESULT get_Frequency(INT* plFrequency)

get_Frequency メソッドは、生成するトーン成分の周波数を取得します。

plFrequency

INT*

out

トーン成分の周波数(ヘルツ単位)を受け取る値へのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

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

vtbl 8 HRESULT put_Frequency(INT lFrequency)

put_Frequency メソッドは、生成するトーン成分の周波数を設定します。

lFrequency

INT

トーン成分の周波数(ヘルツ単位)を指定します。

戻り値

このメソッドは次のいずれかの値を返します。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 9 HRESULT get_CadenceOn(INT* plCadenceOn)

get_CadenceOn メソッドは、生成するカスタムトーンのケイデンスの「オン」継続時間を取得します。

plCadenceOn

INT*

out

カスタムトーンのケイデンスの「オン」継続時間(ミリ秒単位)を受け取る値へのポインター。ゼロはトーンが生成されないことを意味します。

戻り値

このメソッドは次のいずれかの値を返します。

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

vtbl 10 HRESULT put_CadenceOn(INT CadenceOn)

put_CadenceOn メソッドは、生成するカスタムトーンのケイデンスの「オン」継続時間を設定します。

CadenceOn

INT

生成するカスタムトーンのケイデンスの「オン」継続時間(ミリ秒単位)を指定します。ゼロはトーンが生成されないことを意味します。

戻り値

このメソッドは次のいずれかの値を返します。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 11 HRESULT get_CadenceOff(INT* plCadenceOff)

get_CadenceOff メソッドは、生成するカスタムトーンのケイデンスの「オフ」継続時間を取得します。

plCadenceOff

INT*

out

カスタムトーンのケイデンスの「オフ」継続時間(ミリ秒単位)を受け取る値へのポインター。ゼロはオフ時間がないこと、つまり連続したトーンであることを意味します。

戻り値

このメソッドは次のいずれかの値を返します。

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

vtbl 12 HRESULT put_CadenceOff(INT lCadenceOff)

put_CadenceOff メソッドは、生成するカスタムトーンのケイデンスの「オフ」継続時間を設定します。

lCadenceOff

INT

生成するカスタムトーンのケイデンスの「オフ」継続時間(ミリ秒単位)を指定します。ゼロはオフ時間がないこと、つまり連続したトーンであることを意味します。

戻り値

このメソッドは次のいずれかの値を返します。

戻り値	説明
S_OK	メソッドは成功しました。

vtbl 13 HRESULT get_Volume(INT* plVolume)

get_Volume メソッドは、トーンを生成する音量レベルを取得します。

plVolume

INT*

out

音量レベルを受け取る値へのポインター。0x0000FFFF は最大音量を表し、0x00000000 は無音を表します。

戻り値

このメソッドは次のいずれかの値を返します。

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

vtbl 14 HRESULT put_Volume(INT lVolume)

put_Volume メソッドは、トーンを生成する音量レベルを設定します。

lVolume

INT

トーンの音量レベルを指定します。0x0000FFFF は最大音量を表し、0x00000000 は無音を表します。

戻り値

このメソッドは次のいずれかの値を返します。

戻り値	説明
S_OK	メソッドは成功しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITCustomTone "{357AD764-B3C6-4B2A-8FA5-0722827A9254}"
#usecom global ITCustomTone IID_ITCustomTone "{}"
#comfunc global ITCustomTone_get_Frequency   7 var
#comfunc global ITCustomTone_put_Frequency   8 int
#comfunc global ITCustomTone_get_CadenceOn   9 var
#comfunc global ITCustomTone_put_CadenceOn   10 int
#comfunc global ITCustomTone_get_CadenceOff  11 var
#comfunc global ITCustomTone_put_CadenceOff  12 int
#comfunc global ITCustomTone_get_Volume      13 var
#comfunc global ITCustomTone_put_Volume      14 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_ITCustomTone "{357AD764-B3C6-4B2A-8FA5-0722827A9254}"
#usecom global ITCustomTone IID_ITCustomTone "{}"
#comfunc global ITCustomTone_get_Frequency   7 sptr
#comfunc global ITCustomTone_put_Frequency   8 int
#comfunc global ITCustomTone_get_CadenceOn   9 sptr
#comfunc global ITCustomTone_put_CadenceOn   10 int
#comfunc global ITCustomTone_get_CadenceOff  11 sptr
#comfunc global ITCustomTone_put_CadenceOff  12 int
#comfunc global ITCustomTone_get_Volume      13 sptr
#comfunc global ITCustomTone_put_Volume      14 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。