Navigation
API > API/Plugins > API/Plugins/RivermaxCore
Core module for Rivermax access from the engine. Users can create different stream types that are exposed to get data flow ongoing.
| Name | IRivermaxCoreModule |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxCore/Source/RivermaxCore/Public/IRivermaxCoreModule.h |
| Include Path | #include "IRivermaxCoreModule.h" |
Syntax
class IRivermaxCoreModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| IRivermaxCoreModule.h | |||
TUniquePtr< UE::RivermaxCore::IRivermaxInputStream > CreateInputStream
(
UE::RivermaxCore::ERivermaxStreamType, |
Create input stream managing receiving data from rivermax | IRivermaxCoreModule.h | |
| IRivermaxCoreModule.h | |||
TUniquePtr< UE::RivermaxCore::IRivermaxOutputStream > CreateOutputStream
(
UE::RivermaxCore::ERivermaxStreamType, |
Create output stream managing sending data to rivermax | IRivermaxCoreModule.h | |
UE::RivermaxCore::IRivermaxBoundaryMonitor & GetRivermaxBoundaryMonitor() |
Returns frame boundary monitor | IRivermaxCoreModule.h | |
TSharedPtr< UE::RivermaxCore::IRivermaxManager > GetRivermaxManager() |
Returns Rivermax manager singleton to query for stats, status, etc... | IRivermaxCoreModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IRivermaxCoreModule & Get() |
IRivermaxCoreModule.h | ||
static bool IsAvailable() |
IRivermaxCoreModule.h |