Navigation
API > API/Plugins > API/Plugins/RivermaxMedia
Output information for a Rivermax media capture.
| Name | URivermaxMediaOutput |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxMedia/Source/RivermaxMedia/Public/RivermaxMediaOutput.h |
| Include Path | #include "RivermaxMediaOutput.h" |
Syntax
UCLASS (BlueprintType, Meta=(MediaIOCustomLayout="Rivermax", DisplayName="NVIDIA Rivermax Output"))
class URivermaxMediaOutput : public UMediaOutput
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaOutput → URivermaxMediaOutput
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AlignmentMode | ERivermaxMediaAlignmentMode | Used by frame scheduler to know how to align the output | RivermaxMediaOutput.h |
|
| AncStreams | TArray< FRivermaxAncStream > | Collection of Ancillary streams. | RivermaxMediaOutput.h |
|
| bDoContinuousOutput | bool | Whether to produce a continuous output stream repeating last frame if no new frames provided Note: Not supported in frame creation mode | RivermaxMediaOutput.h |
|
| bDoFrameCounterTimestamping | bool | 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. | RivermaxMediaOutput.h |
|
| FrameLockingMode | ERivermaxFrameLockingMode | For alignment point mode, controls whether we stall engine before capturing if there are no buffer available to capture into | RivermaxMediaOutput.h |
|
| PresentationQueueSize | int32 | Number of frames that can be queued / used in output queue. Frame being sent counts for 1. | RivermaxMediaOutput.h |
|
| VideoStream | FRivermaxVideoStream | Video output stream properties. | RivermaxMediaOutput.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExportSDP
(
const FString& InPath |
Saves SDP into the file fath. | RivermaxMediaOutput.h | |
UE::RivermaxCore::FRivermaxOutputOptions GenerateStreamOptions() |
Aggregates URivermaxMediaOutput settings into FRivermaxOutputOptions that have information about individual stream types. | RivermaxMediaOutput.h |
Overridden from UMediaOutput
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMediaCaptureConversionOperation GetConversionOperation
(
EMediaCaptureSourceType InSourceType |
RivermaxMediaOutput.h | ||
virtual FString GetDescriptionString() |
RivermaxMediaOutput.h | ||
virtual void GetDetailsPanelInfoElements
(
TArray< FInfoElement >& OutInfoElements |
RivermaxMediaOutput.h | ||
virtual EPixelFormat GetRequestedPixelFormat() |
RivermaxMediaOutput.h | ||
virtual FIntPoint GetRequestedSize() |
RivermaxMediaOutput.h | ||
virtual bool Validate
(
FString& FailureReason |
RivermaxMediaOutput.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
RivermaxMediaOutput.h | ||
virtual void PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
RivermaxMediaOutput.h | ||
virtual void PostLoad() |
RivermaxMediaOutput.h | ||
virtual void Serialize
(
FArchive& Ar |
RivermaxMediaOutput.h |
Protected
Overridden from UMediaOutput
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UMediaCapture * CreateMediaCaptureImpl() |
RivermaxMediaOutput.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bOverrideResolution_DEPRECATED | bool | If false, use the default source buffer size. If true, a specific resolution will be used. | RivermaxMediaOutput.h | |
| bUseGPUDirect_DEPRECATED | bool | Whether to use GPUDirect if available (Memcopy from GPU to NIC directly bypassing system) if available | RivermaxMediaOutput.h | |
| FrameRate_DEPRECATED | FFrameRate | Frame rate of this output stream | RivermaxMediaOutput.h | |
| InterfaceAddress_DEPRECATED | FString | RivermaxMediaOutput.h | ||
| PixelFormat_DEPRECATED | ERivermaxMediaOutputPixelFormat | Pixel format for this output stream | RivermaxMediaOutput.h | |
| Port_DEPRECATED | int32 | Port to use for this output | RivermaxMediaOutput.h | |
| Resolution_DEPRECATED | FIntPoint | Resolution of this output stream | RivermaxMediaOutput.h | |
| StreamAddress_DEPRECATED | FString | RivermaxMediaOutput.h |