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

ITScriptableAudioFormat

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

公式ドキュメント

ITScriptableAudioFormat インターフェイスは、スクリプト可能なクライアントがトラックのオーディオ形式を取得または設定するために使用します。このインターフェイスは、WAVEFORMATEX 構造体の各メンバーに対応するプロパティを提供します。

メソッド 12

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

vtbl 7 HRESULT get_Channels(INT* pVal)

get_Channels メソッドは、WAVEFORMATEX 構造体の nChannels メンバーの値を返します。

pValINT*outWAVEFORMATEX 構造体の nChannels メンバーの値へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pVal 引数が有効なポインターではありません。
vtbl 8 HRESULT put_Channels(INT nNewVal)

put_Channels メソッドは、WAVEFORMATEX 構造体の nChannels メンバーを設定します。

nNewValINTinWAVEFORMATEX 構造体の nChannels メンバーの新しい値。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
vtbl 9 HRESULT get_SamplesPerSec(INT* pVal)

get_SamplesPerSec メソッドは、WAVEFORMATEX 構造体の nSamplesPerSec メンバーの値を返します。

pValINT*outWAVEFORMATEX 構造体の nSamplesPerSec メンバーの値へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pVal 引数が有効なポインターではありません。
vtbl 10 HRESULT put_SamplesPerSec(INT nNewVal)

put_SamplesPerSec メソッドは、WAVEFORMATEX 構造体の nSamplesPerSec メンバーを設定します。

nNewValINTinWAVEFORMATEX 構造体の nSamplesPerSec メンバーの新しい値。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
vtbl 11 HRESULT get_AvgBytesPerSec(INT* pVal)

get_AvgBytesPerSec メソッドは、WAVEFORMATEX 構造体の nAvgBytesPerSec メンバーの値を返します。

pValINT*outWAVEFORMATEX 構造体の nAvgBytesPerSec メンバーの値へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました
E_POINTER
pVal 引数が有効なポインターではありません。
vtbl 12 HRESULT put_AvgBytesPerSec(INT nNewVal)

put_AvgBytesPerSec メソッドは、WAVEFORMATEX 構造体の nAvgBytesPerSec メンバーを設定します。

nNewValINTinWAVEFORMATEX 構造体の nAvgBytesPerSec メンバーの新しい値。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
vtbl 13 HRESULT get_BlockAlign(INT* pVal)

get_BlockAlign メソッドは、WAVEFORMATEX 構造体の nBlockAlign メンバーの値を返します。

pValINT*outWAVEFORMATEX 構造体の nBlockAlign メンバーの値へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pVal 引数が有効なポインターではありません。
vtbl 14 HRESULT put_BlockAlign(INT nNewVal)

put_BlockAlign メソッドは、WAVEFORMATEX 構造体の nBlockAlign メンバーを設定します。

nNewValINTinWAVEFORMATEX 構造体の nBlockAlign メンバーの新しい値。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
vtbl 15 HRESULT get_BitsPerSample(INT* pVal)

get_BitsPerSample メソッドは、WAVEFORMATEX 構造体の wBitsPerSample メンバーの値を返します。

pValINT*outWAVEFORMATEX 構造体の wBitsPerSample メンバーの値へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pVal 引数が有効なポインターではありません。
vtbl 16 HRESULT put_BitsPerSample(INT nNewVal)

put_BitsPerSample メソッドは、WAVEFORMATEX 構造体の wBitsPerSample メンバーを設定します。

nNewValINTinWAVEFORMATEX 構造体の wBitsPerSample メンバーの新しい値。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
vtbl 17 HRESULT get_FormatTag(INT* pVal)

get_FormatTag メソッドは、WAVEFORMATEX 構造体の wFormatTag メンバーの値を返します。

pValINT*outWAVEFORMATEX 構造体の wFormatTag メンバーの値へのポインター。

戻り値

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

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
pVal 引数が有効なポインターではありません。
vtbl 18 HRESULT put_FormatTag(INT nNewVal)

put_FormatTag メソッドは、WAVEFORMATEX 構造体の wFormatTag メンバーを設定します。

nNewValINTinWAVEFORMATEX 構造体の wFormatTag メンバーの新しい値。

戻り値

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

戻り値 説明
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_ITScriptableAudioFormat "{B87658BD-3C59-4F64-BE74-AEDE3E86A81E}"
#usecom global ITScriptableAudioFormat IID_ITScriptableAudioFormat "{}"
#comfunc global ITScriptableAudioFormat_get_Channels        7 var
#comfunc global ITScriptableAudioFormat_put_Channels        8 int
#comfunc global ITScriptableAudioFormat_get_SamplesPerSec   9 var
#comfunc global ITScriptableAudioFormat_put_SamplesPerSec   10 int
#comfunc global ITScriptableAudioFormat_get_AvgBytesPerSec  11 var
#comfunc global ITScriptableAudioFormat_put_AvgBytesPerSec  12 int
#comfunc global ITScriptableAudioFormat_get_BlockAlign      13 var
#comfunc global ITScriptableAudioFormat_put_BlockAlign      14 int
#comfunc global ITScriptableAudioFormat_get_BitsPerSample   15 var
#comfunc global ITScriptableAudioFormat_put_BitsPerSample   16 int
#comfunc global ITScriptableAudioFormat_get_FormatTag       17 var
#comfunc global ITScriptableAudioFormat_put_FormatTag       18 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。