Edit

IAudioClientDuckingControl::SetDuckingOptionsForCurrentStream method (audioclient.h)

  • Article

Sets the audio ducking options for an audio render stream. Allows an app to specify that the system shouldn't duck the audio of other streams when the app's audio render stream is active.

Syntax

HRESULT SetDuckingOptionsForCurrentStream(
  AUDIO_DUCKING_OPTIONS options
);

Parameters

options

A value from the AUDIO_DUCKING_OPTIONS enumeration specifying the requested ducking behavior.

Return value

On successful completion, returns S_OK.

Remarks

Get an instance of the IAudioClientDuckingControl interface by calling IAudioClient::GetService, passing in the interface ID constant IID_IAudioClientDuckingControl.

IAudioClientDuckingControl only controls the ducking caused by the audio stream (IAudioClient) that the interface is obtained from.

Audio from applications could continue to be ducked if there are other concurrent applications with streams that cause ducking.

Requirements

Requirement Value
Minimum supported client Windows 10 Build 20348
Header audioclient.h