Navigation
API > API/Plugins > API/Plugins/RivermaxMedia
Media source for Rivermax streams.
| Name | URivermaxMediaSource |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxMedia/Source/RivermaxMedia/Public/RivermaxMediaSource.h |
| Include Path | #include "RivermaxMediaSource.h" |
Syntax
UCLASS (BlueprintType, HideCategories=(Platforms, Object),
Meta=(MediaIOCustomLayout="Rivermax", DisplayName="NVIDIA Rivermax Source"))
class URivermaxMediaSource : public UCaptureCardMediaSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMediaSource → UBaseMediaSource → UTimeSynchronizableMediaSource → UCaptureCardMediaSource → URivermaxMediaSource
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URivermaxMediaSource() |
RivermaxMediaSource.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bOverrideResolution | bool | If false, use the default source buffer size. If true, a specific resolution will be used. | RivermaxMediaSource.h |
|
| bUseGPUDirect | bool | Whether to use GPUDirect if available (Memcopy from NIC to GPU directly bypassing system memory) if available | RivermaxMediaSource.h |
|
| FrameRate | FFrameRate | Incoming stream video frame rate | RivermaxMediaSource.h |
|
| InterfaceAddress | FString | Network card interface to use to receive 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* | RivermaxMediaSource.h |
|
| PixelFormat | ERivermaxMediaSourcePixelFormat | Incoming stream pixel format | RivermaxMediaSource.h |
|
| Port | int32 | Port used by the sender to send its stream | RivermaxMediaSource.h |
|
| Resolution | FIntPoint | Incoming stream video resolution | RivermaxMediaSource.h |
|
| StreamAddress | FString | IP address where incoming stream is coming from | RivermaxMediaSource.h |
|
Functions
Public
Overridden from UMediaSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetDescriptionString() |
RivermaxMediaSource.h | ||
virtual void GetDetailsPanelInfoElements
(
TArray< FInfoElement >& OutInfoElements |
RivermaxMediaSource.h | ||
virtual FString GetUrl() |
RivermaxMediaSource.h | ||
virtual bool Validate() |
RivermaxMediaSource.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostLoad() |
RivermaxMediaSource.h | ||
virtual void Serialize
(
FArchive& Ar |
RivermaxMediaSource.h |
Overridden from IMediaOptions
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetMediaOption
(
const FName& Key, |
RivermaxMediaSource.h | ||
virtual int64 GetMediaOption
(
const FName& Key, |
RivermaxMediaSource.h | ||
virtual FString GetMediaOption
(
const FName& Key, |
RivermaxMediaSource.h | ||
virtual bool HasMediaOption
(
const FName& Key |
RivermaxMediaSource.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsSRGBInput_DEPRECATED | bool | Whether the video input is in sRGB color space.If true, sRGBToLinear will be done on incoming pixels before writing to media texture | RivermaxMediaSource.h |
|
| bUseZeroLatency_DEPRECATED | bool | If true, when looking for the sample to render, the current frame number will be looked for. | RivermaxMediaSource.h |
|
| PlayerMode_DEPRECATED | ERivermaxPlayerMode_DEPRECATED | Player mode to be used. | RivermaxMediaSource.h |
|