UTimeSynchronizationSource | Unreal Engine 5.7 Documentation

Base class for sources to be used for time synchronization.

Subclasses don't need to directly contain data, nor provide access to the data in any way (although they may).

Currently, Synchronization does not work on the subframe level.


Name	UTimeSynchronizationSource
Type	class
Header File	/Engine/Source/Runtime/TimeManagement/Public/TimeSynchronizationSource.h
Include Path	#include "TimeSynchronizationSource.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UTimeSynchronizationSource : public UObject

Name	Remarks	Include Path	Unreal Specifiers
UTimeSynchronizationSource ( const FObjectInitializer& ObjectInitializer )		TimeSynchronizationSource.h

Name	Type	Remarks	Include Path	Unreal Specifiers
bUseForSynchronization	bool	Whether or not this source should be considered when establishing synchronization.	TimeSynchronizationSource.h	EditAnywhere Category=Synchronization
FrameOffset	int32	An additional offset in frames (relative to this source's frame rate) that should used.	TimeSynchronizationSource.h	EditAnywhere Category=Synchronization

Name	Remarks	Include Path
virtual void Close()	Called when synchronization has been completed. The source may discard any unnecessary frames.	TimeSynchronizationSource.h
virtual FString GetDisplayName()	Name to used when displaying an error message or to used in UI.	TimeSynchronizationSource.h
virtual FFrameRate GetFrameRate()	Get the source actual FrameRate	TimeSynchronizationSource.h
virtual FFrameTime GetNewestSampleTime ()	Get the time of the newest available sample (relative to this source's frame rate).	TimeSynchronizationSource.h
virtual FFrameTime GetOldestSampleTime ()	Get the time of the oldest available sample (relative to this source's frame rate).	TimeSynchronizationSource.h
virtual TSharedRef< SWidget > GetVisualWidget()	Get Visual Widget of this source to display in UI	TimeSynchronizationSource.h
virtual bool IsReady()	Used to know if the source is ready to be used for synchronization.	TimeSynchronizationSource.h
virtual bool Open ( const FTimeSynchronizationOpenData& OpenData )	Called when synchronization is started to notify this source to begin buffering frames.	TimeSynchronizationSource.h
virtual void Start ( const FTimeSynchronizationStartData& StartData )	Start playing samples.	TimeSynchronizationSource.h

Name	Remarks	Include Path
static FFrameTime AddOffsetWithRolloverModulus ( const FFrameTime& FrameTime, const int32 Offset, const FFrameTime& RolloverModulus )	Adds an integer offset (representing frames) to the given FrameTime.	TimeSynchronizationSource.h
static FTimecode ConvertFrameTimeToTimecode ( const FFrameTime& FrameTime, const FFrameRate& FrameRate )	Convenience method to convert a FrameTime and FrameRate to a timecode value.	TimeSynchronizationSource.h
static int32 FindDistanceBetweenFramesWithRolloverModulus ( const FFrameTime& StartFrameTime, const FFrameTime& EndFrameTime, const TOptional< FFrameTime >& RolloverModulus, bool& bDidRollover )	Calculates the distance between two frames.	TimeSynchronizationSource.h
static bool IsFrameBetweenWithRolloverModulus ( const FFrameTime& ToCheck, const FFrameTime& LowerBound, const FFrameTime& UpperBound, const FFrameTime& RolloverModulus )	Checks to see whether or not the given frame is between the Lower and Upper bounds.	TimeSynchronizationSource.h