1. Epic GamesDeveloper
  3. FClockOffsetEstimatorRamp

FClockOffsetEstimatorRamp

Continually estimates the time offset between two live time sources.

API > API/Plugins > API/Plugins/LiveLink

References

   
Module LiveLink
Header /Engine/Plugins/Animation/LiveLink/Source/LiveLink/Public/ClockOffsetEstimatorRamp.h
Include #include "ClockOffsetEstimatorRamp.h"

Syntax

class FClockOffsetEstimatorRamp

Remarks

Continually estimates the time offset between two live time sources.

Samples of clock times corresponding to the same instant are provided, and it will update its estimation of the time difference between the clocks.

Variables

  Type Name Description
Protected variable int32 ConsecutiveBigErrorCount Current consecutive big error count. Initialized at required count so first pass snaps
Protected variable int32 ConsecutiveTooBigErrorRequired Consecutive time a too big estimation error is required before clamping
Protected variable double CorrectionStep Correction step to apply, positive or negative depending on error sign
Protected variable double EstimatedOffset Current estimated offset between two clocks
Protected variable double MaxAllowedEstimationError Maximum error tolerated before considering clamping to current offset

Functions

  Type Name Description
Public function Const double Get current estimated offset between the two tracked clocks
Public function void

Reset ()

 Puts back the estimator in its initial state
Public function void

SetCorrectionStep ( double NewValue
)

 Sets incremental correction step
Public function void

SetMaxAllowedEstimationError ( double NewValue
)

 Set maximum allowed estimation error before looking to clamp
Public function void Set required consecutive big errors to clamp
Public function void

UpdateEstimation ( double Atime,
double Btime
)

 Update the current time offset estimation with a new data sample

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page