XAppBroadcastUnregisterIsAppBroadcastingChanged

Article
06/22/2023

Remove an app broadcast status change event handler.

Syntax

bool XAppBroadcastUnregisterIsAppBroadcastingChanged(  
         XTaskQueueRegistrationToken token,  
         bool wait  
)

Parameters

token _In_
Type: XTaskQueueRegistrationToken

Event handler token created by XAppBroadcastRegisterIsAppBroadcastingChanged. Used to unregister the callback.

wait _In_
Type: bool

Tells the unregister function to wait in the case that the callback function is running some blocking function. This guarantees that once this function returns there will be no more callbacks; hence safe to shut down.

Return value

Type: bool

Remarks

Note

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

Each call to XAppBroadcastRegisterIsAppBroadcastingChanged should be followed by a call to AppBroadcastUnregisterIsAppBroadcastingChanged when the event handler is no longer needed. Failing to call this function will cause memory leaks to occur. This function will unregister the XAppBroadcastMonitorCallback set by XAppBroadcastRegisterIsAppBroadcastingChanged.

Requirements

Header: XAppCapture.h

Library: xgameruntime.lib

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

Share via