XUserUnregisterForDefaultAudioEndpointUtf16Changed

Unregisters a previously-registered default audio endpoint change callback.

Syntax

bool XUserUnregisterForDefaultAudioEndpointUtf16Changed(  
         XTaskQueueRegistrationToken token,  
         bool wait  
)  

Parameters

token   
Type: XTaskQueueRegistrationToken

The token that the XUserRegisterForDefaultAudioEndpointUtf16Changed function returns when registering the callback.

wait   
Type: bool

Set to true to wait until the callback registers. Set to false to return immediately.

Return value

Type: bool

Returns true if the callback successfully unregisters; false otherwise.

Remarks

Note

This function isn't safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.

XUserDefaultAudioEndpointUtf16ChangedCallback is a callback function that an application invokes when the default audio endpoint for a specific user changes.

To register a callback that invokes when the default audio endpoint changes, call XUserRegisterForDefaultAudioEndpointUtf16Changed.

To register a callback for user device association change events, call XUserRegisterForDeviceAssociationChanged.

Requirements

Header: XUser.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

XUser
XUserDefaultAudioEndpointUtf16ChangedCallback
XUserRegisterForDefaultAudioEndpointUtf16Changed