Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > MediaIOCore > UMediaCapture > UMediaCapture::CaptureSceneViewport

Light Theme

Dark Theme

UMediaCapture::CaptureSceneViewport

Stop the actual capture if there is one.

Windows

MacOS

Linux

References

Module	MediaIOCore
Header	/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaCapture.h
Include	#include "MediaCapture.h"
Source	/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Private/MediaCapture.cpp

Syntax

bool CaptureSceneViewport
(
TSharedPtr< FSceneViewport > & SceneViewport,
FMediaCaptureOptions CaptureOptions
)

Remarks

Stop the actual capture if there is one. Then start the capture of a SceneViewport. If the SceneViewport is destroyed, the capture will stop. The SceneViewport needs to be of the same size and have the same pixel format as requested by the media output. @note make sure the size of the SceneViewport doesn't change during capture.

Returns

True if the capture was successfully started

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss