Navigation
API > API/Plugins > API/Plugins/RivermaxCore
Not doing much at the moment but should be used as a central point to register every stream created and keep track of stats. Also manages initialization of the library.
| Name | IRivermaxManager |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxCore/Source/RivermaxCore/Public/IRivermaxManager.h |
| Include Path | #include "IRivermaxManager.h" |
Syntax
class IRivermaxManager
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IRivermaxManager() |
IRivermaxManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DisableDynamicHeaderSupport
(
const FString& Interface |
If it's the last user of that interface, we disable dynamic header | IRivermaxManager.h | |
bool EnableDynamicHeaderSupport
(
const FString& Interface |
Enables dynamic header support for a particular Rivermax device. | IRivermaxManager.h | |
const Private::RIVERMAX_API_FUNCTION_LIST * GetApi() |
Return the Rivermax API. | IRivermaxManager.h | |
TConstArrayView< FRivermaxDeviceInfo > GetDevices() |
Returns list of found devices that can be used | IRivermaxManager.h | |
| Returns a matching device interface address for the provided source IP | IRivermaxManager.h | ||
uint64 GetTime() |
Returns current time in nanoseconds for Rivermax If PTP is available, it will be used If not, FPlatform::Seconds will be used | IRivermaxManager.h | |
ERivermaxTimeSource GetTimeSource() |
Returns where time is coming from | IRivermaxManager.h | |
bool IsGPUDirectInputSupported() |
Whether gpudirect is enabled for input streams. | IRivermaxManager.h | |
bool IsGPUDirectOutputSupported() |
Whether gpudirect is enabled for output streams. | IRivermaxManager.h | |
bool IsGPUDirectSupported() |
Whether gpudirect is supported on this platform. At the moment, we rely on CUDA to handle it. | IRivermaxManager.h | |
bool IsLibraryInitialized() |
Returns true if Rivermax library has been initialized and is usable | IRivermaxManager.h | |
bool IsManagerInitialized() |
Returns true if RivermaxManager has been initialized | IRivermaxManager.h | |
bool IsValidIP
(
const FString& InSourceIP |
Returns true if provided IP string is in a valid format | IRivermaxManager.h | |
FOnPostRivermaxManagerInit & OnPostRivermaxManagerInit() |
Delegate triggered after manager has been initialized and library tried to be loaded | IRivermaxManager.h | |
bool ValidateLibraryIsLoaded() |
Returns true if Rivermax library has been initialized and is usable, but also warns the user with a toast notification if it's not. | IRivermaxManager.h |