Edit

Share via

IAudioProcessingObjectNotifications::HandleNotification method (audioengineextensionapo.h)

  • Article

Called by the system to notify clients of changes to APO endpoints or system effects.

Syntax

void HandleNotification(
  APO_NOTIFICATION *apoNotification
);

Parameters

apoNotification

An APO_NOTIFICATION representing the APO change associated with the notification.

Return value

None

Remarks

Specify the set of APO changes for which this method is called by implementing IAudioProcessingObjectNotifications::GetApoNotificationRegistrationInfo.

This method will be called after LockForProcess is called and will stop being called before UnlockForProcess. If there are any notifications in flight, they might get executed during or after UnlockForProcess. The APO must handle synchronization in this case.

Note

APOs must query each property once to get its initial value because HandleNotification method is only invoked when any of the properties have changed. The exceptions to this are the initial audio endpoint volume when the APO registers for APO_NOTIFICATION_TYPE_ENDPOINT_VOLUME and the value of PKEY_AudioEndpoint_Disable_SysFx if the APO registers for APO_NOTIFICATION_TYPE_ENDPOINT_PROPERTY_CHANGE

For more information on the Windows 11 APIs for the Audio Processing Objects (APOs) that can ship with audio drivers, see Windows 11 APIs for Audio Processing Objects.

Requirements

Requirement Value
Minimum supported client Windows Build 22000
Header audioengineextensionapo.h