Navigation
API > API/Plugins > API/Plugins/RivermaxCore
References
| Module | RivermaxCore |
| Header | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxCore/Source/RivermaxCore/Public/IRivermaxManager.h |
| Include | #include "IRivermaxManager.h" |
Syntax
class IRivermaxManager
Remarks
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.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | DisableDynamicHeaderSupport
(
const FString& Interface |
If it's the last user of that interface, we disable dynamic header |
 |
bool | EnableDynamicHeaderSupport
(
const FString& Interface |
Enables dynamic header support for a particular Rivermax device. |
  |
const Private::RIVERMAX_API_FUNCTION_LIST * | GetApi () |
Return the Rivermax API. |
  |
TConstArrayView< FRivermaxDeviceInfo > | GetDevices () |
Returns list of found devices that can be used |
  |
bool | GetMatchingDevice
(
const FString& InSourceIP, |
Returns a matching device interface address for the provided source IP |
  |
uint64 | GetTime () |
Returns current time in nanoseconds for Rivermax If PTP is available, it will be used If not, FPlatform::Seconds will be used |
  |
ERivermaxTimeSource | Returns where time is coming from | |
  |
bool | Whether gpudirect is enabled for input streams. | |
  |
bool | Whether gpudirect is enabled for output streams. | |
  |
bool | Whether gpudirect is supported on this platform. At the moment, we rely on CUDA to handle it. | |
  |
bool | Returns true if Rivermax library has been initialized and is usable | |
  |
bool | Returns true if RivermaxManager has been initialized | |
  |
bool | Returns true if provided IP string is in a valid format | |
 |
FOnPostRivermaxManagerInit & | Delegate triggered after manager has been initialized and library tried to be loaded | |
  |
bool | Returns true if Rivermax library has been initialized and is usable, but also warns the user with a toast notification if it's not. |