XAppCaptureStopUserRecord
Stop an ongoing user recording started via XAppCaptureStartUserRecord and specified by the inputted ID. Users will receive a toast to indicate a recording has been saved and the recording will be accessible by the user. Windows support for this API will be added in a future release.
Syntax
HRESULT XAppCaptureStopUserRecord(
const char* localId,
XAppCaptureUserRecordingResult* result
)
Parameters
localId _In_
Type: const char*
Handle representing the user requesting the recording.
result _Out_
Type: XAppCaptureUserRecordingResult*
On successful function completion, contains information for the recorded clip.
Return value
Type: HRESULT
Function result. See XAppCapture Error Codes for non-S_OK return values.
Remarks
Assumes localIdOfUserRecording holds a local ID returned from XAppCaptureStartUserRecord.
XAppCaptureUserRecordingResult userRecording = { 0 };
if (FAILED_LOG(XAppCaptureStopUserRecord(localIdOfUserRecording, &userRecording)))
{
return;
}
appLog.AddLog("Recording stopped: Start timestamp: %llu, Duration (ms): %llu, File Size (bytes): %llu, Width: %d, Height: %d, Encoding: %d, Color Format: %d\n",
userRecording.clipStartTimestamp, userRecording.durationInMilliseconds, userRecording.fileSizeInBytes, userRecording.width, userRecording.height, userRecording.encoding, userRecording.colorFormat);
Requirements
Header: XAppCapture.h
Library: xgameruntime.lib
Supported platforms: Xbox One family consoles and Xbox Series consoles