1. Epic GamesDeveloper
  3. URivermaxMediaOutput

URivermaxMediaOutput

Output information for a Rivermax media capture.

API > API/Plugins > API/Plugins/RivermaxMedia

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Meta&61;&40;MediaIOCustomLayout&61;"Rivermax", DisplayName&61;"NVIDIA Rivermax Output"&41;&41;  
class URivermaxMediaOutput : public UMediaOutput

Remarks

Output information for a Rivermax media capture.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ERivermaxMediaAlignmentMode AlignmentMode Used by frame scheduler to know how to align the output
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bDoContinuousOutput Whether to produce a continuous output stream repeating last frame if no new frames provided Note: Not supported in frame creation mode
Public variable UProperty Category, EditAnywhere, Meta bool bDoFrameCounterTimestamping Experimental flag to use frame counter instead of using NVIDIA Rivermax clock for timestamping output frames Meant to be used for UE-UE streams where frame locking is done, e.g. nDisplay.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bOverrideResolution If false, use the default source buffer size. If true, a specific resolution will be used.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay bool bUseGPUDirect Whether to use GPUDirect if available (Memcopy from GPU to NIC directly bypassing system) if available
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ERivermaxFrameLockingMode FrameLockingMode For alignment point mode, controls whether we stall engine before capturing if there are no buffer available to capture into
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FFrameRate FrameRate Frame rate of this output stream
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString InterfaceAddress Network card interface to use to send data Wildcards are supported to match against an interface found on the machine 192.*.0.110 192.168.0.1?0 192.168.0.1*
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ERivermaxMediaOutputPixelFormat PixelFormat Pixel format for this output stream
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 Port Port to use for this output
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 PresentationQueueSize Number of frames that can be queued / used in output queue. Frame being sent counts for 1.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FIntPoint Resolution Resolution of this output stream
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString StreamAddress Address of the stream. Can be multicast, i.e. 224.1.1.1)

Overridden from UMediaOutput

  Type Name Description
Protected function Virtual UMediaCapture *  
Public function Virtual Const EMediaCaptureConversionOperation The conversion we wish to accomplish on the GPU before the DMA transfer occurs.
Public function Virtual Const EPixelFormat The pixel format of the buffer we wish to capture.
Public function Virtual Const FIntPoint The size of the buffer we wish to capture.
Public function Virtual Const bool

Validate ( FString& OutFailureReason
)

 Validate the media output settings (must be implemented in child classes).

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page