IAudioVolumeDuckNotification::OnVolumeDuckNotification method

The OnVolumeDuckNotification method sends a notification about a pending system ducking event. For more information, see Implementation Considerations for Ducking Notifications.

Syntax


HRESULT OnVolumeDuckNotification(
  [in]  LPCWSTR sessionID,
  [in]  UINT32 countCommunicationsSessions
);

Parameters

sessionID [in]

A string containing the session instance identifier of the communications session that raises the the auto-ducking event. To get the session instance identifier, call IAudioSessionControl2::GetSessionInstanceIdentifier.

countCommunicationsSessions [in]

The number of active communications sessions. If there are n sessions, the sessions are numbered from 0 to –1.

Return value

If the method succeeds, it returns S_OK.

Remarks

After the application registers its implementation of the IAudioVolumeDuckNotification interface by calling IAudioSessionManager2::RegisterDuckNotification, the session manager calls OnVolumeDuckNotification when it wants to send a notification about when ducking begins. The application receives the event notifications in the form of callbacks.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

AudioPolicy.h

See also

IAudioVolumeDuckNotification
Using a Communication Device

 

 

Community Additions

ADD
Show:
© 2014 Microsoft