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

Light Theme

Dark Theme

UMediaCapture

Abstract base class for media capture.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMediaCapture

	UAjaMediaCapture
	UBlackmagicMediaCapture
	UFileMediaCapture
	URemoteSessionMediaCapture

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew, BlueprintType, HideCategories=(Object))
class UMediaCapture : public UObject

Remarks

Abstract base class for media capture.

MediaCapture capture the texture of the Render target or the SceneViewport and sends it to an external media device. MediaCapture should be created by a MediaOutput.

Variables

	Name	Description
UMediaOutput &#...	MediaOutput
FMediaCaptureSt...	OnStateChanged	Called when the state of the capture changed.
FMediaCaptureSt...	OnStateChangedNative	Called when the state of the capture changed.

Constructors

	Name	Description
	UMediaCapture ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	CaptureActiveSceneViewport ( FMediaCaptureOptions CaptureOptions )	Stop the current capture if there is one.
bool	CaptureRenderTargetImpl ( UTextureRenderTarget2D* InRend... )
bool	CaptureSceneViewport ( TSharedPtr< FSceneViewport >& Scen..., FMediaCaptureOptions CaptureOptions )	Stop the actual capture if there is one.
bool	CaptureSceneViewportImpl ( TSharedPtr< FSceneViewport >& InSc... )
bool	CaptureTextureRenderTarget2D ( UTextureRenderTarget2D* Render..., FMediaCaptureOptions CaptureOptions )	Stop the actual capture if there is one.
TSharedPtr< ...	GetCaptureFrameUserData_GameThread()	Capture the data that will pass along to the callback.
TSharedPtr< ...	GetCapturingSceneViewport()
EMediaCaptur...	GetConversionOperation()
EPixelFormat	GetCustomOutputPixelFormat ( const EPixelFormat& InPixelFormat )	Get the pixel format of the buffer when the conversion operation is custom.
FIntPoint	GetCustomOutputSize ( const FIntPoint& InSize )	Get the size of the buffer when the conversion operation is custom.
EPixelFormat	GetDesiredPixelFormat()	Get the desired pixel format of the current capture.
FIntPoint	GetDesiredSize()	Get the desired size of the current capture.
EMediaCaptur...	GetState()	Get the current state of the capture.
UTextureRend...	GetTextureRenderTarget()
bool	HasFinishedProcessing()	Check whether this capture has any processing left to do.
void	OnCustomCapture_RenderingThread ( FRHICommandListImmediate& RHICmdLi..., const FCaptureBaseData& InBaseData, TSharedPtr< FMediaCaptureUserData, ..., FTexture2DRHIRef InSourceTexture, FTextureRHIRef TargetableTexture, FResolveParams& ResolveParams, FVector2D CropU, FVector2D CropV )	Callback when the buffer is ready to be copied on the GPU.
void	OnFrameCaptured_RenderingThread ( const FCaptureBaseData& InBaseData, TSharedPtr< FMediaCaptureUserData, ..., void* InBuffer, int32 Width, int32 Height )	Callback when the buffer was successfully copied to CPU ram.
void	OnRHITextureCaptured_RenderingThread ( const FCaptureBaseData& InBaseData, TSharedPtr< FMediaCaptureUserData, ..., FTextureRHIRef InTexture )	Callback when the buffer was successfully copied on the GPU ram.
void	SetMediaOutput ( UMediaOutput* InMediaOutput )	Set the media output. Can only be set when the capture is stopped.
void	SetState ( EMediaCaptureState InNewState )
bool	ShouldCaptureRHITexture()	Should we call OnFrameCaptured_RenderingThread() with a RHI Texture -or- copy the memory to CPU ram and call OnFrameCaptured_RenderingThread().
void	StopCapture ( bool bAllowPendingFrameToBeProcess )	Stop the previous requested capture.
void	StopCaptureImpl ( bool bAllowPendingFrameToBeProcess )
bool	UpdateRenderTargetImpl ( UTextureRenderTarget2D* InRend... )
bool	UpdateSceneViewport ( TSharedPtr< FSceneViewport >& Scen... )	Update the current capture with a SceneViewport.
bool	UpdateSceneViewportImpl ( TSharedPtr< FSceneViewport >& InSc... )
bool	UpdateTextureRenderTarget2D ( UTextureRenderTarget2D* Render... )	Update the current capture with every frame for a TextureRenderTarget2D.
bool	ValidateMediaOutput()

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	FString	GetDesc()	Return a one line description of an object for viewing in the thumbnail view of the generic browser

Classes

	Name	Description
	FCaptureBaseData

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

Take our survey

Dismiss