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

IAudioSystemEffectsPropertyStore

COM
📘 Microsoft Learn (日本語) · English
IID302ae7f9-d7e0-43e4-971b-1f8293613d2a継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

オーディオシステムエフェクトのオーディオストアを管理するためのアクセス手段を提供し、オーディオシステムエフェクトのプロパティが変更されたときに通知を受け取るための登録を行います。

解説(Remarks)

この API は、オーディオデバイスに関連付けられたプロパティストアを照会および変更する機能を必要とし、HSA アプリを Microsoft Store で公開したいと考えている OEM やアプリ開発者を支援することを目的としています。この API を使用するには、アプリパッケージマニフェストで制限付きの audioDeviceConfiguration 機能を指定する必要があります。これは制限付き機能です。詳細については、アプリ機能の宣言を参照してください。

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

メソッド 7

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

vtbl 3 HRESULT OpenDefaultPropertyStore(DWORD stgmAccess, IPropertyStore** propStore)

オーディオシステムエフェクトの既定のプロパティストアを開きます。

stgmAccessDWORDin

ストレージアクセスモード。このパラメーターは、プロパティストアを読み取りモード、書き込みモード、または読み取り/書き込みモードのいずれで開くかを指定します。このパラメーターには、次の STGM 定数のいずれかを設定します。

STGM_READ

STGM_WRITE

STGM_READWRITE

このメソッドは、管理者として実行されているクライアントに対して、読み取り専用、書き込み専用、または読み取り/書き込みアクセスでストアを開くことを許可します。管理者として実行されていないクライアントは、読み取り専用アクセスに制限されます。

propStoreIPropertyStore**out既定のプロパティストアを表す IPropertyStore へのポインターを受け取ります。

戻り値

次のものを含む(ただしこれらに限定されない)HRESULT を返します。

値 説明
S_OK 成功
E_NOTFOUND 存在しないプロパティストアを開こうとしています。「解説」を参照してください。
E_ACCESSDENIED 指定された stgmAccess 値に対して呼び出し元のアクセスが拒否されました

解説(Remarks)

このメソッドは、コンテキストレジストリキーの下にある既存のプロパティストアのみを開きます。関連付けられた INF ファイルにキーが存在しない場合でも、新しいキーは作成されません。まだ存在しないプロパティストアにアクセスしようとすると、E_NOTFOUND エラーになります。

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

vtbl 4 HRESULT OpenUserPropertyStore(DWORD stgmAccess, IPropertyStore** propStore)

オーディオシステムエフェクトのユーザープロパティストアを開きます。

stgmAccessDWORDin

ストレージアクセスモード。このパラメーターは、プロパティストアを読み取りモード、書き込みモード、または読み取り/書き込みモードのいずれで開くかを指定します。このパラメーターには、次の STGM 定数のいずれかを設定します。

STGM_READ

STGM_WRITE

STGM_READWRITE

このメソッドは、管理者として実行されているクライアントに対して、読み取り専用、書き込み専用、または読み取り/書き込みアクセスでストアを開くことを許可します。管理者として実行されていないクライアントは、読み取り専用アクセスに制限されます。

propStoreIPropertyStore**outユーザープロパティストアを表す IPropertyStore へのポインターを受け取ります。

戻り値

次のものを含む(ただしこれらに限定されない)HRESULT を返します。

値 説明
S_OK 成功
E_NOTFOUND 存在しないプロパティストアを開こうとしています。「解説」を参照してください。
E_ACCESSDENIED 指定された stgmAccess 値に対して呼び出し元のアクセスが拒否されました

解説(Remarks)

このメソッドは、コンテキストレジストリキーの下にある既存のプロパティストアのみを開きます。関連付けられた INF ファイルにキーが存在しない場合でも、新しいキーは作成されません。まだ存在しないプロパティストアにアクセスしようとすると、E_NOTFOUND エラーになります。

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

vtbl 5 HRESULT OpenVolatilePropertyStore(DWORD stgmAccess, IPropertyStore** propStore)

オーディオシステムエフェクトの揮発性プロパティストアを開きます。

stgmAccessDWORDin

ストレージアクセスモード。このパラメーターは、プロパティストアを読み取りモード、書き込みモード、または読み取り/書き込みモードのいずれで開くかを指定します。このパラメーターには、次の STGM 定数のいずれかを設定します。

STGM_READ

STGM_WRITE

STGM_READWRITE

このメソッドは、管理者として実行されているクライアントに対して、読み取り専用、書き込み専用、または読み取り/書き込みアクセスでストアを開くことを許可します。管理者として実行されていないクライアントは、読み取り専用アクセスに制限されます。

propStoreIPropertyStore**out揮発性プロパティストアを表す IPropertyStore へのポインターを受け取ります。

戻り値

次のものを含む(ただしこれらに限定されない)HRESULT を返します。

値 説明
S_OK 成功
E_NOTFOUND 存在しないプロパティストアを開こうとしています。「解説」を参照してください。
E_ACCESSDENIED 指定された stgmAccess 値に対して呼び出し元のアクセスが拒否されました

解説(Remarks)

このメソッドは、コンテキストレジストリキーの下にある既存のプロパティストアのみを開きます。関連付けられた INF ファイルにキーが存在しない場合でも、新しいキーは作成されません。まだ存在しないプロパティストアにアクセスしようとすると、E_NOTFOUND エラーになります。

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

vtbl 6 HRESULT ResetUserPropertyStore()

オーディオシステムエフェクトのユーザープロパティストア内の既存のすべてのキーと値のペアを削除します。

戻り値

成功した場合は S_OK。

解説(Remarks)

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

vtbl 7 HRESULT ResetVolatilePropertyStore()

オーディオシステムエフェクトの揮発性プロパティストア内の既存のすべてのキーと値のペアを削除します。

戻り値

成功した場合は S_OK。

解説(Remarks)

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

vtbl 8 HRESULT RegisterPropertyChangeNotification(IAudioSystemEffectsPropertyChangeNotificationClient* callback)

オーディオシステムエフェクトのプロパティが変更されたときに通知を受け取るために、IAudioSystemEffectsPropertyChangeNotificationClient コールバックインターフェイスを登録します。

callbackIAudioSystemEffectsPropertyChangeNotificationClient*in登録する IAudioSystemEffectsPropertyChangeNotificationClient コールバックインターフェイスへのポインター。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

このメソッドは APO では使用すべきではなく、ハードウェアサポートアプリが通知の登録を行う場合にのみ使用してください。

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

vtbl 9 HRESULT UnregisterPropertyChangeNotification(IAudioSystemEffectsPropertyChangeNotificationClient* callback)

IAudioSystemEffectsPropertyChangeNotificationClient コールバックインターフェイスの登録を解除します。

callbackIAudioSystemEffectsPropertyChangeNotificationClient*in登録を解除する IAudioSystemEffectsPropertyChangeNotificationClient コールバックインターフェイスへのポインター。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

オーディオドライバーに同梱できる Audio Processing Object (APO) 向けの Windows 11 API の詳細については、Audio Processing Object 向けの Windows 11 APIを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAudioSystemEffectsPropertyStore "{302AE7F9-D7E0-43E4-971B-1F8293613D2A}"
#usecom global IAudioSystemEffectsPropertyStore IID_IAudioSystemEffectsPropertyStore "{}"
#comfunc global IAudioSystemEffectsPropertyStore_OpenDefaultPropertyStore              3 int,sptr
#comfunc global IAudioSystemEffectsPropertyStore_OpenUserPropertyStore                 4 int,sptr
#comfunc global IAudioSystemEffectsPropertyStore_OpenVolatilePropertyStore             5 int,sptr
#comfunc global IAudioSystemEffectsPropertyStore_ResetUserPropertyStore                6
#comfunc global IAudioSystemEffectsPropertyStore_ResetVolatilePropertyStore            7
#comfunc global IAudioSystemEffectsPropertyStore_RegisterPropertyChangeNotification    8 sptr
#comfunc global IAudioSystemEffectsPropertyStore_UnregisterPropertyChangeNotification  9 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。