XAppCaptureCancelUserRecord

Stop an ongoing user recording started via XAppCaptureStartUserRecord and specified by the inputted ID. Users will not receive a toast to indicate a recording has been stopped and the recording will not be saved to disk. Windows support for this API will be added in a future release.

Syntax

HRESULT XAppCaptureCancelUserRecord(
    const char* localId
)

Parameters

localId _In_
Type: const char*

Handle representing the user requesting the recording.

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.

if (FAILED_LOG(XAppCaptureCancelUserRecord(localIdOfUserRecording)))
{
    return;
}

appLog.AddLog("Recording cancelled: localId = %s\n", localIdOfUserRecording);

Requirements

Header: XAppCapture.h

Library: xgameruntime.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

XAppCapture members