1. Epic GamesDeveloper
  3. UMediaCapture

UMediaCapture

Abstract base class for media capture.

Unreal Engine C++ API Reference > Plugins > MediaIOCore

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Abstract, EditInlineNew, BlueprintType, HideCategories&61;&40;Object&41;&41;  
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

  Type Name Description
Protected variable FAudioDeviceHandle AudioDeviceHandle Audio device to be captured. If none, main engine's audio device is captured.
Protected variable EMediaCaptureSourceType CaptureSourceType Type of capture currently being done. i.e Viewport, RT, RHI Resource
Protected variable FIntPoint DesiredOutputSize Output size of the media capture.
Protected variable UProperty Transient TObjectPtr< UMediaOutput > MediaOutput MediaOutput associated with this capture
Public variable FMediaCaptureOutputSynchronization OnOutputSynchronization Called when output data is ready to be sent out.
Public variable UProperty Category BlueprintAssignable FMediaCaptureStateChangedSignature OnStateChanged Called when the state of the capture changed.
Public variable FMediaCaptureStateChangedSignatureNative OnStateChangedNative Called when the state of the capture changed.
Protected variable std::atomic< FRHIGPUMask > ValidSourceGPUMask Valid source gpu mask of the source.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual   Default constructor / destructor to use forward declared uniqueptr

Functions

  Type Name Description
Protected function Virtual void

BeforeFrameCaptured_RenderingThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FBufferRHIRef InBuffer
)

 Called at the beginning of the Capture_RenderThread call if output resource type is Buffer
Protected function Virtual void

BeforeFrameCaptured_RenderingThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FTextureRHIRef InTexture
)

 Called at the beginning of the Capture_RenderThread call if output resource type is Texture
Public function UFunction BlueprintCallable, Category bool Stop the current capture if there is one.
Public function void

CaptureImmediate_RenderThread ( FRDGBuilder& GraphBuilder,
FRDGTextureRef InSourceTextureRef,
FIntRect SourceViewRect
)

  
Public function void

CaptureImmediate_RenderThread ( FRDGBuilder& GraphBuilder,
FRHITexture* InSourceTexture,
FIntRect SourceViewRect
)

 Captures a resource immediately from the render thread. Used in RHI_RESOURCE capture mode
Public function bool

CaptureRHITexture ( const FRHICaptureResourceDescription& ResourceDescription,
FMediaCaptureOptions CaptureOptions
)

 Stop the actual capture if there is one.
Public function bool

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

 Stop the actual capture if there is one.
Public function UFunction BlueprintCallable, Category bool Stop the actual capture if there is one.
Public function Const const FAudioDeviceHandle & Get the audio device to capture.
Protected function Virtual TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > Capture the data that will pass along to the callback.
Protected function Const FString  
Protected function Const TSharedPtr< FSceneViewport >  
Protected function Const EMediaCaptureConversionOperation  
Protected function Virtual Const FRDGBufferDesc

GetCustomBufferDescription ( const FIntPoint& InDesiredSize
)

 Get the desired output buffer description when the conversion is custom and operating in buffer resource type
Protected function Virtual Const EPixelFormat

GetCustomOutputPixelFormat ( const EPixelFormat& InPixelFormat
)

 Get the pixel format of the buffer when the conversion operation is custom.
Protected function Virtual Const EMediaCaptureResourceType Get the desired output resource type when the conversion is custom.
Protected function Virtual Const FIntPoint

GetCustomOutputSize ( const FIntPoint& InSize
)

 Get the size of the buffer when the conversion operation is custom.
Public function Const const FMediaCaptureOptions & Get the capture options specified by the user.
Public function Const UFunction BlueprintCallable, Category EPixelFormat Get the desired pixel format of the current capture.
Public function Const UFunction BlueprintCallable, Category FIntPoint Get the desired size of the current capture.
Public function Const FString Get the name of the media output that created this capture.
Public function Virtual Const const FMatrix & Get the RGB to YUV Conversion Matrix, should be overriden for media outputs that support different color gamuts (ie. BT 2020).
Public function Virtual Const UFunction BlueprintCallable, Category EMediaCaptureState Get the current state of the capture.
Public function Static const TSet< EPixelFormat > &  
Protected function Const UTextureRenderTarget2D *  
Public function Virtual Const bool Check whether this capture has any processing left to do.
Protected function Virtual bool Initialization method to prepare implementation for capture
Public function Virtual Const bool Returns true if media capture implementation supports synchronization logic.
Protected function Virtual void

LockDMATexture_RenderThread ( FTextureRHIRef InTexture
)

  
Protected function Virtual void

OnCustomCapture_RenderingThread ( FRDGBuilder& GraphBuilder,
const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FRDGTextureRef InSourceTexture,
FRDGBufferRef OutputBuffer,
const FRHICopyTextureInfo& CopyInfo,
FVector2D CropU,
FVector2D CropV
)

 Callback when the source texture is ready to be copied on the GPU.
Protected function Virtual void

OnCustomCapture_RenderingThread ( FRDGBuilder& GraphBuilder,
const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FRDGTextureRef InSourceTexture,
FRDGTextureRef OutputTexture,
const FRHICopyTextureInfo& CopyInfo,
FVector2D CropU,
FVector2D CropV
)

 Callback when the source texture is ready to be copied on the GPU.
Protected function Virtual void

OnFrameCaptured_AnyThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
const FMediaCaptureResourceData& InResourceData
)

 Callback when the buffer was successfully copied to CPU ram.
Protected function Virtual void

OnFrameCaptured_RenderingThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
void* InBuffer,
int32 Width,
int32 Height,
int32 BytesPerRow
)

 Callback when the buffer was successfully copied to CPU ram.
Protected function Virtual void

OnRHIResourceCaptured_AnyThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FBufferRHIRef InBuffer
)

  
Protected function Virtual void

OnRHIResourceCaptured_AnyThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FTextureRHIRef InTexture
)

 AnyThread version of the above callbacks.
Protected function Virtual void

OnRHIResourceCaptured_RenderingThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FBufferRHIRef InBuffer
)

  
Protected function Virtual void

OnRHIResourceCaptured_RenderingThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FTextureRHIRef InTexture
)

 Callbacks when the buffer was successfully copied on the GPU ram.
Public function Virtual bool Called after initialize for render target capture type
Public function Virtual bool Called after initialize for rhi resource capture type
Public function Virtual bool Called after initialize for viewport capture type
Public function void

ResetFixedViewportSize ( TSharedPtr< FSceneViewport > InViewport,
bool bInFlushRenderingCommands
)

  
Protected function void  
Public function bool

SetCaptureAudioDevice ( const FAudioDeviceHandle& InAudioDeviceHandle
)

 Set the audio device to capture.
Public function void

SetFixedViewportSize ( TSharedPtr< FSceneViewport > InSceneViewport,
FIntPoint InSize
)

  
Public function UFunction BlueprintCallable, Category void

SetMediaOutput ( UMediaOutput* InMediaOutput
)

 Set the media output. Can only be set when the capture is stopped.
Protected function void

SetState ( EMediaCaptureState InNewState
)

  
Public function Virtual void Set the valid GPU mask of the source buffer/texture being captured. Can be called from any thread.
Protected function Virtual Const bool Should we call OnFrameCaptured_RenderingThread() with a RHI resource -or- readback the memory to CPU ram and call OnFrameCaptured_RenderingThread().
Public function UFunction BlueprintCallable, Category void

StopCapture ( bool bAllowPendingFrameToBeProcess
)

 Stop the previous requested capture.
Protected function Virtual void

StopCaptureImpl ( bool bAllowPendingFrameToBeProcess
)

  
Protected function Virtual Const bool Whether the capture callbacks can be called on any thread.
Protected function Virtual Const bool Whether the capture implementation supports restarting on input format change.
Protected function Virtual void

UnlockDMATexture_RenderThread ( FTextureRHIRef InTexture
)

  
Public function Virtual bool

UpdateAudioDeviceImpl ( const FAudioDeviceHandle& InAudioDeviceHandle
)

  
Public function Virtual bool  
Public function bool Update the current capture with a SceneViewport.
Public function Virtual bool  
Public function UFunction BlueprintCallable, Category bool Update the current capture with every frame for a TextureRenderTarget2D.
Protected function Virtual Const bool  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser

Classes

  Type Name Description
Protected struct FCaptureBaseData    
Protected struct FMediaCaptureResourceData Args passed to OnFrameCaptured  

Constants

Name Description
MaxCaptureDataAgeInFrames  

Deprecated Functions

  Type Name Description
Protected function Virtual bool This method has been deprecated. Please override InitializeCapture() and PostInitializeCapture variants if needed instead.
Protected function Virtual bool This method has been deprecated. Please override InitializeCapture() and PostInitializeCapture variants if needed instead.
Protected function Virtual void

OnRHITextureCaptured_RenderingThread ( const FCaptureBaseData& InBaseData,
TSharedPtr< FMediaCaptureUserData, ESPMode::ThreadSafe > InUserData,
FTextureRHIRef InTexture
)

 OnRHITextureCaptured_RenderingThread has been deprecated to support texture and buffer output resource. Please use OnRHIResourceCaptured_RenderingThread instead.
Protected function Virtual Const bool ShouldCaptureRHITexture has been deprecated to support both texture and buffer output resource. Please use the ShouldCaptureRHIResource instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page