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::CaptureActiveSceneViewport

Light Theme

Dark Theme

UMediaCapture::CaptureActiveSceneViewport

Stop the current 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

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Media|Output")
bool CaptureActiveSceneViewport
(
FMediaCaptureOptions CaptureOptions
)

Remarks

Stop the current capture if there is one. Then find and capture every frame from active SceneViewport. It can only find a SceneViewport when you play in Standalone or in "New Editor Window PIE". If the active 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.

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