Navigation
API > API/Plugins > API/Plugins/LiveLink
Inheritance Hierarchy
- UEngineCustomTimeStep
- UFixedFrameRateCustomTimeStep
- UGenlockedCustomTimeStep
- ULiveLinkCustomTimeStep
References
| Module | LiveLink |
| Header | /Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/LiveLinkCustomTimeStep.h |
| Include | #include "LiveLinkCustomTimeStep.h" |
Syntax
UCLASS (Blueprintable, EditInlineNew, MinimalAPI)
class ULiveLinkCustomTimeStep : public UGenlockedCustomTimeStep
Remarks
Control the Engine TimeStep via a live link source
Philosophy:
- Quantized time steps based on live link expected data rate.
- Made for Live Link sources can receive data asynchronously, and therefore trigger the waiting game thread.
- FApp::GetDeltaTime
- Forced to a multiple of the desired FrameTime.
- This multiple will depend on Frame Id increment and user settings.
- FApp::GetCurrentTime
- Incremented in multiples of the desired FrameTime.
Variables
| Type | Name | Description | |
|---|---|---|---|
   |
bool | bLockStepMode | Lockstep mode means that we only allow FrameRateDivider data frames of the selected subject per engine loop. |
   |
uint32 | FrameRateDivider | Allows genlock to period to be a multiple of the live link data period. |
   |
FFrameRate | LiveLinkDataRate | Expected Live Link data rate. |
   |
FLiveLinkSubjectKey | SubjectKey | The specific subject that we listen to. |
   |
double | TimeoutInSeconds | Determines how long it should wait for live link data before deciding that it is not in synchronized state anymore |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
void | BeginDestroy () |
|
   |
ECustomTimeStepSynchronizationState | ||
  |
bool | Initialize
(
UEngine* InEngine |
|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
|
  |
void | Shutdown
(
UEngine* InEngine |
|
  |
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 |