Navigation
API > API/Plugins > API/Plugins/RivermaxMedia
Inheritance Hierarchy
- UEngineCustomTimeStep
- UFixedFrameRateCustomTimeStep
- UGenlockedCustomTimeStep
- URivermaxCustomTimeStep
References
| Module | RivermaxMedia |
| Header | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxMedia/Source/RivermaxMedia/Public/RivermaxCustomTimeStep.h |
| Include | #include "RivermaxCustomTimeStep.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew)
class URivermaxCustomTimeStep : public UGenlockedCustomTimeStep
Remarks
Genlock using PTP time from a rivermax card
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
double | AlignmentPointDelayMS | Delay from alignment point at which we tick the engine, in milliseconds |
   |
bool | bEnableOverrunDetection | When enabled, will warn for skipped frames when engine is too slow |
   |
FFrameRate | FrameRate | Target frame rate to which to genlock. Uses ST2059 standard to align PTP time to standard genlock |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
ECustomTimeStepSynchronizationState | ||
  |
bool | Initialize
(
UEngine* InEngine |
|
  |
void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
|
  |
void | ||
  |
bool | UpdateTimeStep
(
UEngine* InEngine |
Overridden from UGenlockedCustomTimeStep
| Type | Name | Description | |
|---|---|---|---|
   |
uint32 | Returns how many syncs occurred since the last tick | |
   |
FFrameRate | GetSyncRate () |
Get the sync rate (not always the same as the fixed frame rate) |
   |
bool | Returns true if the Sync related functions will return valid data | |
  |
bool | WaitForSync () |
Blocks until it gets a sync signal. Returns false if unsuccessful |
Overridden from UFixedFrameRateCustomTimeStep
| Type | Name | Description | |
|---|---|---|---|
   |
FFrameRate | Get The fixed FrameRate |