XboxGameBarWidgetRecordingManager

This class provides access to the Xbox Game Bar recording functionality. It allows widgets to control and monitor gameplay recording, including starting and stopping recordings, capturing timeframes from the rolling buffer, and receiving notifications about recording state changes.

Note

This API was introduced in SDK version 7.3.2511061.

Constructor

XboxGameBarWidgetRecordingManager(XboxGameBarWidget widget)

Creates a new recording manager instance associated with the specified widget.

Properties

XboxGameBarRecordingState RecordingState

Gets the current XboxGameBarRecordingState of the Game Bar capture system. Subscribe to the RecordingStateChanged event to monitor changes.

Boolean NotificationsEnabled / NotificationsEnabled(Boolean value)

Gets or sets whether recording notifications are displayed to the user. When enabled, the user will see visual feedback when recordings start, stop, or are saved.

Methods

Windows.Foundation.IAsyncOperation<XboxGameBarWidgetRecordingResultSummary> RecordLastAsync(TimeSpan duration)

Records the last specified duration of gameplay from the rolling buffer. The duration parameter specifies how much time to capture from the buffer. Returns an XboxGameBarWidgetRecordingResultSummary containing the result status and file path.

Windows.Foundation.IAsyncOperation<XboxGameBarWidgetRecordingResultSummary> RecordTimeframeAsync(TimeSpan start, TimeSpan duration)

Records a specific timeframe from the rolling buffer. The start parameter specifies the offset from the current time, and duration specifies the length of the recording. Returns an XboxGameBarWidgetRecordingResultSummary containing the result status and file path.

Windows.Foundation.IAsyncOperation<XboxGameBarWidgetRecordingResult> StartRecordingAsync()

Starts a new recording session. Returns an XboxGameBarWidgetRecordingResult indicating whether the recording started successfully.

Windows.Foundation.IAsyncOperation<XboxGameBarWidgetRecordingResultSummary> StopRecordingAsync()

Stops the current recording session. Returns an XboxGameBarWidgetRecordingResultSummary containing the result status and the file path where the recording was saved.

Windows.Foundation.IAsyncOperation<Boolean> IsTimeframeRecordingEnabledAsync()

Checks whether timeframe recording is enabled. Returns true if the rolling buffer is active and timeframe recording is available, false otherwise.

Events


event Windows.Foundation.TypedEventHandler<XboxGameBarWidgetRecordingManager, Object> RecordingStateChanged

Notification for when the XboxGameBarRecordingState changes. Subscribe to this event to monitor recording activity and update your widget's UI accordingly.