1. Epic GamesDeveloper
  3. URivermaxMediaCapture

URivermaxMediaCapture

Output Media for Rivermax streams.

API > API/Plugins > API/Plugins/RivermaxMedia

Inheritance Hierarchy

References

   
Module RivermaxMedia
Header /Engine/Plugins/VirtualProduction/Rivermax/RivermaxMedia/Source/RivermaxMedia/Public/RivermaxMediaCapture.h
Include #include "RivermaxMediaCapture.h"

Syntax

UCLASS&40;BlueprintType&41;  
class URivermaxMediaCapture :  
    public UMediaCapture,  
    public UE::RivermaxCore::IRivermaxOutputStreamListener

Remarks

Output Media for Rivermax streams.

Functions

  Type Name Description
Public function Const UE::RivermaxCore::FRivermaxOutputStreamOptions Rivermax capture specific API to provide stream options access

Overridden from UMediaCapture

  Type Name Description
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 EMediaCaptureResourceType Get the desired output resource type when the conversion is custom.
Protected function Virtual Const FIntPoint

GetCustomOutputSize ( const FIntPoint& InSize
)

 For custom conversion, methods that need to be overriden
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
Protected function Virtual Const bool Returns true if media capture implementation supports synchronization logic.
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

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 Const bool Should we call OnFrameCaptured_RenderingThread() with a RHI resource -or- readback the memory to CPU ram and call OnFrameCaptured_RenderingThread().
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 bool  
Protected function Virtual bool  
Protected function Virtual Const bool  

Overridden from UObject

  Type Name Description
Protected function Virtual bool Called to check if the object is ready for FinishDestroy.

Overridden from IRivermaxOutputStreamListener

  Type Name Description
Protected function Virtual void

OnInitializationCompleted ( bool bHasSucceed
)

 Initialization completion callback with result
Protected function Virtual void Called when stream is about to enqueue new frame
Protected function Virtual void Called when stream has encountered an error and has to stop

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page