USystemTimeTimecodeProvider | Unreal Engine 5.7 Documentation

Converts the current system time to timecode, relative to a provided frame rate.


Name	USystemTimeTimecodeProvider
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/Engine/SystemTimeTimecodeProvider.h
Include Path	#include "Engine/SystemTimeTimecodeProvider.h"

Syntax

UCLASS (Config=Engine, Blueprintable, EditInlineNew, MinimalAPI)  
class USystemTimeTimecodeProvider : public UTimecodeProvider

Name	Remarks	Include Path	Unreal Specifiers
USystemTimeTimecodeProvider()		Engine/SystemTimeTimecodeProvider.h

Name	Type	Remarks	Include Path	Unreal Specifiers
bGenerateFullFrame	bool	When generating frame time, should we generate full frame without subframe value.	Engine/SystemTimeTimecodeProvider.h	EditAnywhere Category=Timecode
bUseHighPerformanceClock	bool	Use the high performance clock instead of the system time to generate the timecode value.	Engine/SystemTimeTimecodeProvider.h	AdvancedDisplay EditAnywhere Category=Timecode
FrameRate	FFrameRate	The frame rate at which the timecode value will be generated.	Engine/SystemTimeTimecodeProvider.h	EditAnywhere Category=Timecode

Name	Type	Remarks	Include Path	Unreal Specifiers
State	ETimecodeProviderSynchronizationState	Current state of the provider	Engine/SystemTimeTimecodeProvider.h

Name	Remarks	Include Path
virtual FQualifiedFrameTime GetQualifiedFrameTime ()	Return current frame time.	Engine/SystemTimeTimecodeProvider.h
virtual ETimecodeProviderSynchronizationState GetSynchronizationState()	The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.	Engine/SystemTimeTimecodeProvider.h
virtual bool Initialize ( UEngine* InEngine )	This Provider became the Engine's Provider.	Engine/SystemTimeTimecodeProvider.h
virtual void Shutdown ( UEngine* InEngine )	This Provider stopped being the Engine's Provider.	Engine/SystemTimeTimecodeProvider.h

Name	Remarks	Include Path
static FFrameTime GenerateFrameTimeFromHighPerformanceClock ( FFrameRate Rate )	Generate a frame time value, including subframe, using the high performance clock Using the high performance clock is faster but will make the value drift over time.	Engine/SystemTimeTimecodeProvider.h
static FFrameTime GenerateFrameTimeFromSystemTime ( FFrameRate Rate )	Generate a frame time value, including subframe, using the system clock.	Engine/SystemTimeTimecodeProvider.h
static FTimecode GenerateTimecodeFromHighPerformanceClock ( FFrameRate Rate )	Generate a timecode value using the high performance clock Using the high performance clock is faster but will make the value drift over time.	Engine/SystemTimeTimecodeProvider.h
static FTimecode GenerateTimecodeFromSystemTime ( FFrameRate Rate )	Generate a timecode value using the system clock.	Engine/SystemTimeTimecodeProvider.h