Windows Dev Center

IAudioLfxControl::GetLocalEffectsState method

The GetLocalEffectsState method retrieves the local effects state that is currently applied to the offloaded audio stream.

Syntax


HRESULT GetLocalEffectsState(
  [out] BOOL *pbEnabled
);

Parameters

pbEnabled [out]

A pointer to the Boolean variable that indicates the state of the local effects that have been applied to the offloaded audio stream. A value of TRUE indicates that local effects have been enabled and applied to the stream. A value of FALSE indicates that local effects have been disabled.

Return value

The GetLocalEffectsState method returns S_OK to indicate that it has completed successfully. Otherwise it returns an appropriate error code.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Audioengineendpoint.h

See also

IAudioLfxControl

 

 

Community Additions

ADD
Show:
© 2015 Microsoft