Skip to main content

XAppBroadcastShowUI

Show broadcast UI to app user so that they may start broadcasting activity.

Syntax

Parameters

requestingUser   _In_
Type: XUserHandle
The user that the broadcast UI will appear for.

Return value

Type: HRESULT Function result.

Remarks

This function isn’t safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.
This function does not start a broadcast on its own, it merely shows the User the UI that they would need to navigate in order to begin a broadcast.
You can verify that a broadcast was started by the occurrence of a broadcast status change event or by checking the broadcast status with XAppBroadcastIsAppBroadcasting. Before calling this function you should also call XAppBroadcastGetStatus to check whether or not a user is capable of starting a broadcast.

Requirements

Header: XAppCapture.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Conceptual documentation

See also

GameDVR Overview
XAppCapture Members
XAppBroadcastIsAppBroadcasting
XAppBroadcastGetStatus
Last modified on August 20, 2026