EVT_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE コールバック関数 (acxelements.h)

EVT_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE コールバック関数はドライバーによって実装され、指定されたオーディオ エンジン ノードにグローバル効果の状態が要求されたときに呼び出されます。

構文

EVT_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE EvtAcxAudioengineRetrieveEffectsState;

NTSTATUS EvtAcxAudioengineRetrieveEffectsState(
  ACXAUDIOENGINE AudioEngine,
  PULONG State
)
{...}

パラメーター

AudioEngine

グローバル効果の状態が要求された ACXAUDIOENGINE オブジェクト。 ACX オブジェクトの詳細については、「 ACX オブジェクトの概要」を参照してください。

State

指定したオーディオ エンジン ノードのグローバル効果の状態を示す ULONG 値。 0 以外の値は、オーディオ エンジン ノードでのグローバル効果処理が有効であることを示し、値 0 はオーディオ エンジン ノードでのグローバル効果処理が無効になっていることを示します。

戻り値

STATUS_SUCCESS呼び出しが成功した場合は を返します。 それ以外の場合は、適切なエラー コードを返します。 詳細については、「 NTSTATUS 値の使用」を参照してください。

解説

例

使用例を次に示します。

typedef struct _CODEC_ENGINE_CONTEXT {
    ACXDATAFORMAT   MixFormat;
    BOOLEAN         GFxEnabled;
} CODEC_ENGINE_CONTEXT, *PCODEC_ENGINE_CONTEXT;

WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(CODEC_ENGINE_CONTEXT, GetCodecEngineContext)

EVT_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE      Codec_EvtAcxAudioEngineRetrieveEffectsState;

NTSTATUS
Codec_EvtAcxAudioEngineRetrieveEffectsState(
    _In_    ACXAUDIOENGINE  AudioEngine,
    _Out_   PULONG          State
)
{
    PAGED_CODE();

    PCODEC_ENGINE_CONTEXT   pAudioEngineCtx;
    pAudioEngineCtx = GetCodecEngineContext(AudioEngine);

    *State = pAudioEngineCtx->GFxEnabled;

    return STATUS_SUCCESS;
}

ACX の要件

最小 ACX バージョン: 1.0

ACX バージョンの詳細については、「 ACX バージョンの概要」を参照してください。

要件

要件	値
Header	acxelements.h
IRQL	PASSIVE_LEVEL

こちらもご覧ください

• acxelements.h ヘッダー