UTimeSynchronizationSource

Base class for sources to be used for time synchronization.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

TimeManagement

Header

/Engine/Source/Runtime/TimeManagement/Public/TimeSynchronizationSource.h

Include

#include "TimeSynchronizationSource.h"

Syntax

class UTimeSynchronizationSource : public UObject

Remarks

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.

Variables

Name Description

Public variable

bool

 

bUseForSynchronization

Whether or not this source should be considered when establishing synchronization.

Public variable

int32

 

FrameOffset

An additional offset in frames (relative to this source's frame rate) that should used.

Constructors

Name Description

Public function

UTimeSynchronizationSource

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

FFrameTime

 

AddOffsetWithRolloverModulus

(
    const FFrameTime& FrameTime,
    const int32 Offset,
    const FFrameTime& RolloverModulus
)

Adds an integer offset (representing frames) to the given FrameTime.

Public function Virtual

void

 

Close()

Called when synchronization has been completed. The source may discard any unnecessary frames.

Public function Static

FTimecode

 

ConvertFrameTimeToTimecode

(
    const FFrameTime& FrameTime,
    const FFrameRate& FrameRate
)

Convenience method to convert a FrameTime and FrameRate to a timecode value.

Public function Static

int32

 

FindDistanceBetweenFramesWithRolloverModulus

(
    const FFrameTime& StartFrameTime,
    const FFrameTime& EndFrameTime,
    const TOptional< FFrameTime >& Rol...,
    bool& bDidRollover
)

Calculates the distance between two frames.

Public function Virtual Const

FString

 

GetDisplayName()

Name to used when displaying an error message or to used in UI.

Public function Virtual Const

FFrameRate

 

GetFrameRate()

Get the source actual FrameRate

Public function Virtual Const

FFrameTime

 

GetNewestSampleTime()

Get the time of the newest available sample (relative to this source's frame rate).

Public function Virtual Const

FFrameTime

 

GetOldestSampleTime()

Get the time of the oldest available sample (relative to this source's frame rate).

Public function Virtual Const

TSharedRef< ...

 

GetVisualWidget()

Get Visual Widget of this source to display in UI

Public function 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.

Public function Virtual Const

bool

 

IsReady()

Used to know if the source is ready to be used for synchronization.

Public function Virtual

bool

 

Open

(
    const FTimeSynchronizationOpenData ...
)

Called when synchronization is started to notify this source to begin buffering frames.

Public function Virtual

void

 

Start

(
    const FTimeSynchronizationStartData...
)

Start playing samples.