Navigation
Unreal Engine C++ API Reference > Runtime > TimeManagement
Inheritance Hierarchy
- UObject
- UTimeSynchronizationSource
- ULiveLinkTimeSynchronizationSource
- UMediaBundleTimeSynchronizationSource
- UMediaPlayerTimeSynchronizationSource
References
Module | TimeManagement |
Header | /Engine/Source/Runtime/TimeManagement/Public/TimeSynchronizationSource.h |
Include | #include "TimeSynchronizationSource.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
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
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
bool | bUseForSynchronization | Whether or not this source should be considered when establishing synchronization. |
![]() ![]() ![]() |
int32 | FrameOffset | An additional offset in frames (relative to this source's frame rate) that should used. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UTimeSynchronizationSource
(
const FObjectInitializer& ObjectInitializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
FFrameTime | AddOffsetWithRolloverModulus
(
const FFrameTime& FrameTime, |
Adds an integer offset (representing frames) to the given FrameTime. |
![]() ![]() |
void | Close () |
Called when synchronization has been completed. The source may discard any unnecessary frames. |
![]() ![]() |
FTimecode | ConvertFrameTimeToTimecode
(
const FFrameTime& FrameTime, |
Convenience method to convert a FrameTime and FrameRate to a timecode value. |
![]() ![]() |
int32 | FindDistanceBetweenFramesWithRolloverModulus
(
const FFrameTime& StartFrameTime, |
Calculates the distance between two frames. |
![]() ![]() ![]() |
FString | Name to used when displaying an error message or to used in UI. | |
![]() ![]() ![]() |
FFrameRate | GetFrameRate () |
Get the source actual FrameRate |
![]() ![]() ![]() |
FFrameTime | Get the time of the newest available sample (relative to this source's frame rate). | |
![]() ![]() ![]() |
FFrameTime | Get the time of the oldest available sample (relative to this source's frame rate). | |
![]() ![]() ![]() |
TSharedRef< SWidget > | Get Visual Widget of this source to display in UI | |
![]() ![]() |
bool | IsFrameBetweenWithRolloverModulus
(
const FFrameTime& ToCheck, |
Checks to see whether or not the given frame is between the Lower and Upper bounds. |
![]() ![]() ![]() |
bool | IsReady () |
Used to know if the source is ready to be used for synchronization. |
![]() ![]() |
bool | Open
(
const FTimeSynchronizationOpenData& OpenData |
Called when synchronization is started to notify this source to begin buffering frames. |
![]() ![]() |
void | Start
(
const FTimeSynchronizationStartData& StartData |
Start playing samples. |