Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

USystemTimeTimecodeProvider

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTimecodeProvider

USystemTimeTimecodeProvider

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/SystemTimeTimecodeProvider.h
Include	#include "Engine/SystemTimeTimecodeProvider.h"

Syntax

class USystemTimeTimecodeProvider : public UTimecodeProvider

Remarks

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

Variables

	Name	Description
bool	bGenerateFullFrame	When generating frame time, should we generate full frame without subframe value.
bool	bUseHighPerformanceClock	Use the high performance clock instead of the system time to generate the timecode value.
FFrameRate	FrameRate	The frame rate at which the timecode value will be generated.

Constructors

	Name	Description
	USystemTimeTimecodeProvider()

Functions

	Name	Description
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.
FFrameTime	GenerateFrameTimeFromSystemTime ( FFrameRate Rate )	Generate a frame time value, including subframe, using the system clock.
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.
FTimecode	GenerateTimecodeFromSystemTime ( FFrameRate Rate )	Generate a timecode value using the system clock.

Overridden from UTimecodeProvider

	Name	Description
FQualifiedFr...	GetQualifiedFrameTime()	Return current frame time.
ETimecodePro...	GetSynchronizationState()	The state of the TimecodeProvider and if it's currently synchronized and the Timecode and FrameRate getters are valid.
bool	Initialize ( UEngine* InEngine )	This Provider became the Engine's Provider.
void	Shutdown ( UEngine* InEngine )	This Provider stopped being the Engine's Provider.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss