Navigation
API > API/Plugins > API/Plugins/RivermaxMedia
Output Media for Rivermax streams.
| Name | URivermaxMediaCapture |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxMedia/Source/RivermaxMedia/Public/RivermaxMediaCapture.h |
| Include Path | #include "RivermaxMediaCapture.h" |
Syntax
UCLASS (BlueprintType)
class URivermaxMediaCapture :
public UMediaCapture ,
public UE::RivermaxCore::IRivermaxOutputStreamListener
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaCapture → URivermaxMediaCapture
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsActive | std::atomic< bool > | Whether capture is active. Used to be queried by sync task | RivermaxMediaCapture.h | |
| GPUWaitCompleteEvent | TSharedPtr< FEvent, ESPMode::ThreadSafe > | Used with GPUDirect An Event used to block from render thread writing a fence again when we wait for it. | RivermaxMediaCapture.h | |
| Options | UE::RivermaxCore::FRivermaxOutputOptions | Set of options used to configure output stream | RivermaxMediaCapture.h | |
| ShaderCompletedRenderingFence | TRefCountPtr< FRHIGPUFence > | When using GPUDirect we have to rely on our own fence to wait for output to be converted into buffer. | RivermaxMediaCapture.h | |
| Streams | TStaticArray< TUniquePtr< UE::RivermaxCore::IRivermaxOutputStream >, static_cast< uint32 >(UE::RivermaxCore::ERivermaxStreamType::MAX)> | RivermaxMediaCapture.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GetLastPresentedFrameInformation
(
UE::RivermaxCore::FPresentedFrameInfo& OutFrameInfo |
Returns information about last presented frame on the output stream | RivermaxMediaCapture.h | |
| Rivermax capture specific API to provide stream options access | RivermaxMediaCapture.h |
Overridden from UMediaCapture
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HasFinishedProcessing() |
RivermaxMediaCapture.h | ||
virtual void WaitForGPU
(
FRHITexture* InRHITexture |
In cases of GPUDirect we should manually wait for work to be done. | RivermaxMediaCapture.h |
Protected
Overridden from UMediaCapture
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FRDGBufferDesc GetCustomBufferDescription
(
const FIntPoint& InDesiredSize |
RivermaxMediaCapture.h | ||
virtual EMediaCaptureResourceType GetCustomOutputResourceType() |
RivermaxMediaCapture.h | ||
virtual FIntPoint GetCustomOutputSize
(
const FIntPoint& InSize |
For custom conversion, methods that need to be overriden | RivermaxMediaCapture.h | |
virtual bool InitializeCapture() |
RivermaxMediaCapture.h | ||
virtual bool IsOutputSynchronizationSupported() |
RivermaxMediaCapture.h | ||
virtual void OnCustomCapture_RenderingThread
(
FRDGBuilder& GraphBuilder, |
RivermaxMediaCapture.h | ||
virtual void OnFrameCaptured_AnyThread
(
const FCaptureBaseData& InBaseData, |
RivermaxMediaCapture.h | ||
virtual void OnFrameCaptured_RenderingThread
(
const FCaptureBaseData& InBaseData, |
RivermaxMediaCapture.h | ||
virtual void OnRHIResourceCaptured_AnyThread
(
const FCaptureBaseData& InBaseData, |
RivermaxMediaCapture.h | ||
virtual void OnRHIResourceCaptured_RenderingThread
(
FRHICommandListImmediate& RHICmdList, |
RivermaxMediaCapture.h | ||
virtual bool ShouldCaptureRHIResource() |
RivermaxMediaCapture.h | ||
virtual void StopCaptureImpl
(
bool bAllowPendingFrameToBeProcess |
RivermaxMediaCapture.h | ||
virtual bool SupportsAnyThreadCapture() |
RivermaxMediaCapture.h | ||
virtual bool SupportsAutoRestart() |
RivermaxMediaCapture.h | ||
virtual bool UpdateRenderTargetImpl
(
UTextureRenderTarget2D* InRenderTarget |
RivermaxMediaCapture.h | ||
virtual bool UpdateSceneViewportImpl
(
TSharedPtr< FSceneViewport >& InSceneViewport |
RivermaxMediaCapture.h | ||
virtual bool ValidateMediaOutput() |
RivermaxMediaCapture.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsReadyForFinishDestroy() |
RivermaxMediaCapture.h |
Overridden from IRivermaxOutputStreamListener
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnInitializationCompleted
(
bool bHasSucceed |
RivermaxMediaCapture.h | ||
virtual void OnPreFrameEnqueue() |
RivermaxMediaCapture.h | ||
virtual void OnStreamError() |
RivermaxMediaCapture.h |