IAudioSessionEvents::OnGroupingParamChanged method (audiopolicy.h)

Article
10/13/2021

The OnGroupingParamChanged method notifies the client that the grouping parameter for the session has changed.

Syntax

HRESULT OnGroupingParamChanged(
  [in] LPCGUID NewGroupingParam,
  [in] LPCGUID EventContext
);

Parameters

[in] NewGroupingParam

The new grouping parameter for the session. This parameter points to a grouping-parameter GUID.

[in] EventContext

The event context value. This is the same value that the caller passed to IAudioSessionControl::SetGroupingParam in the call that changed the grouping parameter for the session. For more information, see Remarks.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The session manager calls this method each time a call to the IAudioSessionControl::SetGroupingParam method changes the grouping parameter for the session.

The EventContext parameter provides a means for a client to distinguish between a grouping-parameter change that it initiated and one that some other client initiated. When calling the IAudioSessionControl::SetGroupingParam method, a client passes in an EventContext parameter value that its implementation of the OnGroupingParamChanged method can recognize.

For a code example that implements the methods in the IAudioSessionEvents interface, see Audio Session Events.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2008 [desktop apps \| UWP apps]
Target Platform	Windows
Header	audiopolicy.h