IAudioSessionEvents::OnDisplayNameChanged method

The OnDisplayNameChanged method notifies the client that the display name for the session has changed.

Syntax

HRESULT OnDisplayNameChanged(
  LPCWSTR NewDisplayName,
  LPCGUID EventContext
);

Parameters

NewDisplayName

The new display name for the session. This parameter points to a null-terminated, wide-character string containing the new display name. The string remains valid for the duration of the call.

EventContext

The event context value. This is the same value that the caller passed to IAudioSessionControl::SetDisplayName in the call that changed the display name 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::SetDisplayName method changes the display name of the session. The Sndvol program uses a session's display name to label the volume slider for the session.

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

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

Requirements

   
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

See Also

IAudioSessionControl::SetDisplayName

IAudioSessionEvents Interface