XAppCaptureStopUserRecord

停止通过 XAppCaptureStartUserRecord 启动且由输入的 ID 指定的正在进行的用户录制。 用户将收到一个 Toast,指示录制内容已保存,并且用户可以访问录制内容。 将来的版本中将添加对此 API 的 Windows 支持。

语法

HRESULT XAppCaptureStopUserRecord(
    const char* localId,
    XAppCaptureUserRecordingResult* result
)

参数

localId _In_
类型:const char*

表示请求录制的用户的句柄。

result _Out_
类型: XAppCaptureUserRecordingResult*

函数成功完成时,包含录制剪辑的信息。

返回值

类型:HRESULT

函数结果。 有关非S_OK返回值,请参阅 XAppCapture 错误代码

备注

假设 localIdOfUserRecording 保存从 XAppCaptureStartUserRecord 返回的本地 ID。

注意

如果在录制达到最大时间限制之前未调用此 API,则录制将停止并删除, (不保存) 。 在时间限制过后调用此 API 停止录制将返回错误代码。

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);

要求

头文件:XAppCapture.h

库:xgameruntime.lib

支持的平台:Xbox One 系列主机和 Xbox Series 主机

另请参阅

XAppCapture 成员