Win32 API 日本語リファレンス
ホーム › Media.Audio › IAudioLoudness

IAudioLoudness

COM
📘 Microsoft Learn (日本語) · English
IID7d8b1437-dd53-4350-9c1b-1ee2890bd938継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IAudioLoudness インターフェイスは、「ラウドネス」補正コントロールへのアクセスを提供します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetEnabled(BOOL* pbEnabled)

GetEnabled メソッドは、ラウドネスコントロールの現在の状態(有効または無効)を取得します。

pbEnabledBOOL*out現在のラウドネス状態が書き込まれる BOOL 変数へのポインター。状態が TRUE の場合、ラウドネスは有効です。FALSE の場合、ラウドネスは無効です。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値コード 説明
E_POINTER
 ポインター pbEnabled が NULL です。
vtbl 4 HRESULT SetEnabled(BOOL bEnable, GUID* pguidEventContext)

SetEnabled メソッドは、ラウドネスコントロールを有効または無効にします。

bEnableBOOLin新しいラウドネス状態。bEnable が TRUE(非ゼロ)の場合、メソッドはラウドネスを有効にします。FALSE の場合、ラウドネスを無効にします。
pguidEventContextGUID*inoptionalIControlChangeNotify::OnNotify メソッドのコンテキスト値。このパラメーターはイベントコンテキスト GUID を指します。SetEnabled の呼び出しによってラウドネスコントロールの状態が変化した場合、そのコントロールに対して IControlChangeNotify インターフェイスを登録しているすべてのクライアントが通知を受け取ります。OnNotify メソッドの実装において、クライアントはイベントコンテキスト GUID を調べることで、コントロール変更イベントの発生元が自身なのか別のクライアントなのかを判別できます。呼び出し元がこのパラメーターに NULL ポインターを指定した場合、クライアントの通知メソッドは NULL コンテキストポインターを受け取ります。

戻り値

メソッドが成功した場合は S_OK を返します。失敗した場合、返される可能性のあるコードには、次の表に示す値が含まれますが、これらに限定されません。

戻り値コード 説明
E_OUTOFMEMORY
 メモリ不足です。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAudioLoudness "{7D8B1437-DD53-4350-9C1B-1EE2890BD938}"
#usecom global IAudioLoudness IID_IAudioLoudness "{}"
#comfunc global IAudioLoudness_GetEnabled  3 var
#comfunc global IAudioLoudness_SetEnabled  4 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。