Navigation
API > API/Plugins > API/Plugins/RivermaxMedia
Genlock using PTP time from a rivermax card
| Name | URivermaxCustomTimeStep |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Rivermax/RivermaxMedia/Source/RivermaxMedia/Public/RivermaxCustomTimeStep.h |
| Include Path | #include "RivermaxCustomTimeStep.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew)
class URivermaxCustomTimeStep : public UGenlockedCustomTimeStep
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEngineCustomTimeStep → UFixedFrameRateCustomTimeStep → UGenlockedCustomTimeStep → URivermaxCustomTimeStep
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AlignmentPointDelayMS | double | Delay from alignment point at which we tick the engine, in milliseconds | RivermaxCustomTimeStep.h |
|
| bEnableOverrunDetection | bool | When enabled, will warn for skipped frames when engine is too slow | RivermaxCustomTimeStep.h |
|
| FrameRate | FFrameRate | Target frame rate to which to genlock. Uses ST2059 standard to align PTP time to standard genlock | RivermaxCustomTimeStep.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIgnoreWarningForOneFrame | bool | RivermaxCustomTimeStep.h | ||
| bIsPreviousFrameNumberValid | bool | Frame number tracking | RivermaxCustomTimeStep.h | |
| BoundaryMonitorListener | FGuid | Frame boundary monitoring ID | RivermaxCustomTimeStep.h | |
| CachedFrameRate | FFrameRate | Cached frame rate used for boundary monitoring | RivermaxCustomTimeStep.h | |
| DeltaFrameNumber | uint64 | RivermaxCustomTimeStep.h | ||
| InitializedEngine | TObjectPtr< UEngine > | Engine used to initialize the Provider | RivermaxCustomTimeStep.h |
|
| PreviousFrameNumber | uint64 | RivermaxCustomTimeStep.h | ||
| State | ECustomTimeStepSynchronizationState | The current SynchronizationState of this custom timestep | RivermaxCustomTimeStep.h |
Functions
Public
Overridden from UGenlockedCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual uint32 GetLastSyncCountDelta() |
RivermaxCustomTimeStep.h | ||
virtual FFrameRate GetSyncRate() |
RivermaxCustomTimeStep.h | ||
virtual bool IsLastSyncDataValid() |
RivermaxCustomTimeStep.h | ||
virtual bool WaitForSync() |
RivermaxCustomTimeStep.h |
Overridden from UFixedFrameRateCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FFrameRate GetFixedFrameRate() |
RivermaxCustomTimeStep.h |
Overridden from UEngineCustomTimeStep
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ECustomTimeStepSynchronizationState GetSynchronizationState() |
RivermaxCustomTimeStep.h | ||
virtual bool Initialize
(
UEngine* InEngine |
RivermaxCustomTimeStep.h | ||
virtual void Shutdown
(
UEngine* InEngine |
RivermaxCustomTimeStep.h | ||
virtual bool UpdateTimeStep
(
UEngine* InEngine |
RivermaxCustomTimeStep.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
RivermaxCustomTimeStep.h |