Navigation
API > API/Plugins > API/Plugins/RivermaxCore
References
| Module | RivermaxCore |
| Header | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxCore/Source/RivermaxCore/Public/RivermaxTypes.h |
| Include | #include "RivermaxTypes.h" |
Syntax
struct FRivermaxOutputStreamOptions
Variables
| Type | Name | Description | |
|---|---|---|---|
| FIntPoint | AlignedResolution | Resolution aligning with pgroup of sampling type | |
| ERivermaxAlignmentMode | AlignmentMode | Method used to align output stream | |
| bool | bDoContinuousOutput | Whether the stream will output a frame at every frame interval, repeating last frame if no new one provided | |
| bool | bDoFrameCounterTimestamping | Whether to use frame's frame number instead of standard timestamping | |
| bool | bUseGPUDirect | Whether to leverage GPUDirect (Cuda) capability to transfer memory to NIC if available | |
| EFrameLockingMode | FrameLockingMode | Defines how frame requests are handled. Whether they can block or not. | |
| FFrameRate | FrameRate | Stream FrameRate | |
| FString | InterfaceAddress | Interface IP to bind to | |
| int32 | NumberOfBuffers | Sample count to buffer. | |
| ESamplingType | PixelFormat | Desired stream pixel format | |
| uint32 | Port | Port to be used by stream | |
| FIntPoint | Resolution | Desired stream resolution | |
| FString | StreamAddress | IP of the stream. Defaults to multicast group IP. |