XAppBroadcastGetStatus

Article
06/22/2023

Retrieves the current status for broadcasting for the device and current app.

Syntax

HRESULT XAppBroadcastGetStatus(  
         XUserHandle requestingUser,  
         XAppBroadcastStatus* appBroadcastStatus  
)

Parameters

requestingUser _In_
Type: XUserHandle

Handle for the user requesting a broadcast status.

appBroadcastStatus _Out_
Type: XAppBroadcastStatus*

The broadcast status of the requestingUser.

Return value

Type: HRESULT

Function result.

Remarks

Note

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

Use this function to determine whether or not you can start broadcasting for your game. Retrieving the broadcast status may also reveal the reason you are unable to broadcast in the event you are not able to. It is recommended you call this function before calling the XAppBroadcastShowUI method. If you would like to see whether your game is currently broadcasting call XAppBroadcastIsAppBroadcasting.

Requirements

Header: XAppCapture.h

Library: xgameruntime.lib

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

Share via